Skip to main content

Withdrawal query

is used to query deposit requests

Request address

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

Request parameters

Parameter nameTypeRequirementdescription
trackingIdStringRMerchant tracking ID. Each merchant should guarantee a unique

Sample request

{
"trackingId": "20220408123456789"
}

Response parameters

Parameter nameTypeRequirementdescription
trackingIdStringOMerchant tracking ID
statusIntegerOWithdrawal 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
assetNameStringOAsset name, [e.g. BTC]
assetNetStringOAsset Network
netProtocolStringONetwork Protocol
sourceAddressStringOSource
destinationAddressStringODestination address
merchantNameStringOMerchant Name
amountBigDecimalOAmount
txHashStringOtxHash
auditStatusIntegerOReview status, [1: passed, 2: failed, 3: terminated, 4: re-executed]
remarkStringORemarks
assetTypeIntegerOAsset type, [0: Cryptocurrency, 1: Fiat Currency]
webhookUrlStringONotification callback address/webhook url
bankCodeStringOBank code, which is required for payment types in some currencies
bankNameStringOBank name, payment type for some currencies requires
accountNameStringOCardholder name,
bankNumStringOIFSCcode, INR currency required, called Indian Financial System Code, the default for other currencies: NA
userIdStringOUser ID
userIpStringOUser IP address
stayReasonStringOReason for stay
withdrawalDetailDtoListArrayListOWithdrawal record details

WithdrawalDetailDto

Parameter nameTypeRequirementdescription
txHashStringOTxHash
assetNameStringOAsset Name
netProtocolStringONetwork Protocol
sourceAddressStringOSource
destinationAddressStringODestination address
merchantNameStringOMerchant Name
amountBigDecimalOAmount
addrBalanceBigDecimalODestination Address Balance
statusIntegerOWithdrawal 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
}
]
}