Recipientを削除する

DELETEhttps://api.omise.co/recipients/:id

今後の送金を防ぐためにRecipientを完全に削除します。既存のRecipientへの送金は影響を受けません。

---

リクエストパラメータ

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

▼

`id`STRING(required)

Recipient ID（例：recp_test_...）。URLパスで指定します。

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

成功

Recipientが正常に削除されました。deleted: trueで確認を返します。

返されるRecipient属性:

• object - "recipient"という値
• id - Recipient識別子（recp_*）
• livemode - ライブモードまたはテストモード
• location - Recipientオブジェクトへのパス
• activated_at - 有効化タイムスタンプ（ISO 8601）
• active - Recipientが有効かどうか
• bank_account - 送金先銀行口座オブジェクト
• created_at - 作成タイムスタンプ（ISO 8601）
• default - Recipientがアカウントのデフォルトかどうか
• deleted - Recipientが削除されたかどうか
• description - Recipientの説明
• email - Recipientのメールアドレス
• failure_code - 失敗理由コード（name_mismatch, account_not_found, bank_not_found）
• metadata - カスタムメタデータ
• name - Recipient名
• schedule - 送金スケジュール（展開可能）
• tax_id - Recipientの納税者番号
• type - Recipientタイプ（individual, corporation）
• verified - Recipientが確認済みかどうか
• verified_at - 確認タイムスタンプ（ISO 8601）

401

認証エラー

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

一般的な原因:

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

404

見つかりません

Recipientが見つかりません。

一般的な原因:

• 無効なRecipient ID
• Recipientがアカウントに属していない
• Recipientが既に削除されている
• テストモードとライブモードのIDを混同

5xx

サーバーエラー

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

対処方法:

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

---

コードサンプル

cURL

curl https://api.omise.co/recipients/recp_test_5xuy4w91xqz7d1w9u0t \
  -X DELETE \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
recipient.destroy

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
recipient.destroy()

Node.js

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

await omise.recipients.destroy('recp_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');
$recipient->destroy();

Java

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

client.recipients().destroy("recp_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

await client.Recipients.Delete("recp_test_5xuy4w91xqz7d1w9u0t");

Go

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

recipient, _ := client.Recipients().Destroy("recp_test_5xuy4w91xqz7d1w9u0t")

---

重要事項

• 削除されたRecipientは復元できません
• 削除されたRecipientへの既存の送金は影響を受けません
• 削除後、Recipient IDは再利用できません
• 銀行口座情報を更新するには、削除して新しいRecipientを作成してください

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

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