# ODUS Documentation > ODUS is a payment orchestration platform. These are the guides for Core API v2, the current version: every Core API path starts with `/v2`. Core API v1 stops being served at 00:00 UTC on 4 November 2026. For exact request and response schemas, read the OpenAPI document linked under Optional. ## Documentation ODUS is a payment orchestration platform that simplifies payment processing through a unified API and a drop-in Checkout SDK. Connect multiple payment service providers, manage subscriptions, and accept payments — all from a single integration. - [ODUS Documentation](https://docs.odus.com/docs.md): ODUS is a payment orchestration platform that simplifies payment processing through a unified API and a drop-in Checkout SDK. Connect multiple payment service providers, manage subscriptions, and accept payments — all from a single integration. ### Guides Learn how to use ODUS in your projects with examples and step-by-step guides. - [Overview](https://docs.odus.com/docs/guides.md): Learn how to use ODUS in your projects with examples and step-by-step guides. #### Upgrading Core API v2 is the current version of the API. v1 stops being served at 00:00 UTC on 4 November 2026. If your integration calls /v1 routes or unprefixed routes such as GET /payments, or uses a Checkout SDK version earlier than 1.12.0, upgrade before then. - [Upgrading](https://docs.odus.com/docs/guides/upgrading.md): Core API v2 is the current version of the API. v1 stops being served at 00:00 UTC on 4 November 2026. If your integration calls /v1 routes or unprefixed routes such as GET /payments, or uses a Checkout SDK version earlier than 1.12.0, upgrade before then. - [Upgrading from v1 to v2](https://docs.odus.com/docs/guides/upgrading/v1-to-v2.md): Core API v2 is the current version of the API. v1 stops being served at 00:00 UTC on 4 November 2026, so 3 November is the last day it answers. Upgrade before then. You can move one flow at a time, and nothing moves to v2 for you. - [Upgrading webhooks to payload version 2](https://docs.odus.com/docs/guides/upgrading/webhook-payload-v2.md): Payload version 2 changes the shape of data in the webhooks you receive. It is optional and separate from the API version. It has no deadline: a subscriber on payload version 1 keeps receiving it after Core API v1 stops being served on 4 November 2026. #### API features Learn about ODUS API and its features with usage examples. - [API Features](https://docs.odus.com/docs/guides/api-features.md): Learn about ODUS API and its features with usage examples. - [Authentication](https://docs.odus.com/docs/guides/api-features/authentication.md): All server-side ODUS API calls must include a secret key to prove identity. This guide shows you how to create a secret key, add it to your requests, and rotate it when needed. - [Data Consistency](https://docs.odus.com/docs/guides/api-features/data-consistency.md): The ODUS API is designed for high throughput and low latency. As a result, some read endpoints can reflect a write with a slight delay. This page explains how consistency works across different endpoint types. - [Error Responses](https://docs.odus.com/docs/guides/api-features/errors.md): Every request the ODUS API rejects answers with the same JSON body, whatever went wrong: - [Metadata](https://docs.odus.com/docs/guides/api-features/metadata.md): Many ODUS API resources support a metadata field that lets you attach custom key-value data to objects. This is useful for storing additional structured information that's relevant to your business logic that is not captured by the standard fields. - [Pagination, filtering, sorting](https://docs.odus.com/docs/guides/api-features/pagination-filtering-sorting.md): Core API v2 paginates by cursor only. page and pageSize are not part of the v2 contract, and v2 also changes filtering semantics and the set of list endpoints. - [Webhooks](https://docs.odus.com/docs/guides/api-features/webhooks.md): ODUS webhooks allow you to receive real-time notifications about events that occur in your ODUS account. This enables you to build integrations that can react to events such as successful payments, recurring payments, subscription updates, and more. #### Payments Learn how to accept payments using ODUS with various payment gateways and methods. - [Payments](https://docs.odus.com/docs/guides/payments.md): Learn how to accept payments using ODUS with various payment gateways and methods. - [Captures](https://docs.odus.com/docs/guides/payments/capture.md): Manual capture separates authorization from the transfer of funds. When you authorize a payment with manual capture, the customer's card is held for the amount but no money is transferred until you explicitly capture it. - [Chargebacks](https://docs.odus.com/docs/guides/payments/chargebacks.md): A chargeback occurs when a cardholder's bank reverses a payment and reclaims the funds on the customer's behalf. ODUS does not automatically detect chargebacks from your payment gateway — you must record them manually when your bank or processor notifies you. - [Error Codes](https://docs.odus.com/docs/guides/payments/error-codes.md): When a payment fails, ODUS reports the reason as a standardized error code. Where the failure came from a payment processor, the processor-specific error is normalized into that same set — so regardless of whether the payment was routed through Stripe, Adyen, PayPal, or any other gateway, the error response uses the same codes. This lets you build a single error-handling path in your integration instead of mapping each processor's errors individually. - [Flow Overview](https://docs.odus.com/docs/guides/payments/flow-overview.md): Learn about how payment flows work in ODUS and the different participants involved in the process. Your application needs to be ready to handle these flows to ensure a smooth payment experience for your customers. - [Making Payments](https://docs.odus.com/docs/guides/payments/making-payments.md): Learn how to create payments for usage with Checkout SDK or direct API calls. - [Working with Saved Payment Methods](https://docs.odus.com/docs/guides/payments/payment-methods.md): A saved payment method is a tokenized card, PayPal account, or Apple Pay wallet stored against a customer. Once saved, it can be reused for future payments and subscription renewals without requiring the customer to enter their details again. - [Payment Statuses](https://docs.odus.com/docs/guides/payments/payment-statuses.md): A payment in ODUS carries two separate status fields: status and displayStatus. Understanding the difference between them — and how they relate to the boolean lifecycle flags — helps you build integrations that correctly handle every payment outcome. - [Refunds and Voids](https://docs.odus.com/docs/guides/payments/refunds.md): Use the POST /v2/payments//reverse endpoint to refund a captured payment or void an uncaptured authorization. The same endpoint handles both operations — ODUS decides which action to perform based on the current state of the payment. #### Checkout ODUS Checkout SDK provides two integration paths for accepting payments in your application. Both are part of the @odus/checkout package and share the same backend APIs, 3DS handling, and payment lifecycle — they differ in how much control you have over the UI. - [Checkout SDK](https://docs.odus.com/docs/guides/checkout.md): ODUS Checkout SDK provides two integration paths for accepting payments in your application. Both are part of the @odus/checkout package and share the same backend APIs, 3DS handling, and payment lifecycle — they differ in how much control you have over the UI. - [3DS and redirect handling](https://docs.odus.com/docs/guides/checkout/3ds-and-redirect-handling.md): This guide applies to both Drop-in Checkout and Elements. The return URL handling and query parameter parsing are identical for both integration paths. - [Choosing Between Drop-in and Elements](https://docs.odus.com/docs/guides/checkout/choosing-integration.md): ODUS Checkout SDK offers two integration paths: Drop-in and Elements. Both use the same backend APIs, handle 3DS authentication, and support the same payment methods — they differ in how much UI control you retain. - [Appearance](https://docs.odus.com/docs/guides/checkout/drop-in/appearance.md): ODUS Checkout SDK lets you customize colors, fonts, button labels, field layout, and the set of supported payment methods through the appearance configuration option. - [Builder](https://docs.odus.com/docs/guides/checkout/drop-in/builder.md): Guides and API reference for ODUS: the Core API, the Checkout SDK, subscriptions, webhooks and order management. - [Configuration](https://docs.odus.com/docs/guides/checkout/drop-in/configuration.md): ODUS Checkout SDK is deeply customizable to fit your application's needs. - [Getting Started](https://docs.odus.com/docs/guides/checkout/drop-in/getting-started.md): Learn how to integrate ODUS Checkout SDK into your application. This guide walks you through the complete setup process with code examples in React. - [SDK Reference](https://docs.odus.com/docs/guides/checkout/drop-in/sdk-reference.md): Complete reference for the OdusCheckout class, its methods, and TypeScript types. - [Builder](https://docs.odus.com/docs/guides/checkout/elements/builder.md): Guides and API reference for ODUS: the Core API, the Checkout SDK, subscriptions, webhooks and order management. - [Configuration](https://docs.odus.com/docs/guides/checkout/elements/configuration.md): ODUS Elements is configured at two levels: - [Examples](https://docs.odus.com/docs/guides/checkout/elements/examples.md): Self-contained React components showing common integration patterns. Each builds on the same three-step flow from Getting Started — the differences are which elements you mount and how you collect customer data. - [Getting Started](https://docs.odus.com/docs/guides/checkout/elements/getting-started.md): This guide walks you through integrating ODUS Elements into a React application — from installation to accepting your first payment. - [SDK Reference](https://docs.odus.com/docs/guides/checkout/elements/sdk-reference.md): Complete API reference for the OdusElements class, BaseElement class, and all TypeScript types. - [Theming](https://docs.odus.com/docs/guides/checkout/elements/theming.md): ODUS Elements uses CSS custom properties for styling, giving you fine-grained control over every element's visual appearance. Each element renders inside its own Shadow DOM and inherits theme variables from CSS custom properties set on its host element. - [Migration to Checkout V1 (iFrame fields)](https://docs.odus.com/docs/guides/checkout/migration-v1.md): The Checkout SDK renders card payment fields inside secure iFrames instead of native browser inputs. This change reduces your PCI DSS scope — sensitive card data (card number, expiry, CVV, and cardholder name) no longer enters your page. #### Subscriptions Learn about ODUS subscriptions and how to manage them using the API. - [Subscriptions](https://docs.odus.com/docs/guides/subscriptions.md): Learn about ODUS subscriptions and how to manage them using the API. - [Cancelling and Resuming](https://docs.odus.com/docs/guides/subscriptions/canceling-and-resuming.md): ODUS gives you three ways to cancel a subscription: immediately, at the end of the current billing period, or at the end of the next one — letting the upcoming renewal charge go through first. Either scheduled option can be reversed by resuming the subscription before it takes effect. - [Creating Subscriptions](https://docs.odus.com/docs/guides/subscriptions/creating-subscriptions.md): A subscription is not created by calling a dedicated endpoint. Instead, ODUS creates a subscription automatically when a payment that contains a recurring price succeeds. This guide explains how to set up that payment so a subscription is activated for your customer. - [Payment Bundling](https://docs.odus.com/docs/guides/subscriptions/payment-bundling.md): When a customer has multiple active subscriptions, ODUS can charge them in a single payment instead of separate charges per subscription. This reduces transaction fees, simplifies billing statements for your customers, and can improve payment success rates by reducing the number of charges. - [Related Subscriptions](https://docs.odus.com/docs/guides/subscriptions/related-subscriptions.md): A single checkout often creates more than one subscription — a paid plan plus a free add-on, or a - [Configure a Payment Retry Policy](https://docs.odus.com/docs/guides/subscriptions/retry-policy.md): When a subscription renewal charge fails, ODUS automatically retries the charge according to the merchant's retry policy (also called a recycle profile). A retry policy defines a schedule of retry attempts, each with configurable delays and gateway options. - [Subscription Lifecycle](https://docs.odus.com/docs/guides/subscriptions/subscription-lifecycle.md): A subscription in ODUS is a recurring billing agreement between a merchant and a customer for a specific product and price. Once created, ODUS automatically charges the customer at each renewal date according to the price's recurring schedule — no further action is required from your backend. - [Updating plans](https://docs.odus.com/docs/guides/subscriptions/updating-plans.md): ODUS allows you to modify active subscriptions by changing their pricing plan at any time. This functionality enables both upgrades (moving to a higher-priced plan) and downgrades (moving to a lower-priced plan) with automatic proration calculations. #### Connecting AI assistants ODUS has a remote MCP server. Add it to Claude, ChatGPT, Cursor, VS Code or another AI assistant, and the assistant can answer questions about your payments, customers, subscriptions, invoices, products and orders by reading them from ODUS, for example "which payments failed yesterday, and why?". - [Connect an AI assistant to ODUS](https://docs.odus.com/docs/guides/ai-connector.md): ODUS has a remote MCP server. Add it to Claude, ChatGPT, Cursor, VS Code or another AI assistant, and the assistant can answer questions about your payments, customers, subscriptions, invoices, products and orders by reading them from ODUS, for example "which payments failed yesterday, and why?". - [Connect ChatGPT to ODUS](https://docs.odus.com/docs/guides/ai-connector/chatgpt.md): Add ODUS to ChatGPT as a custom app in developer mode. - [Connect Claude to ODUS](https://docs.odus.com/docs/guides/ai-connector/claude.md): Add ODUS to Claude as a custom connector. A connector you add on the web is also available in the Claude desktop and mobile apps. - [Connect Claude Code to ODUS](https://docs.odus.com/docs/guides/ai-connector/claude-code.md): Add ODUS to Claude Code as a remote HTTP server. Claude Code can then read your ODUS data while it works in your codebase, for example to check a real payment's shape while you write a webhook handler. - [Connect Cursor to ODUS](https://docs.odus.com/docs/guides/ai-connector/cursor.md): Add ODUS to Cursor as a remote MCP server. Cursor's agent can then read your ODUS data while you work. - [Connect other MCP clients to ODUS](https://docs.odus.com/docs/guides/ai-connector/other-clients.md): Any MCP client that supports remote servers over Streamable HTTP with OAuth can connect to ODUS. Give it the server URL, https://mcp.odus.com/mcp, and nothing else. - [Connect VS Code to ODUS](https://docs.odus.com/docs/guides/ai-connector/vs-code.md): Add ODUS to VS Code as an MCP server. GitHub Copilot can then read your ODUS data in agent mode. #### Customers Customers are reusable records in ODUS that represent the people or organizations you charge. Each customer holds contact information and serves as the central reference point for payments, subscriptions, and saved payment methods. - [Customers](https://docs.odus.com/docs/guides/customers.md): Customers are reusable records in ODUS that represent the people or organizations you charge. Each customer holds contact information and serves as the central reference point for payments, subscriptions, and saved payment methods. - [Restrictions](https://docs.odus.com/docs/guides/customers/customer-restrictions.md): Customer restrictions let you block a specific customer from making payments. You can block new payment attempts made by the customer (CIT — customer-initiated transactions), block recurring subscription charges (MIT — merchant-initiated transactions), or both. - [Managing Customers](https://docs.odus.com/docs/guides/customers/managing-customers.md): A customer record in ODUS represents a person or organization you charge. Each record holds contact information — name, email, phone number, and addresses. Payments, subscriptions, and saved payment methods reference the customer by its id (prefixed cus_). #### Dashboard The ODUS Dashboard is a web interface that allows you to manage your account. Learn how to use the Dashboard to configure your settings. Most dashboard operations can also be performed via the API assuming your Secret API Key has the necessary permissions. - [Dashboard](https://docs.odus.com/docs/guides/dashboard.md): The ODUS Dashboard is a web interface that allows you to manage your account. Learn how to use the Dashboard to configure your settings. Most dashboard operations can also be performed via the API assuming your Secret API Key has the necessary permissions. - [Analytics](https://docs.odus.com/docs/guides/dashboard/analytics.md): The ODUS Dashboard home page shows a real-time summary of your payment activity. It combines a key metrics strip, a customizable grid of revenue and insight widgets, and a monthly rebills calendar. The metrics and widgets are driven by shared date range, granularity, and timezone controls, and you choose which widgets to show, how they are arranged, and how each chart is drawn. - [Gateway Profiles](https://docs.odus.com/docs/guides/dashboard/gateway-profiles.md): A gateway profile is a named set of credentials for one payment gateway connection. For example, your Stripe live account and your Stripe test account are each a separate profile. You can create multiple profiles for the same gateway — for example, one per country or business unit. - [Merchant Configuration](https://docs.odus.com/docs/guides/dashboard/merchant-configuration.md): The Merchant Configuration page lets you set account-wide defaults that apply to all payments. Individual payment requests can override these defaults, but the values you configure here are used when no override is provided. - [Request Logs](https://docs.odus.com/docs/guides/dashboard/request-logs.md): Request Logs are a record of every inbound API request made to ODUS. Use them to debug integration issues, audit API usage, and inspect the exact payloads that were sent and received. - [Manage Team Members](https://docs.odus.com/docs/guides/dashboard/team-management.md): The ODUS Dashboard lets you create user accounts for your team members and assign each one a role that controls what they can do. This guide explains how to add, edit, and remove users in the Dashboard. - [Webhook Subscriber](https://docs.odus.com/docs/guides/dashboard/webhook-subscriber.md): Webhook subscribers represent a destination URL where ODUS will send webhook events for the events you subscribe to. You can create multiple webhook subscribers to send events to different URLs based on your application's needs. #### FAQ Quick answers to the most common questions merchants ask about ODUS. - [Frequently Asked Questions](https://docs.odus.com/docs/guides/faq.md): Quick answers to the most common questions merchants ask about ODUS. #### Integrations Explore the available integration options for connecting external services with ODUS. - [Integrations](https://docs.odus.com/docs/guides/integrations.md): Explore the available integration options for connecting external services with ODUS. - [General](https://docs.odus.com/docs/guides/integrations/gateways.md): Learn how to integrate various payment gateways (e.g., Stripe, PayPal) with ODUS to expand your payment processing options. - [Adyen](https://docs.odus.com/docs/guides/integrations/gateways/adyen.md): Adyen is a global payment company that allows businesses to accept payments in a single system. - [Setting up Apple Pay](https://docs.odus.com/docs/guides/integrations/gateways/adyen/adyen-apple-pay.md): Learn how to configure ODUS to accept Apple Pay payments via Adyen. - [Setting up Webhooks](https://docs.odus.com/docs/guides/integrations/gateways/adyen/adyen-webhooks.md): Learn how to configure ODUS to receive webhook notifications from Adyen. - [Checkout.com](https://docs.odus.com/docs/guides/integrations/gateways/checkout.md): Checkout.com is a cloud-based payment platform that enables businesses to accept payments globally through a unified API. - [Setting up Webhooks](https://docs.odus.com/docs/guides/integrations/gateways/checkout/checkout-webhooks.md): Learn how to configure ODUS to receive webhook notifications from Checkout.com. - [PayPal](https://docs.odus.com/docs/guides/integrations/gateways/paypal.md): PayPal is a widely used digital payments platform that allows businesses to accept PayPal payments, including PayPal Checkout and Pay Later options. A PayPal gateway profile can also process card payments; see Card payments. - [Setting up Webhooks](https://docs.odus.com/docs/guides/integrations/gateways/paypal/paypal-webhooks.md): Learn how to configure ODUS to receive webhook notifications from PayPal. - [Stripe](https://docs.odus.com/docs/guides/integrations/gateways/stripe.md): Stripe is a global payments platform that provides APIs and tools for businesses to accept and manage online payments. - [Setting up Webhooks](https://docs.odus.com/docs/guides/integrations/gateways/stripe/stripe-webhooks.md): Learn how to configure ODUS to receive webhook notifications from Stripe. #### Order Management System Order Management System turns successful payments for physical goods into orders and tracks them through fulfillment — from the moment a customer pays until every item is shipped or cancelled. - [Order Management System](https://docs.odus.com/docs/guides/order-management.md): Order Management System turns successful payments for physical goods into orders and tracks them through fulfillment — from the moment a customer pays until every item is shipped or cancelled. - [Automatic Fulfillment](https://docs.odus.com/docs/guides/order-management/automatic-fulfillment.md): Automatic fulfillment ships orders end to end without manual work: new orders are submitted to your logistics integration automatically, and when the provider ships, the fulfillment is recorded with carrier and tracking details. Fulfillment routes are the rules that decide which orders are submitted to which integration. - [Cancelling Orders](https://docs.odus.com/docs/guides/order-management/cancelling-orders.md): Cancellation removes units from an order that will not ship. It happens in two ways: automatically, when a payment is reversed or its capture fails, and manually, from the order detail page. This guide covers both — and the partial-refund case that connects them. - [Export and Bulk Fulfill](https://docs.odus.com/docs/guides/order-management/export-and-bulk-fulfill.md): Export and Bulk Fulfill form a file-based round-trip with your logistics provider: download your open orders as a file the provider's platform can import, let the provider ship them, then upload the provider's shipment report to mark the orders as fulfilled — hundreds at a time. - [How Orders Are Created](https://docs.odus.com/docs/guides/order-management/how-orders-are-created.md): Orders are created from webhooks which purchases become orders, which of them ship, when multiple payments are bundled into one order, and how customer details stay in sync. - [Importing Orders](https://docs.odus.com/docs/guides/order-management/importing-orders.md): Import creates orders retroactively from payments that already exist. Use it when an order was never created automatically — most commonly because the payment event did not reach Order Management System — or when you enable Order Management System after you have already been taking payments. - [Logistics Integrations](https://docs.odus.com/docs/guides/order-management/integrations.md): A logistics integration connects Order Management System to a third-party logistics (3PL) provider — the company that stores and ships your physical goods. Integrations power the file-based fulfillment round-trip and, where supported, fully automatic fulfillment. - [Inventory](https://docs.odus.com/docs/guides/order-management/inventory.md): The Inventory page shows how many units of each SKU your logistics providers are holding right now, side by side in one table. Use it to spot the SKUs that are running out before orders start waiting for stock. - [Viewing and Managing Orders](https://docs.odus.com/docs/guides/order-management/managing-orders.md): The Orders page is the operational center of Order Management System: find the orders that need action, inspect their details, and work them through fulfillment. - [Order Statuses](https://docs.odus.com/docs/guides/order-management/order-statuses.md): Every order and every order item carries a status derived from its quantities. Understanding how shipped and cancelled units interact helps you read the orders list correctly — especially for orders that were partially refunded or partially shipped. - [PayPal Shipment Tracking](https://docs.odus.com/docs/guides/order-management/paypal-shipment-tracking.md): When you record a fulfillment with a tracking number for an order paid through PayPal, Order Management System automatically submits the shipment details to PayPal. You do not need to copy the tracking number into PayPal separately. - [Setting Up](https://docs.odus.com/docs/guides/order-management/setup.md): Order Management System (OMS) is a first-class addon. Enable it once from your dashboard and every successful payment that contains goods you ship becomes an order automatically — no manual webhook wiring or secrets to copy. #### Products and prices This section covers how products and prices work in ODUS. A product represents something you sell, and a price defines the billing terms for that product — the amount, the currency, and whether the charge is one-time or recurring. Together, products and prices are the foundation for creating subscriptions. - [Products and Prices](https://docs.odus.com/docs/guides/products.md): This section covers how products and prices work in ODUS. A product represents something you sell, and a price defines the billing terms for that product — the amount, the currency, and whether the charge is one-time or recurring. Together, products and prices are the foundation for creating subscriptions. - [Creating products and prices](https://docs.odus.com/docs/guides/products/creating-products-and-prices.md): This guide explains how to create products and prices, and how to manage them after creation. - [What are products and prices?](https://docs.odus.com/docs/guides/products/overview.md): In ODUS, products and prices are the building blocks for billing. Before you can create a subscription or charge a customer, you need at least one product with at least one price attached to it. #### Reports Reports give you aggregated views of payment and customer data across your business. Use them to track revenue performance, compare segments, and export data for offline analysis. - [Reports](https://docs.odus.com/docs/guides/reports.md): Reports give you aggregated views of payment and customer data across your business. Use them to track revenue performance, compare segments, and export data for offline analysis. - [Customer Value Report](https://docs.odus.com/docs/guides/reports/customer-value-report.md): The Customer Value Report breaks revenue down by first charges, upsells, rebills, and lifetime value across any segment of your business — products, prices, currencies, dates, or attribution channels. - [Payment Summary Report](https://docs.odus.com/docs/guides/reports/payment-summary-report.md): The Payment Summary Report aggregates transaction outcomes across your business and splits them into two payment buckets — first-charge (FC) and recurring — alongside refund, chargeback, gross and net revenue metrics. - [Projected Billing Report](https://docs.odus.com/docs/guides/reports/projected-billing-report.md): The Projected Billing Report forecasts upcoming subscription revenue by combining the base amount of every scheduled rebill and recycle (retry) attempt with per-attempt approval rates that you supply. #### Routing The Routing section explains how ODUS decides which payment gateway to use for each card payment. There are two ways to configure it. - [Routing](https://docs.odus.com/docs/guides/routing.md): The Routing section explains how ODUS decides which payment gateway to use for each card payment. There are two ways to configure it. - [How Cascade Routing Works](https://docs.odus.com/docs/guides/routing/cascade-overview.md): A cascade is a named configuration that defines which gateway profiles ODUS uses to process a payment and in what order. When one gateway fails or is no longer available, ODUS automatically routes the payment to the next gateway in the cascade — without any action required from you. - [Configuring Cascade Routing Rules](https://docs.odus.com/docs/guides/routing/configuring-cascades.md): A cascade defines which gateway profiles ODUS uses to process a payment and how traffic is distributed across them. This guide shows how to create and configure a cascade, assign it as the default for card payments, and verify it is active. - [How Routes Work](https://docs.odus.com/docs/guides/routing/how-routes-work.md): A route decides which gateway profile ODUS attempts for a card payment, and where it fails over to after a decline. Unlike a cascade, a route can read the payment: the card's brand, BIN, issuer and funding type, the amount and currency, who initiated it, and your own metadata. So you can send cards from one issuer to one gateway and everything else to another. - [Routing Card Payments with a Route](https://docs.odus.com/docs/guides/routing/routing-card-payments.md): This guide creates a route, points card payments at it, and shows how to read the path a payment took. For how a route decides, see How Routes Work. #### Testing resources This guide covers everything you need to test your ODUS integration in sandbox before going live: test card numbers, example webhook payloads. - [Testing resources](https://docs.odus.com/docs/guides/testing.md): This guide covers everything you need to test your ODUS integration in sandbox before going live: test card numbers, example webhook payloads. #### Using AI tools Every guide here is also available as plain Markdown, so you can give it to an AI assistant or a coding agent without copying from the page. Give the tool the version you integrate with: these files describe Core API v2. - [Using these docs with AI tools](https://docs.odus.com/docs/guides/ai-tools.md): Every guide here is also available as plain Markdown, so you can give it to an AI assistant or a coding agent without copying from the page. Give the tool the version you integrate with: these files describe Core API v2. ## Optional - [Core API v2 reference](https://docs.odus.com/docs/api/core/v2/odus-core-api.md): Every Core API v2 endpoint and webhook event, each linking to its own Markdown page with parameters, request body and responses. - [OMS API reference](https://docs.odus.com/docs/api/oms/odus-oms-api.md): Every Order Management System API endpoint, each linking to its own Markdown page. - [Core API v2 OpenAPI document (production)](https://api.odus.com/openapi.v2.json): Every Core API v2 endpoint, request and response schema, and webhook event body, in OpenAPI 3.1. - [Core API v2 OpenAPI document (sandbox)](https://sandbox-api.odus.com/openapi.v2.json): The same document for the sandbox environment. Use it while you build and test. - [OMS API OpenAPI document](https://sandbox-oms-api.odus.com/openapi.json): The Order Management System API. - [Checkout SDK package](https://www.npmjs.com/package/@odus/checkout) - [Changelog](https://docs.odus.com/changelog): Every merchant-facing change, by release date.