Get a checkout session
Retrieves a checkout session with full details including available payment methods, checkout configuration, and HATEOAS action links.
curl --request GET \
--url https://api.lite.sa/v1/checkout/sessions/{session_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.lite.sa/v1/checkout/sessions/{session_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
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: 'GET', headers: {'x-api-key': '<api-key>'}};
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"
"net/http"
"io"
)
func main() {
url := "https://api.lite.sa/v1/checkout/sessions/{session_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
}
}Authorizations
API key for service-to-service or merchant authentication.
Headers
Unique identifier for request tracing. Generated by the client or server if not provided.
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
Unique identifier of the checkout session
"ses_a1b2c3d4e5f6"
Query Parameters
Whether to include checkout configuration and payment methods
Response
Checkout session details.
Full checkout session details
Unique checkout session identifier
"550e8400-e29b-41d4-a716-446655440000"
Session is active and awaiting payment
"Pending""Pending"
Session expiry timestamp
"2026-05-18T12:00:00.000Z"
Order reference
"ORD-123456"
Session amount in minor units
10000
Currency code (ISO 4217)
"SAR"
Whether 3DS authentication is required
true
Creation timestamp
"2026-05-17T12:00:00.000Z"
Last update timestamp
"2026-05-17T12:00:00.000Z"
Deprecated — use id instead
"ses_a1b2c3d4e5f6"
Redirect URLs for checkout session
Show child attributes
Show child attributes
Customer details
Show child attributes
Show child attributes
Order details
Show child attributes
Show child attributes
Additional metadata
{ "session_type": "standard" }Available payment methods for the checkout session
Show child attributes
Show child attributes
Checkout page configuration
Show child attributes
Show child attributes
HATEOAS links for checkout session actions
Show child attributes
Show child attributes
curl --request GET \
--url https://api.lite.sa/v1/checkout/sessions/{session_id} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.lite.sa/v1/checkout/sessions/{session_id}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
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: 'GET', headers: {'x-api-key': '<api-key>'}};
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"
"net/http"
"io"
)
func main() {
url := "https://api.lite.sa/v1/checkout/sessions/{session_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
}
}