Skip to main content
POST
Create 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.

Body

application/json

Recipient details to save in the account address book. This request does not submit a withdrawal.

Recipient details to save in the account address book.

label
string
required
Example:

"Main USDT recipient"

recipient_type
enum<string>
required

Saved recipient type. Fiat recipients use bank details; crypto recipients use chain and address details.

Available options:
fiat,
crypto
account_name
string | null
Example:

"Jane Doe"

account_number
string | null
Example:

"0123456789"

bank_code
string | null
Example:

"058"

bank_name
string | null
Example:

"GTBank"

chain
string | null
Example:

"evm"

country
string | null

ISO-3166 alpha-3 country code for crypto recipients. Null for existing recipients or when the client has not collected the destination country.

Example:

"NGA"

crypto_address
string | null
Example:

"0x1234...abcd"

currency
string | null
Example:

"USDT"

Response

Recipient created

data
object
required

Saved fiat or crypto recipient record.

status
enum<string>
required
Available options:
success