Checkout

Checkout gets you paid without building a payment page. Your server describes the purchase, and Ionic hosts the payment page: the card form, Apple Pay, and decline handling that lets the buyer try another card. Card details stay off your servers, and one webhook tells you when to fulfill. Hosted Checkout, embedded checkout, and payment links run the same hosted payment page, and each creates a checkout session.

Hosted Checkout

Create a session from your server and redirect the buyer to its URL.

Embedded checkout

Create the session in embedded mode and mount it inside your page, so buyers stay on your site.

Payment links

Publish a reusable URL that opens a fresh checkout for every buyer.

When to use Checkout

Situation	Use
Your app has a cart, order, or plan, and a redirect is acceptable	Hosted Checkout
Buyers should complete the purchase without leaving your website	Embedded checkout
A sales team, QR code, or campaign shares the same offer many times	Payment links
Your platform takes a payment for a connected account	Hosted checkout for connected accounts
You design the payment form and own the Pay button	Ionic Blocks
The buyer presents a card at the counter	In-person payments

Start with Hosted Checkout. It is the smallest integration, and embedded checkout uses the same session fields, webhooks, and fulfillment when you want buyers to stay on your site.

What you can do

Capability	How it works
One-time payments	Create a session with `mode: "payment"` from inline line items or catalog prices.
Subscription signup	Create a session with `mode: "subscription"` from recurring catalog prices. Checkout collects the first payment and activates the subscription.
Add-ons and quantities	`optional_items` offers add-ons, and `adjustable_quantity` lets the buyer change a line item’s count.
Buyer details	`collect_config` requires contact, billing, or shipping fields. Payment links also accept `custom_fields`.
Apple Pay	Offered on the hosted page and on payment links once Apple Pay is enabled on your account.
Google Pay	Offered on the hosted page and on payment links for one-time payments.
Known customers	Pass `customer` to link the session to an existing customer record.
Fulfillment	A verified `checkout.session.completed` event tells your server the payment completed.

Start here

Quickstart

Create a hosted checkout session and complete a test payment.

Accept a payment with Hosted Checkout

Create a session, redirect the buyer, and fulfill from the webhook.

Availability

Apple Pay is enabled per account. Hosted Checkout and payment links show it with no domain setup. Embedded checkout shows it after you register your domain and serve Apple’s association file. See Apple Pay.
Google Pay appears on Hosted Checkout and payment links for one-time payments, with no domain setup. Google Pay requires payment processing that supports it; ask Ionic support to confirm it for your account. See Google Pay.
Subscription mode uses recurring catalog prices that share one currency and billing cadence.
Payment links use catalog prices. Create the products and prices first.
To save a card without a purchase, use a SetupIntent with Ionic Blocks.

Guides

Guide	Use it to
Quickstart	Complete one hosted checkout payment end to end.
Accept a payment with Hosted Checkout	Create sessions, redirect buyers, and fulfill orders.
Embedded checkout	Register your domain and mount checkout on your page.
Payment links	Create, update, activate, and deactivate reusable links.
Apple Pay	Offer Apple Pay on each checkout surface.
Google Pay	Offer Google Pay on hosted checkout and payment links.
Catalog	Create the products and prices that checkout and links reference.
Test cards	Simulate approvals and declines in test mode.

Server code uses @ionicfi/sdk. Embedded checkout mounts with @ionicfi/js or the React <CheckoutEmbed> component.

API reference

Resource	Endpoints
Checkout sessions	Create, list, retrieve, confirm, adjust a line item quantity, select an optional item, deselect an optional item
Payment links	Create, list, retrieve, update, deactivate, activate
Products and prices	Create a product, create a price, and the rest of the catalog endpoints
Web domains	Add, list, delete, register for Apple Pay

Ionic sends checkout.session.created, checkout.session.completed, and checkout.session.expired. See their payloads in the event catalog.

Payments

Manage payments

Hosted Checkout

Embedded checkout

Payment links

When to use Checkout

What you can do

Start here

Quickstart

Accept a payment with Hosted Checkout

Availability

Guides

API reference

Hosted Checkout

Embedded checkout

Payment links

​When to use Checkout

​What you can do

​Start here

Quickstart

Accept a payment with Hosted Checkout

​Availability

​Guides

​API reference

When to use Checkout

What you can do

Start here

Availability

Guides

API reference