Created by the Mexican convenience store chain OXXO, OXXO Pay offers a practical way for consumers to pay online using cash at any OXXO store. By blending traditional cash payments with digital convenience, it’s become a popular choice in Mexico, especially in areas with limited banking access.

Payment method properties

Make an OXXO Pay payment

OXXO Pay payments follow our standardized REDIRECT and SCAN_CODE flows. Enabling you redirect the consumer to the provider or offer a seamless desktop experience by generating the CODE128 on your site.

To create an OXXO Pay payment, you'll need to provide the following data at minimum when calling our /v1/payment-charges API:

Request

POST /v1/payment-charges

{
  "paymentMethod": "OXXO_PAY",
  "amount": {
    "value": 1000,
    "currency": "MXN"
  },
  "consumer": {
    "name": "John Smith",
    "country": "MX"
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    },
    {
      "type": "SCAN_CODE",
      "settings": {
        "scanBy": "2025-05-26T20:24:27Z"
      }
    }
  ]
}

Response

You'll receive our standard payment charge response (see potential responses in the API Reference) with the available authentication methods.

{
  "id": "charge_X0O78tadFHrZCbGhkycPk",
  "status": "AUTHENTICATION_PENDING",
  
  // ...
  
  "authenticationMethods": [
    {
      "type": "REDIRECT",
      "details": {
        "requestUrl": "https://redirection-target.ppro.com",
        "requestMethod": "GET"
      }
    },
    {
      "type": "SCAN_CODE",
      "details": {
        "codePayload": "23790001246042596560986123456708610930000000100",
        "codeDocument": "cdn.ppro.com//linktocodedocument",
        "scanBy": "2023-03-26T20:24:27Z",
        "codeType": "ITF"
      }
    }
  ]
}

Pick the desired authentication method

REDIRECT

1. Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
   For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
2. The consumer will finalize the payment process on the redirected page.

SCAN_CODE

1. Render the code using one of the techniques available.
2. The consumer will scan the code to complete the payment.

Handling the payment result

REDIRECT

1. Once the consumer has confirmed the payment, they are redirected to the returnUrl provided in the initial payment charge creation request.
2. After the consumer is redirected back to your site, check the payment status by making a GET /v1/payment-charges/{paymentChargeId}. Use the Status that you received to display the payment outcome to the consumer.
3. Webhooks are also sent to inform you of the payment outcome. If the shopper closes the browser and doesn't return to your website, you can rely on webhooks to receive the payment result.

SCAN_CODE

1. You'll be notified of the payment outcome via Webhook.
2. You can check the payment status at any time by making a GET /v1/payment-charges/{paymentChargeId}.
3. Use the Status that you received to display the payment outcome to the consumer.

Refunds

Boleto does not provide native support for refunds. However, PPRO offers a solution to address this limitation through a manual refund process available to its customers. This process involves collaborative efforts between PPRO and its customers, wherein consumer information is shared with PPRO. Subsequently, PPRO's team manages the refund process by initiating a bank transfer to reimburse the consumer.

The refundDescriptor field serves the purpose of incorporating the consumer details, including their name, tax identification number (CPF/CNPJ), and pertinent banking information such as account/agency details or a Pix key.

POST /v1/payment-charges/{paymentChargeId}/refunds

{
	"amount": 1000,
	"merchantRefundReference": "5c019979-0751-469e-96e0-b67f1d95c577",
	"refundDescriptor": "Name: João Comprador CPF:12345678909 Bank Name: Banco Santander Agency Number: 1234 Account Number: 123456789"
}

Payment instrument

A PASSTHROUGH_WALLET instrument will be created for Boleto, with no additional data provided.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
    "id": "instr_5ChenWBwW8xARvJ3GccAx",
    "type": "PASSTHROUGH_WALLET"
}