Skip to main content
残高のエンドポイントにより、Hello Clever アカウントの資金をリアルタイムに把握できます。残高詳細のエンドポイントですべての残高種別の現在の状態を確認し、残高履歴のエンドポイントで指定した期間における残高の変動(受け取った決済、発行した返金、トップアップを含む)を監査できます。
これらのエンドポイントは AUD の残高のみに対応しています。他の通貨の残高や残高履歴を照会するには、アカウントに設定されたすべての通貨を扱う v2 残高 API を使ってください。

残高の詳細を取得する

GET /v1/balances/detail
アカウント内のすべての残高種別のリアルタイムな内訳を取得します。

残高の種別

レスポンスの項目

string
通貨コード (AUD)。
number
あらゆる取引に直ちに利用できる資金(AUD)。
number
成功した決済から計上待ちの資金(AUD)。
number
保留中の返金、異議申立て、Payout のために確保された資金(AUD)。
number
安全余裕として保持される予備資金(AUD)。
number
ローリングリザーブの資金を除いた利用可能残高(AUD)。
string
残高のスナップショットを取得した日時(ISO 8601)。

コードの例


残高履歴を取得する

GET /v1/balances/history
指定した期間内のすべての残高の変動の詳細な履歴を取得します。入金された決済、返金、トップアップ、Payout、そしてアカウント残高に影響するその他の活動が含まれます。
多通貨の残高履歴には、代わりに GET /v2/balances/history を使ってください。アカウントのすべての通貨にわたる記録を返し、取引ごとの手数料の内訳も含みます。パラメーターとレスポンスの違いはv1 残高履歴からの移行を参照してください。

クエリのパラメーター

string
必須
期間の開始日(ISO 8601 形式。例:2026-01-01)。
string
必須
期間の終了日(ISO 8601 形式。例:2026-04-17)。
number
デフォルト:"1"
ページ分割された結果のページ番号。
number
デフォルト:"20"
1 ページあたりの件数。

レスポンスの項目

array
残高履歴の項目の一覧。
number
クエリに一致する残高履歴の項目の総数。
number
現在のページ番号。

コードの例