Cruisepay API Documentation

Build secure checkout, status checks, and refunds with one clear API guide.

Start with the integration guide, review payment and refund endpoints, then test requests through the API interface with Bearer token authentication and JSON callbacks.

Start Guide API Interface

Payment Request POST

{
  "paymentMethod": "CARD",
  "amount": "66.00",
  "currency": "USD",
  "invoiceNumber": "abcd1234",
  "cardNumber": "4000000000000002",
  "expMonth": "05",
  "expYear": "30",
  "cvv": "123",
  "firstName": "Sherlock",
  "lastName": "Holmes",
  "email": "[email protected]",
  "phone": "9876543210",
  "address": "221B Baker Street",
  "city": "London",
  "state": "State",
  "zip": "NW16XE",
  "country": "UK",
}

Documentation Map

Choose the page you need

Each page focuses on a specific part of the payment lifecycle, from setup to callback handling.

Integration Guide

Authentication, checkout process flow, environments, and callback behavior.

Payments API

Create payment requests, inspect payload fields, and review callback responses.

Refunds API

Submit refund requests, validate refund rules, and handle refund result callbacks.

Support

Find common answers and next steps when integration or testing needs help.

Recommended Flow

Move from setup to live transaction handling.

The documentation is organized around the same path your integration follows: authenticate, create payments, receive callbacks, query status, and process refunds.

01 Authenticate

Send requests with a valid Bearer token.

02 Create Payment

Submit customer, card, amount, and callback details.

03 Handle Callback

Process success, declined, unauthorized, and 3DS responses.

04 Refund or Query

Check transaction status or initiate eligible refunds.

Secure payment processing APIs for seamless checkout and refunds. API Version: v1