カードを削除

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

顧客のアカウントからカードを完全に削除します。このアクションは取り消すことができません。

---

リクエストパラメータ

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

▼

`id`STRING(required)

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

Example:"cust_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効な顧客IDである必要があります

`card_id`STRING(required)

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

Example:"card_test_5xuy4w91xqz7d1w9u0t"

Constraints:有効なカードIDである必要があります, カードは顧客に属している必要があります

---

レスポンス

200

カードが正常に削除されました

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

削除の影響:

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

400

不正なリクエスト

無効な顧客IDまたはカードID形式です。

一般的な原因:

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

401

認証エラー

認証に失敗しました。APIキーが無効または不足しています。

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用
• HTTP Basic Auth形式の誤り

404

見つかりません

顧客またはカードが見つかりません。

一般的な原因:

• 顧客IDが存在しない
• カードIDが存在しない
• カードが指定された顧客に属していない
• カードがすでに削除済み

5xx

サーバーエラー

サーバー側でエラーが発生しました。稀ですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストを再試行
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスはエラー処理を参照

---

コードサンプル

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",
)

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決策
bad_request	無効なID形式	顧客とカードのID形式を確認
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
not_found	顧客またはカードが見つからない	IDが存在し、カードが顧客に属しているか確認
conflict	使用中のカードを削除できない	保留中の課金が完了するまで待機

削除レスポンス

フィールド	説明
object	オブジェクトタイプ（常に"card"）
id	削除されたカードのID
deleted	ブールフラグ（成功した削除の場合は常にtrue）
livemode	本番モードのカードかどうか

---

🔑API認証情報

▼

試してみる

必須 - 2項目

▼

id(必須)

card_id(必須)

あなたのIP: ...読み込み中...