CheckoutSessionDetails

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

{
  "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"
  },
  "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": {}
}

Account Settlement

Payment Acceptance

Tokenization