Web Component

Requirements

Add additional parameters to your /sessions request

You do not need to add any parameters when you create a payment session.

Import OXXO

When you import Adyen Web, include Oxxo.

import { AdyenCheckout, Oxxo } from '@adyen/adyen-web';

Add additional configuration for OXXO

You do not need to add any configuration parameters for OXXO.

Initialize the Component for OXXO

To initialize OXXO, use the Oxxo class.

const oxxoComponent = newOxxo(checkout,
    {
    
    // The configuration object for OXXO that you created.
    
    // Mount the Component to a container.
    } ).mount('#oxxo-container') 

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.

1. Log in to your test Customer Area.
2. Go to Transactions > Offers.
3. Select the PSP reference of the pending OXXO payment.
4. 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.