Skip to main content
PATCH
Update saved recipient

Authorizations

X-Api-Key
string
header
default:sb_test_your_key
required

API credential. Withdrawal quote and submit operations additionally require the documented Ed25519 timestamp, nonce, and signature headers.

Path Parameters

recipient_id
string<uuid>
required

Saved recipient ID returned by create or list recipient endpoints.

Body

application/json

Mutable recipient fields to update. Bank detail changes require account verification again.

Mutable saved-recipient fields to update.

account_name
string | null
account_number
string | null
bank_code
string | null
bank_name
string | null
chain
string | null
country
string | null

ISO-3166 alpha-3 country code for crypto recipients. Omit to keep the current value.

Example:

"NGA"

crypto_address
string | null
currency
string | null
label
string | null

Response

Recipient updated

data
object
required

Saved fiat or crypto recipient record.

status
enum<string>
required
Available options:
success