Get a checkout session

GET

https://api.lite.sa

checkout-sessions

{session_id}

Get a checkout session

curl --request GET \
  --url https://api.lite.sa/checkout-sessions/{session_id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

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: 'GET', headers: {'x-api-key': '<api-key>'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lite.sa/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/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": false,
  "processing_type": "REGULAR",
  "capture_mode": "INSTANT",
  "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": "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"
  },
  "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"
    }
  },
  "terminal_id": "0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11",
  "splits": [
    {
      "amount": 9000,
      "business_account_id": "019859f8-3149-7a55-8211-a8179675d269",
      "account_reference": "main"
    }
  ],
  "_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": {},
    "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"

Query Parameters

with_config

boolean

default:true

Whether to include checkout configuration and payment methods

Response

Checkout session details.

Full checkout session details

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

deprecated

Deprecated. Always false; the session no longer carries a 3D Secure preference. 3D Secure is enforced per channel.

Example:

false

processing_type

required

Standard one-time payment

Allowed value: "REGULAR"

Example:

"REGULAR"

capture_mode

required

Payment is captured immediately upon authorization

Allowed value: "INSTANT"

Example:

"INSTANT"

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

Show child attributes

customer

object

Customer details

Show child attributes

order

object

Order details

Show child attributes

metadata

object

Additional metadata

Example:

{ "session_type": "standard" }

payment_methods

object

Available payment methods for the checkout session

Show child attributes

checkout_config

object

Checkout page configuration

Show child attributes

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"

splits

object[]

read-only

Transaction-level split allocations set when the session was created, in minor units.

Show child attributes

_links

object

HATEOAS links for checkout session actions

Show child attributes

Get a checkout session

curl --request GET \
  --url https://api.lite.sa/checkout-sessions/{session_id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

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: 'GET', headers: {'x-api-key': '<api-key>'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lite.sa/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/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": false,
  "processing_type": "REGULAR",
  "capture_mode": "INSTANT",
  "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": "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"
  },
  "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"
    }
  },
  "terminal_id": "0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11",
  "splits": [
    {
      "amount": 9000,
      "business_account_id": "019859f8-3149-7a55-8211-a8179675d269",
      "account_reference": "main"
    }
  ],
  "_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": {},
    "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

Query Parameters

Response