10.3 Query cash channel orders (collection, payment)
#Brief description: This interface is used to query cash channel collection and payment orders, and the order details can be viewed according to the order number.
- Request method: POST
- Request interface: https://gateway-domain/wallet-trade-merchant/v1/receive/cash/query/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 | See the parameters below for details |
Return to Example
{
"code": 0,
"success": true,
"message": null,
"data": {
"merchantId": 302992856974,
"merchantUserId": "conan",
"orderId": "477564506808517",
"localOrderId": "conantest9913279",
"type": "PAYMENT",
"status": "SUCCESS",
"currency": "CNY",
"paidAmount": "100",
"amount": "100",
"isReissue": false,
"notifyTime": 1772789295567,
"orderCreateTime": 1772789258844
}
}
data parameter description
| Parameter name | Type | Parameter meaning | Parameter description |
|---|---|---|---|
merchantId | int64 | Merchant ID | |
merchantUserId | string | Merchant user ID | Value corresponding to the order parameter localUserId |
orderId | string | Order number | Our platform order number |
localOrderId | string | Merchant’s local order number | Merchant’s local platform order number (corresponding to the value of the order parameter localOrderId) |
type | enum | Order Type | PAYMENT:支付订单 | WITHDRAW:提款订单 |
status | enum | Order Status | PROCESSING:处理中| SUCCESS:已完成|FAIL:已失败 |
currency | string | Order currency | |
paidAmount | number | Order receivable and payment amount | |
amount | number | Order amount | |
isReissue | boolean | Whether to reissue | |
notifyTime | int64 | Notification timestamp | Milliseconds |
orderCreateTime | int64 | Order creation timestamp | Milliseconds |