> ## Documentation Index
> Fetch the complete documentation index at: https://docs.helloclever.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Reporting API Overview

> The Hello Clever Reporting API lists the settlement reports generated for your account and links to each CSV, so you can reconcile payouts on your own schedule instead of waiting for the report email.

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](/portal/balances) screen in the Merchant Portal, so the portal and your integration never disagree.

## When to use the Reporting API

<CardGroup cols={2}>
  <Card title="Merchant Portal" icon="chart-line" href="/portal/balances">
    Use the Merchant Portal to review settlements visually, open a settlement record, and check its recipient and included transactions. No API calls required.
  </Card>

  <Card title="Reporting API" icon="file-lines" href="/api/reporting/get-settlement-reports">
    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.
  </Card>
</CardGroup>

## 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.

```bash theme={null}
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](/integration-keys).

## Available endpoints

| Endpoint                                                        | Description                                                                                                                         |
| --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| [Get Settlement Reports](/api/reporting/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](/api/reporting/settlement) 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:

<CodeGroup>
  ```bash List reports theme={null}
  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"
  ```

  ```bash Fetch a file theme={null}
  curl "https://cdn-private.helloclever.co/hellocleverweb-prod/clever/sections/report/9f3c1ab2-...?sv=2021-08-06&sr=b&sp=r&sig=..." \
    -o settlement.csv
  ```
</CodeGroup>

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.

## Related APIs

* [Get Balance Details V2](/api/balance/get-balance-details-v2): current available and pending balance per currency.
* [Get Balance History V2](/api/balance/get-balance-history-v2): every balance movement, including the `settlement` entries these reports list.
* [Settlement Service](/services/settlement): the settlement modes available to you and how funds reach your beneficiary.


## Related topics

- [Hello Clever API Overview](/api/overview.md)
- [Cashback API Overview](/api/cashback/overview.md)
- [Card Payment API Overview](/api/card/overview.md)