Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Path Parameters

orderId
string<uuid>
required

The ID of an order: the record of a completed shopping checkout session.

Maximum string length: 36
Example:

"7e2b9d4a-6c1f-4a5e-8b3d-2f9c0a1e6b78"

Query Parameters

accountId
string
required

The ID of the account to work with.

Example:

"F50091"

Response

OK

id
string<uuid>
required

The ID of an order: the record of a completed shopping checkout session.

Maximum string length: 36
Example:

"7e2b9d4a-6c1f-4a5e-8b3d-2f9c0a1e6b78"

checkoutSessionId
string<uuid>
required

The ID of a checkout session: one payment journey.

Maximum string length: 36
Example:

"0b8e5c3a-2f1d-4c6b-8a9e-7d4f2c1b0a93"

merchantReference
string
required

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.

Required string length: 1 - 128
Example:

"ORDER-10421"

amount
object
required

A money value: a decimal amount as a string plus an ISO-4217 currency code.

basket
object | null
required
shipping
object | null
required
paymentId
string<uuid>
required

The ID of a Roqqett payment or refund record.

Maximum string length: 36
Example:

"9c4e1a7b-3d2f-4b6a-8e5c-0f7d2a9b1c34"

createdAt
string<date-time>
required

The date the Resource was initially created. ISO 8601 format without milliseconds.