Query Payout Order
Best practices
- Treat 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/vn/order/query
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
sign | string | Yes | Signature |
mchOrderNo | string | Yes | Merchant order number |
mchId | integer | Yes | Merchant ID |
timestamp | integer | Yes | Current timestamp — Unix timestamp in seconds |
trxId | string | Yes | Bank reference (UTR) |
Request Example
json
{
"mchId": 364295370187661,
"timestamp": 1662450012,
"mchOrderNo": "order20220717",
"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 (UTR) |
Response Example
json
{
"status": 200,
"msg": null,
"data": {
"mchOrderNo": "payout_1662104438",
"platOrderNo": "wussXUCOoXO3yptr7rQV",
"trxId": "39018277212",
"orderStatus": "PENDING",
"amount": "180.34",
"fee": "200.36"
}
}