# BNPLX.AI Documentation
> AI-powered BNPL orchestration platform

## Documentation Pages
- [API Reference Overview](https://docs.bnplx.io/docs/api-reference/overview): Welcome to the **BNPLx API Reference**!
- [Configuration](https://docs.bnplx.io/docs/configuration): DocsAI is configured using a single `constants.ts` file.
- [E-commerce Plugins Overview](https://docs.bnplx.io/docs/e-commerce/overview): Welcome to the **BNPLx E-commerce Integration Guide**!
- [Shopify Integration](https://docs.bnplx.io/docs/e-commerce/shopify): Integrate BNPLX Buy Now, Pay Later payment methods into your Shopify store via the Shopify App Store.
- [Shopware Plugin](https://docs.bnplx.io/docs/e-commerce/shopware): Integrate BNPLX Buy Now, Pay Later payment methods into your Shopware 6 store.
- [WooCommerce Plugin](https://docs.bnplx.io/docs/e-commerce/woocommerce): **Latest Plugin Version:** 1.0.4
- [Features Overview](https://docs.bnplx.io/docs/features): This documentation platform is packed with features designed to make writing and reading documentation a joy.
- [Account Setup](https://docs.bnplx.io/docs/first-steps/account-setup): Ready to offer Buy Now, Pay Later (BNPL) payments? Follow this quick-start guide to set up your account and integrate BNPL services in just a few minutes!
- [Connect Real BNPL Providers](https://docs.bnplx.io/docs/first-steps/connectors-guide): Once you've tested payments with the dummy connector, it's time to connect real BNPL providers. This guide walks you through setting up the BNPL providers available on BNPLx: Svea, Riverty, Payla, Ratepay, Zaver (Production-ready), Mondu, Billie, Zinia (Configured), and Avarda, Twisto (Development).
- [Setup Connector](https://docs.bnplx.io/docs/first-steps/create-dummy-connector): Set up your first BNPL connector in minutes. The BNPLx Test provider is provided by BNPLx to help you familiarize yourself with the platform before integrating real providers.
- [First payment](https://docs.bnplx.io/docs/first-steps/first-call): You're all set up! Now let's initiate your first payment using the BNPLx API.
- [Get API Keys](https://docs.bnplx.io/docs/first-steps/get-apis): To interact with the BNPLx APIs, every request must be securely authenticated using an API key.
- [Hosted Checkout](https://docs.bnplx.io/docs/first-steps/hosted-checkout): Integrate BNPLx payments into your custom website or application using the hosted checkout flow. This is the recommended integration for merchants not using a pre-built plugin (Shopify, Shopware, WooCommerce).
- [MCP Server](https://docs.bnplx.io/docs/first-steps/mcp-server): Give your AI coding assistant direct access to BNPLx APIs. The BNPLX MCP Server is a plugin for AI tools like Claude, Cursor, and Windsurf that lets them create payments, check statuses, and monitor system health — all through natural language.
- [Quickstart](https://docs.bnplx.io/docs/first-steps/quickstart): Go from zero to a confirmed test payment in under 10 minutes. This guide gives you the fastest path with copy-paste code — no detours.
- [Sandbox Testing](https://docs.bnplx.io/docs/first-steps/sandbox-testing): Test your full payment integration without processing real money. This guide covers how to simulate success, failure, refund, and cancel flows in the BNPLx sandbox.
- [Smart Routing](https://docs.bnplx.io/docs/first-steps/smart-routing): Smart routing lets you control which BNPL provider handles each payment. Define rules based on conditions like country, amount, or payment method — and BNPLx automatically routes payments to the right processor.
- [Installation](https://docs.bnplx.io/docs/installation): To get started with **DocsAI**, follow these simple steps.
- [Documentation](https://docs.bnplx.io/docs/intro): Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers and teams.
- [Authentication & API Keys](https://docs.bnplx.io/docs/key-information/authentication): BNPLx authenticates your API requests using your account's API keys. Each account has two API keys for authentication:
- [B2B Payments](https://docs.bnplx.io/docs/key-information/b2b-payments): Accept payments from business customers with company verification through BNPLx. B2B transactions use company name and VAT ID for credit assessment instead of personal details like date of birth.
- [Cancellations](https://docs.bnplx.io/docs/key-information/cancellations): Cancel a payment before it's captured. BNPLx releases the authorization hold with the BNPL provider and the payment moves to a terminal cancelled state.
- [Cancellations from Shopify](https://docs.bnplx.io/docs/key-information/cancellations/shopify): Cancel a BNPLX payment in Shopify before it's captured. This guide covers the two cancellation flows available in the BNPLX Shopify app.
- [Cancellations from Shopware](https://docs.bnplx.io/docs/key-information/cancellations/shopware): Cancel a BNPLX payment in Shopware before capture. This guide covers the three cancellation flows available in the [BNPLX Shopware plugin](/docs/e-commerce/shopware).
- [Dashboard Overview](https://docs.bnplx.io/docs/key-information/dashboard-overview): Your command center for all BNPL operations. Track performance, manage transactions, and configure your payment setup from one place.
- [Error Codes](https://docs.bnplx.io/docs/key-information/error-codes): BNPLx uses error codes, types, and messages to communicate errors during API calls. There are two main types of error codes: Error Codes and Unified Error Codes.
- [Go-live Checklist](https://docs.bnplx.io/docs/key-information/go-live): Refer to this checklist for a seamless transition as you prepare to go live with your integration.
- [Idempotency](https://docs.bnplx.io/docs/key-information/idempotency): Idempotency ensures that repeating the same API request does not create duplicate resources. This is critical for payment APIs where network timeouts, retries, or double-clicks could otherwise result in charging a customer twice.
- [Installment Plans](https://docs.bnplx.io/docs/key-information/installment-plans): Offer customers the option to pay in monthly installments instead of a single invoice. BNPLx retrieves available plans from your connected providers and lets the customer choose their preferred duration, interest rate, and monthly amount.
- [Pagination](https://docs.bnplx.io/docs/key-information/pagination): BNPLx list endpoints return paginated results to help you efficiently retrieve large datasets. The API supports two pagination styles depending on the endpoint.
- [Payment Status Life Cycle](https://docs.bnplx.io/docs/key-information/payment_status): BNPLx handles the complex functionality of a comprehensive payments flow through the Payments object that transitions through multiple states during its payments lifecycle. Given below are the various statuses a payment can have:
- [Rate Limits](https://docs.bnplx.io/docs/key-information/rate-limit): The BNPLx API has multiple checks in place to enhance its stability when faced with sudden surges of incoming traffic. Merchants who send numerous requests in rapid succession could encounter error responses indicated by the status code 429.
- [Refunds](https://docs.bnplx.io/docs/key-information/refunds): Process full or partial refunds through the API or dashboard. BNPLx handles communication with the BNPL provider and tracks the refund status through to completion.
- [Refunds from Shopify](https://docs.bnplx.io/docs/key-information/refunds/shopify): Refund a captured BNPLX payment from the Shopify admin. This guide covers the capture prerequisite, full refunds, and partial refunds in the BNPLX Shopify app.
- [Refunds from Shopware](https://docs.bnplx.io/docs/key-information/refunds/shopware): Refund a captured BNPLX payment from the Shopware admin. This guide covers the three refund flows available in the [BNPLX Shopware plugin](/docs/e-commerce/shopware).
- [Webhook Simulator](https://docs.bnplx.io/docs/key-information/webhook-simulator): {% callout type="tip" %}
- [Webhooks](https://docs.bnplx.io/docs/key-information/webhooks): Stay in sync with real-time payment updates. Webhooks notify your application instantly when payment statuses change, eliminating the need to constantly poll our API.
- [Webhooks for Shopify](https://docs.bnplx.io/docs/key-information/webhooks/shopify): The BNPLX Shopify app uses webhooks to receive real-time notifications from Shopify about checkout, order, and app lifecycle events. These webhooks are essential for the payment flow to work correctly.
- [Webhooks with Shopware](https://docs.bnplx.io/docs/key-information/webhooks/shopware): The BNPLX Shopware plugin keeps payment state in sync automatically — capture, refund, and cancel happen through synchronous REST API calls, and a scheduled polling task (Order Sync) pulls the latest state from BNPLX on a configurable interval. **You do not need to configure or handle webhooks for the plugin to work.**
- [Documentation Overview](https://docs.bnplx.io/docs/overview): Welcome to the **BNPLx Documentation**!
- [Plugins Overview](https://docs.bnplx.io/docs/plugins): DocsAI supports a robust plugin architecture allowing you to extend functionality.
- [Top Secret Area](https://docs.bnplx.io/docs/private): If you are reading this, you have successfully entered the correct password.
- [Roadmap](https://docs.bnplx.io/docs/roadmap): This page is protected. Please enter the password to view the roadmap.
- [About Us](https://docs.bnplx.io/docs/start/about-us): BNPLx is a next-generation fintech company reshaping the Buy Now, Pay Later (BNPL) ecosystem.
- [Buy Now, Pay Later (BNPL)](https://docs.bnplx.io/docs/start/bnpl): **BNPL** is a flexible payment method that enables customers to make purchases immediately and pay later — either in interest-free installments, after a set delay (e.g., 14 or 30 days), or through long-term financing.
- [Dashboard Signup Steps](https://docs.bnplx.io/docs/start/dashboard-signup-steps): Get started with BNPLx in minutes. Follow these simple steps to create your account and access the dashboard.
- [BNPL Flow](https://docs.bnplx.io/docs/start/flow): How the bnplx.io platform connects merchants with BNPL providers to deliver seamless payment experiences.
- [Environments](https://docs.bnplx.io/docs/start/understanding-environments): Two environments. One smooth journey from testing to live transactions.
- [Support Matrix](https://docs.bnplx.io/docs/support-matrix): This page is protected. Please enter the password to view the support matrix.

## API Endpoints
### Guide
- POST /payments: Payments - Create
- POST /payments/{payment_id}/confirm: Payments - Confirm
- POST /payments/{payment_id}/capture: Payments - Capture
- POST /payments/{payment_id}/cancel: Payments - Cancel

### Payments
- POST /payments/{payment_id}: Payments - Update
- GET /payments/{payment_id}: Payments - Retrieve
- POST /payments/session_tokens: Payments - Session token
- GET /payments/list: Payments - List
- POST /payments/{payment_id}/incremental_authorization: Payments - Incremental Authorization
- GET /payment_link/{payment_link_id}: Payments Link - Retrieve
- POST /payments/{payment_id}/3ds/authentication: Payments - External 3DS Authentication
- POST /payments/{payment_id}/complete_authorize: Payments - Complete Authorize
- POST /payments/{payment_id}/post_session_tokens: Payments - Post Session Tokens

### Refunds
- POST /refunds: Refunds - Create
- GET /refunds/{refund_id}: Refunds - Retrieve
- POST /refunds/{refund_id}: Refunds - Update
- POST /refunds/list: Refunds - List

### Organization
- POST /organization: Organization - Create
- GET /organization/{id}: Organization - Retrieve
- PUT /organization/{id}: Organization - Update

### Merchant Account
- POST /accounts: Merchant Account - Create
- GET /accounts/{account_id}: Merchant Account - Retrieve
- POST /accounts/{account_id}: Merchant Account - Update
- DELETE /accounts/{account_id}: Merchant Account - Delete
- POST /accounts/{account_id}/kv: Merchant Account - KV Status

### Merchant Connector Account
- POST /accounts/{account_id}/connectors: Merchant Connector - Create
- GET /accounts/{account_id}/connectors: Merchant Connector - List
- GET /accounts/{account_id}/connectors/{connector_id}: Merchant Connector - Retrieve
- POST /accounts/{account_id}/connectors/{connector_id}: Merchant Connector - Update
- DELETE /accounts/{account_id}/connectors/{connector_id}: Merchant Connector - Delete

### Gsm
- POST /gsm: Gsm - Create
- POST /gsm/get: Gsm - Get
- POST /gsm/update: Gsm - Update
- POST /gsm/delete: Gsm - Delete
- POST /gsm/list: Gsm - List

### Mandates
- GET /mandates/{mandate_id}: Mandates - Retrieve Mandate
- POST /mandates/revoke/{mandate_id}: Mandates - Revoke Mandate
- POST /customers/{customer_id}/mandates: Mandates - Customer Mandates List

### Customers
- POST /customers: Customers - Create
- GET /customers/{customer_id}: Customers - Retrieve
- POST /customers/{customer_id}: Customers - Update
- DELETE /customers/{customer_id}: Customers - Delete
- GET /customers/list: Customers - List

### Products
- POST /products: Products - Create
- GET /products/{product_id}: Products - Retrieve

### Payment Methods
- POST /payment_methods: PaymentMethods - Create
- GET /account/payment_methods: List payment methods for a Merchant
- GET /customers/{customer_id}/payment_methods: List payment methods for a Customer
- GET /customers/payment_methods: List customer saved payment methods for a Payment
- GET /{customer_id}/payment_methods/{payment_method_id}/default: Payment Method - Set Default Payment Method for Customer
- GET /payment_methods/{method_id}: Payment Method - Retrieve
- DELETE /payment_methods/{method_id}: Payment Method - Delete
- POST /payment_methods/{method_id}/update: Payment Method - Update

### Profile
- POST /account/{account_id}/business_profile: Profile - Create
- GET /account/{account_id}/business_profile: Profile - List
- GET /account/{account_id}/business_profile/{profile_id}: Profile - Retrieve
- POST /account/{account_id}/business_profile/{profile_id}: Profile - Update
- DELETE /account/{account_id}/business_profile/{profile_id}: Profile - Delete

### Disputes
- GET /disputes/{dispute_id}: Disputes - Retrieve Dispute
- GET /disputes/list: Disputes - List Disputes

### Routing
- POST /routing: Routing - Create
- GET /routing: Routing - List
- POST /routing/{routing_algorithm_id}/activate: Routing - Activate config
- GET /routing/{routing_algorithm_id}: Routing - Retrieve
- POST /routing/deactivate: Routing - Deactivate
- POST /routing/default: Routing - Update Default Config
- GET /routing/default: Routing - Retrieve Default Config
- GET /routing/active: Routing - Retrieve Config
- GET /routing/default/profile: Routing - Retrieve Default For Profile
- POST /routing/default/profile/{profile_id}: Routing - Update Default For Profile
- POST /account/:account_id/business_profile/:profile_id/dynamic_routing/success_based/toggle: Routing - Toggle success based dynamic routing for profile

### Blocklist
- DELETE /blocklist
- GET /blocklist
- POST /blocklist
- POST /blocklist/toggle

### API Key
- POST /api_keys/{merchant_id}: API Key - Create
- GET /api_keys/{merchant_id}/{key_id}: API Key - Retrieve
- POST /api_keys/{merchant_id}/{key_id}: API Key - Update
- DELETE /api_keys/{merchant_id}/{key_id}: API Key - Revoke
- GET /api_keys/{merchant_id}/list: API Key - List

### Event
- GET /events/{merchant_id}: Events - List
- GET /events/{merchant_id}/{event_id}/attempts: Events - Delivery Attempt List
- POST /events/{merchant_id}/{event_id}/retry: Events - Manual Retry

### Poll
- GET /poll/status/{poll_id}: Poll - Retrieve Poll Status