Skip to main content
DELETE
Delete a transfer recipient
Deleting is immediate for reads: the recipient disappears from the list and answers 404. There is no undelete — recreate it, which mints a new id.
A destination already created from this recipient stays spendable until it expires. Deleting the recipient does not cancel a destination that has been handed to a transfer.

Error codes

Authorizations

Authorization
string
header
required

A secret API key, sent as Authorization: Bearer sk_test_… in sandbox or Bearer sk_live_… in live.

Path Parameters

recipientId
string
required

Saved recipient ULID. A 26-character ULID.

Required string length: 26
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
Example:

"01K2Z3AB4C5D6E7F8G9HJKMNPQ"

Response

Successful response.

deleted
any
required