Skip to main content
対象範囲について: Hello Clever の Card API は、カード決済の受け付けと管理(作成、オーソリ、キャプチャ、Void、返金、トークン化)を目的としたものであり、ユーザーへの物理カードやバーチャルカードの発行は対象としていません。このガイドでは、カードの受け付けと管理のライフサイクル全体を扱います。

構築するもの

Card API では、カード決済のフローを最初から最後までコントロールできます。決済の作成、オーソリ済み資金のキャプチャ、キャプチャ前の Void、キャプチャ後の返金、繰り返し利用のためのカードのトークン化、そして一覧と詳細のエンドポイントによる消込が可能です。ステータスの変更は Webhook で通知され、購入後のフローはアップセルの場面にも対応します。 対応するスキームには Visa、Mastercard、その他の主要ブランドに加え、Apple Pay と Google Pay が含まれます。資金は通貨ごとの Treasury Account へ精算され、自動的に消込されます。

連携方法を選ぶ

SDK(クライアントサイド)

Hello Clever の JavaScript SDK を使ったウェブ/モバイルのフロントエンドです。USD と AUD に対応します。生のカード情報を扱わずに、そのまま組み込めるチェックアウトに最適です。

サーバー間通信 (S2S)

自社のバックエンドから生の card_info を送信します。AUD に対応します。PCI DSS に準拠したシステムで、オーソリとキャプチャを完全にコントロールしたい場合に適します。
PCI DSS に準拠しており、生のカード情報の取り扱いが特に必要な場合を除き、SDK を選んでください。SDK ならカード情報が自社のサーバーを通りません。

事前準備

  • 加盟店アカウントと app-id / secret-key
  • サンドボックス https://api.cleverhub.co、本番環境 https://api-merchant.helloclever.co
  • 決済ステータスの変更を受ける Webhook のエンドポイント(TLS 1.2、公開、商用証明書)。
  • S2S の場合:PCI DSS に準拠した環境。

カードのエンドポイント

決済のライフサイクル

1

作成(オーソリ)

フロントエンドで JS SDK を初期化し、決済を作成してコールバックを処理します。導入と初期化については SDK 連携ガイドを参照してください。
この手順で決済がオーソリされます。フローによっては自動でキャプチャされる場合と、キャプチャ待ちのままオーソリ状態で残る場合があります。
2

キャプチャまたは Void

  • 決済がオーソリされたがキャプチャされていない場合は、Capture Payment を呼び出して全額を精算します(注文を発送するときなど)。
  • キャプチャ前に取り消す必要がある場合は、Void Payment を呼び出します。
キャプチャと Void は排他的です。Void はキャプチャ前にのみ機能します。
3

返金

キャプチャ後は、Refund Payment を使って全額または一部を返金します(返品や価格の調整などの場合)。
4

購入後・アップセル

Card API は購入後のフローに対応します。保存されたトークンを再利用して、顧客がカード情報を再入力せずに、最初の購入の後にアップセルを請求できます。

トークン化と保存されたカード

カードを一度トークン化すれば、その後は token_id を使って Create Payment via Tokenisation で請求できます。顧客がカードを削除した場合や不要になった場合は、Delete Token を呼び出して無効化してください。
PCI DSS に準拠し S2S を使用している場合を除き、自社側で保存するのは token_id のみとし、生のカード情報は決して保存しないでください。

消込

  • List Payment:レポート作成のため、期間とステータスで取引を取得します。既定では1ページ 20 件でページ分割されます。
  • Detail Payment:サポートや異議申立ての対応のため、個々の取引を詳しく確認します。

Webhook

決済のステータスが変わった(オーソリ、キャプチャ、Void、返金など)ときに自社システムへ通知されるよう、Webhook の通知を設定してください。すべての配信に対して 200 OK を返し、重複を冪等に処理してください。配信が失敗した場合はリトライされます。ペイロードと署名の詳細は Card Webhook ガイドを参照してください。

補足

  • カード Payin サービスでは、サーチャージデジタルウォレット(Apple Pay / Google Pay)に対応しています。
  • 対応通貨は連携方法に合わせてください。SDK は USD と AUD、S2S は AUD に対応します。