Collection

Create a Mexico collection order for the customer to complete through the selected payment method.

POST/api/v2/pay/submit

Use this endpoint to create a collection order and receive the initial platform acceptance result.

Request Headers

x-access-keystringRequired

Merchant access identifier

signaturestringRequired

Request signature

Request Parameters

timestampstringRequired

Millisecond timestamp string, for example 1715941383720

orderAmountstringRequired

Payment amount. Decimals are not allowed

payMethodstringRequired

Supported payment types: SPEI

merchantOrderNostringRequired

Unique transaction number. Recommended format: YYYYMMDDHHMMSS + random number

customerNamestringRequired

Payer name

customerPhonestringRequired

Payer mobile number

customerEmailstringRequired

Payer email. A gmail.com address is recommended, for example johndoe@gmail.com

callbackUrlstringRequired

Async callback URL

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

Transaction time

successbooleanReturned

API call result

dataobjectReturned

Response object

data.platformOrderNostringReturned

Unique platform order number

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.payInfoobjectReturned

Payment information object. Returned fields may vary by payment method

data.payInfo.accountNumberstringReturned

SPEI collection account number or CLABE

data.messagestringReturned

Status description message