Withdrawal query
is used to query deposit requests
Request address
- API Address (requestURI): /openapi/v1/withdrawal/query
Request parameters
Parameter name | Type | Requirement | description |
---|---|---|---|
trackingId | String | R | Merchant tracking ID. Each merchant should guarantee a unique |
Sample request
{
"trackingId": "20220408123456789"
}
Response parameters
Parameter name | Type | Requirement | description |
---|---|---|---|
trackingId | String | O | Merchant tracking ID |
status | Integer | O | Withdrawal status, [0: Submitted, 1: Pending, 2: Insufficient balance, 3: Withdrawal in progress, 4: Withdrawal completed, 5: Rejected, 6: Withdrawal error, 7, Withdrawal terminated], Example: 1 |
assetName | String | O | Asset name, [e.g. BTC] |
assetNet | String | O | Asset Network |
netProtocol | String | O | Network Protocol |
sourceAddress | String | O | Source |
destinationAddress | String | O | Destination address |
merchantName | String | O | Merchant Name |
amount | BigDecimal | O | Amount |
txHash | String | O | txHash |
auditStatus | Integer | O | Review status, [1: passed, 2: failed, 3: terminated, 4: re-executed] |
remark | String | O | Remarks |
assetType | Integer | O | Asset type, [0: Cryptocurrency, 1: Fiat Currency] |
webhookUrl | String | O | Notification callback address/webhook url |
bankCode | String | O | Bank code, which is required for payment types in some currencies |
bankName | String | O | Bank name, payment type for some currencies requires |
accountName | String | O | Cardholder name, |
bankNum | String | O | IFSCcode, INR currency required, called Indian Financial System Code, the default for other currencies: NA |
userId | String | O | User ID |
userIp | String | O | User IP address |
stayReason | String | O | Reason for stay |
withdrawalDetailDtoList | ArrayList | O | Withdrawal record details |
WithdrawalDetailDto
Parameter name | Type | Requirement | description |
---|---|---|---|
txHash | String | O | TxHash |
assetName | String | O | Asset Name |
netProtocol | String | O | Network Protocol |
sourceAddress | String | O | Source |
destinationAddress | String | O | Destination address |
merchantName | String | O | Merchant Name |
amount | BigDecimal | O | Amount |
addrBalance | BigDecimal | O | Destination Address Balance |
status | Integer | O | Withdrawal details status 1 Unconfirmed, 2 confirmed, 3 confirmed, 4 canceled, 5 withdrawn, 6 withdrawn failed |
Sample Response
{
"trackingId": "20220408123456789",
"status": 1,
"assetName": "BTC",
"netProtocol": "BTC",
"sourceAddress": "123456",
"destinationAddress": "123456",
"merchantName": "merchantName",
"amount": 100,
"txHash": "txHash",
"auditStatus": 1,
"remark": "Withdrawal",
"assetType": 0,
"webhookUrl": "https://yourdomain.com/webhook",
"bankCode": "bankCode",
"userId": "123456",
"userIp": "127.0.0.1",
"stayReason": "stayReason",
"withdrawalDetailDtoList": [
{
"txHash": "txHash",
"assetName": "BTC",
"netProtocol": "BTC",
"sourceAddress": "sourceAddress",
"destinationAddress": "destinationAddress",
"merchantName": "merchantName",
"amount": 100,
"addrBalance": 100,
"status": 1
}
]
}