v2 が扱う範囲
Payin
銀行振込、電子ウォレット、QR コード、モバイルマネーなどで決済を受け付けます。返金、取消、OTP を用いたモバイルマネーのフローに対応します。
Payout
対応通貨の受取人へ資金を送ります。スケジュール Payout、支店コードの照会、QR による銀行口座の解決を含みます。
顧客とコンタクト
顧客の記録とコンタクトを作成・管理します。取引の前に本人確認が必要な手段については、KYC の書類を提出できます。
残高
すべての通貨について、利用可能、入金予定、出金予定、ローリングリザーブ、出金可能の各残高を照会し、残高取引の履歴全体を取得できます。
対応通貨
v2 API は、Hello Clever の Merchant Dashboard で設定されたすべての通貨に対応します。
自社のアカウントで有効になっている手段を確認するには、Get Payin Methods または Get Payout Methods を呼び出してください。追加の通貨を有効にするには support@helloclever.co へお問い合わせください。
GST を
true に設定すべきなのは、AUD の取引を処理するオーストラリアの加盟店のみです。それ以外の通貨では false に設定してください。金額の丸め
VND、JPY、XAF、KRW、XOF では、処理中に各通貨が対応する精度へ取引金額が丸められます。そのため、取引に記録される金額が送信した値とわずかに異なる場合があります。 消込は、送信した値ではなく API のレスポンスと Webhook のペイロードで返される金額に対して行ってください。それ以外の通貨では、金額は送信されたとおりに処理されます。ベース URL
認証
v2 API へのすべてのリクエストには、Hello Clever の Merchant Dashboard から発行される2つのヘッダーベースの APIキーが必要です。string
必須
Hello Clever 内で登録・管理されるアプリケーションの識別子です。すべてのリクエストで必要です。
string
必須
サーバーサイドのリクエストを認証するために使うクライアントのシークレットです。クライアントサイドのコードで決して露出させないでください。
Example request
連携の全体像
一般的な Payin の連携は4つの手順で進みます。1
Payin の手段を取得する
GET /v2/payins/payin_methods を呼び出して、設定した通貨で利用できる決済手段の一覧を取得します。2
必須項目を取得する
選択した手段のコードを指定して
GET /v2/payins/payin_method/params を呼び出し、顧客から収集する必要のある項目を確認します。3
Payin を作成する
手段のコード、必須項目、顧客の情報を指定して
POST /v2/payins を呼び出し、決済を開始します。4
シミュレーションする（サンドボックスのみ）
サンドボックス環境では、テストのために
POST /v2/payins/simulate を呼び出して保留中の決済を完了させます。リソース
問い合わせと規約
- サポート：support@helloclever.co
- 利用規約：helloclever.co/terms