Query Payout Order

Best practices

1. Treat 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/php/order/query

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 reference (UTR) — Provide one of trxId, mchOrderNo, or platOrderNo
platOrderNo	string	No	Platform order number (recommended) — Provide one of trxId, mchOrderNo, or platOrderNo

Request Example

{
  "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)

Related

• Philippines
• Signature & Verification
• Payout Webhook