Skip to main content
Hello Clever の決済 API (v1) は、オーストラリア市場向けに構築された AUD 決済サービスの包括的な機能群を提供します。これらのエンドポイントを使えば、PayID による決済の受け付け、BSB/口座番号への送金の開始、PayTo の継続契約の管理、一括 Payout の実行、キャッシュバック特典の配布、リアルタイムの残高データの取得を、すべて一貫した1つの API から行えます。
このセクションのすべてのエンドポイントは AUD 専用です。追加の通貨への対応は開発中です。1年を超える期間の照会については support@helloclever.co へお問い合わせください。

ベース URL

認証

v1 API へのすべてのリクエストには、アプリケーションに発行された2つの APIキーのヘッダーが必要です。
string
必須
アプリケーションに割り当てられた一意の識別子です。
string
必須
app-id に紐づく秘密のトークンです。
Generate Access Token のエンドポイントを使って、認証情報を短命のアクセストークンと交換することもできます。トークンは 3600 秒(1 時間)有効です。

API の機能

PayID

ワンタイムおよび固定の PayID の作成、決済リクエストの一覧とステータスの取得、保留中の PayID の取消、ホスト型決済ゲートウェイのリンクの生成ができます。

BSB/口座番号

オーストラリアの BSB と口座番号への銀行振込の開始、銀行決済の一覧、決済ステータスの確認、返金の処理ができます。

PayTo 契約

加盟店と支払人の間の継続的またはスケジュールされた決済のために、PayTo の決済契約を作成、変更し、そのライフサイクルを管理できます。

Payout

PayID または BSB の口座を通じて複数の受取人へ一括 Payout を送信し、ファイルで Payout のバッチをアップロードし、Payout の詳細を取得し、スケジュールされた Payout を取り消せます。

キャッシュバック

キャッシュバックキャンペーンの照会、ユーザーのキャッシュバックアカウントの有効化、購入後のキャッシュバック特典の配布、そしてユーザーによるキャッシュバック残高の出金ができます。

残高

AUD の利用可能、入金予定、出金予定、ローリングリザーブ、出金可能の各残高のリアルタイムな内訳と、AUD の残高履歴の全体を取得できます。他の通貨については v2 残高 API を使ってください。