支払い方法を保留する

決済を作成する際に、対象の支払い方法を保留することで、売上をリザーブして後からキャプチャーすることができます。たとえば、ホテルではゲストのチェックイン前に決済を全額オーソリし、ゲストのチェックアウト時にその金額をキャプチャーするといったことがよく行われます。これは、手動キャプチャーと呼ばれることもあります。

決済のオーソリにより、顧客の支払い方法で金額が確保されて保証されます。API を使用している場合、支払いの payment_method_details.card.capture_before 属性は、オーソリの有効期限が切れる日時を示します。

オーソリの有効期限が切れる前に売上をキャプチャーする必要があります。売上のキャプチャー前にオーソリの有効期限が切れた場合、売上がリリースされ、決済ステータスが canceled に変更されます。詳細は非同期型の支払いのステータスをご確認ください。

オーソリの有効期間

次の表は、さまざまな取引タイプをオーソリする際の有効期間の概要を示しています。

カード非提示取引

カード提示取引 (対面支払い)

日本における 30 日間のオーソリ期間

日本に所在するアカウントの場合、Visa、Mastercard、JCB、ダイナースクラブ、ディスカバーを利用する日本円建ての取引は最長 30 日間、保留にできます。 日本円以外の取引とアメリカン・エキスプレスの取引は、標準どおり 7 日間で有効期限が切れます。

決済手段の制限事項

導入前に、オーソリとキャプチャーの分離に関する次の制限事項を確認してください。

• オーソリとキャプチャーの分離に対応しているのは一部の決済手段に限られます。対応している決済手段は、カード支払い、Affirm、Afterpay、Cash App Pay、Klarna、PayPal などです。一方、対応していない決済手段は、ACH や iDEAL などです。詳細は決済手段の機能のサポートをご覧ください。

• 上の表に記載されている以外にも、他の支払い方法には、さまざまな規則とオーソリ期間が適用されます。

  • カード支払い: 通常、オンライン決済で 7 日間、対面の Terminal 決済で 2 日間、金額が保留されます (取引のタイプとカードネットワークに応じて異なります)。有効期間延長の対象となる一部のオンライン決済および Terminal 決済のオーソリについては、オーソリの延長をリクエストすることができます。また、カードネットワークはキャプチャーを意図しない 1 USD のオーソリを禁止する可能性があります。
  • Affirm: Affirm で非常に高額の注文額に対して頭金が必要な場合、オーソリ時にその金額が請求され、支払いがキャプチャーされなかった場合は返金されます。その後は、30 日以内に支払い残高をキャプチャーしてください。
  • Afterpay / Clearpay: オーソリ時に、顧客は最初の返済の分割払いを支払います。Afterpay は、支払いがキャプチャーされなかった場合、その支払いを返金します。13 日以内に支払い残高をキャプチャーする必要があります。
  • Cash App Pay: 決済を完了するには、有効なオーソリを 7 日以内にキャプチャーする必要があります。
  • Klarna: 支払いリクエストから 28 日目の午前 0 時までに支払いをキャプチャーする必要があります。そうしないと、オーソリの有効期限が切れます。たとえば、UTC 2020-10-01 14:00 に行われた支払いリクエストは、UTC 2020-10-29 00:00 までにキャプチャーする必要があります。
  • PayPal: 金額を 10 日間保留します。Stripeは自動的にさらに 10 日間 (合計 20 日間) の保留の延長を試みます。決済の設定がオーソリ有効期間に影響する場合があります。詳細については、オーソリとキャプチャーの分離をご覧ください。

ダッシュボードを使用してオーソリとキャプチャーを行う

コードを記述せずに、支払いのオーソリと売上のキャプチャーを別々に行うことができます。

1. ダッシュボードで新しい支払いを作成し、1 回限りを選択します。
2. 支払い方法を入力または選択する際に、その他のオプション を選択して、売上を後でキャプチャーを選びます。

支払いは、支払いページに未キャプチャーとして表示されます。

売上をキャプチャーするには、支払いの詳細ページに移動してキャプチャーをクリックします。

