Skip to navigation
API ReferenceFunding

Withdrawal

Withdraw funds from the funding account to an on-chain address or via internal transfer. Only supported for on-chain and internal withdrawal.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
ccystringRequired
Currency, e.g. USDT.
amtstringRequired
Withdrawal amount. The withdrawal fee is not included in this amount.
destenumRequired

Withdrawal method: 3=internal transfer, 4=on-chain withdrawal.

Allowed values:
toAddrstringRequired

For on-chain: the recipient address (may append tag/memo with :). For internal transfer: recipient's email, phone, or login account name.

toAddrTypeenumOptional

Address type: 1=wallet address/email/phone/login account name, 2=UID (only for whitelisted users; applicable only when dest=3).

Allowed values:
chainstringOptional

Chain name, e.g. USDT-ERC20, USDT-TRC20. If not set, the default chain of the currency is used.

areaCodestringOptional
Area code for the phone number, required when toAddr is a phone number.
clientIdstringOptional

Client-supplied ID. A combination of case-sensitive alphanumerics, up to 32 characters.

rcvrInfoobjectOptional

Recipient information, required for some entity users doing on-chain/lightning withdrawals.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional