List payment links

GET

https://api.lite.sa

payment-links

List payment links

curl --request GET \
  --url https://api.lite.sa/payment-links \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.lite.sa/payment-links', 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/payment-links', 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/payment-links"

	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/payment-links",
  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;
}

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "publicToken": "plive_7c9f2a1b8e4d6035",
      "hostedUrl": "https://pay.lite.sa/pay/plive_7c9f2a1b8e4d6035",
      "merchantId": "7f3c8b21-0d4e-4a92-9f65-2b8e1c7a4d30",
      "mode": "SINGLE_USE",
      "status": "ACTIVE",
      "amount": 10000,
      "currency": "SAR",
      "usedCount": 2,
      "paidCount": 2,
      "failedCount": 1,
      "createdAt": "2026-06-01T10:30:00.000Z",
      "updatedAt": "2026-06-04T09:12:44.000Z",
      "merchantReferenceId": "order-2026-0042",
      "redirectUrls": {
        "success": "https://merchant.example.com/success",
        "failure": "https://merchant.example.com/failure"
      },
      "threeDsRequired": true,
      "description": "Invoice",
      "customer": {
        "id": "cus_8f1e2a4b",
        "firstName": "Sara",
        "lastName": "Al-Harbi",
        "email": "sara@example.com",
        "phoneCountryCode": "+966",
        "phoneNumber": "512345678",
        "billingAddress": {
          "line1": "123 High St.",
          "line2": "Apartment 5B",
          "city": "Riyadh",
          "state": "Riyadh Province",
          "postalCode": "11564",
          "country": "SA"
        }
      },
      "metadata": {
        "invoice_id": "INV-4471",
        "sales_rep": "rep_88"
      },
      "channelId": "3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13",
      "terminalId": "0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11",
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "maxUses": 1,
      "lastPaidAt": "2026-06-04T09:12:44.000Z"
    }
  ],
  "total": 42,
  "limit": 20,
  "offset": 0
}

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

Query Parameters

limit

integer

Page size

Required range: x >= 1

Example:

20

offset

integer

Number of links to skip

Required range: x >= 0

Example:

0

status

enum<string>

Return only links in this status Lifecycle status of the payment link.

ACTIVE — payable.
DISABLED — deactivated by the merchant. Reversible via the update endpoint.
EXPIRED — expires_at has passed. Applied automatically when the link is read or listed; not settable by the caller.
PAID — the usage ceiling has been reached, i.e. the SINGLE_USE link has been paid. Not settable by the caller.

Only ACTIVE ↔ DISABLED transitions are accepted on the update endpoint.

Available options:

ACTIVE,

DISABLED,

EXPIRED,

PAID

Example:

"ACTIVE"

mode

enum<string>

Return only links in this mode How many times the link may be paid.

SINGLE_USE — exactly one successful payment. The link is promoted to PAID as soon as a payment reaches a terminal successful status.

Available options:

SINGLE_USE

Example:

"SINGLE_USE"

Response

Payment links retrieved successfully.

A page of payment links, newest first

items

object[]

required

Payment links on this page, ordered by creation time descending

Show child attributes

total

integer

required

Total number of links matching the filters, across all pages

Example:

42

limit

integer

required

Page size that was applied

Example:

20

offset

integer

required

Offset that was applied

Example:

0

List payment links

curl --request GET \
  --url https://api.lite.sa/payment-links \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.lite.sa/payment-links', 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/payment-links', 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/payment-links"

	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/payment-links",
  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;
}

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "publicToken": "plive_7c9f2a1b8e4d6035",
      "hostedUrl": "https://pay.lite.sa/pay/plive_7c9f2a1b8e4d6035",
      "merchantId": "7f3c8b21-0d4e-4a92-9f65-2b8e1c7a4d30",
      "mode": "SINGLE_USE",
      "status": "ACTIVE",
      "amount": 10000,
      "currency": "SAR",
      "usedCount": 2,
      "paidCount": 2,
      "failedCount": 1,
      "createdAt": "2026-06-01T10:30:00.000Z",
      "updatedAt": "2026-06-04T09:12:44.000Z",
      "merchantReferenceId": "order-2026-0042",
      "redirectUrls": {
        "success": "https://merchant.example.com/success",
        "failure": "https://merchant.example.com/failure"
      },
      "threeDsRequired": true,
      "description": "Invoice",
      "customer": {
        "id": "cus_8f1e2a4b",
        "firstName": "Sara",
        "lastName": "Al-Harbi",
        "email": "sara@example.com",
        "phoneCountryCode": "+966",
        "phoneNumber": "512345678",
        "billingAddress": {
          "line1": "123 High St.",
          "line2": "Apartment 5B",
          "city": "Riyadh",
          "state": "Riyadh Province",
          "postalCode": "11564",
          "country": "SA"
        }
      },
      "metadata": {
        "invoice_id": "INV-4471",
        "sales_rep": "rep_88"
      },
      "channelId": "3d1f9c60-5a72-4e18-b0c4-9a6d2f5e7b13",
      "terminalId": "0b9d1c3e-6a51-4f6e-9a54-0f4f2b6e7d11",
      "expiresAt": "2026-12-31T23:59:59.000Z",
      "maxUses": 1,
      "lastPaidAt": "2026-06-04T09:12:44.000Z"
    }
  ],
  "total": 42,
  "limit": 20,
  "offset": 0
}

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

Query Parameters

Response