Skip to main content
GET
Bootstrap a checkout (Kalixo.js)

Authorizations

Authorization
string
header
required

Publishable key, kc_pk_test_... or kc_pk_live_.... Safe for browsers.

Headers

Kalixo-Client-Secret
string
required

The checkout session's client_secret.

Path Parameters

id
string
required

Response

Client view of the checkout session.

id
string
required
status
enum<string>
required
Available options:
open,
complete,
expired
payment_status
enum<string>
required
Available options:
requires_payment_method,
processing,
requires_action,
authorized,
partially_captured,
captured,
partially_refunded,
refunded,
canceled,
expired,
disputed,
charged_back
amount
integer<int64>
required

Amount in the currency's minor unit.

Required range: x >= 0
currency
string
required

ISO 4217 currency code, uppercase.

Pattern: ^[A-Z]{3}$
Example:

"EUR"

country
string
required

ISO 3166-1 alpha-2 country code of the shopper.

Pattern: ^[A-Z]{2}$
Example:

"NL"

locale
string
required
renderer
object
required
description
string | null
partner_name
string
store_payment_method
boolean
return_url
string<uri>
terms_url
string<uri>
theme
object