Delete a recipient

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

Permanently delete a recipient to prevent future transfers. Existing transfers to the recipient are not affected.

---

Request Parameters

Required - 1 fieldRequired Parameters

▼

`id`STRING(required)

Recipient ID (e.g., recp_test_...). Provided in the URL path.

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

---

Responses

200

Successful transaction

Recipient deleted successfully. Returns confirmation with deleted: true.

Returned recipient attributes:

• object - The value "recipient"
• id - Recipient identifier (recp_*)
• livemode - Live or test mode
• location - API path to the recipient object
• activated_at - Activation timestamp (ISO 8601)
• active - Whether recipient is active
• bank_account - Destination bank account object
• created_at - Creation timestamp (ISO 8601)
• default - Whether recipient is account default
• deleted - Whether recipient is deleted
• description - Recipient description
• email - Recipient email address
• failure_code - Failure reason code (name_mismatch, account_not_found, bank_not_found)
• metadata - Custom metadata
• name - Recipient name
• schedule - Transfer schedule (expandable)
• tax_id - Recipient tax ID
• type - Recipient type (individual, corporation)
• verified - Whether recipient is verified
• verified_at - Verification timestamp (ISO 8601)

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

404

Not found

Recipient not found.

Common causes:

• Invalid recipient ID
• Recipient does not belong to your account
• Recipient already deleted
• Mixing test and live mode IDs

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

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

---

Important notes

• Deleted recipients cannot be recovered
• Existing transfers to deleted recipients are not affected
• Once deleted, the recipient ID cannot be reused
• To update bank account details, delete and create a new recipient

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

id(Required)

Your IP: ...Loading...