Checkout Session

Checkout Session API enables merchants to easily integrate secure online checkout and payment into their systems, streamlining order processing and automatically updating payment status via webhooks.

The Checkout Session API provides a simple and secure way to initiate and manage a customer’s payment flow through our Payment Gateway.

A checkout session represents a single transaction attempt, encapsulating all the necessary details such as the products or services being purchased, their prices, customer information, payment methods, and any applicable taxes or discounts.

By creating a checkout session, merchants can quickly generate a hosted, PCI‑compliant payment page or an embeddable checkout interface. The customer is then redirected or presented with this interface to review their order and complete payment. Once the payment is processed, the Checkout Session API returns a status update and relevant transaction data, enabling seamless order fulfillment and reconciliation.

Typical Flow:

1. Create Checkout Session → Define items, amounts, currency, and customer data.

2. Obtain Checkout URL or Token → Redirect the customer or embed the payment widget in your app/site.

3. Customer Completes Payment → Via card, wallet, bank transfer, or other supported methods.

4. Receive Payment Result → Via API response or webhook for order processing.

Endpoints Overview

Action	Method	Description
Create Checkout Session	POST	Create a singple-pay or subscription checkout session with a product ID.

This guide provides instructions for utilizing the API in Test Mode. To transition to Live Mode, please refer to the following endpoint: https://live.bagelpay.io