{"title":"OXXO for API only","category":"default","creationDate":1776961628,"content":"

You can add OXXO to your existing integration. The following instructions show only what you must add to your integration specifically for OXXO.<\/p>\n

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.<\/p>\n

Requirements<\/h2>\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nMake sure that you have an existing API-only integration<\/a>.<\/td>\n <\/td>\n<\/tr>\n
Action handling<\/strong><\/td>\nMake sure that your existing integration is set up to handle the additional action<\/a>.
action.type<\/code>: voucher.<\/td>\n		<\/td>\n<\/tr>\n
Setup steps<\/strong><\/td>\n Before you begin, add OXXO in your Customer Area<\/a>. <\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

How it works<\/h2>\n
    \n
  1. The shopper selects OXXO as the payment method.<\/li>\n
  2. The shopper enters their details in the payment form that you build<\/a>.<\/li>\n
  3. When you make the payment request, you include additional information about the items that the shopper intends to purchase<\/a>.<\/li>\n
  4. The shopper receives a voucher, which they use in-store to finalize the payment.<\/li>\n<\/ol>\n

    Build your payment form<\/h2>\n

    Include OXXO in the list of available payment methods<\/a>.<\/p>\n

    You do not need to collect any information from the shopper in your payment form.<\/p>\n

    \n

    You can download the logo for OXXO<\/a> to use in your form.<\/p>\n<\/div>\n

    Get OXXO as an available payment method<\/h2>\n

    When you make the \/paymentMethods<\/a> to get available payment methods<\/a>, specify the following so that OXXO is included in the response.<\/p>\n\n\n\n\n\n\n
    Parameter<\/th>\nValues<\/th>\n<\/tr>\n<\/thead>\n
    countryCode<\/a><\/td>\nMX<\/strong><\/strong><\/span><\/td>\n<\/tr>\n
    amount.currency<\/a><\/td>\nMXN<\/strong><\/strong><\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    \n <\/code-sample>\n<\/div>\n
    \n <\/code-sample>\n<\/div>\n

    Add additional parameters to your \/payments request<\/h2>\n

    You do not need to add any additional parameters when you make a payment<\/a>.<\/p>\n

    The \/payments<\/a> response includes action.type<\/code> : voucher<\/strong><\/span>, and part of handling this action type is to show the voucher to the shopper<\/a>.<\/p>\n

    Test and go live<\/h2>\n

    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.<\/p>\n

    To follow the status of the voucher, you have to set up webhooks<\/a>.<\/p>\n

    When you create the voucher, it is shown as an offer in your Customer Area, with an Open<\/strong> status. If you set up PENDING webhooks specifically for OXXO<\/a>, you receive a webhook for pending OXXO voucher payments.<\/p>\n

    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<\/strong>. You will receive the final result of the payment in an AUTHORISATION webhook<\/a>. This all happens automatically in a live environment, but you can test this process in your Customer Area.<\/p>\n

    In the test environment, you can simulate an OXXO payment by promoting the pending payment to a sale.<\/p>\n

      \n
    1. Log in to your test Customer Area<\/a>.<\/li>\n
    2. Go to Transactions<\/strong> > Offers<\/strong>.<\/li>\n
    3. Select the PSP reference<\/strong> of the pending OXXO payment.<\/li>\n
    4. Select the Promote this offer to a sale<\/strong> button.<\/li>\n<\/ol>\n

      OXXO vouchers that have been paid (including test offers that you manually promoted to sale), are under Transactions<\/strong> > Payments<\/strong>.<\/p>\n

      Test the reconciliation process by promoting test payments from offer to sale in your test Customer Area<\/a>.<\/p>\n

      Before you can accept live OXXO payments, you need to submit a request to add the OXXO payment method<\/a> in your live Customer Area<\/a>.<\/p>\n

      See also<\/h2>\n