Skip to main content
Hello Clever の API 群は、同社のフィンテックプラットフォーム上に決済体験を構築するために必要なすべてを提供します。このページでは各 API のバージョンを紹介し、それぞれの用途を説明し、連携に適したものを選べるようにします。

ベース URL

各 API のバージョンには独自のベース URL があります。開発中はサンドボックスのエンドポイントを使い、本番稼働時に本番環境へ切り替えてください。
すべての API リクエストで必ず HTTPS を使用してください。暗号化されていない接続で認証情報を送らないでください。

API のバージョンの一覧

API v1:AUD Payment Gateway

オーストラリアドルの取引向けの、Hello Clever の初期の決済ゲートウェイです。PayID、PayTo、BSB/口座番号による送金、AUD の Payout に対応します。キャッシュバックキャンペーンの連携も含みます。AUD のみで事業を行い、PayID や PayTo への対応が必要な場合はこの API を使ってください。

API v2:Multi-Currency Payments

複数の通貨に対応した、機能の揃った Payin と Payout の API です。モバイルマネー、バーチャル口座への銀行振込、顧客とコンタクトの管理、VND の銀行照会を含みます。AUD 以外の通貨で決済を受け付けたり送金したりする必要がある場合はこの API を使ってください。

API v3:Payment Gateway 3

1つの連携点ですべての通貨を扱うホスト型のゲートウェイのチェックアウト API です。手順に沿った連携の流れと、ステータス変更に対する Webhook のサポートが組み込まれています。決済フォームの UI を自ら構築せずに、管理されたチェックアウト体験を利用したい場合はこの API を使ってください。

Card API

JavaScript SDK(クライアントサイド、AUD と USD)またはサーバー間通信 (S2S) の連携(サーバーサイド、AUD のみ)でカード決済を受け付けます。継続決済のためのカードのトークン化、3DS 認証、通常および非定期の決済種別、返金に対応します。

Cashback API

顧客向けのキャッシュバックキャンペーンと特典を管理します。キャンペーンの一覧を取得し、キャッシュバックの操作を実行できます。決済の連携の上にロイヤルティと特典のプログラムを構築する場合はこの API を使ってください。

各バージョンの使いどころ

認証

Hello Clever API へのすべてのリクエストでは、app-idsecret-key による認証が必要です。認証情報の取得方法とリクエストでの渡し方の手順は、認証のページを参照してください。

Webhook

Hello Clever は、決済のステータスが変わったときに Webhook でサーバーへ通知します。ペイロードの完全なリファレンス、ステータスの一覧、セキュリティの設定、リトライの挙動については、Webhook のページを参照してください。