Skip to main content
PATCH
Update a checkout session

Authorizations

x-api-key
string
header
required

API key for service-to-service or merchant authentication.

Headers

x-correlation-id
string<uuid>

Unique identifier for request tracing. Generated by the client or server if not provided.

Example:

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

Path Parameters

session_id
string<uuid>
required

Unique identifier of the checkout session

Example:

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

Body

application/json

Update an existing checkout session

Request body for updating a checkout session

redirect_urls
object

Redirect URLs for checkout session

three_ds_required
boolean

Whether 3DS authentication is required

Example:

true

processing_type

Standard one-time payment

Allowed value: "REGULAR"
Example:

"REGULAR"

customer
object

Customer details to update

metadata
object

Additional metadata

Example:
payment_methods
string[]

Allowed payment methods

Credit or debit card

Allowed value: "card"

Response

Checkout session updated.

Response returned after creating or updating a checkout session

id
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

order
object

Order details

channel_id
string

Channel ID for the session

Example:

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