Get transaction by external reference ID

GET

https://api.lite.sa/v1

settlement

transactions

external-reference

{external_reference_id}

Get transaction by external reference ID

curl --request GET \
  --url https://api.lite.sa/v1/settlement/transactions/external-reference/{external_reference_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.lite.sa/v1/settlement/transactions/external-reference/{external_reference_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.lite.sa/v1/settlement/transactions/external-reference/{external_reference_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/v1/settlement/transactions/external-reference/{external_reference_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/v1/settlement/transactions/external-reference/{external_reference_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/v1/settlement/transactions/external-reference/{external_reference_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": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "amount": 100000,
  "currency": "USD",
  "external_reference_id": "payment_123456789",
  "status": "ACTIVE",
  "is_settled": false,
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "settled_amount": 95000,
  "settlement_window_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "payment_transaction_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "operation": "capture",
  "fees": [
    {
      "fee_type": "PROCESSING",
      "amount": 5000
    }
  ],
  "hold_at": null,
  "refunded_at": null,
  "removed_at": null
}

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

{
  "errors": [
    {
      "category": "SETUP",
      "code": "FORBIDDEN",
      "message": "You do not have permission to perform this action.",
      "retriable": false
    }
  ],
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "errors": [
    {
      "category": "VALIDATION",
      "code": "ENTITY_NOT_FOUND",
      "message": "The entity was not found. Verify the entity ID in the dashboard.",
      "retriable": false
    }
  ],
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "errors": [
    {
      "category": "SYSTEM",
      "code": "INTERNAL_ERROR",
      "message": "An unexpected error occurred. Retry with backoff. lite.sa has been alerted.",
      "retriable": true
    }
  ],
  "request_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"

Path Parameters

external_reference_id

string

required

External reference ID of the transaction (operation ID)

Example:

"payment_123456789"

Response

Transaction details.

A settlement transaction record

string<uuid>

required

Unique transaction identifier

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

amount

integer

required

Transaction amount in minor units

Required range: x >= 0

Example:

100000

currency

string

required

Currency code (ISO 4217)

Required string length: 3

Pattern: ^[A-Z]{3}$

Example:

"USD"

external_reference_id

string

required

External reference ID - unique ID for the payment transaction or transfer from ledger

Example:

"payment_123456789"

status

required

Transaction counts towards its settlement window

Allowed value: "ACTIVE"

is_settled

boolean

required

Whether the transaction has been settled

Example:

false

created_at

string<date-time>

required

Creation timestamp

Example:

"2024-01-01T00:00:00.000Z"

updated_at

string<date-time>

required

Last update timestamp

Example:

"2024-01-01T00:00:00.000Z"

settled_amount

integer

Settled amount in minor units (calculated as total amount minus fees)

Required range: x >= 0

Example:

95000

settlement_window_id

string<uuid>

Settlement window ID assigned when associated to a window

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

payment_transaction_id

string

Payment transaction ID (for refunds, the parent payment transaction ID)

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

operation

enum<string> | null

Pricing operation that created the transaction

Available options:

authorize,

capture,

pay,

refund,

reversal_adjustment,

manual_adjustment,

null

Example:

"capture"

fees

object[]

Array of fee objects with fee type and amount in minor units

Show child attributes

hold_at

string<date-time> | null

When a refund transaction was placed on hold

Example:

null

refunded_at

string<date-time> | null

When a held refund completed

Example:

null

removed_at

string<date-time> | null

When the transaction was removed or cancelled

Example:

null

Get transaction by external reference ID

curl --request GET \
  --url https://api.lite.sa/v1/settlement/transactions/external-reference/{external_reference_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.lite.sa/v1/settlement/transactions/external-reference/{external_reference_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.lite.sa/v1/settlement/transactions/external-reference/{external_reference_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/v1/settlement/transactions/external-reference/{external_reference_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/v1/settlement/transactions/external-reference/{external_reference_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/v1/settlement/transactions/external-reference/{external_reference_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": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "amount": 100000,
  "currency": "USD",
  "external_reference_id": "payment_123456789",
  "status": "ACTIVE",
  "is_settled": false,
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "settled_amount": 95000,
  "settlement_window_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "payment_transaction_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "operation": "capture",
  "fees": [
    {
      "fee_type": "PROCESSING",
      "amount": 5000
    }
  ],
  "hold_at": null,
  "refunded_at": null,
  "removed_at": null
}

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

{
  "errors": [
    {
      "category": "SETUP",
      "code": "FORBIDDEN",
      "message": "You do not have permission to perform this action.",
      "retriable": false
    }
  ],
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "errors": [
    {
      "category": "VALIDATION",
      "code": "ENTITY_NOT_FOUND",
      "message": "The entity was not found. Verify the entity ID in the dashboard.",
      "retriable": false
    }
  ],
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "errors": [
    {
      "category": "SYSTEM",
      "code": "INTERNAL_ERROR",
      "message": "An unexpected error occurred. Retry with backoff. lite.sa has been alerted.",
      "retriable": true
    }
  ],
  "request_id": "550e8400-e29b-41d4-a716-446655440000"
}

Payment Acceptance

Tokenization

Account Settlement

Authorizations

Headers

Path Parameters

Response