> ## 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 の概要

> Hello Clever の Reporting API は、アカウント向けに生成された精算レポートを一覧で返し、各 CSV へのリンクを提供します。レポートのメールを待たずに、自社のスケジュールで Payout を照合できます。

Hello Clever の Reporting API は、精算レポートを読み取り専用のファイルとして提供します。決済の API が個々の取引を作成・追跡するのに対し、Reporting API は会計上の問いに答えます。Payments Account から何が、いつ、どの通貨で、どの手数料に対して精算されたかです。

これらは、Hello Clever がこれまでメールで送っていたものと同じレポートです。ファイル、数値、レポートの頻度は変わりません。違いは、アカウントのタイムゾーンで 09:00 に受け取るのではなく、照合のジョブを実行するタイミングで自分から取得できることです。

現時点では、この API は精算レポートを対象としています。返される内容はすべて Merchant Portal の [All Balances](/ja/portal/balances) の画面に表示される内容と一致するため、ポータルと連携の内容が食い違うことはありません。

## Reporting API を使う場面

<CardGroup cols={2}>
  <Card title="Merchant Portal" icon="chart-line" href="/ja/portal/balances">
    精算を画面上で確認し、精算の記録を開いて、その受取人と含まれる取引を確認したい場合は Merchant Portal を使ってください。API の呼び出しは不要です。
  </Card>

  <Card title="Reporting API" icon="file-lines" href="/api/reporting/get-settlement-reports">
    精算レポートを定期的に取得し、自社の台帳と照合したり、会計システムやデータウェアハウスに取り込んだりする場合は Reporting API を使ってください。
  </Card>
</CardGroup>

<a id="base-urls" />

## ベース URL

| 環境      | ベース URL                                   |
| ------- | ----------------------------------------- |
| サンドボックス | `https://sandbox-api.lightningpay.me/api` |
| 本番環境    | `https://api.lightningpay.me/api`         |

## 認証

Reporting API は `app-id` と `secret-key` を HTTP ヘッダーとして使用します。Hello Clever の他の API と同じ認証情報です。レポートは、認証に使った `app-id` に紐づく通貨について返されます。

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

認証情報は Merchant Portal から取得します。[連携キー](/ja/integration-keys)を参照してください。

## 利用できるエンドポイント

| エンドポイント                                                         | 説明                                                               |
| --------------------------------------------------------------- | ---------------------------------------------------------------- |
| [Get Settlement Reports](/api/reporting/get-settlement-reports) | 指定した期間に生成された精算レポートを一覧で返します。ファイル名、レポートの対象期間、精算の合計、各ファイルへのリンクを含みます |

ダウンロード用の別のエンドポイントはありません。各項目には CSV への署名付きリンクである `file_url` が含まれます。認証ヘッダーを付けずに、通常の `GET` で取得してください。ファイルの形式、列の一覧、ファイルと台帳の照合方法は、[精算レポート](/ja/api/reporting/settlement)を参照してください。

## クイックスタート

期間内に生成されたレポートを一覧で取得し、そのリンクからファイルを取得します。

<CodeGroup>
  ```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&report_frequency=daily" \
    -H "app-id: your-app-id" \
    -H "secret-key: your-secret-key"
  ```

  ```bash ファイルの取得 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>

2つ目の呼び出しには認証情報が不要です。`file_url` は署名付きのリンクだからです。ただし有効なのは 3 分間だけなので、保存せずに同じ処理の中で取得してください。有効期限が切れた場合は、`id` を指定してレポートを再度一覧で取得し、新しいリンクを受け取ってください。

## 関連する API

* [Get Balance Details V2](/api/balance/get-balance-details-v2)：通貨ごとの現在の利用可能残高と保留中の残高。
* [Get Balance History V2](/api/balance/get-balance-history-v2)：残高のすべての動き。これらのレポートに記載される `settlement` の項目も含みます。
* [精算サービス](/ja/services/settlement)：利用できる精算のモードと、資金が受取人に届くまでの流れ。


## Related topics

- [Hello Clever API の概要](/ja/api/overview.md)
- [Cashback API の概要](/ja/api/cashback/overview.md)
- [カード決済 API の概要](/ja/api/card/overview.md)