OXXO is a popular cash payment method in Mexico, allowing customers to pay for goods and services at physical OXXO convenience stores using a unique reference code. Due to it being a physical payment method, there may be a delay in processing the payment. Merchants can either use the default hosted payment page, where the charge is created once the customer accepts it, or set a custom approval URL to charge upfront and display their own barcode page.

​
Sign-up

To create an OXXO account you will need to request credentials.

​
Credentials

The following API credentials are needed to configure the OXXO connector.
  • Private key - This is the name of the private key on OXXO.
  • Webhook public key
  • Approval URL - See Custom voucher page below.
The following credentials are optional:
  • Child company ID

​
Cart Items Validation

Cart items are required and must match the transaction amount. If they do not match, a single cart item for the correct amount will replace the original items sent by the merchant.

​
Custom voucher page

By default, OXXO payments use the hosted option, delaying the charge until customer acceptance. To charge upfront and render your own barcode, set an approval URL at the connection or transaction level. The OXXO reference will be passed for barcode generation. In this example, the transaction’s approval_url receives the reference as a parameter: e.g. https://merchant.com/voucher?reference=123456 
{
    "connection_options": {
        "approval_url": "https://merchant.com/voucher"
    }
}
Alternatively, you can configure this at the connection level in the connector’s credentials tab.