Skip to main content

Deposit query

is used to query deposit requests

Request address

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

Request parameters

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

Sample request

{
"trackingId": "20220408123456789"
}

Response parameters

Parameter nameTypeRequirementdescription
trackingIdStringMerchant tracking ID
statusIntegerDeposit status. [0: Pending Deposit, 1: Partial Deposit, 2: Full Deposit, 3: Withdrawal of Deposit, 4: Invalid Request], the example value is 1
assetNameStringThe name of the asset. For example: BTC
netProtocolStringNetwork Protocol
sourceAddressStringSource
destinationAddressStringDestination address
merchantNameStringMerchant Name
amountBigDecimalAmount
accumulatedAmountBigDecimalDeposited amount
remarkStringRemarks
assetTypeIntegerAsset type. [0: Cryptocurrency, 1: Fiat Currency]
webhookUrlStringNotification callback address/webhook url
successPageUrlStringSuccessful deposit redirects to page address
businessNameStringName of the deposit business. For example, the product name/business name, for example: xxx application fee
bankCodeStringBank code. Payment types in some currencies require
userIdStringUser ID
userIpStringUser IP address
stayReasonStringReason for stay
depositDetailDtoListArrayListDeposit details

depositDetailDtoList

Parameter nameTypeRequirementdescription
assetNameStringThe name of the asset. For example: BTC
netProtocolStringNetwork Protocol
sourceAddressStringSource
destinationAddressStringDestination address
merchantNameStringMerchant Name
txHashStringTxHash
amountBigDecimalAmount
statusIntegerDeposit details status. 1 Unconfirmed, 2 Confirmed, 3 Confirmed, 4 Cancelled, 5 Unpaid, 6 Successful, 7 Failed

Sample response

{
"code": 200,
"msg": "success",
"data": {
"trackingId": "20220408123456789",
"status": 1,
"assetName": "BTC",
"netProtocol": "BTC",
"sourceAddress": "sourceAddress",
"destinationAddress": "destinationAddress",
"merchantName": "merchantName",
"amount": 100,
"accumulatedAmount": 0,
"remark": "Deposit",
"assetType": 0,
"webhookUrl": "https://yourdomain.com/webhook",
"successPageUrl": "https://yourdomain.com/success",
"businessName": "Deposit",
"bankCode": "bankCode",
"userId": "123456",
"userIp": "127.0.0.1",
"stayReason": "stayReason",
"depositDetailDtoList": [
{
"assetName": "BTC",
"netProtocol": "BTC",
"sourceAddress": "sourceAddress",
"destinationAddress": "destinationAddress",
"merchantName": "merchantName",
"txHash": "txHash",
"amount": 100,
"status": 1
}
]
}
}