You can add OXXO to your existing integration. The following instructions show only what you must add to your integration specifically for OXXO.
If an instruction on this page corresponds with a step in the main integration guide, it includes a link to that corresponding step of the main integration guide.
Requirements
| Requirement | Description | |
|---|---|---|
| Integration type | Make sure that you have an existing API-only integration. | |
| Action handling | Make sure that your existing integration is set up to handle the additional action. action.type: voucher. |
|
| Setup steps | Before you begin, add OXXO in your Customer Area. |
How it works
- The shopper selects OXXO as the payment method.
- The shopper enters their details in the payment form that you build.
- When you make the payment request, you include additional information about the items that the shopper intends to purchase.
- The shopper receives a voucher, which they use in-store to finalize the payment.
Build your payment form
Include OXXO in the list of available payment methods.
You do not need to collect any information from the shopper in your payment form.
You can download the logo for OXXO to use in your form.
Get OXXO as an available payment method
When you make the /paymentMethods to get available payment methods, specify the following so that OXXO is included in the response.
| Parameter | Values |
|---|---|
| countryCode | MX |
| amount.currency | MXN |
Add additional parameters to your /payments request
You do not need to add any additional parameters when you make a payment.
The /payments response includes action.type : voucher, and part of handling this action type is to show the voucher to the shopper.
Test and go live
OXXO is an offline payment method. This means that there is time between the shopper receiving the voucher and the actual processing of the payment.
To follow the status of the voucher, you have to set up webhooks.
When you create the voucher, it is shown as an offer in your Customer Area, with an Open status. If you set up PENDING webhooks specifically for OXXO, you receive a webhook for pending OXXO voucher payments.
When the shopper pays the voucher at an OXXO store, the payment will be processed. The offer becomes a sale and the status changes to Received. You will receive the final result of the payment in an AUTHORISATION webhook. This all happens automatically in a live environment, but you can test this process in your Customer Area.
In the test environment, you can simulate an OXXO payment by promoting the pending payment to a sale.
- Log in to your test Customer Area.
- Go to Transactions > Offers.
- Select the PSP reference of the pending OXXO payment.
- Select the Promote this offer to a sale button.
OXXO vouchers that have been paid (including test offers that you manually promoted to sale), are under Transactions > Payments.
Test the reconciliation process by promoting test payments from offer to sale in your test Customer Area.
Before you can accept live OXXO payments, you need to submit a request to add the OXXO payment method in your live Customer Area.