Mexico

This integration is not available to all merchants. Check availability with your manager.

How is it different from a regular order?

For this payment method, you add additional fields to customer, as well as externalUserId. Other fields (amount, currency, successUrl, failUrl, etc.) remain the same as when creating a regular order.

For this payment method, the externalUserId field is required.

Additional fields for a regular order

Field	Type	Description
`customer`	object	Customer data (email, phone, address, etc.)

Customer object fields

Field	Type	Description
`country`	string	Country code for payment
`document`	string	Customer document
`documentType`	string	Customer document type
`email`	string	Customer email
`firstName`	string	First name
`lastName`	string	Last name

Supported currencies and countries

Country	Currency	Country Code
Mexico	`MXN`	`MX`

Request example

{
    "purpose": "Payment for order #1234",
    "amount": "1000",
    "externalId": "external_id",
    "externalUserId": "external_user_id",
    "successUrl": "https://example.com",
    "failUrl": "https://example.com",
    "callbackUrl": "https://example.com",
    "currency": "MXN",
    "isFeeOnUser": false,
    "customer": {
      "lastName": "Doe",
      "firstName": "John",
      "country": "MX",
      "email": "john.doe@example.com",
      "document": "ABCD8104019Z3",
      "documentType": "RFC"
    }
  }

Response example

{
  "id": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "status": "CREATED",
  "statusMessage": "Ok",
  "purpose": "Payment for order #1234",
  "amount": "1000",
  "currency": "MXN",
  "paymentType": null,
  "shopId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "terminalId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "fingerprint": null,
  "ipAddress": null,
  "gatewayTransactionId": null,
  "merchantId": "a1b2c3d4-e5f6-7g8h-i9j0-k1l2m3n4o5p6",
  "externalId": "external_id",
  "externalUserId": "external_user_id",
  "paymentLink": "https://example.com/payment",
  "successUrl": "https://example.com",
  "failUrl": "https://example.com",
  "metadata": null,
  "callbackUrl": "https://example.com",
  "payedAt": null,
  "updatedAt": "2023-03-21T12:34:56Z",
  "createdAt": "2023-03-21T12:34:56Z"
}

Mexico

Before you start

How to authorize requests

How to create regular orders