オーソリのみを行うように Stripe に指示する

オーソリとキャプチャーを分離することを示すには、PaymentIntent の作成時に、capture_method に manual を指定します。このパラメーターは、Stripe に対して、金額のオーソリのみを行い、顧客の支払い方法でキャプチャーしないよう指示します。

curl https://api.stripe.com/v1/payment_intents \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=1099 \
  -d currency=usd \
  -d "payment_method_types[]"=card \
  -d capture_method=manual

上記の方法では、対象となる決済手段を使用した PaymentIntent でのみ「後でのキャプチャー」を Stripe に指示できます。たとえば、カード支払いと SEPA ダイレクトデビット (後でのキャプチャーに対応していない) を 1 つの PaymentIntent で受け付けることはできません。後でのキャプチャーに対応していない可能性のある決済手段を受け付けるには、payment_method_options[<payment_method_type>] オブジェクトで capture_method=manual を設定して、capture-after-per-payment-method を設定できます。

たとえば、payment_method_options[card][capture_method]=manual を設定すると、カード支払いのみが保留されます。決済手段はダッシュボードで管理できます。Stripe は取引額、通貨、決済フローなどの要素に基づいて、各顧客に対応した最も関連性の高い決済手段を動的に表示するロジックを処理します。

curl https://api.stripe.com/v1/payment_intents \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=1099 \
  -d currency=usd \
  -d "automatic_payment_methods[enabled]"=true \
  -d "payment_method_options[card][capture_method]"=manual

また、以下の例のように決済手段タイプを使用して、card と sepa_debit を一覧表示することもできます。

curl https://api.stripe.com/v1/payment_intents \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=1099 \
  -d currency=eur \
  -d "payment_method_types[]"=card \
  -d "payment_method_types[]"=sepa_debit \
  -d "payment_method_options[card][capture_method]"=manual

引き続きキャプチャーを行う前に、カード詳細による支払い方法を PaymentIntent に関連付け、PaymentIntent を確定してカードをオーソリします。これを行うには、PaymentIntent で payment_method フィールドと confirm フィールドを設定します。

売上をキャプチャーする

支払い方法のオーソリが完了すると、PaymentIntent のステータスは requires_capture に移行します。オーソリ済みの売上をキャプチャーするには、PaymentIntent のキャプチャーリクエストを行います。デフォルトでは、オーソリ済みの総額がキャプチャーされます。当初の金額より少ない、または (特定のオンラインカード決済に対して) 多い金額をキャプチャーするには、amount_to_capture オプションを渡します。部分的なキャプチャーを行った場合、残額は自動的にリリースされます。オンラインカード決済に対して当初より多い金額をキャプチャーする場合は、オーバーキャプチャーに関するドキュメントで詳細をご確認ください。

次の例は、オーソリ済みの 10.99 USD の支払いのうち、7.50 USD をキャプチャーする方法を示しています。

curl https://api.stripe.com/v1/payment_intents/pi_123/capture \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount_to_capture=750

一部のカード決済はマルチキャプチャーの対象となりますが、大半の決済ではオーソリ済みの決済をキャプチャーできるのは 1 回のみです。決済の一部をキャプチャーした場合、差額分に対して別途キャプチャーを行うことはできません (代わりに、顧客の決済手段の詳細を後で使用できるように保存し、必要に応じてそれ以降の決済を作成することを検討してください)。

カード発行会社および支払い方法のインターフェイスによっては、カード明細書でオーソリとキャプチャー (売上処理) された支払いが区別されておらず、顧客の混乱を招くことがあります。

さらに、顧客が手動キャプチャーによって PaymentIntent 上で支払い処理を完了すると、payment_intent.amount_capturable_updated イベントがトリガーされます。PaymentIntent からキャプチャー可能な合計額を確認するには、PaymentIntent の amount_capturable プロパティを調べます。

オーソリをキャンセルする

オーソリをキャンセルする必要がある場合は、PaymentIntent をキャンセルしてください。