CreateCheckoutSessionRequest - LiteCore API Reference

Request body for creating a new checkout session

customer

object

required

Customer details

Show child attributes

amount

integer

required

Payment amount in minor units (e.g. 10000 for 100.00 SAR)

Required range: x >= 1

Example:

10000

currency

string

required

Currency code (ISO 4217)

Example:

"SAR"

redirect_urls

object

required

Redirect URLs for checkout session

Show child attributes

order

object

required

Order details

Show child attributes

expiry

integer

Session expiry in seconds (default 3600)

Required range: 60 <= x <= 86400

Example:

1800

three_ds_required

boolean

Whether 3DS authentication is required

Example:

true

metadata

object

Additional metadata

Example:

{ "session_type": "standard" }

channel_id

string<uuid>

Channel ID for the session

Example:

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

CreatePaymentRequestCreatePaymentRequest data model

{
  "customer": {
    "id": "cust_a1b2c3d4e5f6",
    "email": "donald.duck@duckworld.com",
    "first_name": "Donald",
    "last_name": "Duck",
    "phone_country_code": "+966",
    "phone_number": "555123456"
  },
  "amount": 10000,
  "currency": "SAR",
  "redirect_urls": {
    "success": "https://example.com/success",
    "failure": "https://example.com/failure"
  },
  "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"
  },
  "expiry": 1800,
  "three_ds_required": true,
  "metadata": {
    "session_type": "standard"
  },
  "channel_id": "550e8400-e29b-41d4-a716-446655440000"
}