Cardの削除

DELETEhttps://api.omise.co/customers/:id/cards/:card_id

顧客アカウントからカードを完全に削除します。この操作は元に戻すことができません。

---

🔑API認証情報

▼

---

リクエストパラメータ

必須 - 2フィールドパスパラメータ

▼

`id`STRING(required)

Customer ID（cust_で始まる有効なCustomer IDである必要があります）。

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid customer ID

`card_id`STRING(required)

削除するCard ID（card_で始まる有効なCard IDである必要があります）。

Example:"card_test_5xuy4w91xqz7d1w9u0t"

Constraints:Must be a valid card ID, Card must belong to the customer

---

レスポンス

200

Cardが正常に削除されました

顧客アカウントからカードが完全に削除されました。

削除の影響:

• Cardは顧客から完全に削除されます
• Card詳細にアクセスできなくなります
• 今後の課金にCardを使用できなくなります
• 過去の課金は記録に残りますが、cardフィールドはnullになります
• これがデフォルトのカードだった場合、顧客のdefault_cardはnullになります
• 削除を元に戻すことはできません

400

不正なリクエスト

無効なcustomer IDまたはcard IDの形式です。

一般的な原因:

• 無効なIDの形式
• IDがcust_またはcard_で始まっていません

401

認証されていません

認証に失敗しました。無効または欠落しているAPI keyです。

一般的な原因:

• Authorizationヘッダーが欠落しています
• 無効なsecret key
• secret keyの代わりにpublic keyを使用しています
• HTTP Basic Authの形式が正しくありません

404

見つかりません

CustomerまたはCardが見つかりません。

一般的な原因:

• Customer IDが存在しません
• Card IDが存在しません
• Cardが指定された顧客に属していません
• Cardはすでに削除されています

---

コードサンプル

cURL

curl https://api.omise.co/customers/cust_test_5xuy4w91xqz7d1w9u0t/cards/card_test_5xuy4w91xqz7d1w9u0t \
  -X DELETE \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

card = Omise::Card.destroy(
  'card_test_5xuy4w91xqz7d1w9u0t',
  customer_id: 'cust_test_5xuy4w91xqz7d1w9u0t'
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

customer = omise.Customer.retrieve('cust_test_5xuy4w91xqz7d1w9u0t')
card = customer.destroy_card('card_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const card = await omise.customers.destroyCard(
  'cust_test_5xuy4w91xqz7d1w9u0t',
  'card_test_5xuy4w91xqz7d1w9u0t'
);

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$customer = OmiseCustomer::retrieve('cust_test_5xuy4w91xqz7d1w9u0t');
$card = $customer->destroyCard('card_test_5xuy4w91xqz7d1w9u0t');

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Card card = client.customer("cust_test_5xuy4w91xqz7d1w9u0t")
    .card("card_test_5xuy4w91xqz7d1w9u0t")
    .destroy();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var card = await client.Customers.DestroyCard(
    "cust_test_5xuy4w91xqz7d1w9u0t",
    "card_test_5xuy4w91xqz7d1w9u0t"
);

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

deleted, _ := client.Cards().DestroyCard(
    "cust_test_5xuy4w91xqz7d1w9u0t",
    "card_test_5xuy4w91xqz7d1w9u0t",
)

---

エラーと結果コード

一般的なエラーコード

Code	Description	Resolution
bad_request	無効なIDの形式	customer IDとcard IDの形式を確認してください
authentication_failure	無効なAPI key	secret keyが正しいことを確認してください
not_found	CustomerまたはCardが見つかりません	IDが存在し、カードが顧客に属していることを確認してください
conflict	使用中のカードを削除できません	保留中の課金が完了するまでお待ちください

削除レスポンス

Field	Description
object	Objectのタイプ（常に「card」）
id	削除されたCardのID
deleted	ブーリアンフラグ（削除成功時は常にtrue）
livemode	これがlive modeのカードであったかどうか

---

試してみる

必須 - 2項目

▼

id(必須)

card_id(必須)