Payout Query

Query the current status of a Philippines payout order by merchant order number.

POST/api/v2/payout/status

Use this endpoint to check the latest processing result of a payout order.

Request Headers

x-access-keystringRequired

Merchant access identifier

signaturestringRequired

Request signature

Request Parameters

merchantOrderNostringRequired

Transaction number passed when the merchant initiates payout

timestampstringRequired

Millisecond timestamp string

Response Parameters

messagestringReturned

Request result. success only means the current API call succeeded and should not be used as the final business result

codestringReturned

Business status code. 00000 means the request was accepted. Other 5-digit values indicate specific error reasons; refer to the error code page

timestampstringReturned

Timestamp, for example 1715941383720

successbooleanReturned

API call result

dataobjectReturned

Response object

data.platformOrderNostringReturned

Platform order number

data.merchantOrderNostringReturned

Merchant transaction number

data.orderAmountstringReturned

Actual payout amount

data.orderStatusstringReturned

Order status. SUCCESS means success, PENDING means processing, FAILED means failure, EXPIRED means expired, CANCELLED means cancelled, and REFUNDED means refunded

data.messagestringReturned

Status description message

data.completedAtstringOptional

Transaction completion time (local time), returned when the order is successful