Update a checkout session

PATCH

https://api.lite.sa

checkout-sessions

{session_id}

Update a checkout session

curl --request PATCH \
  --url https://api.lite.sa/checkout-sessions/{session_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "redirect_urls": {
    "success": "https://example.com/success",
    "failure": "https://example.com/failure"
  },
  "three_ds_required": false,
  "processing_type": "REGULAR",
  "customer": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+966555123456"
  },
  "metadata": {
    "session_type": "standard"
  },
  "payment_methods": [
    "card"
  ]
}
'

import requests

url = "https://api.lite.sa/checkout-sessions/{session_id}"

payload = {
    "redirect_urls": {
        "success": "https://example.com/success",
        "failure": "https://example.com/failure"
    },
    "three_ds_required": False,
    "processing_type": "REGULAR",
    "customer": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+966555123456"
    },
    "metadata": { "session_type": "standard" },
    "payment_methods": ["card"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    redirect_urls: {success: 'https://example.com/success', failure: 'https://example.com/failure'},
    three_ds_required: false,
    processing_type: 'REGULAR',
    customer: {name: 'John Doe', email: 'john@example.com', phone: '+966555123456'},
    metadata: {session_type: 'standard'},
    payment_methods: ['card']
  })
};

fetch('https://api.lite.sa/checkout-sessions/{session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    redirect_urls: {success: 'https://example.com/success', failure: 'https://example.com/failure'},
    three_ds_required: false,
    processing_type: 'REGULAR',
    customer: {name: 'John Doe', email: 'john@example.com', phone: '+966555123456'},
    metadata: {session_type: 'standard'},
    payment_methods: ['card']
  })
};

fetch('https://api.lite.sa/checkout-sessions/{session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lite.sa/checkout-sessions/{session_id}"

	payload := strings.NewReader("{\n  \"redirect_urls\": {\n    \"success\": \"https://example.com/success\",\n    \"failure\": \"https://example.com/failure\"\n  },\n  \"three_ds_required\": false,\n  \"processing_type\": \"REGULAR\",\n  \"customer\": {\n    \"name\": \"John Doe\",\n    \"email\": \"john@example.com\",\n    \"phone\": \"+966555123456\"\n  },\n  \"metadata\": {\n    \"session_type\": \"standard\"\n  },\n  \"payment_methods\": [\n    \"card\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lite.sa/checkout-sessions/{session_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'redirect_urls' => [
        'success' => 'https://example.com/success',
        'failure' => 'https://example.com/failure'
    ],
    'three_ds_required' => false,
    'processing_type' => 'REGULAR',
    'customer' => [
        'name' => 'John Doe',
        'email' => 'john@example.com',
        'phone' => '+966555123456'
    ],
    'metadata' => [
        'session_type' => 'standard'
    ],
    'payment_methods' => [
        'card'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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"
  },
  "order": {
    "reference": "ORD-123456",
    "items": {
      "products": [
        {
          "id": "prod_123",
          "price": 5000,
          "quantity": 2,
          "name": "T-Shirt",
          "metadata": {
            "color": "Blue",
            "size": "L"
          }
        }
      ],
      "vat": {
        "amount": 750
      },
      "shipping": {
        "amount": 1000
      }
    },
    "shipping_address": {
      "name": "John Doe",
      "email": "john@example.com",
      "street": "123 Main St",
      "city": "Riyadh",
      "state": "Riyadh Region",
      "zip": "12213",
      "country": "SA"
    },
    "billing_address": {
      "name": "John Doe",
      "email": "john@example.com",
      "street": "123 Main St",
      "city": "Riyadh",
      "state": "Riyadh Region",
      "zip": "12213",
      "country": "SA"
    },
    "amount": 10000,
    "currency": "SAR",
    "description": "Order description"
  },
  "channel_id": "550e8400-e29b-41d4-a716-446655440000",
  "terminal_id": "0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11"
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

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"

x-business-account-id

string<uuid>

The business account to act on, for platform use cases. When sent, that account is the merchant for the request: resources are created under it, reads and 404 checks are scoped to it, and per-merchant uniqueness (such as merchant_reference_id) applies within it. The API key's own account is recorded as the account acting on its behalf. Omit it to act on the API key's own account.

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

Show child attributes

three_ds_required

boolean

deprecated

Deprecated and ignored. 3D Secure is enforced per channel; turn it on under Settings, Acceptance, Payment methods in the dashboard. Sending this field still succeeds and has no effect.

Example:

false

processing_type

Standard one-time payment

Allowed value: "REGULAR"

Example:

"REGULAR"

customer

object

Customer details to update

Show child attributes

metadata

object

Additional metadata

Example:

{ "session_type": "standard" }

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

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"

terminal_id

string<uuid>

read-only

Online terminal the session's payment is taken through. Present for business accounts only.

Example:

"0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11"

Update a checkout session

curl --request PATCH \
  --url https://api.lite.sa/checkout-sessions/{session_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "redirect_urls": {
    "success": "https://example.com/success",
    "failure": "https://example.com/failure"
  },
  "three_ds_required": false,
  "processing_type": "REGULAR",
  "customer": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+966555123456"
  },
  "metadata": {
    "session_type": "standard"
  },
  "payment_methods": [
    "card"
  ]
}
'

