Skip to main content

50 docs tagged with "How-to Guide"

View all tags

3DS and redirect handling

This guide applies to both Drop-in Checkout and Elements. The return URL handling and query parameter parsing are identical for both integration paths.

Adyen

Adyen is a global payment company that allows businesses to accept payments in a single system.

Analytics

The Odus Dashboard home page shows a real-time summary of your payment activity. It combines four revenue and refund charts, a product sales panel, and a monthly rebills calendar — all driven by the same date range and timezone controls.

Appearance

Odus Checkout SDK lets you customize colors, fonts, button labels, field layout, and the set of supported payment methods through the appearance configuration option.

Authentication

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.

Automatic Fulfillment

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 and Resuming

Odus gives you two ways to cancel a subscription: immediately, or at the end of the current billing period. If you choose the end-of-period option, you can reverse it before the period ends by resuming the subscription.

Cancelling Orders

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.

Captures

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

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.

Checkout.com

Checkout.com is a cloud-based payment platform that enables businesses to accept payments globally through a unified API.

Configuration

Odus Checkout SDK is deeply customizable to fit your application's needs.

Configure a Payment Retry Policy

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.

Configuring Cascade Routing Rules

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.

Creating Subscriptions

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.

Examples

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.

Export and Bulk Fulfill

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.

Gateway Profiles

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.

General

Learn how to integrate various payment gateways (e.g., Stripe, PayPal) with Odus to expand your payment processing options.

Getting Started

Learn how to integrate Odus Checkout SDK into your application. This guide walks you through the complete setup process with code examples in React.

Getting Started

This guide walks you through integrating Odus Elements into a React application — from installation to accepting your first payment.

Importing Orders

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

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.

Making Payments

Learn how to create payments for usage with Checkout SDK or direct API calls.

Manage Team Members

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 — both in the Dashboard and via the API.

Managing Customers

A customer record in Odus represents a person or organization you charge. Each record holds contact information — name, email, phone number, and addresses — and links to that customer's payments, subscriptions, and saved payment methods. Creating a customer record lets you reuse it across multiple transactions instead of entering the same details each time.

Merchant Configuration

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.

Migration to Checkout V1 (iFrame fields)

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.

Offers

An offer maps a price from your product catalog to the physical goods that ship when that price is purchased. Offers are the entry point of Order Management System: only payments that contain at least one offer-mapped price create orders.

PayPal

PayPal is a widely used digital payments platform that allows businesses to accept PayPal payments, including PayPal Checkout and Pay Later options.

Publishable Key

Publishable keys are non-sensitive API keys that can be safely used in the client-side code and public environments. You will need a publishable key to initialize the Odus Checkout SDK in your frontend application. All publishable keys start with the prefix pk_ followed by a unique identifier.

Refunds and Voids

Use the POST /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.

Request Logs

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.

Restrictions

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.

Setting Up

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.

Setting up Webhooks

Learn how to configure Odus to receive webhook notifications from Checkout.com.

Stripe

Stripe is a global payments platform that provides APIs and tools for businesses to accept and manage online payments.

Testing resources

This guide covers everything you need to test your Odus integration in sandbox before going live: test card numbers, example webhook payloads.

Theming

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.

Updating plans

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.

Viewing and Managing Orders

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.

Webhook Subscriber

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.

Webhooks

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.

Working with Saved Payment Methods

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.