List settlement windows

GET

https://api.lite.sa/v1

settlement

settlement-windows

List settlement windows

curl --request GET \
  --url https://api.lite.sa/v1/settlement/settlement-windows \
  --header 'x-api-key: <api-key>'

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

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

	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/v1/settlement/settlement-windows",
  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;
}

{
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "merchant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "cycle_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "value_date": "2024-01-01T23:59:59.000Z",
      "status": "OPENED",
      "created_by": "system",
      "updated_by": "system",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z",
      "closing_date": "2024-01-02T00:00:00.000Z",
      "total_instructions": 5,
      "total_amount": 100000,
      "settled_amount": 95000,
      "currency": "USD"
    }
  ],
  "pagination_data": {
    "count": 100,
    "pages": 4,
    "page": 1,
    "page_size": 25,
    "has_next": true,
    "has_previous": false
  },
  "summary": {
    "opened": 500000,
    "in_progress": 1000000,
    "success": 5000000,
    "failed": 0,
    "partially_success": 250000,
    "total": 6750000,
    "by_currency": [
      {
        "currency": "USD",
        "opened": 500000,
        "in_progress": 1000000,
        "success": 5000000,
        "failed": 0,
        "partially_success": 250000,
        "total": 6750000
      }
    ]
  }
}

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

Query Parameters

page

integer

default:1

Page number (1-indexed)

Required range: x >= 1

page_size

integer

default:25

Number of items per page

Required range: 1 <= x <= 100

merchant_id

string

Filter by merchant ID

cycle_id

string<uuid>

Filter by cycle ID

status

enum<string>

Filter by settlement window status

Available options:

OPENED,

IN_PROGRESS,

SUCCESS,

FAILED,

PARTIALLY_SUCCESS

date_from

string<date-time>

Filter settlement windows with value date from this date (ISO 8601 format)

date_to

string<date-time>

Filter settlement windows with value date up to this date (ISO 8601 format)

Response

List of settlement windows retrieved successfully.

data

object[]

required

List of settlement windows

Show child attributes

pagination_data

object

required

Pagination metadata for list responses

Show child attributes

summary

object

required

Summary of settled amounts aggregated by settlement window status

Show child attributes

List settlement windows

curl --request GET \
  --url https://api.lite.sa/v1/settlement/settlement-windows \
  --header 'x-api-key: <api-key>'

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

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

	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/v1/settlement/settlement-windows",
  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;
}

{
  "data": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "merchant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "cycle_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "value_date": "2024-01-01T23:59:59.000Z",
      "status": "OPENED",
      "created_by": "system",
      "updated_by": "system",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z",
      "closing_date": "2024-01-02T00:00:00.000Z",
      "total_instructions": 5,
      "total_amount": 100000,
      "settled_amount": 95000,
      "currency": "USD"
    }
  ],
  "pagination_data": {
    "count": 100,
    "pages": 4,
    "page": 1,
    "page_size": 25,
    "has_next": true,
    "has_previous": false
  },
  "summary": {
    "opened": 500000,
    "in_progress": 1000000,
    "success": 5000000,
    "failed": 0,
    "partially_success": 250000,
    "total": 6750000,
    "by_currency": [
      {
        "currency": "USD",
        "opened": 500000,
        "in_progress": 1000000,
        "success": 5000000,
        "failed": 0,
        "partially_success": 250000,
        "total": 6750000
      }
    ]
  }
}

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

Query Parameters

Response