オーソリを増額する

サーバーで Checkout セッションを作成し、ui_mode を embedded に設定します。Checkout セッションを設定する際、line items に加え、currency などのオプションを指定できます。

自社サイトでホストされているカスタムページに顧客を戻すには、そのページの URL を return_url パラメーターに指定します。URL にテンプレート変数 {CHECKOUT_SESSION_ID} を含めて、戻り先ページでセッションのステータスを取得します。Checkout では、リダイレクト前にこの変数が Checkout セッション ID に自動的に置き換えられます。

戻り先ページの設定と、リダイレクト動作をカスタマイズするためのオプションについてご紹介します。

Checkout セッションの作成後、レスポンスで返される client_secret を使用して、Checkout をマウントします。

増分オーソリ機能を有効にするには、request_incremental_authorization を if_available に設定します。

# This example sets up an endpoint using the Sinatra framework.
# To learn more about Sinatra, watch this video: https://youtu.be/8aA9Enb8NVc.
require 'json'
require 'sinatra'
require 'stripe'

# Set your secret key. Remember to switch to your live secret key in production.
# See your keys here: https://dashboard.stripe.com/apikeys
Stripe.api_key = 
'sk_test_BQokikJOvBiI2HlWgH4olfQ2'

post '/create-checkout-session' do
  session = Stripe::Checkout::Session.create({
    line_items: [{
      price_data: {
        currency: 'usd',
        product_data: {
          name: 'T-shirt',
        },
        unit_amount: 2000,
      },
      quantity: 1,
    }],
    mode: 'payment',
    ui_mode: 'embedded',
    payment_method_options: {
      card: {
        request_incremental_authorization: 'if_available',
      },
    },
    return_url: 'https://example.com/checkout/return?session_id={CHECKOUT_SESSION_ID}'
  })

  {clientSecret: session.client_secret}.to_json
end

顧客が決済を完了すると、PaymentIntent の latest_charge の payment_method_details フィールドに、顧客の決済手段と上記の利用基準に基づいて available または unavailable が示されます。これにより、PaymentIntent が増分オーソリを受けられるかかどうかを判別できます。(CheckoutSession の作成時に増分オーソリをリクエストしなかった場合は、unavailable になります。)

{
  "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. まず、上記の CheckoutSession の作成ステップで、テストカードを使用して CheckoutSession を作成します。

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