Skip to main content

Withdraw

Frequency limit:10 times/1s (UID)

Description

Coin withdrawals including on-chain withdrawals and internal transfers(the address needs to be added in the address book on web)

HTTP Request

  • POST /api/v2/spot/wallet/withdrawal
Request Example
curl -X POST "https://api.cointr.com/api/v2/spot/wallet/withdrawal" \  
-H "ACCESS-KEY:your apiKey" \
-H "ACCESS-SIGN:*" \
-H "ACCESS-PASSPHRASE:*" \
-H "ACCESS-TIMESTAMP:1659076670000" \
-H "locale:en-US" \
-H "Content-Type: application/json" \
-d '{"coin": "USDT","transferType":"internal_transfer","internal_withdraw","address": "*******************************************","chain": "trc20","size": "0.009"}

Request Parameters

ParameterTypeRequiredDescription
coinStringYesCoin
All coin names can be returned from Get Coin Info interface
transferTypeStringYesThe type of withdrawal
on_chain: withdrawal on chain
internal_transfer: Transfer internally
addressStringYesWithdrawal address
when transferType is on_chain, it represents the chain address
When transferType is internal_transfer, according the innerToType parameter, please input the UID, email or the mobile
chainStringNoChain network e.g. erc20, trc20, etc.
This field must be passed when the transferType is on-chain.
You can get the chain names via Get Coin Info interface
innerToTypeStringNoType of address for internal withdrawals
email: Email address
mobile: Mobile phone number
uid: UID
The default value is uid
areaCodeStringNoThis field is required when the value of the collection address type is mobile
tagStringNoAddress tag
Some special coins need this field, e.g. EOS
sizeStringYesWithdrawal amount
Special instructions for Bitcoin Lightning Network withdrawals:
1.This parameter must be filled in with a value that is equal to the deposit amount of your invoice on the Bitcoin Lightning Network;
2.The value of size is the credited amount, excluding fees;
The decimal places of withdrawal amount will be returned by the Get Coin Info interface
remarkStringNoNote
clientOidStringNoClient Unique Customized Id
Response Example
{
"code": "00000",
"msg": "success",
"requestTime": 1695808949356,
"data": {
"orderId": "123",
"clientOid": "123"
}
}

Response Parameters

ParameterTypeDescription
orderIdStringOrder ID
clientOidStringCustom order ID