Query Collection Order
WARNING
Best practices
- Treat payment as successful when status==200 && orderStatus="SUCCESS"
- If timeout occurs or orderStatus is unavailable, do not change or conclude the order status
Endpoint
POST /cashin/mex/order/query
Request Headers
| Name | Required | Example | Description |
|---|---|---|---|
Content-Type | Yes | application/json |
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
sign | string | Yes | Verified name |
mchOrderNo | string | No | Merchant order number — Provide one of mchOrderNo or platOrderNo |
mchId | integer | Yes | Merchant ID |
timestamp | integer | Yes | Current timestamp — Unix timestamp in seconds |
platOrderNo | string | No | Platform order number (recommended) — Provide one of mchOrderNo or platOrderNo |
Request Example
json
{
"mchId": 10001,
"timestamp": 1184353024,
"platOrderNo": "platOrderNo",
"sign": "xxxxxxxxxxxxx"
}Response Parameters
| Field | Type | Required | Description |
|---|---|---|---|
status | integer | Yes | Status |
msg | string | Yes | Message |
data | object | Yes | Data |
data.orderStatus | string enum | Yes | Order status — PENDING, SUCCESS, FAILED, REFUND |
data.amount | number | Yes | Actual paid amount |
data.timeEnd | integer | No | Completion time — Timestamp unit: seconds |
data.fee | number | Yes | Fee amount |
data.mchOrderNo | string | Yes | Merchant order number |
data.platOrderNo | string | Yes | Platform order number |
Response Example
json
{
"status": 200,
"msg": null,
"data": {
"mchOrderNo": "order_1662112944",
"platOrderNo": "P5nosqyWAQsQZNtYa5OW",
"orderStatus": "PENDING",
"amount": "1200.00",
"fee": "14.00"
}
}