CheckoutSessionResponse

Response returned after creating or updating a checkout session

string<uuid>

required

Unique checkout session identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

session_id

string

required

deprecated

Deprecated alias of id. Use id instead.

Example:

"550e8400-e29b-41d4-a716-446655440000"

hosted_url

string<uri>

required

URL for the hosted checkout page

Example:

"https://checkout.lite.sa/ses_a1b2c3d4e5f6"

client_secret

string

required

Client secret for frontend SDK authentication

Example:

"cs_a1b2c3d4e5f6"

status

required

Session is active and awaiting payment

Allowed value: "Pending"

Example:

"Pending"

expires_on

string<date-time>

required

Session expiry timestamp

Example:

"2026-05-18T12:00:00.000Z"

order_id

string

required

Order reference

Example:

"ORD-123456"

amount

integer

required

Session amount in minor units

Example:

10000

currency

string

required

Currency code (ISO 4217)

Example:

"SAR"

customer

object

Customer details

Show child attributes

order

object

Order details

Show child attributes

channel_id

string

Channel ID for the session

Example:

"550e8400-e29b-41d4-a716-446655440000"

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "session_id": "550e8400-e29b-41d4-a716-446655440000",
  "hosted_url": "https://checkout.lite.sa/ses_a1b2c3d4e5f6",
  "client_secret": "cs_a1b2c3d4e5f6",
  "status": "Pending",
  "expires_on": "2026-05-18T12:00:00.000Z",
  "order_id": "ORD-123456",
  "amount": 10000,
  "currency": "SAR",
  "customer": {
    "id": "cust_a1b2c3d4e5f6",
    "email": "john.doe@email.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone_country_code": "+966",
    "phone_number": "555123456"
  },
  "channel_id": "550e8400-e29b-41d4-a716-446655440000"
}

Account Settlement

Payment Acceptance

Tokenization