Get a single payment report

GET

https://api.lite.sa

payments

reports

{report_id}

Get a single payment report

curl --request GET \
  --url https://api.lite.sa/payments/reports/{report_id} \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.lite.sa/payments/reports/{report_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/payments/reports/{report_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/payments/reports/{report_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/payments/reports/{report_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": "3f1c0b2a-0e5d-4a1b-9c2f-6a7b8c9d0e1f",
  "status": "COMPLETED",
  "format": "CSV",
  "filters": {
    "to_date": "2023-11-07T05:31:56Z",
    "status": [
      "CREATED"
    ],
    "payment_method": [
      "CARD"
    ],
    "card_brand": [
      "MADA"
    ],
    "channel_type": "<string>",
    "channel_id": "<string>",
    "from_date": "2023-11-07T05:31:56Z",
    "amount_min": 1,
    "amount_max": 1,
    "customer_id": "<string>",
    "decline_reason": "<string>",
    "last_four": "<string>",
    "rrn": "<string>",
    "approval_code": "<string>"
  },
  "created_at": "2026-09-06T12:00:00.000Z",
  "row_count": 1284,
  "completed_at": "2026-09-06T12:03:11.000Z",
  "expires_at": "2026-12-05T12:03:11.000Z",
  "error_code": "MAX_ROWS_EXCEEDED",
  "error_message": "This report matched too many payments. Narrow your filters and try again."
}

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

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"

Path Parameters

report_id

string<uuid>

required

Unique identifier of the report (UUID v4)

Example:

"3f1c0b2a-0e5d-4a1b-9c2f-6a7b8c9d0e1f"

Response

The report

string<uuid>

required

Report identifier

Example:

"3f1c0b2a-0e5d-4a1b-9c2f-6a7b8c9d0e1f"

status

enum<string>

required

Derived status. A COMPLETED report whose retention window (expires_at) has passed reports as EXPIRED.

Available options:

QUEUED,

RUNNING,

COMPLETED,

FAILED,

EXPIRED

Example:

"COMPLETED"

format

enum<string>

required

Available options:

CSV,

XLSX

Example:

"CSV"

filters

object

required

The materialized filter set used for this report. The upper date bound is always concrete.

Show child attributes

created_at

string<date-time>

required

Example:

"2026-09-06T12:00:00.000Z"

row_count

integer

Exact row count. Present once the report is COMPLETED.

Example:

1284

completed_at

string<date-time>

Example:

"2026-09-06T12:03:11.000Z"

expires_at

string<date-time>

Informational retention boundary. Past this instant the report is EXPIRED.

Example:

"2026-12-05T12:03:11.000Z"

error_code

string

Stable failure code the caller can branch on. Present only when status is FAILED.

Example:

"MAX_ROWS_EXCEEDED"

error_message

string

Caller-safe failure message. Present only when status is FAILED.

Example:

"This report matched too many payments. Narrow your filters and try again."

Get a single payment report

curl --request GET \
  --url https://api.lite.sa/payments/reports/{report_id} \
  --header 'x-api-key: <api-key>'

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

fetch('https://api.lite.sa/payments/reports/{report_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/payments/reports/{report_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/payments/reports/{report_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/payments/reports/{report_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": "3f1c0b2a-0e5d-4a1b-9c2f-6a7b8c9d0e1f",
  "status": "COMPLETED",
  "format": "CSV",
  "filters": {
    "to_date": "2023-11-07T05:31:56Z",
    "status": [
      "CREATED"
    ],
    "payment_method": [
      "CARD"
    ],
    "card_brand": [
      "MADA"
    ],
    "channel_type": "<string>",
    "channel_id": "<string>",
    "from_date": "2023-11-07T05:31:56Z",
    "amount_min": 1,
    "amount_max": 1,
    "customer_id": "<string>",
    "decline_reason": "<string>",
    "last_four": "<string>",
    "rrn": "<string>",
    "approval_code": "<string>"
  },
  "created_at": "2026-09-06T12:00:00.000Z",
  "row_count": 1284,
  "completed_at": "2026-09-06T12:03:11.000Z",
  "expires_at": "2026-12-05T12:03:11.000Z",
  "error_code": "MAX_ROWS_EXCEEDED",
  "error_message": "This report matched too many payments. Narrow your filters and try again."
}

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

Payment Acceptance

Tokenization

Account Settlement

Authorizations

Headers

Path Parameters

Response