Skip to main content
OXXO is a cash-based payment method in Mexico that provides buyers with a voucher and reference number for in-store payment.

Setup

Follow the Stripe setup instructions before configuring OXXO.

Features

Stripe OXXO payments support the following features:
  • Webhook integration - Receive asynchronous payment updates
  • Redirect checkout - Redirect buyers to complete the cash voucher flow
  • Zero auth - Verify a payment method without capturing funds

Supported countries

Stripe supports transactions from buyers in MX.

Supported currencies

Stripe supports processing payments in MXN.

Limitations

The following features are not supported by this connector:
  • Refunds - Refunds are not supported
  • Partial refunds - Partial refunds are not supported
  • Partial capture - Capturing a portion of the authorized amount is not supported
  • Delayed capture - Authorization and capture must happen together
  • Over-capture - Capturing more than the authorized amount is not supported
  • Void - Canceling an authorization is not available
  • Payment method tokenization - Storing payment methods for recurring transactions is not supported
  • Transaction sync - Automated status synchronization is not available
  • Settlement reporting - Settlement reporting is not available
  • Deep linking - Direct app linking is not supported
  • Partial authorization - Authorizing only a portion of the requested amount is not supported

Configuration

For shared APM credentials, see Stripe APM credentials.

Approval URL (optional)

By default, the connector returns an approval URL that redirects buyers to a Stripe-hosted page with instructions for completing an OXXO cash payment. If required, you can set a different approval URL here which allows you to build your own page for showing the OXXO voucher to buyers. When set, the Approval URL is returned with a Session Token appended as a query parameter named token. This Session Token can be used with the Transaction Session API to retrieve the details required to build your own page.

Webhooks

OXXO payments are completed asynchronously, so you must configure webhooks to update the status of transactions. Webhooks are configured in the Stripe Dashboard within Developer Settings under Webhooks. The OXXO connector relies on the following Stripe webhook event:
  • payment_intent.succeeded

Integration

The default integration for OXXO via Stripe uses a redirect to payments page hosted by Stripe.

Redirect integration

Start by creating a new transaction with the following required fields.
var transaction = await client.Transactions.CreateAsync(
  transactionCreate: new TransactionCreate()
  {
    Amount = 1299,
    Currency = "MXN",
    Country = "MX",
    PaymentMethod =
      TransactionCreatePaymentMethod.CreateCheckoutSessionWithUrlPaymentMethodCreate(
        new RedirectPaymentMethodCreate()
        {
          Method = "oxxo",
          RedirectUrl = "https://example.com/callback",
        }
      ),
  }
);
After the transaction is created, the API response includes a payment_method.approval_url and a processing status.
{
  "type": "transaction",
  "id": "ea1efdd0-20f9-44d9-9b0b-0a3d71e9b625",
  "payment_method": {
    "type": "payment-method",
    "approval_url": "https://payments.stripe.com/oxxo/voucher/test..."
  },
  "method": "oxxo"
}
Redirect the buyer to the approval_url where they see an OXXO voucher and instructions to complete the cash payment. Once the buyer completes the cash payment at an OXXO location, the transaction progresses to a capture_succeeded state in response to a webhook from Stripe.

Direct integration

If you intend to use your own hosted page for presenting the buyer with the OXXO voucher, you can include an integration_client parameter set to web, ios or android when creating a new transaction.
var transaction = await client.Transactions.CreateAsync(
  transactionCreate: new TransactionCreate()
  {
    Amount = 1299,
    Currency = "MXN",
    Country = "MX",
    IntegrationClient = "ios",
    PaymentMethod =
      TransactionCreatePaymentMethod.CreateCheckoutSessionWithUrlPaymentMethodCreate(
        new RedirectPaymentMethodCreate()
        {
          Method = "oxxo",
          RedirectUrl = "myapp://callback",
        }
      ),
  }
);
After the transaction is created, the API response includes a session_token which can be used to get the session data for the transaction, which can be used to build a custom page for displaying the OXXO voucher.
POST /transactions/:transaction_id/session?token=:session_token

{
    "session_data": {
        "paymentIntentId": "pi_3StlgnRAbJldLcy50NYwrdAN",
        "oxxoDisplayDetails": {
            "expires_after": 1770098399,
            "hosted_voucher_url": "https://payments.stripe.com/oxxo/voucher/test...",
            "number": "12345678901234657890123456789012"
        }
    },
    "default_completion_url": "https://example.com/callback",
    "integration_client": "ios"
}