Sources API非推奨
Sources API を通じて利用できるさまざまな支払い方法とメカニズムは、以下のとおりです。
警告
We deprecated the Sources API and plan to remove support for local payment methods. If you currently handle any local payment methods using the Sources API, you must migrate them to the Payment Methods API.
Stripe はカード決済のサポートを終了する予定はありませんが、Sources API のご利用を PaymentMethods API に切り替えることをお勧めします。PaymentMethods API を使用することで、最新機能と支払い方法のタイプを利用できます。
Source (ソース) オブジェクトを使用すると、単一の API でさまざまな支払い方法を受け付けることができます。ソースは顧客の支払い手段を表し、Stripe API と共に使用して支払いを作成できます。ソースを直接請求することも、後で再利用するために顧客に関連付けることもできます。
Sources API によってサポートされている支払い方法はそれぞれ、4 つの主要な特性によって定義されます。これらの特性の組み合わせにより、ソースを支払い可能にする方法と、支払いを完了するために支払いリクエストで使用する方法が決まります。
- プルまたはプッシュ: 支払い方法ごとに、売上が顧客から送金される方法
- フロー: 顧客が支払いを認証するために実行する必要があるアクションタイプ
- 使用状況:
Sourceが再利用可能かどうか - 同期型または非同期型: 支払い結果をすぐに確認できるか、後でのみ確認できるか
Sources API を使用して支払い方法を受け付ける場合の完全な例については、このサンプル E-コマースストアを確認し、その GitHub でのソースコードを参照してください。
サポートされている支払い方法
ダッシュボード内で利用可能支払い方法をすべて有効にできます。通常、有効化は瞬時に行われ、追加の契約は必要なく、長いプロセスも含まれません。詳細なリストについては、利用可能な支払い方法とサポートされている地域をご覧ください。
次の表は、サポートされている支払い方法に対して、前述の主要な特性を対応付けたものです。
| 送金 | 確定 | なし | リダイレクト | コードの確認 | 受取人 |
|---|---|---|---|---|---|
| プル | 同期型 | カード | — | — | — |
| 非同期型 | SEPA ダイレクトデビット (非推奨) | 認証付きの ACH デビット | マイクロデポジット付きの ACH デビット | — | |
| プッシュ | 同期型 |
| — | — | Multibanco (非推奨) |
| 非同期型 | — | Sources API を使用した Sofort の支払い (非推奨) | — | — |
売上のプルまたはプッシュ
各支払い方法は、売上が顧客の支払い方法から送金される方法に応じて、プルまたはプッシュのいずれかに分類されます。
- 「プル」方法を使用すると、顧客が同意した後、顧客のアカウントから売上を引き落とすことができます。カード支払いはプル方法の一例です。支払いが行われると顧客のカードから引き落とされ、その後の引き落としに顧客とのやり取りは必要ありません。
- 「プッシュ」方法を使用すると、顧客が売上をお客様に送金します。ACH クレジットトランスファーは、プッシュ方法の一例です。顧客には、正しい金額を送金 (追加) するための金融番号と口座番号が提供されます。顧客が売上を送金したことを確認した後で、ソースが支払い可能になり、支払いリクエストで使用できるようになります。iDEAL や Sofort など、他のプッシュタイプの支払い方法では、顧客がリダイレクトを使用して、オンライン銀行口座から直接お客様に資金を追加します。一般に、プッシュ方法では、支払いごとに顧客とのやり取りが必要です。
顧客のアクションフロー
特定の支払い方法では、ソースが支払い可能になる前に、顧客が特定のアクション (フロー) を完了する必要があります。支払い方法に適用されるフロータイプは、Source オブジェクトの flow パラメータ内に記述されています。各方法は、次のフロータイプのいずれかに分類されます。
必要なフローが完了し、ソースが支払い可能になったら、ソースを使用をして、支払いを完了するために支払いリクエストを作成する必要があります。使用しない場合、ソースはキャンセルされ、顧客の認証済みの支払いは自動的に返金されます。お客様のアカウントへの送金はありません。
1 回限りの使用または再利用可能
特定の支払い方法では、顧客が支払いプロセスを再度完了しなくても、追加の支払いに再利用できるソースを作成できます。再利用可能なソースでは、usage パラメータが reusable に設定されています。
逆に、ソースが 1 回しか使用できない場合、このパラメータは single_ に設定され、顧客が支払いを行うたびにソースを作成する必要があります。そのようなソースは顧客に関連付けるのではなく、直接請求する必要があります。請求できるのは 1 回だけで、請求するとステータスが consumed に変わります。
再利用可能なソースを再利用するには、ソースを Customer (顧客) に関連付ける必要があります。(直接請求した場合、顧客のステータスは consumed に変わります。) ソースを顧客に関連付ける方法と顧客のソースリストを管理する方法については、ソースと顧客ガイドを参照してください。
同期型または非同期型の確認
支払い方法を使用して Charge (支払い) オブジェクトを作成すると、その支払いステータスはすぐに (同期型) または一定時間後に (非同期型) 確認できます。
同期型の支払い方法を使用すると、支払いリクエストのステータスを
succeededまたはfailedとしてすぐに確認できます。支払いリクエストが成功すると、支払いが完了し、顧客に請求が行われ、売上を受け取ることが保証されていると見なされます。カード支払いは、同期型の支払い方法の一例です。支払いの成功または失敗をリアルタイムで確認できます。非同期型の支払い方法の場合、支払いが成功したかどうかを確認するのに最大で数日かかる場合があります。この間、支払いは保証できません。支払いが成功または失敗したことが確認されるまで、支払いの
Chargeオブジェクトのステータスは当初のpendingに設定されます。ACH デビットは非同期型の方法の一例です。これらのデビットでは、支払いが成功したことを確認するのに数日かかります。
支払いステータスが変更されると、Stripe は Webhook イベントを送信します。非同期型の支払い方法を受け付けるには、Webhook の通知を受信できるように設定する必要があります。この通知を受信することによって、顧客の支払いが成功したか失敗したかを確認できるようになります。