Deposit query
is used to query deposit requests
Request address
- API Address (requestURI): /openapi/v1/deposit/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 | Merchant tracking ID | |
status | Integer | Deposit status. [0: Pending Deposit, 1: Partial Deposit, 2: Full Deposit, 3: Withdrawal of Deposit, 4: Invalid Request], the example value is 1 | |
assetName | String | The name of the asset. For example: BTC | |
netProtocol | String | Network Protocol | |
sourceAddress | String | Source | |
destinationAddress | String | Destination address | |
merchantName | String | Merchant Name | |
amount | BigDecimal | Amount | |
accumulatedAmount | BigDecimal | Deposited amount | |
remark | String | Remarks | |
assetType | Integer | Asset type. [0: Cryptocurrency, 1: Fiat Currency] | |
webhookUrl | String | Notification callback address/webhook url | |
successPageUrl | String | Successful deposit redirects to page address | |
businessName | String | Name of the deposit business. For example, the product name/business name, for example: xxx application fee | |
bankCode | String | Bank code. Payment types in some currencies require | |
userId | String | User ID | |
userIp | String | User IP address | |
stayReason | String | Reason for stay | |
depositDetailDtoList | ArrayList | Deposit details |
depositDetailDtoList
Parameter name | Type | Requirement | description |
---|---|---|---|
assetName | String | The name of the asset. For example: BTC | |
netProtocol | String | Network Protocol | |
sourceAddress | String | Source | |
destinationAddress | String | Destination address | |
merchantName | String | Merchant Name | |
txHash | String | TxHash | |
amount | BigDecimal | Amount | |
status | Integer | Deposit 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
}
]
}
}