Skip to main content
PATCH
https://api.lite.sa/v1
/
checkout
/
sessions
/
{session_id}
Update a checkout session
curl --request PATCH \
  --url https://api.lite.sa/v1/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": true,
  "customer": {
    "name": "John Doe",
    "email": "john@example.com",
    "phone": "+966555123456"
  },
  "metadata": {
    "session_type": "standard"
  },
  "payment_methods": [
    "<string>"
  ]
}
'
import requests

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

payload = {
    "redirect_urls": {
        "success": "https://example.com/success",
        "failure": "https://example.com/failure"
    },
    "three_ds_required": True,
    "customer": {
        "name": "John Doe",
        "email": "john@example.com",
        "phone": "+966555123456"
    },
    "metadata": { "session_type": "standard" },
    "payment_methods": ["<string>"]
}
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: true,
    customer: {name: 'John Doe', email: 'john@example.com', phone: '+966555123456'},
    metadata: {session_type: 'standard'},
    payment_methods: ['<string>']
  })
};

fetch('https://api.lite.sa/v1/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: true,
    customer: {name: 'John Doe', email: 'john@example.com', phone: '+966555123456'},
    metadata: {session_type: 'standard'},
    payment_methods: ['<string>']
  })
};

fetch('https://api.lite.sa/v1/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/v1/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\": true,\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    \"<string>\"\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/v1/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' => true,
    'customer' => [
        'name' => 'John Doe',
        'email' => 'john@example.com',
        'phone' => '+966555123456'
    ],
    'metadata' => [
        'session_type' => 'standard'
    ],
    'payment_methods' => [
        '<string>'
    ]
  ]),
  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",
  "status": "Pending",
  "expires_on": "2026-05-18T12:00:00.000Z",
  "order_id": "ORD-123456",
  "amount": 10000,
  "currency": "SAR",
  "three_ds_required": true,
  "created_at": "2026-05-17T12:00:00.000Z",
  "updated_at": "2026-05-17T12:00:00.000Z",
  "session_id": "ses_a1b2c3d4e5f6",
  "redirect_urls": {
    "success": "https://example.com/success",
    "failure": "https://example.com/failure"
  },
  "customer": {
    "id": "cust_a1b2c3d4e5f6",
    "email": "donald.duck@duckworld.com",
    "first_name": "Donald",
    "last_name": "Duck",
    "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"
  },
  "metadata": {
    "session_type": "standard"
  },
  "payment_methods": {
    "card": {
      "status": "ACTIVE",
      "config": {
        "public_key": "pk_live_a1b2c3d4e5f6",
        "payment_confirmation": "DELAYED",
        "networks": {
          "mada": true,
          "visa": true,
          "mastercard": true
        }
      },
      "stored_instruments": [
        {
          "id": "instr_a1b2c3d4e5f6",
          "payment_method": "card",
          "holder_type": "primary",
          "display": {
            "expiry_year": "27",
            "expiry_month": "12",
            "scheme": "mada",
            "last_4": "1111"
          }
        }
      ]
    },
    "apple_pay": {
      "status": "ACTIVE",
      "dependencies": {
        "merchant_identifier": "merchant.com.live",
        "service_id": "srv_a1b2c3d4e5f6"
      }
    },
    "google_pay": {
      "status": "ACTIVE",
      "dependencies": {
        "merchant_identifier": "merchant.com.live",
        "service_id": "srv_a1b2c3d4e5f6"
      }
    },
    "samsung_pay": {
      "status": "ACTIVE",
      "dependencies": {
        "merchant_identifier": "merchant.com.live",
        "service_id": "srv_a1b2c3d4e5f6"
      }
    }
  },
  "checkout_config": {
    "locale": "en",
    "redirect_urls": {
      "success": "https://example.com/success",
      "failure": "https://example.com/failure",
      "cancel": "https://example.com/cancel"
    },
    "theme": {
      "primaryColor": "#0056D2",
      "secondaryColor": "#0041A5",
      "backgroundColor": "#FFFFFF",
      "fontFamily": "Arial, sans-serif",
      "logoUrl": "https://example.com/logo.png"
    }
  },
  "_links": {
    "self": {
      "href": "<string>",
      "method": "POST"
    },
    "tokenize": {
      "href": "<string>",
      "method": "POST"
    },
    "authorize": {
      "href": "<string>",
      "method": "POST"
    },
    "start_payment_session": {
      "href": "<string>",
      "method": "POST"
    },
    "payment": {
      "href": "<string>",
      "method": "POST"
    }
  }
}
{
  "error": {
    "code": "PAYMENT_DETAILS_MISMATCH",
    "message": "The request was invalid or malformed",
    "timestamp": "2024-12-16T10:30:00.000Z",
    "details": {},
    "correlationId": "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": {},
    "correlationId": "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": {},
    "correlationId": "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": {},
    "correlationId": "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": {},
    "correlationId": "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"

Path Parameters

​
session_id
string
required

Unique identifier of the checkout session

Example:

"ses_a1b2c3d4e5f6"

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

​
customer
object

Customer details to update

​
metadata
object

Additional metadata

Example:
{ "session_type": "standard" }
​
payment_methods
string[]

Allowed payment methods

Credit or debit card

Allowed value: "card"

Response

Checkout session details.

Full checkout session details

​
id
string<uuid>
required

Unique checkout session identifier

Example:

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

​
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"

​
three_ds_required
boolean
required

Whether 3DS authentication is required

Example:

true

​
created_at
string<date-time>
required

Creation timestamp

Example:

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

​
updated_at
string<date-time>
required

Last update timestamp

Example:

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

​
session_id
string

Deprecated — use id instead

Example:

"ses_a1b2c3d4e5f6"

​
redirect_urls
object

Redirect URLs for checkout session

​
customer
object

Customer details

​
order
object

Order details

​
metadata
object

Additional metadata

Example:
{ "session_type": "standard" }
​
payment_methods
object

Available payment methods for the checkout session

​
checkout_config
object

Checkout page configuration

​
_links
object

HATEOAS links for checkout session actions