The ID of a checkout session: one payment journey.
Maximum string length: 36
Example:
"0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"
Query Parameters
accountId
string
required
The ID of the account to work with.
Example:
"F50091"
Response
OK
id
string<uuid>
required
The ID of a checkout session: one payment journey.
Maximum string length: 36
Example:
"0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"
status
enum<string>
required
OPEN until the payer authorises at their bank, PROCESSING while the payment settles, then exactly one terminal status.
Available options:
OPEN,
PROCESSING,
COMPLETED,
CANCELLED,
ABANDONED,
EXPIRED
Example:
"OPEN"
amount
object
required
The total the payer pays, including any shipping.
Show child attributes
locale
string | null
required
The locale the checkout is presented in. null when neither the request nor the checkout set one, in which case the payer's browser preference decides and en-GB is the final fallback.