Reporting

Get Settlement Reports

Lists the settlement reports generated for your account within a date range. One report covers one reporting period, for one currency, at one frequency — so a merchant with daily and monthly reports enabled receives both, and the same settlements appear in each.

Reports are returned for the currency tied to the app-id you authenticate with. Each entry carries file_url, a pre-signed link to the CSV: fetch it with a plain GET and no authentication headers.

from_date and to_date are matched against when the report was generated, not the period it covers. A daily report generated on 7 September covers 6–7 September, so widen the range by one period if you are looking for a specific window.

Results are ordered by generation time descending and are paginated with a cursor, in either direction: pass next_cursor back as cursor to move forward, or previous_cursor back as previous_cursor to move backward.

GET

reports

settlements

Get Settlement Reports

curl --request GET \
  --url https://sandbox-api.lightningpay.me/api/v2/reports/settlements \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://sandbox-api.lightningpay.me/api/v2/reports/settlements"

headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>"
}

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

print(response.text)

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

fetch('https://sandbox-api.lightningpay.me/api/v2/reports/settlements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.lightningpay.me/api/v2/reports/settlements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "app-id: <api-key>",
    "secret-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.lightningpay.me/api/v2/reports/settlements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.lightningpay.me/api/v2/reports/settlements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "from_date": "2026-09-01T00:00:00Z",
  "to_date": "2026-09-30T00:00:00Z",
  "size": 20,
  "next_cursor": "MjAyNi0wOS0wMVQwOTowMDowOS4wMDAwMDArMDA6MDB8NDc5NQ==",
  "previous_cursor": null,
  "has_more": true,
  "has_previous": false,
  "records": [
    {
      "id": "rpt_8KmRvXq3N2dL",
      "file_name": "Daily Report (AUD) (Sep 06, 2026 - Sep 07, 2026).csv",
      "file_url": "https://cdn-private.helloclever.co/hellocleverweb-prod/clever/sections/report/9f3c1ab2-5d84-4c11-b0a7-2e6f8c4d1b90?sv=2021-08-06&se=2026-09-07T09%3A03%3A00Z&sr=b&sp=r&sig=...",
      "file_url_expires_at": "2026-09-07T09:03:00.000+0000",
      "format": "csv",
      "report_frequency": "daily",
      "currency": "AUD",
      "period_start": "2026-09-06T09:00:00.000+1000",
      "period_end": "2026-09-07T09:00:00.000+1000",
      "generated_at": "2026-09-07T09:00:14.000+0000",
      "summary": {
        "currency": "AUD",
        "settlement_count": 3,
        "settled_amount": 4205,
        "settled_fee": 2.34,
        "closing_balance": 12980.55,
        "closing_balance_at": "2026-09-07T08:47:33.000+10:00"
      }
    },
    {
      "id": "rpt_2QbYtF7hJ9wS",
      "file_name": "Monthly Report (AUD) (Aug 01, 2026 - Sep 01, 2026).csv",
      "file_url": "https://cdn-private.helloclever.co/hellocleverweb-prod/clever/sections/report/2b74de90-1c35-4f88-9a6d-77f1e0c5a413?sv=2021-08-06&se=2026-09-07T09%3A03%3A00Z&sr=b&sp=r&sig=...",
      "file_url_expires_at": "2026-09-07T09:03:00.000+0000",
      "format": "csv",
      "report_frequency": "monthly",
      "currency": "AUD",
      "period_start": "2026-08-01T09:00:00.000+1000",
      "period_end": "2026-09-01T09:00:00.000+1000",
      "generated_at": "2026-09-01T09:00:09.000+0000",
      "summary": {
        "currency": "AUD",
        "settlement_count": 12,
        "settled_amount": 31877.4,
        "settled_fee": 18.62,
        "closing_balance": 9410.2,
        "closing_balance_at": "2026-09-01T08:52:11.000+10:00"
      }
    }
  ]
}

{
  "errors": {
    "code": "INVALID_DATE_RANGE",
    "message": "The requested date range must not exceed 90 days"
  }
}

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

{
  "errors": {
    "code": "UNPROCESSABLE_ENTITY",
    "message": "from_date is required"
  }
}

Authorizations

app-id

string

header

required

A unique identifier assigned to each application.

secret-key

string

header

required

A secure token associated with the app-id.

Query Parameters

from_date

string<date-time>

required

Start of the range, in the format 'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone. Matched against the time the report was generated.

to_date

string<date-time>

required

End of the range, in the format 'YYYY-MM-DDThh:mm:ssZ'. Defaults to UTC timezone. The range must not exceed 90 days.

report_frequency

enum<string>

Return only reports generated at this frequency. Accepts a comma-separated list, for example daily,weekly. Omit to return every frequency enabled on your account.

Available options:

daily,

weekly,

monthly

cursor

string

Page forward. Pass the next_cursor from the previous response to fetch the entries after that page. Omit both cursors to fetch the first page. Cannot be combined with previous_cursor.

previous_cursor

string

Page backward. Pass the previous_cursor from a response to fetch the entries before that page. Cannot be combined with cursor.

