Checkout Integration Guide

Version : 1.0
Released : 2026/01/01

Introduction


This guide explains how to integrate the payment API into your application. It covers authentication, request flow, transaction handling, and callbacks.

General Information


The Checkout service provides a quick and convenient way to build a secure payment page. It enables merchants to collect payment details, submit transactions, and send them for processing seamlessly.

To use the Checkout service on a website, an integration process is required. This integration offers a set of APIs that allow businesses to customize and control their payment processing workflows. These APIs support payment acquisition (purchases) through defined interactions between the merchant’s website and the payment system and also the refund requests from the authorized merchants for their transactions.

All API requests must be sent in JSON format, and responses are also returned as JSON data.

Process Flow


The diagram below illustrates how a payment is initiated, processed, and completed through the Checkout system.

Customer places an order and starts the payment process
Website validates the order and sends payment details, order info, and hash to the Checkout system
Checkout system verifies the request and returns a secure redirect URL
Customer is redirected to the Checkout payment page
Customer selects a payment method, enters payment details, and confirms the transaction
Payment is processed by the Payment Gateway
Payment Gateway sends a callback with the transaction result
Payment result is displayed to the customer
Transaction may be declined if invalid data is detected

Authentication


All API requests require Bearer token authentication. Tokens are issued privately and must be kept secure.

Authorization: Bearer YOUR_API_TOKEN

Payment Flow


A payment request is submitted to the API. Depending on the card and issuer, the transaction may complete immediately or require additional customer verification.

2DS and 3DS Transactions


2DS transactions complete instantly. 3DS transactions require redirecting the customer to an authentication page.

Callbacks


Transaction results are sent asynchronously to the callback URL provided during the payment request. Transaction results are sent asynchronously to the callback URL provided during the payment request.

Environments


Sandbox and production environments are available. Use sandbox credentials for testing and validation.

Secure payment processing APIs for seamless checkout and refunds. API Version: v1
© 2026 Cruisepay. All rights reserved.