Create Cashier

Create a Mexico cashier link so the customer can complete payment on a hosted page.

POST/api/v2/pay/collect

Use this endpoint to create a cashier order and receive a payment link.

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

callbackUrlstringRequired

Async callback URL

redirectUrlstringOptional

Redirect URL after successful payment, for example https://merchant.example.com/cashier/return. If omitted, the default success page is used

customerNamestringRequired

Payer name

customerPhonestringRequired

Payer mobile number

customerEmailstringRequired

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

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

Status description message

data.paymentLinkstringReturned

Payment link, which is the cashier URL