10.1 Query merchant’s digital currency orders (collection and payment)
#Brief description: This interface is used to query the merchant's digital currency collection, payment and other orders. The order details can be viewed according to the order number.
- Request method: POST
- Request interface: https://gateway-domain/wallet-trade-merchant/payment/payment/by-third
- Request media type (JSON data format)Content-Type: application/json
Query parameters
| Parameter name | Type | Required | Parameter meaning | Parameter description |
|---|---|---|---|---|
orderId | string | No | Platform order number | Choose 1 from our platform order number or merchant’s local order number |
localOrderId | string | No | Merchant’s local order number | Choose 1 of 2 merchant’s local order number or our platform’s order number |
key | string | Yes | Merchant key | apiKey |
sign | string | Yes | Signature | See Signature Algorithm for details |
Request json sample
{
"key": "9yUreYgTRtit39Dy",
"orderId": 274224939517780,
"sign": "07792d2cf97811d3f2e7bd98edb477e3"
}
Return value
| Parameter name | Type | Parameter meaning | Parameter description |
|---|---|---|---|
code | int32 | Request status | Return code, 0 means the business is successful, otherwise it represents a different error |
success | boolean | Success status | Success identification, consistent with code=0, used for compatibility history |
message | string | Description | Error message. If there is an error, the error message returned |
data | json | Return data. | Please refer to the following description for parameters |
Return to Example
{
"code": 0,
"success": true,
"message": null,
"data": {
"merchantId": 302992856974,
"merchantUserId": null,
"orderId": "474882554749381",
"localOrderId": "CONAN-TES1225668",
"type": "PAYMENT",
"status": "SUCCESS",
"bizType": "PAYMENT_FIXED_DIGITAL_SCAN",
"currency": "CNY",
"amount": "75",
"merchantCurrency": "CNY",
"merchantPaidAmount": "75",
"merchantActualAmount": "53.85",
"userCurrency": "USDT",
"userAmount": "11.19",
"userReceivableAmount": "11.19",
"userMinerFee": null,
"rate": "6.70227804",
"rateExpression": "1USDT≈6.7022CNY",
"notifyTime": 1772461910628,
"extra": null,
"blockchain": {
"network": "TRON",
"txId":"403dd99b07cb2fd0a4a8ab3f99ef74c0
40700117a3429f393a74585ed3f23c09",
"senderAddress": "TPutFhYUQnrRxHSmKVwjp55vgk9QY6r5nS",
"receiverAddress": "TYZSzcYySHGQ1Kb1oC3GdEM1NiK95BvnX7"
},
"walletUserId": null,
"orderFailReason": null,
"orderCreateTime": 1772461861907
}
}
data parameter description
| Parameter name | Type | Parameter meaning | Parameter description |
|---|---|---|---|
orderId | string | Order number | |
merchantId | int64 | Merchant ID | |
merchantUserId | string | Merchant user ID | Returns the value of the order parameter localUserId, or null if not passed |
localOrderId | string | Order number | |
status | enum | Order Status | PROCESSING:处理中| SUCCESS:已完成|FAIL:已失败 |
type | enum | Order Type | PAYMENT:支付订单 | WITHDRAW:提款订单 |
bizType | enum | bizType type description is as follows | |
currency | string | Order currency | |
amount | string | Order amount | |
merchantCurrency | string | Merchant payment currency | |
merchantPaidAmount | number | Amount receivable or payable by the merchant | |
userCurrency | string | User payment or withdrawal currency | |
userAmount | number | User payment or withdrawal amount | |
merchantActualAmount | number | Amount actually received or paid by the merchant | |
notifyTime | int64 | Notification timestamp | |
orderCreateTime | int64 | Order creation timestamp | |
blockchain | object | Chain transaction information | |
| └ network | string | main network | |
| └ txid | string | Transaction ID | |
| └senderAddress | string | Sending address | |
| └receiverAddress | string | Receipt address | |
userMinerFee | string | Mining fee | |
userReceivableAmount | string | Amounts receivable and payable by users | |
rate | string | Exchange rate | |
rateExpression | string | Exchange rate expression | |
orderFailReason | string | Reason for order failure | |
walletUserId | string | Wallet internal user ID | |
extra | json | Custom exchange rate information | Merchants will return this information when calling the custom exchange rate interface |
bizType type description:
- PAYMENT_WALLET_SCAN MINPAY wallet scan code payment
- PAYMENT_TRANSFER digital currency binding address direct deposit
- PAYMENT_ANY_DIGITAL_SCAN Scan the QR code to pay any amount of digital currency
- WITHDRAW_WALLET withdraw money to MINPAY wallet
- WITHDRAW_ANY_DIGITAL_WALLET Withdraw digital currency to any wallet
- PAYMENT_FIXED_DIGITAL_SCAN digital currency limited amount scan code payment
- BATCH_PAY batch payment