注文のフルフィルメント

支払いを正常にフルフィルメントするための関数をサーバー上に作成します。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_4eC39HqLyjWDarjtT1zdp7dc'

  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 イベントが作成されます。これらのイベントの受け付け、処理、受領確認を行うように、サーバー上のエンドポイントを設定します。

ACH Direct Debit やその他の銀行振込など、一部の決済手段は即時ではありません。Checkout が完了しても、売上はすぐ利用できるようにはなりません。決済手段が遅延した場合、後で支払いが成功すると checkout.session.async_payment_succeeded イベントが生成されます。

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_...) をイベント処理コードに追加し、顧客として Checkout を実行してフルフィルメントをテストします。

• 購入ボタンを押して Checkout に進むか、決済用リンクにアクセスします。
• Checkout で次のテストデータを指定します。
  • カード番号として 4242 4242 4242 4242 を入力する
  • カードの有効期限として将来の任意の日付を入力する
  • 3 桁の任意のセキュリティコードを入力する
  • 請求先の任意の郵便番号 (90210) を入力する
• 支払うボタンを押します。

支払いが完了したら、次の点を確認します。

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

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

Checkout を設定することで、顧客の決済完了後にお客様のウェブサイトのページを送信します。ページの URL に {CHECKOUT_SESSION_ID} プレースホルダーを含めると、顧客が Checkout からリダイレクトされるときにプレースホルダーが Checkoutセッション ID に置き換えられます。

ホストされた Checkout

デフォルトの ui_mode が hosted の Checkout セッションでは、success_url を設定します。

curl https://api.stripe.com/v1/checkout/sessions \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d "line_items[0][price]"=
{{PRICE_ID}} \
  -d "line_items[0][quantity]"=1 \
  -d mode=payment \
  --data-urlencode success_url="https://example.com/after-checkout?session_id={CHECKOUT_SESSION_ID}"

Payment Links

API を使用して作成する Payment Links の場合、after_completion.redirect.url を設定します。

curl https://api.stripe.com/v1/payment_links \
  -u "
sk_test_4eC39HqLyjWDarjtT1zdp7dc
:" \
  -d "line_items[0][price]"=
{{PRICE_ID}} \
  -d "line_items[0][quantity]"=1 \
  -d "after_completion[type]"=redirect \
  --data-urlencode "after_completion[redirect][url]"="https://example.com/after-checkout?session_id={CHECKOUT_SESSION_ID}"

Payment Links の場合、次のようにダッシュボードで作成します。

1. 支払い後タブに移動します。
2. 確認ページを表示しないを選択します。
3. {CHECKOUT_SESSION_ID} プレースホルダーが含まれたランディングページの URL を指定します (例: https://example.com/after-checkout?session_id={CHECKOUT_SESSION_ID})。

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

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

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

ランディングページをレンダリングすると、次の情報を表示できます。

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