import requests

url = "https://api.lite.sa/checkout-sessions/{session_id}"

payload = {
    "redirect_urls": {
        "success": "https://example.com/success",
        "failure": "https://example.com/failure"
    },
    "three_ds_required": False,
    "processing_type": "REGULAR",
    "customer": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+966555123456"
    },
    "metadata": { "session_type": "standard" },
    "payment_methods": ["card"]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    redirect_urls: {success: 'https://example.com/success', failure: 'https://example.com/failure'},
    three_ds_required: false,
    processing_type: 'REGULAR',
    customer: {name: 'John Doe', email: 'john@example.com', phone: '+966555123456'},
    metadata: {session_type: 'standard'},
    payment_methods: ['card']
  })
};

fetch('https://api.lite.sa/checkout-sessions/{session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    redirect_urls: {success: 'https://example.com/success', failure: 'https://example.com/failure'},
    three_ds_required: false,
    processing_type: 'REGULAR',
    customer: {name: 'John Doe', email: 'john@example.com', phone: '+966555123456'},
    metadata: {session_type: 'standard'},
    payment_methods: ['card']
  })
};

fetch('https://api.lite.sa/checkout-sessions/{session_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lite.sa/checkout-sessions/{session_id}"

	payload := strings.NewReader("{\n  \"redirect_urls\": {\n    \"success\": \"https://example.com/success\",\n    \"failure\": \"https://example.com/failure\"\n  },\n  \"three_ds_required\": false,\n  \"processing_type\": \"REGULAR\",\n  \"customer\": {\n    \"name\": \"John Doe\",\n    \"email\": \"john@example.com\",\n    \"phone\": \"+966555123456\"\n  },\n  \"metadata\": {\n    \"session_type\": \"standard\"\n  },\n  \"payment_methods\": [\n    \"card\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lite.sa/checkout-sessions/{session_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'redirect_urls' => [
        'success' => 'https://example.com/success',
        'failure' => 'https://example.com/failure'
    ],
    'three_ds_required' => false,
    'processing_type' => 'REGULAR',
    'customer' => [
        'name' => 'John Doe',
        'email' => 'john@example.com',
        'phone' => '+966555123456'
    ],
    'metadata' => [
        'session_type' => 'standard'
    ],
    'payment_methods' => [
        'card'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "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"
  },
  "order": {
    "reference": "ORD-123456",
    "items": {
      "products": [
        {
          "id": "prod_123",
          "price": 5000,
          "quantity": 2,
          "name": "T-Shirt",
          "metadata": {
            "color": "Blue",
            "size": "L"
          }
        }
      ],
      "vat": {
        "amount": 750
      },
      "shipping": {
        "amount": 1000
      }
    },
    "shipping_address": {
      "name": "John Doe",
      "email": "john@example.com",
      "street": "123 Main St",
      "city": "Riyadh",
      "state": "Riyadh Region",
      "zip": "12213",
      "country": "SA"
    },
    "billing_address": {
      "name": "John Doe",
      "email": "john@example.com",
      "street": "123 Main St",
      "city": "Riyadh",
      "state": "Riyadh Region",
      "zip": "12213",
      "country": "SA"
    },
    "amount": 10000,
    "currency": "SAR",
    "description": "Order description"
  },
  "channel_id": "550e8400-e29b-41d4-a716-446655440000",
  "terminal_id": "0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11"
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlation_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Payment Acceptance

Tokenization

Account Settlement

Authorizations

Headers

Path Parameters

Body

Response