Skip to main content

Withdrawal request

is used to initiate withdrawals

Request address

  • API Address (requestURI): /openapi/v1/withdrawal/request

Request parameters

Parameter nameTypeRequirementdescription
trackingIdStringRMerchant tracking ID, each transaction operation of each merchant should be guaranteed to be unique
assetTypeIntegerRAsset type, [0: Cryptocurrency, 1: Fiat Currency]
userSelectableIntegerRDeprecated, default is 0, no need to transfer Whether the user is optional, [0: No, 1: Yes]. Optional: Fields such as amount, asset name/currency, network type/payment type can be left blank first, and specified by
assetNameStringRAsset Name/Currency
netProtocolStringRNetwork Type/Payment Type
bankCodeStringCBank code, which is required for payment types in some currencies
bankNameStringCBank name, IDR currency is required
accountNameStringCCardholder Name, IDR Currency Required
bankNumStringCIFSCcode, INR currency requires
amountBigDecimalRAmount
addressStringRWithdrawal address, who you want to pay the money to, such as BTC address, ETH address, bank card number, etc
webhookUrlStringRNotification callback address/webhook url
remarkStringOThe transaction remarks cannot exceed 255, add some additional data or identifiers to the transaction, such as the order number, etc., and the interface will return
text1StringOText 1, only for the display of the cashier page, does not participate in the payment, e.g. 1000
text2StringOText 2, only used for the display of the cashier page, does not participate in the payment, e.g. $1000
text3StringOText 3, only for the display of the cashier page, does not participate in the payment, e.g. Mfedfring
text4StringOText 4, only used for cashier page display, does not participate in payment, e.g. 1USD = 1038KRW
userIdStringRUser ID
userIpStringOUser IP address

Sample request

{
"trackingId": "20220408123456789",
"assetType": 1,
"assetName": "USD",
"netProtocol": "bank",
"bankCode": "BOC",
"bankName": "中国银行",
"accountName": "张三",
"bankNum": "123456",
"amount": 100,
"address": "123456",
"webhookUrl": "https://yourdomain.com/webhook",
"remark": "Withdrawal",
"text1": "100",
"text2": "$100",
"text3": "Mfedfring",
"text4": "1USD = 1038KRW",
"userId": "123456",
"userIp": "127.0.0.1"
}

Response parameters

Parameter nameTypeRequirementdescription
trackingIdStringRMerchant tracking ID
redirectPageUrlStringOThe address of the redirected payment page, if any, please jump to the address where you can make a withdrawal/withdrawal
remarkStringOTransaction notes, add some additional data or identifiers to the transaction, such as the order number, etc., and the interface will return

Sample response

{
"code": 200,
"msg": "success",
"data": {
"trackingId": "20220408123456789",
"redirectPageUrl": "https://yourdomain.com/withdrawal",
"remark": "Withdrawal"
}
}