Skip to main content
Hello Clever の Reporting API は、精算レポートを読み取り専用のファイルとして提供します。決済の API が個々の取引を作成・追跡するのに対し、Reporting API は会計上の問いに答えます。Payments Account から何が、いつ、どの通貨で、どの手数料に対して精算されたかです。 これらは、Hello Clever がこれまでメールで送っていたものと同じレポートです。ファイル、数値、レポートの頻度は変わりません。違いは、アカウントのタイムゾーンで 09:00 に受け取るのではなく、照合のジョブを実行するタイミングで自分から取得できることです。 現時点では、この API は精算レポートを対象としています。返される内容はすべて Merchant Portal の All Balances の画面に表示される内容と一致するため、ポータルと連携の内容が食い違うことはありません。

​
Reporting API を使う場面

Merchant Portal

精算を画面上で確認し、精算の記録を開いて、その受取人と含まれる取引を確認したい場合は Merchant Portal を使ってください。API の呼び出しは不要です。

Reporting API

精算レポートを定期的に取得し、自社の台帳と照合したり、会計システムやデータウェアハウスに取り込んだりする場合は Reporting API を使ってください。

​
ベース URL

​
認証

Reporting API は app-id と secret-key を HTTP ヘッダーとして使用します。Hello Clever の他の API と同じ認証情報です。レポートは、認証に使った app-id に紐づく通貨について返されます。
認証情報は Merchant Portal から取得します。連携キーを参照してください。

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

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

​
クイックスタート

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

​
関連する API

  • Get Balance Details V2：通貨ごとの現在の利用可能残高と保留中の残高。
  • Get Balance History V2：残高のすべての動き。これらのレポートに記載される settlement の項目も含みます。
  • 精算サービス：利用できる精算のモードと、資金が受取人に届くまでの流れ。