Skip to main content
POST
Create a checkout session
See the Checkout Sessions guide for purchase inputs, idempotency, and payment status.

Authorizations

X-API-Key
string
header
required

Merchant API key (format: ak_BASE64)

Headers

Idempotency-Key
string
required

Unique creation request key: 1-255 ASCII characters in the range 0x21-0x7E (no spaces or control characters)

Required string length: 1 - 255

Body

application/json

Purchase and checkout configuration

cancelUrl
string
customerEmail
string

Optional customer email, at most 255 bytes. Mutually exclusive with customerId.

customerId
string

Optional existing customer ID. Omit both customer fields or provide only one.

expiresIn
integer
default:3600

Lifetime in seconds: 1800-86400 for card checkout, 60-86400 for cryptocurrency checkout.

merchantReference
string

Optional business correlation value, at most 255 bytes; not a uniqueness constraint.

metadata
object

At most 50 string pairs. Keys must contain 1-40 characters without [ or ]; values may contain at most 500 characters.

pricingData
object
pricingId
string
provider
enum<string>

Omit for card checkout; use CRYPTO for cryptocurrency checkout.

Available options:
STRIPE,
CRYPTO
quantity
integer
default:1
Required range: 1 <= x <= 999999
successUrl
string

Response

Created

data
object
error
object
message
string
success
boolean