size

integer

default:20

Number of report entries to return per page. A pre-signed link is minted for every entry returned, so request only the page size you intend to fetch.

Required range: x <= 100

Response

from_date

string

Example:

"2026-09-01T00:00:00Z"

to_date

string

Example:

"2026-09-30T00:00:00Z"

size

integer

Number of report entries returned per page.

Example:

20

next_cursor

string | null

Cursor to pass as the cursor query parameter to fetch the next page. null when there are no more entries after this page.

Example:

"MjAyNi0wOS0wMVQwOTowMDowOS4wMDAwMDArMDA6MDB8NDc5NQ=="

previous_cursor

string | null

Cursor to pass as the previous_cursor query parameter to fetch the preceding page. null on the first page.

Example:

"MjAyNi0wOS0wN1QwOTowMDoxNC4wMDAwMDArMDA6MDB8NDgyMQ=="

has_more

boolean

Whether more entries are available after this page.

Example:

true

has_previous

boolean

Whether entries are available before this page. Always false on the first page.

Example:

false

records

object[]

Show child attributes

Get Settlement Reports

curl --request GET \
  --url https://sandbox-api.lightningpay.me/api/v2/reports/settlements \
  --header 'app-id: <api-key>' \
  --header 'secret-key: <api-key>'

import requests

url = "https://sandbox-api.lightningpay.me/api/v2/reports/settlements"

headers = {
    "app-id": "<api-key>",
    "secret-key": "<api-key>"
}

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

print(response.text)

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

fetch('https://sandbox-api.lightningpay.me/api/v2/reports/settlements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.lightningpay.me/api/v2/reports/settlements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "app-id: <api-key>",
    "secret-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.lightningpay.me/api/v2/reports/settlements"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("app-id", "<api-key>")
	req.Header.Add("secret-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.lightningpay.me/api/v2/reports/settlements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["app-id"] = '<api-key>'
request["secret-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "from_date": "2026-09-01T00:00:00Z",
  "to_date": "2026-09-30T00:00:00Z",
  "size": 20,
  "next_cursor": "MjAyNi0wOS0wMVQwOTowMDowOS4wMDAwMDArMDA6MDB8NDc5NQ==",
  "previous_cursor": null,
  "has_more": true,
  "has_previous": false,
  "records": [
    {
      "id": "rpt_8KmRvXq3N2dL",
      "file_name": "Daily Report (AUD) (Sep 06, 2026 - Sep 07, 2026).csv",
      "file_url": "https://cdn-private.helloclever.co/hellocleverweb-prod/clever/sections/report/9f3c1ab2-5d84-4c11-b0a7-2e6f8c4d1b90?sv=2021-08-06&se=2026-09-07T09%3A03%3A00Z&sr=b&sp=r&sig=...",
      "file_url_expires_at": "2026-09-07T09:03:00.000+0000",
      "format": "csv",
      "report_frequency": "daily",
      "currency": "AUD",
      "period_start": "2026-09-06T09:00:00.000+1000",
      "period_end": "2026-09-07T09:00:00.000+1000",
      "generated_at": "2026-09-07T09:00:14.000+0000",
      "summary": {
        "currency": "AUD",
        "settlement_count": 3,
        "settled_amount": 4205,
        "settled_fee": 2.34,
        "closing_balance": 12980.55,
        "closing_balance_at": "2026-09-07T08:47:33.000+10:00"
      }
    },
    {
      "id": "rpt_2QbYtF7hJ9wS",
      "file_name": "Monthly Report (AUD) (Aug 01, 2026 - Sep 01, 2026).csv",
      "file_url": "https://cdn-private.helloclever.co/hellocleverweb-prod/clever/sections/report/2b74de90-1c35-4f88-9a6d-77f1e0c5a413?sv=2021-08-06&se=2026-09-07T09%3A03%3A00Z&sr=b&sp=r&sig=...",
      "file_url_expires_at": "2026-09-07T09:03:00.000+0000",
      "format": "csv",
      "report_frequency": "monthly",
      "currency": "AUD",
      "period_start": "2026-08-01T09:00:00.000+1000",
      "period_end": "2026-09-01T09:00:00.000+1000",
      "generated_at": "2026-09-01T09:00:09.000+0000",
      "summary": {
        "currency": "AUD",
        "settlement_count": 12,
        "settled_amount": 31877.4,
        "settled_fee": 18.62,
        "closing_balance": 9410.2,
        "closing_balance_at": "2026-09-01T08:52:11.000+10:00"
      }
    }
  ]
}

{
  "errors": {
    "code": "INVALID_DATE_RANGE",
    "message": "The requested date range must not exceed 90 days"
  }
}

{
  "errors": {
    "code": "REQUIRE_LOGIN",
    "message": "Not Authorised"
  }
}

{
  "errors": {
    "code": "UNPROCESSABLE_ENTITY",
    "message": "from_date is required"
  }
}

Basics

Payment APIs

Card API

Cashback API

Reporting API

Get Settlement Reports

Authorizations

Query Parameters

Response