Query Payout Order
WARNING
Best practices
- Treat payment as successful when status==200 && orderStatus="SUCCESS"
- Failure: status!=200 && orderStatus="FAILED".
- If timeout occurs or orderStatus is unavailable, do not change or conclude the order status
Endpoint
POST /cashout/bra/order/query
Request Headers
| Name | Required | Example | Description |
|---|---|---|---|
Content-Type | Yes | application/json | |
lang | No | en | Response language: zh Chinese, en English, pt Portuguese |
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
sign | string | Yes | Signature |
mchOrderNo | string | No | Merchant order number — Provide one of trxId, mchOrderNo, or platOrderNo |
mchId | integer | Yes | Merchant ID |
timestamp | integer | Yes | Current timestamp — Unix timestamp in seconds |
trxId | string | No | Bank transaction ID — Provide one of trxId, mchOrderNo, or platOrderNo |
platOrderNo | string | No | Platform order number (recommended) — Provide one of trxId, mchOrderNo, or platOrderNo |
Request Example
json
{
"mchId": 10004,
"timestamp": 16624500121,
"mchOrderNo": "order20220717",
"trxId": "E22896431202305180049FAR5NYPXF8l",
"sign": "xxxxxxxxx"
}Response Parameters
| Field | Type | Required | Description |
|---|---|---|---|
status | integer | Yes | Status |
msg | null | Yes | Message |
data | object | Yes | |
data.orderStatus | string enum | Yes | Order status — PENDING, SUCCESS, FAILED, REFUND |
data.amount | number | Yes | Credited amount |
data.fee | number | Yes | Fee |
data.timeEnd | integer | No | Completion time — Timestamp in seconds |
data.mchOrderNo | string | Yes | Merchant order number |
data.platOrderNo | string | Yes | Platform order number |
data.trxId | string | Yes | Bank reference |
data.detail | string | No | Details |