Skip to main content
POST
Create or replay a crypto checkout session

Authorizations

X-API-Key
string
header
required

Business API key for server-to-server integrations. Key prefix determines the environment — no separate flag needed: test_sk_* = sandbox/testnet, live_sk_* = production/mainnet.

Headers

Idempotency-Key
string

Stable order-attempt key. Reuse after uncertainty; never generate a new key for the same retry.

Maximum string length: 180

Body

application/json
amount
required

Exact positive decimal amount. A decimal string avoids binary floating-point rounding.

Example:

"49.95000001"

currency
enum<string>
required
Available options:
USD,
USDT,
USDC
reference
string
required

Stable merchant order reference, scoped to business and API-key environment.

callback_url
string<uri>

Public HTTPS webhook override. Omit to use the configured merchant webhook URL. Never a browser redirect.

customer_email
string<email>
customer_name
string
description
string
embed_origin
string<uri>

Exact HTTPS origin allowed to embed this session; loopback HTTP is allowed only in test mode.

metadata
object
network
string

Optional asset-network code. Use the public session available_assets catalogue.

payment_method
enum<string>
default:crypto
Available options:
crypto
return_url
string<uri>

HTTPS browser destination after payment; never financial proof.

Response

Session created, or original session replayed.

amount_exact
string
required
Example:

"49.95000001"

currency
string
required
invoice_currency
string
required

Original invoice currency, retained after asset selection.

is_test_mode
boolean
required

Immutable API-key environment for this session.

reference
string
required
session_id
string<uuid>
required
status
enum<string>
required
Available options:
pending,
paid,
expired,
failed
amount
number

Legacy numeric display amount. Use amount_exact for accounting.

charged_amount_exact
string

Actual verified settled total; differs from requested amount_exact on overpayment.

deposit_address
string
embed_url
string<uri>
expires_at
string<date-time>
instructions
object
network
string
payment_method
enum<string>
Available options:
crypto
payment_url
string<uri>
qr_code
string
return_url
string<uri>