Payment Query

Query the current status of a Mexico collection order by merchant order number.

POST/api/v2/pay/status

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

Request Headers

x-access-keystringRequired

Merchant access identifier

signaturestringRequired

Request signature

Request Parameters

merchantOrderNostringRequired

Transaction number passed when the merchant initiates collection

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

Unique platform order number

data.merchantOrderNostringReturned

Merchant order number

data.orderAmountstringReturned

First payment amount, not the accumulated amount of duplicate payments

data.orderStatusstringReturned

Order status. SUCCESS means success, PARTIAL SUCCESS means partially completed payment where the requested order amount and the actual paid amount are different, PENDING means processing, FAILED means failure, EXPIRED means expired, CANCELLED means cancelled, and REFUNDED means refunded

data.messagestringReturned

Status description message

data.completedAtstringOptional

First order success time (local time), returned when the order is successful

data.paymentListListReturned

Actual payment record list. Each actual payment generates one record; when the same order is paid multiple times, multiple records are returned

data.paymentList[].paymentTradeNostringReturned

Platform collection payment serial number for this payment. When the same order is paid multiple times, each record has a different payment serial number

data.paymentList[].paymentStatusstringReturned

Payment record status

data.paymentList[].paymentAmountstringReturned

Payment amount for this payment record

data.paymentList[].paymentSuccessTimestringReturned

Success time of this payment record (local time)

data.payMethodstringOptional

Payment method, such as SPEI