注文のフルフィルメント

支払いを正常にフルフィルメントするための関数をサーバー上に作成します。Webhook によってこの関数がトリガーされ、この関数は、決済完了後に顧客が貴社のウェブサイトに誘導されたときに呼び出されます。本ガイドでは、この関数を fulfill_checkout と呼んでいますが、関数の名前は自由に設定できます。

fulfill_checkout 関数では、次のことを行う必要があります。

1. 同じ Checkout セッション ID で複数回呼び出されたケースを正しく処理します。
2. 引数として Checkout セッション ID を受け入れます。
3. 拡張したline_items プロパティを使って、API で Checkout セッションを取得します。
4. payment_status プロパティを確認して、フルフィルメントが必要かどうかを判断します。
5. ラインアイテムのフルフィルメントを実行します。
6. 指定された Checkout セッションのフルフィルメントステータスを記録します。

以下のコードを fulfill_checkout 関数の開始点として使用します。TODO コメントは、実装する必要がある機能を示します。

def fulfill_checkout(session_id)
  # 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'

  puts "Fullfilling Checkout Session #{session_id}"

  # TODO: Make this function safe to run multiple times,
  # even concurrently, with the same session ID

  # TODO: Make sure fulfillment hasn't already been
  # peformed for this Checkout Session

  # Retrieve the Checkout Session from the API with line_items expanded
  checkout_session = Stripe::Checkout::Session.retrieve({
    id: session_id,
    expand: ['line_items'],
  })

  # Check the Checkout Session's payment_status property
  # to determine if fulfillment should be peformed
  if checkout_session.payment_status != 'unpaid'
    # TODO: Perform fulfillment of the line items

    # TODO: Record/save fulfillment status for this
    # Checkout Session
  end
end

受け付ける決済手段とビジネスニーズに応じて、fulfill_checkout 関数で次の処理を行うことができます。

• サービスへのアクセス権をプロビジョニングする。
• 商品の配送をトリガーする。
• 支払い詳細とラインアイテムのコピーを自社のデータベースに保存する。
• Stripe の領収書を有効にしていない場合に、顧客にカスタムの領収書メールを送信する。
• 顧客が Checkout で数量を調整できるようにする場合に、ラインアイテムと購入数量を照合する。
• 在庫または在庫レコードを更新する。

フルフィルメントをトリガーするには、Webhook イベントハンドラーを作成して支払いイベントをリッスンし、fulfill_checkout 関数をトリガーします。

貴社に対して支払いがあると、checkout.session.completed イベントが作成されます。これらのイベントの受け付け、処理、受領確認を行うように、サーバー上のエンドポイントを設定します。

Immediate versus delayed payment methods

Some payment methods aren’t instant, such as ACH direct debit and other bank transfers. This means, funds won’t be immediately available when Checkout completes. Delayed payment methods generate a checkout.session.async_payment_succeeded event when payment succeeds later. The status of the object is in processing until the payment status either succeeds or fails.

require 'sinatra'

# Use the secret provided by Stripe CLI for local testing
# or your webhook endpoint's secret.
endpoint_secret = 'whsec_...'

post '/webhook' do
  event = nil

  # Verify webhook signature and extract the event
  # See https://stripe.com/docs/webhooks#verify-events for more information.
  begin
    sig_header = request.env['HTTP_STRIPE_SIGNATURE']
    payload = request.body.read
    event = Stripe::Webhook.construct_event(payload, sig_header, endpoint_secret)
  rescue JSON::ParserError => e
    # Invalid payload
    return status 400
  rescue Stripe::SignatureVerificationError => e
    # Invalid signature
    return status 400
  end

  if event['type'] == 'checkout.session.completed' ||
  event['type'] == 'checkout.session.async_payment_succeeded'
    fulfill_checkout(event['data']['object']['id'])
  end

  status 200
end

また、checkout.session.async_payment_failed イベントをリッスンして処理することもできます。たとえば、遅延していた支払いが失敗した場合に顧客にメールを送信できます。

Webhook イベントハンドラーを開発、テストするための最も簡単な方法は、Stripe CLI を使用することです。Stripe CLI をお持ちでない場合は、インストールガイド に従ってインストールしてください。

Stripe CLI がインストールされている場合は、イベントハンドラーをローカルでテストできます。サーバーを (localhost:4242 などで) 実行し、次に stripe listen コマンドを実行すると、Stripe CLI がイベントをローカルサーバーに転送します。

stripe listen --forward-to localhost:4242/webhook

Ready! Your webhook signing secret is 'whsec_<REDACTED>' (^C to quit)

Webhook secret (whsec_...) をイベント処理コードに追加し、顧客として決済フローを実行してフルフィルメントをテストします。

支払いが完了したら、以下を確認します。

• stripe listen が実行されているコマンドラインには、ローカルサーバーに転送された checkout.session.completed イベントが表示されます。
• サーバーログには、fulfill_checkout 関数からの想定出力が表示されます。

ローカルでテストした後、Webhook イベントハンドラーをサーバー上で稼働させます。次に、Webhook エンドポイントを作成して checkout.session.completed イベントをサーバーに送信し、決済フローを再度テストします。

Webhook をリッスンすることは、すべての支払いに対して常にフルフィルメントがトリガーされていることを確認するために必要ですが、そうすると Webhook が遅延することがあります。決済フローを最適化し、顧客がアクセスしたときにすぐに確実にフルフィルメントされるようにするには、ランディングページからもフルフィルメントをトリガーします。ランディングページを設定するには、Checkout セッションの作成時に return_url を渡すか、フロントエンドで returnUrl を confirm に渡します。

指定した URL の Checkout セッション ID を使用して、次の手順を行います。

1. サーバーが決済フローのランディングページに対するリクエストを受信したときに、URL から Checkout セッション ID を抽出します。
2. 指定した ID を使用して fulfill_checkout 関数を実行します。
3. フルフィルメントの試行が完了した後、ページをレンダリングします。

ランディングページをレンダリングする際、以下を表示できます。

• フルフィルメントプロセスの詳細。
• 顧客が現在アクセスできるサービスのリンクまたは情報。
• 物品の配送またはロジスティクスの詳細。