Recipientの削除

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

将来のtransferを防ぐためにrecipientを完全に削除します。Recipientへの既存のtransferは影響を受けません。

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

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

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

成功したトランザクション

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

レスポンス構造:

• object - "recipient"
• id - 削除されたrecipientのID
• deleted - true（削除を確認）

401

認証されていません

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

一般的な原因:

• Authorizationヘッダーの欠落
• 無効なsecret key
• Secret keyの代わりにpublic keyを使用
• HTTP Basic Auth形式が不正

404

見つかりません

Recipientが見つかりません。

一般的な原因:

• 無効なrecipient ID
• Recipientがアカウントに属していません
• Recipientは既に削除されています
• テストモードとライブモードのIDを混在させています

---

Code samples

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への既存のtransferは影響を受けません
• 削除後、recipient IDは再利用できません
• 銀行口座の詳細を更新するには、削除して新しいrecipientを作成してください

---

Try it out

必須 - 1項目

▼

id(必須)