Skip to main content

​
Sign up

Stripe provides self-service sign-up for sandbox accounts. To sign up for an account, visit the sign-up page.

​
Credentials

When setting up the OXXO via Stripe connection in the dashboard, the following credentials can be configured:

​
Secret key

A Stripe Secret key can be found in the Stripe Dashboard within Developer Settings under API keys.

​
Webhook secret

A Stripe Webhook Secret can be found in the Stripe Dashboard within Developer Settings under Webhooks once webhooks have been configured (see Webhooks below).

​
Stripe connected account (when applicable)

If using Stripe Connect, you can set the Stripe Account ID of the connected account that you intend to use for all transactions through the connection.

​
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.
POST /transactions
{
  "amount": 100,
  "currency": "MXN",
  "country": "MX",
  "intent": "capture",
  "payment_method": {
    "method": "oxxo",
    "redirect_url": "https://example.com/callback",
    "country": "MX",
    "currency": "MXN"
  }
}
After the transaction is created, the API response includes a payment_method.approval_url and the transaction will be in a processing state. 
{
  "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 (open in a browser or Webview) 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. 
POST /transactions

{
    "amount": 100,
    "currency": "MXN",
    "country": "MX",
    "intent": "capture",
    "integration_client": "web",
    "payment_method": {
        "method": "oxxo",
        "redirect_url": "https://example.com/callback",
        "country": "MX",
        "currency": "MXN"
    }
}
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": "web"
}