Withdrawal request
is used to initiate withdrawals
Request address
- API Address (requestURI): /openapi/v1/withdrawal/request
Request parameters
Parameter name | Type | Requirement | description |
---|---|---|---|
trackingId | String | R | Merchant tracking ID, each transaction operation of each merchant should be guaranteed to be unique |
assetType | Integer | R | Asset type, [0: Cryptocurrency, 1: Fiat Currency] |
Integer | Deprecated, default is 0, no need to transfer | ||
assetName | String | R | Asset Name/Currency |
netProtocol | String | R | Network Type/Payment Type |
bankCode | String | C | Bank code, which is required for payment types in some currencies |
bankName | String | C | Bank name, IDR currency is required |
accountName | String | C | Cardholder Name, IDR Currency Required |
bankNum | String | C | IFSCcode, INR currency requires |
amount | BigDecimal | R | Amount |
address | String | R | Withdrawal address, who you want to pay the money to, such as BTC address, ETH address, bank card number, etc |
webhookUrl | String | R | Notification callback address/webhook url |
remark | String | O | The 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 |
text1 | String | O | Text 1, only for the display of the cashier page, does not participate in the payment, e.g. 1000 |
text2 | String | O | Text 2, only used for the display of the cashier page, does not participate in the payment, e.g. $1000 |
text3 | String | O | Text 3, only for the display of the cashier page, does not participate in the payment, e.g. Mfedfring |
text4 | String | O | Text 4, only used for cashier page display, does not participate in payment, e.g. 1USD = 1038KRW |
userId | String | R | User ID |
userIp | String | O | User 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 name | Type | Requirement | description |
---|---|---|---|
trackingId | String | R | Merchant tracking ID |
redirectPageUrl | String | O | The address of the redirected payment page, if any, please jump to the address where you can make a withdrawal/withdrawal |
remark | String | O | Transaction 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"
}
}