オーソリを増額する

request_incremental_authorization パラメーターを使用して、増分予定の PaymentIntents を指定できます。

if_available または never パラメーターを使用して、PaymentIntent の更新を開始するタイミングを決定します。

• if_available: 作成した PaymentIntent では、今後の増分が増分オーソリ対応状況に基づいて許可されます。

• never: 作成した PaymentIntent では、今後の増分が許可されません。

未キャプチャー分の支払いに対して増分オーソリを実行できるのは、PaymentIntent の確定後に限られます。確定前に支払いの金額を調整するには、代わりに update メソッドを使用します。

curl https://api.stripe.com/v1/payment_intents \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=1000 \
  -d currency=usd \
  -d "payment_method_types[]"=card \
  -d payment_method=pm_card_debit_incrementalAuthAuthorized \
  -d confirm=true \
  -d capture_method=manual \
  -d "expand[]"=latest_charge \
  -d "payment_method_options[card][request_incremental_authorization]"=if_available

PaymentIntent 確認レスポンスでは、latest_charge の payment_method_details フィールドに、顧客の支払い方法と上記の使用可能条件に基づいて available または unavailable が示され、これによって PaymentIntent が増分オーソリに使用可能かどうかが決まります (PaymentIntent 確認リクエストにおいて増分オーソリをリクエストしなかった場合は、unavailable になります)。

// PaymentIntent Response
{
  "id": "pi_ANipwO3zNfjeWODtRPIg",
  "object": "payment_intent",
  "amount": 1000,
  "amount_capturable": 1000,
  "amount_received": 0,
  ...
  // if latest_charge is expanded
  {
    "latest_charge": {
        "amount": 1000,
        "payment_method_details": {
          "card": {
            "incremental_authorization": {
                "status": "available" // or "unavailable"
            }
          }
        }
        ...
      }
  }

}

PaymentIntent のオーソリ額を増やすには、increment_authorization エンドポイントを使用して、増額後の新しい合計オーソリ額を指定します。この金額は、元のオーソリ額よりも高く設定されていなければなりません。これにより、更新後のオーソリ額が顧客のカードで試行されるようになります。1 つの PaymentIntent でこのエンドポイントを複数回呼び出し、オーソリ額をさらに増やすことが可能です。

1 つの PaymentIntent につき、最大 10 回まで増分オーソリの試行が可能です。

curl https://api.stripe.com/v1/payment_intents/{{PAYMENT_INTENT_ID}}/increment_authorization \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
: \
  -d "amount"=1500

増分オーソリが成功すると、金額が更新された PaymentIntent オブジェクトが返されます。オーソリが失敗すると、代わりに card_declined エラーが返されます。PaymentIntent オブジェクトは、前回のオーソリ額を引き続きキャプチャーします。増分オーソリに失敗した場合、その他の PaymentIntent フィールド (application_fee_amount、transfer_data、metadata、description、statement_descriptor など) に行われる更新は保存されません。

増分オーソリには上限があり、500 USD (または現地通貨による相当額)、または前回のオーソリ額の 500% のいずれか高い方が増分 1 回の上限額にあたります。

増分オーソリされた PaymentIntent のオーソリ額を増やすかどうかにかかわらず、当初のオーソリの有効期間が切れる前に売上をキャプチャーする必要があります。増分オーソリでは有効期間は延長されません。過去に増分オーソリされた PaymentIntent のオーソリ額をキャプチャーする場合は、通常のときと同様に [capture エンドポイントを使用します。

curl https://api.stripe.com/v1/payment_intents/{{PAYMENT_INTENT_ID}}/capture \
  -u 
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:

増分オーソリが成功すると、更新後の金額が指定されたキャプチャー済みの PaymentIntent オブジェクトが返されます。オーソリが失敗すると、代わりに card_declined エラーが返されます。PaymentIntent はキャプチャーされませんが、前回のオーソリ額は引き続きキャプチャーされます。増分オーソリに失敗した場合、その他の PaymentIntent フィールド (application_fee_amount、transfer_data、metadata、description、statement_descriptor など) に行われる更新は保存されません。

増分オーソリ用の Stripe テストカードを、任意のセキュリティコード、郵便番号、将来の有効期限とともに使用して、テスト時に増分オーソリをトリガーします。

1. まず、上記の PaymentIntent の作成と確定ステップで、テストカードを使用して PaymentIntent を作成します。

1. 上記の増分オーソリの実行ステップで指定したパラメーターで増分オーソリを実行します。増分オーソリのトリガーにはテストカードを使用してください。