Create a checkout session
Creates one payment journey on a checkout and returns the checkoutUrl to send the payer to. SHOPPING pays for a basket into the merchant’s settlement account; TOP_UP pays into an APPROVED payee. Returns 201 for a new session, or 200 with the original session when idempotencyKey was already used on this account. Returns 400 if the payee is not APPROVED or the currency does not match the checkout, and 404 if the checkout or payee is not on the account. Nothing is created when validation fails.
Authorizations
Query Parameters
The ID of the account to work with.
"F50091"
Body
Body
- Option 1
- Option 2
SHOPPING The checkout to take the session on. Its configured type must match type.
36"6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12"
Caller-supplied key that makes creation safe to retry: a repeat with the same key on the same account returns the original checkout session instead of creating a second one. Use one key per payment journey.
1 - 255"3f9a1c2e-7b4d-4e8a-9c6f-0d2b5a8e1f47"
The merchant's own reference for this checkout session, such as its order or basket ID. Shown to the merchant, never to the payer's bank.
1 - 128"ORDER-10421"
The total the payer pays, including any shipping. Must be in the checkout's currency.
What the payment is for, as shown to the payer.
1 - 140"Order ORDER-10421"
Where the payer is sent once the session ends. Defaults to the checkout's return URL.
2048"https://shop.example.com/checkout/complete"
BCP 47 language tag for the payer-facing checkout. Matches the locale set held against a person and account in CIS, so a value forwarded from Equals Money always validates. A locale Roqqett has no translations for yet renders in en-GB.
^[a-zA-Z]{2,3}(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|\d{3}))?$"en-GB"
When the session expires if not paid. Must be in the future and within the checkout's maximum expiry window, which is also the default.
"2026-10-02T13:00:00Z"
Response
OK
The ID of a checkout session: one payment journey.
36"0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"
SHOPPING pays for a basket into the merchant's settlement account. TOP_UP pays into a payee the merchant supplies.
SHOPPING, TOP_UP "SHOPPING"
OPEN until the payer authorises at their bank, PROCESSING while the payment settles, then exactly one terminal status.
OPEN, PROCESSING, COMPLETED, CANCELLED, ABANDONED, EXPIRED "OPEN"
The ID of a checkout: the configured payment page a checkout session is taken on.
36"6f1c2d0e-7a4b-4e2f-9c1d-3b5a7e9f0a12"
The merchant's own reference for this checkout session, such as its order or basket ID. Shown to the merchant, never to the payer's bank.
1 - 128"ORDER-10421"
What the payment is for, as shown to the payer.
140"Order ORDER-10421"
The total the payer pays, including any shipping.
The payee a TOP_UP session pays into. null for SHOPPING.
36"d2a7c9e1-5b3f-4a8d-9e6c-1f0b2a4c8e57"
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.
^[a-zA-Z]{2,3}(-[a-zA-Z]{4})?(-([a-zA-Z]{2}|\d{3}))?$"en-GB"
Where to send the payer to pay. Valid until expiresAt.
2048"https://pay.roqqett.com/ch/pay/s/0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"
Where the payer is sent once the session ends.
2048"https://shop.example.com/checkout/complete"
The payment, once the payer has authorised one.
36"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"
The order a completed SHOPPING session produced. Always null for TOP_UP.
36"7e2b9d4a-6c1f-4a5e-8b3d-2f9c0a1e6b78"
When an OPEN session expires.
"2026-10-02T13:00:00Z"
The date the Resource was initially created. ISO 8601 format without milliseconds.
The date the Resource was last modified. ISO 8601 format without milliseconds.