Skip to content

Query Payout Order

WARNING

Best practices

  1. Treat payment as successful when status==200 && orderStatus="SUCCESS"
  2. Failure: status!=200 && orderStatus="FAILED".
  3. If timeout occurs or orderStatus is unavailable, do not change or conclude the order status

Endpoint

POST /cashout/bra/order/query

Request Parameters

FieldTypeRequiredDescription
signstringYesSignature
mchOrderNostringNoMerchant order number — Provide one of mchOrderNo or platOrderNo
timestampintegerYesCurrent timestamp — Unix timestamp in seconds
mchIdstringYesMerchant ID
platOrderNostringNoPlatform order number (recommended) — Provide one of mchOrderNo or platOrderNo

Request Example

json
{
 "mchId": 10001,
 "timestamp": 16624500121,
 "platOrderNo": "platOrderNo",
 "sign": "SIGN"
}

Response Parameters

FieldTypeRequiredDescription
statusintegerYesStatus
msgnullYesMessage
dataobjectYes
data.orderStatusstring enumYesOrder status — PENDING, SUCCESS, FAILED, REFUND
data.amountnumberYesCredited amount
data.feenumberYesFee
data.timeEndintegerNoCompletion time — Timestamp in seconds
data.mchOrderNostringYesMerchant order number
data.platOrderNostringYesPlatform order number

Response Example

json
{
 "status": 200,
 "msg": null,
 "data": {
 "mchOrderNo": "payout_1662104438",
 "platOrderNo": "wussXUCOoXO3yptr7rQV",
 "orderStatus": "PENDING",
 "amount": "180.34",
 "fee": "200.36"
 }
}

Transafe Developer Documentation