概要
Depotはリダイレクト型の電子マネー決済です。APIで決済を作成後、顧客をpayment_urlにリダイレクトして決済を完了します。
制約
フィールドの制約
Depot はカード決済より厳しい検証を行い、しかもその検証は遅い段階で行われます。決済の作成は成功し、違反は顧客が Depot のページで支払おうとした時点で初めて表面化します。API を呼ぶ前に自前で検証してください。そうしないと、顧客はリダイレクトされた先で何も入力できないまま、説明のつかないエラーに遭遇します。customer_id・email・tel・product_name は決済ページで顧客に表示されるため、値がある場合は送信してください。
決済フロー
1
決済作成
POST /v1/payments を呼び出して決済を作成し、payment_url を取得2
顧客をリダイレクト
顧客を
payment_url にリダイレクト3
顧客が決済完了
顧客がDepotのページで決済を完了
4
リダイレクトバック
決済時に指定した
success_url / failure_url / cancel_url にリダイレクトされます。未指定の場合は加盟店ダッシュボードで設定したデフォルト値が使われます5
結果確認
Webhook を正とし、必要に応じて決済取得APIで確認してください
実装例
Webhook連携
Depot決済の結果は Webhook が正です。顧客が戻ってきたページの表示ではなく、Webhook で確定してください。 Depot の Webhook ペイロードは他の決済手段と同一です。payment_method は "depot"、currency は "jpy" となり、カード関連フィールド(card_brand・card_last4 など)は含まれません。決済作成時に渡した metadata はそのまま返却されるため、自社のセッションIDを持たせる用途に使えます。
ペイロード全体と署名検証については Webhook リファレンスをご覧ください。リクエストパラメータの詳細は API リファレンス をご覧ください。