Hello Clever Developer Docs

The Hello Clever Reporting API exposes your settlement reports as read-only files. Where the payment APIs create and track individual transactions, the Reporting API answers the accounting question: what settled out of your Payments Account, when, in which currency, and against which fees. These are the same reports Hello Clever used to email you. The file, the figures, and the reporting frequencies are unchanged — the difference is that you now pull them when your reconciliation job runs, rather than receiving them at 09:00 in your account’s time zone. Today the API covers settlement reporting. Everything it returns matches what you see on the All Balances screen in the Merchant Portal, so the portal and your integration never disagree.

When to use the Reporting API

Merchant Portal

Use the Merchant Portal to review settlements visually, open a settlement record, and check its recipient and included transactions. No API calls required.

Reporting API

Use the Reporting API to pull settlement reports on a schedule, reconcile them against your ledger, or load them into your accounting system or data warehouse.

Base URLs

Environment	Base URL
Sandbox	`https://sandbox-api.lightningpay.me/api`
Production	`https://api.lightningpay.me/api`

Authentication

The Reporting API uses app-id and secret-key as HTTP headers, the same credentials as the rest of the Hello Clever API suite. Reports are returned for the currency tied to the app-id you authenticate with.

curl "https://api.lightningpay.me/api/v2/reports/settlements?from_date=2026-09-01T00:00:00Z&to_date=2026-09-30T00:00:00Z" \
  -H "app-id: your-app-id" \
  -H "secret-key: your-secret-key"

Retrieve your credentials from the Merchant Portal. See Integration Keys.

Available endpoints

Endpoint	Description
Get Settlement Reports	List the settlement reports generated in a date range, with file name, reporting period, settlement totals, and a link to each file

There is no separate download endpoint. Each entry carries file_url, a pre-signed link to the CSV: fetch it with a plain GET and no authentication headers. See Settlement Reporting for the file format, the column reference, and how to reconcile a file against your ledger.

Quick start

List the reports generated in a period, then fetch a file from its link:

curl "https://api.lightningpay.me/api/v2/reports/settlements?from_date=2026-09-01T00:00:00Z&to_date=2026-09-30T00:00:00Z&report_frequency=daily" \
  -H "app-id: your-app-id" \
  -H "secret-key: your-secret-key"

curl "https://cdn-private.helloclever.co/hellocleverweb-prod/clever/sections/report/9f3c1ab2-...?sv=2021-08-06&sr=b&sp=r&sig=..." \
  -o settlement.csv

The second call needs no credentials: file_url is pre-signed. It is also valid for only 3 minutes, so fetch it in the same run rather than storing it. If it has expired, list the report again by id for a fresh link.

Get Balance Details V2: current available and pending balance per currency.
Get Balance History V2: every balance movement, including the settlement entries these reports list.
Settlement Service: the settlement modes available to you and how funds reach your beneficiary.

Basics

Payment APIs

Card API

Cashback API

Reporting API

Reporting API Overview

When to use the Reporting API

Merchant Portal

Reporting API

Base URLs

Authentication

Available endpoints

Quick start

​When to use the Reporting API

Merchant Portal

Reporting API

​Base URLs

​Authentication

​Available endpoints

​Quick start

​Related APIs

When to use the Reporting API

Base URLs

Authentication

Available endpoints

Quick start

Related APIs