Skip to main content
POST
Create a hosted checkout session

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
market
string
required

Market code (e.g. MW for Malawi)

Example:

"MW"

amount
number
required

Amount in minor currency units (e.g. MWK tambala)

Example:

5000

currency
string
required
Example:

"MWK"

reference
string
required

Integrator reconciliation reference

Example:

"INV-2026-001"

success_url
string
required
Example:

"https://shop.example.com/checkout/success"

description
string

Human-readable description shown on checkout page

Example:

"Payment for Order #123"

metadata
object

Arbitrary metadata forwarded to the bound collection

Example:
cancel_url
string
Example:

"https://shop.example.com/checkout/cancel"

logo_url
string

HTTPS URL to the integrator logo shown on the checkout page

Example:

"https://cdn.example.com/logo.png"

primary_color
string

Hex color override for the checkout card primary accent (e.g. #FF5733)

Example:

"#FF5733"

Response

session_id
string
required
Example:

"e3d4b5c6-..."

integrator_id
string
required
Example:

"f1a2b3c4-..."

market
string
required
Example:

"MW"

amount
number
required
Example:

5000

currency
string
required
Example:

"MWK"

reference
string
required
Example:

"INV-2026-001"

success_url
string
required
Example:

"https://shop.example.com/checkout/success"

session_token
string
required

Opaque checkout session token (64 hex chars)

Example:

"a1b2c3d4e5f6..."

checkout_url
string
required
Example:

"https://checkout.eqx.io/a1b2c3d4e5f6..."

status
string
required

active | collection_bound | expired | cancelled

Example:

"active"

created_at
string<date-time>
required
updated_at
string<date-time>
required
expires_at
string<date-time>
required
description
object | null
Example:

"Payment for Order #123"

metadata
object | null
Example:
cancel_url
object | null
Example:

"https://shop.example.com/checkout/cancel"

merchant_name
object | null

Snapshotted from partner account display name at session creation

Example:

"Acme Corp"

logo_url
object | null
Example:

"https://cdn.example.com/logo.png"

primary_color
object | null
Example:

"#FF5733"

market_name
object | null
Example:

"Malawi"

collection_id
object | null
Example:

null