Use XPay to accept embedded payments, save payment methods, manage recurring billing, and integrate supported payment methods into web and mobile applications. Start with a guided workflow, then use the XPay API reference when you need complete endpoint schemas.
Get started
- XPay overview — Understand the payment flow and the responsibilities of your backend, frontend, and XPay.
- Accept your first payment — Build a minimal card-payment flow with a PaymentIntent and XPay Element.
- Test your integration — Verify the server, frontend, and webhook parts of an integration.
- XPay Go-Live Guide — Prepare an approved integration for production.
Payments
- Payments overview — Learn how a PaymentIntent, XPay Element, and webhook result fit together.
- Create a PaymentIntent — Start a payment from the merchant backend.
- Collect payment details with XPay Element — Render XPay-hosted payment fields in the customer interface.
- PaymentIntent lifecycle and statuses — Interpret the status returned for a payment.
- Payment methods — Choose an embedded, hosted, or saved-token payment path.
Payment routing
Payment routing explains how to route eligible payments using merchant-defined routing attributes or a specific configured gateway instance.
Payment links
Payment links explains how to create a shortened payment URL that merchants can share through WhatsApp, SMS, email, or another channel.
B2B Payments API
B2B Payments API explains how to create an XPay-hosted payment page and immediately redirect the customer to it.
Customers
Customers explains how to create and manage reusable customer records across payments, tokenization, and subscriptions.
Tokenization
Tokenization covers collecting, storing, managing, and charging reusable payment tokens. It also explains saved-card 3DS and enabling a token on another gateway.
BIN discounts
BIN discounts explains how to enable BIN discount evaluation, show the result in the Web SDK, and reconcile the accepted discount.
XPay Billing
XPay Billing covers fixed-price subscriptions and usage-based billing. Its content remains a separate documentation family and is not duplicated here.
XPay Element and SDKs
Choose an XPay SDK for Web, React Native, Android, Flutter, or iOS. Each platform guide covers its current setup, element configuration, and payment-confirmation flow.
Platform integrations
Platform integrations route merchants to XPay integrations for commerce platforms such as Shopify and WooCommerce.
Integration essentials
Integration essentials covers the shared authentication, webhook, environment, and error-handling rules used across XPay integrations.
- Authenticate XPay API requests — Generate request signatures on the merchant backend.
- Integrate XPay webhooks — Verify and process asynchronous XPay notifications.
- API responses and errors — Separate HTTP failures, API errors, and payment outcomes.
- Network requirements — Allow required XPay traffic through restricted merchant networks.
XPay MCP server
XPay MCP server explains how to connect Cursor to XPay documentation and verify the documentation tool.
XPay API reference
Use the XPay API reference for complete endpoint paths, fields, enums, and response schemas.