# xPay

## Docs

- [Introduction](https://docs.xpaycheckout.com/get-started/introduction.md): Welcome to xPay Documentation!
- [Onboarding](https://docs.xpaycheckout.com/get-started/onboarding.md): In this section, we'll guide you through the initial steps to get started with xPay
- [Currencies Supported](https://docs.xpaycheckout.com/get-started/currencies-supported.md): List of all currencies supported by xPay
- [Payment Methods](https://docs.xpaycheckout.com/get-started/payment-methods-supported.md): xPay supports a wide range of payment methods to ensure global compatibility.
- [Overview](https://docs.xpaycheckout.com/products/one-time-payments/overview.md): Accept instant payments for individual transactions with xPay's secure and reliable one-time payment solution.
- [Integration Process](https://docs.xpaycheckout.com/products/one-time-payments/integrationProcess.md): Discover how to integrate xPay’s payment flow into your website using xPay’s payment gateway APIs.
- [Payment Statuses](https://docs.xpaycheckout.com/products/one-time-payments/payment-statuses.md)
- [Error Codes](https://docs.xpaycheckout.com/products/one-time-payments/error-codes.md)
- [Saved Cards](https://docs.xpaycheckout.com/products/one-time-payments/saved-cards.md): Enable your customers to save cards for faster future payments and manage their saved cards securely with xPay.
- [Overview](https://docs.xpaycheckout.com/products/subscription/overview.md): Automate recurring billing with xPay's subscription solution designed for businesses with recurring revenue models.
- [Integration Process](https://docs.xpaycheckout.com/products/subscription/integrationProcess.md): Learn how to integrate xPay’s subscription payment flow into your website using xPay’s payment gateway APIs.
- [Subscription Statuses](https://docs.xpaycheckout.com/products/subscription/subscription-statuses.md)
- [Retry Mechanism](https://docs.xpaycheckout.com/products/subscription/subscription-retry-mechanism.md): Comprehensive system for handling failed subscription payments with automatic and manual retry capabilities.
- [Payment Links](https://docs.xpaycheckout.com/products/payment-links/payment-links.md): Create shareable payment links for one-time and subscription payments with xPay's flexible payment link solution.
- [Overview](https://docs.xpaycheckout.com/products/setup-method/overview.md): Securely collect and store customer payment methods for future use with xPay's Setup Method solution.
- [Integration Process](https://docs.xpaycheckout.com/products/setup-method/integrationProcess.md): Learn how to integrate xPay's Setup Method flow to securely store and charge customer payment methods.
- [Virtual Bank Accounts](https://docs.xpaycheckout.com/products/virtual-bank-accounts/virtual-bank-accounts.md): Digital bank accounts that provide businesses with real bank account details without traditional banking setup.
- [Platform Connect](https://docs.xpaycheckout.com/products/platform-connect/overview.md): Onboard and manage sub-merchants under a single platform account. Platform Connect lets you act on behalf of multiple connected merchants from one login, while keeping each merchant's transactions, and settlements isolated.
- [Payouts](https://docs.xpaycheckout.com/dashboard-operations/payouts/payouts.md): Information about payout cadence, limits, currency, statements, and FIRC
- [Overview](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/dispute-management.md): What disputes are, where to track them, and how you're notified.
- [How disputes work](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/how-disputes-work.md): The dispute lifecycle, from a customer complaint to a final outcome.
- [Reason codes](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/reason-codes.md): What each dispute reason code means on a card, bank, ACH, or check transaction.
- [Network code reference](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/network-code-reference.md): Map the underlying Visa, Mastercard, and American Express network codes to xPay dispute categories.
- [Responding by reason](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/responding-by-reason.md): How to fight or accept each dispute reason, and the evidence that makes a strong case.
- [Secondary evidence](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/secondary-evidence.md): Supporting evidence to attach alongside primary evidence for any dispute reason.
- [Evidence guidelines](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/evidence-guidelines.md): How to submit evidence, and how to respond to or accept a dispute.
- [Deadlines](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/deadlines.md): Response deadlines and the consequences of missing them.
- [Reducing disputes](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/reducing-disputes.md): Best practices to prevent disputes before they happen.
- [Dispute FAQ](https://docs.xpaycheckout.com/dashboard-operations/dispute-management/faq.md): Common questions about handling disputes.
- [Get Started](https://docs.xpaycheckout.com/developer-resources/getyourkeys.md)
- [Authentication](https://docs.xpaycheckout.com/developer-resources/authentication.md): Authentication with xPay — Basic Authentication (RFC 7617)
- [Rate Limits](https://docs.xpaycheckout.com/developer-resources/rate-limits.md): Learn about API rate limits and how to work with them.
- [Idempotent Requests](https://docs.xpaycheckout.com/developer-resources/idempotency.md): Learn how to safely retry requests using idempotency keys
- [Errors](https://docs.xpaycheckout.com/developer-resources/errors.md): Overview of xPay's HTTP response codes and error meanings.
- [Create Intent](https://docs.xpaycheckout.com/developer-resources/endpoints/payments/create-intent.md): This API is the first API to be called when the payment flow begins. Through this API, you inform xPay of the intent of the user to pay with all the requisite info about the user.
- [Get Intent](https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-intent.md): You can use this API to get the status of the transaction that corresponds to a particular intent. This API also returns the masked card info of the payer (if it's a card transaction) and the transaction lifecycle, which includes multiple attempts, failures, and other checkpoints during a transactio…
- [Refund](https://docs.xpaycheckout.com/developer-resources/endpoints/payments/refund.md): The Refund APIs allow merchants to process refunds for previously captured payments
- [Cancel Payment](https://docs.xpaycheckout.com/developer-resources/endpoints/payments/cancel-payment.md)
- [List Intents](https://docs.xpaycheckout.com/developer-resources/endpoints/payments/list-intents.md): Retrieve a list of payment intents created within a specific time range, with support for filtering and pagination. This endpoint allows you to track and analyse all payment attempts for your account. It's useful for building dashboards, reconciling payments, or reviewing recent transactions program…
- [Charge Raw Card](https://docs.xpaycheckout.com/developer-resources/endpoints/payments/charge-raw-card.md)
- [Get Refunds of an Intent](https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-refunds-for-intent.md): Retrieve a list of refunds for a specific payment intent
- [Get Refund](https://docs.xpaycheckout.com/developer-resources/endpoints/payments/get-refund.md): Get details of a single refund by refundId
- [Create Subscription](https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/create-subscription.md)
- [Get Subscription](https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/get-subscription.md)
- [Edit Subscription](https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/edit-subscription.md)
- [One Time Charge](https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/one-time-charge.md): Charge a one-time amount against an existing subscription using its saved payment method.
- [Pause Subscription](https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/pause.md)
- [Unpause Subscription](https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/unpause.md)
- [Cancel Subscription](https://docs.xpaycheckout.com/developer-resources/endpoints/subscriptions/cancel.md)
- [Payments Links](https://docs.xpaycheckout.com/developer-resources/endpoints/payment-links/generate-link.md): This API can be used to generate payment links programmatically. Payments links are basically standalone webpages where your customer can make a one time payment.
- [Subscription Link](https://docs.xpaycheckout.com/developer-resources/endpoints/payment-links/subscription-link.md): This API can be used to generate subscription links programmatically. Subscription links are basically standalone webpages where your customer can make a subscription payment.
- [Create Customer](https://docs.xpaycheckout.com/developer-resources/endpoints/customer/create-customer.md): Create a new customer in the xPay system
- [Get Customer](https://docs.xpaycheckout.com/developer-resources/endpoints/customer/get-customer.md): Get customer details by customer ID
- [List Payment Method Tokens](https://docs.xpaycheckout.com/developer-resources/endpoints/customer/get-pm-tokens-for-customer.md): Retrieve a list of payment method tokens for a customer created within a specific time range, with support for filtering and pagination. This endpoint allows you to track and analyse all payment method tokens for a customer. It's useful for building dashboards, reconciling payment methods, or review…
- [Create Setup Method](https://docs.xpaycheckout.com/developer-resources/endpoints/setup-method/create-setup-method.md): Create a new setup method for storing payment methods
- [Create S2S Setup Method](https://docs.xpaycheckout.com/developer-resources/endpoints/setup-method/create-s2s-setup-method.md): Create a new setup method for storing payment methods server to server
- [Get Setup Method](https://docs.xpaycheckout.com/developer-resources/endpoints/setup-method/get-setup-method.md): Get details of a setup method
- [Charge Tokenised PM](https://docs.xpaycheckout.com/developer-resources/endpoints/setup-method/charge-tokenised-pm.md): Charge a payment using a tokenized payment method
- [Get Payment Method Token](https://docs.xpaycheckout.com/developer-resources/endpoints/setup-method/get-payment-method-token.md): Get details of a payment method token
- [Delete Tokenised Payment Method](https://docs.xpaycheckout.com/developer-resources/endpoints/setup-method/delete-tokenised-pm.md): Delete a payment method token
- [Get Payout](https://docs.xpaycheckout.com/developer-resources/endpoints/payouts/get-payout.md): Get details of a single payout by payoutId
- [List Payouts](https://docs.xpaycheckout.com/developer-resources/endpoints/payouts/list-payouts.md): Retrieve a list of payouts created within a specific time range, with support for filtering and pagination. This endpoint allows you to track and analyse all payout transactions to your account. It's useful for building dashboards, reconciling payouts, or reviewing recent payout transactions program…
- [Create a Webhook Configuration](https://docs.xpaycheckout.com/developer-resources/endpoints/webhooks/create-webhook.md): Create a webhook configuration to receive realtime events for payments, intents, subscriptions, payouts, or setup methods.
- [List Webhook Configurations](https://docs.xpaycheckout.com/developer-resources/endpoints/webhooks/get-webhooks.md): Retrieve the list of webhook configurations that are currently active for your account.
- [Get Webhook Configuration](https://docs.xpaycheckout.com/developer-resources/endpoints/webhooks/get-webhook-by-id.md): Retrieve a specific webhook configuration by its identifier.
- [Edit Webhook Configuration](https://docs.xpaycheckout.com/developer-resources/endpoints/webhooks/edit-webhook.md): Update an existing webhook configuration. Use this to rotate the event signer, change the destination endpoint, or adjust the subscribed event types.
- [Delete Webhook Configuration](https://docs.xpaycheckout.com/developer-resources/endpoints/webhooks/delete-webhook.md): Delete an existing webhook configuration and stop delivery of future events to that endpoint.
- [Webhooks Introduction](https://docs.xpaycheckout.com/developer-resources/webhooks/introduction.md): Learn how to securely handle real-time events from xPay using webhooks.
- [Webhook Verification](https://docs.xpaycheckout.com/developer-resources/webhooks/verification.md): xPay supports two methods for webhook signature verification. Both are valid and supported. Please use the one that matches your integration.
- [Webhook Events Directory](https://docs.xpaycheckout.com/developer-resources/webhooks/events-list.md): Quick access list for every webhook event emitted by xPay.
- [Created](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/created.md): This event is triggered when a new payment intent is successfully created.
- [Checkout Opened](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/checkout_opened.md): This event is triggered when a payment intent's checkout page is opened by a customer.
- [Success](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/success.md): This event indicates that the payment intent has been successfully processed and the payment is complete.
- [Failed](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/failed.md): This event is triggered when the payment process for a given intent fails due to an error or insufficient funds.
- [Refunded](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/refunded.md): This event indicates that a payment intent has been successfully refunded.
- [Disputed](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/disputed.md): This event indicates that a payment intent has been disputed, often due to a chargeback or customer claim.
- [Dispute Under Review](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/dispute_under_review.md): This event indicates that a payment intent dispute is currently under review, meaning the dispute is being investigated and no final decision has been made yet.
- [Dispute Won](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/disputedWon.md): This event indicates that a payment intent dispute has been resolved in favor of the merchant, allowing them to retain the funds.
- [Dispute Lost](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/dispute_lost.md): This event indicates that a payment intent dispute has been lost, meaning the dispute was resolved in favor of the customer and the funds have been returned to them.
- [Early Fraud Warning](https://docs.xpaycheckout.com/developer-resources/webhooks/events/intentEvents/early_fraud_warning.md): This event indicates a payment intent flagged as potentially fraudulent, ahead of any formal dispute. Acting on it early can help you avoid a chargeback.
- [Created](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/created.md): This event is triggered when a new subscription intent is successfully created.
- [Checkout Opened](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/checkout_opened.md): This event is triggered when a subscription's checkout page is opened by a customer.
- [Trialing](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/trialing.md): This event is triggered when a subscription enters the trialing state—before it becomes fully active. It indicates the start of the trial period, during which the user can access the subscription benefits without being charged. The event includes details such as the subscription ID, upcoming payment…
- [Active](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/active.md): This event is triggered when a subscription transitions to the active state, indicating it is ready for billing.
- [Paused](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/paused.md): This event is triggered when a subscription is paused by the merchant.
- [Unpaused](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/unpaused.md): This event is triggered when a subscription is unpaused by the merchant.
- [Cycle Charged](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/cycle_charged.md): This event is triggered when a subscription's billing cycle is successfully charged.
- [Unpaid](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/unpaid.md): This event is triggered when a subscription becomes unpaid, indicating it is no longer active for billing.
- [Payment Method Updated](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/payment_method_updated.md): This event is triggered when a subscription's payment method is updated.
- [Ended](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/ended.md): This event is triggered when a subscription is successfully ended after all billing cycles.
- [Cancelled](https://docs.xpaycheckout.com/developer-resources/webhooks/events/subsEvents/cancelled.md): This event is triggered when a subscription is cancelled by the merchant.
- [Setup Method Created](https://docs.xpaycheckout.com/developer-resources/webhooks/events/setupMethodEvents/created.md): This event is triggered when a new setup method is created.
- [Setup Method Checkout Opened](https://docs.xpaycheckout.com/developer-resources/webhooks/events/setupMethodEvents/checkout_opened.md): This event is triggered when a setup method's checkout page is opened by a customer.
- [Setup Method Success](https://docs.xpaycheckout.com/developer-resources/webhooks/events/setupMethodEvents/success.md): This event is triggered when a setup method is successfully completed.
- [Setup Method Failed](https://docs.xpaycheckout.com/developer-resources/webhooks/events/setupMethodEvents/failed.md): This event is triggered when a setup method fails.
- [Payment Method Token Created](https://docs.xpaycheckout.com/developer-resources/webhooks/events/setupMethodEvents/payment_method_token_created.md): This event is triggered when a new payment method token is created.
- [Payment Method Token Deleted](https://docs.xpaycheckout.com/developer-resources/webhooks/events/setupMethodEvents/payment_method_token_deleted.md): This event is triggered when a payment method token is deleted.
- [Payout Initiated](https://docs.xpaycheckout.com/developer-resources/webhooks/events/payoutEvents/initiated.md): This event is triggered when a payout is successfully initiated.
- [Payout Success](https://docs.xpaycheckout.com/developer-resources/webhooks/events/payoutEvents/success.md): This event is triggered when a payout is successfully completed.
- [Virtual Bank Account Transaction](https://docs.xpaycheckout.com/developer-resources/webhooks/events/vbaEvents/transaction.md): This event is triggered when a credit lands in one of your merchant virtual bank accounts.
- [Pagination](https://docs.xpaycheckout.com/developer-resources/pagination.md)
- [Sandbox Environment](https://docs.xpaycheckout.com/developer-resources/sandbox/sandbox.md): Test your xPay integration in a safe sandbox environment with cloned account data
- [Payment Test Simulation](https://docs.xpaycheckout.com/developer-resources/sandbox/payment-test-simulation.md): Test credentials and simulation scenarios for payment methods in the xPay sandbox environment
- [Mobile App Integration](https://docs.xpaycheckout.com/developer-resources/mobileIntegration.md): Learn how to embed your webpage inside a mobile WebView and properly handle deep links across different frameworks.
- [Iframe Guidelines](https://docs.xpaycheckout.com/developer-resources/iframeGuidelines.md): Quick guide to payment method support when embedding xPay Checkout in an iframe.
- [Frequently Asked Questions](https://docs.xpaycheckout.com/faqs/overall-faq.md)
- [xPay Card Installments](https://docs.xpaycheckout.com/faqs/x-pay-card-installments.md)
- [Klarna FAQs for Merchants](https://docs.xpaycheckout.com/faqs/klarna-overview.md): Comprehensive guide to Klarna integration, payment options, and requirements for merchants using xPay
- [Prohibited Activities / Businesses](https://docs.xpaycheckout.com/faqs/prohibited-businesses.md): Activities, products, and services considered prohibited under xPay's terms of service.

## OpenAPI Specs

- [openapi](https://docs.xpaycheckout.com/developer-resources/endpoints/openapi.json)