コンテンツにスキップ
アカウントを作成
または
サインイン
Stripe ドキュメントのロゴ
/
アカウントを作成
サインイン

注

このページはまだ日本語ではご利用いただけません。より多くの言語で文書が閲覧できるように現在取り組んでいます。準備が整い次第、翻訳版を提供いたしますので、もう少しお待ちください。

Connect Webhook

Connect で Webhook を使用して Stripe アクティビティの通知を受ける方法をご紹介します。

アカウントでイベントが発生すると、Stripe は Webhook を使用してアプリケーションに通知します。すべての Connect の組み込みでは、Webhook エンドポイントを設定して、Connect イベントをリッスンする必要があります。

Connect Webhook

Webhook にはいくつかのタイプがあります。

  • 「アカウント」Webhook は、自身のアカウントでのアクティビティー (API キーを使用し、別の Stripe アカウントとしての認証なしで行われるほとんどのリクエストなど) 用です。これには、連結アカウントで直接行われたものを除き、すべてのタイプの支払いが含まれます。
  • _「Connect」_Webhook は、連結アカウントでのアクティビティー用です。連結アカウントのすべてのイベントは Connect Webhook に送信されます。連結アカウントとダイレクト支払いに関する重要な account.updated イベントが含まれます。

Webhook を作成する際には、Connect Webhook イベントを受信するように正しく設定されていることを確認してください。これを行うには、API で Webhook エンドポイントの作成時に connect パラメーターを true に設定するか、ダッシュボードを使用します。

Stripe ダッシュボードでの Webhook の設定

Connect Webhook の場合、開発環境の Webhook URL にはテスト Webhook のみが送信されますが、本番環境の Webhook URL には「本番とテストの両方」の Webhook が送信されます。これは、本番環境のアプリケーションでは、本番取引とテスト取引の両方を実行できるためです。このため、イベントの Webhook を受信した際に livemode の値を確認して、ユーザーがとるべきアクションを把握することをお勧めします。

Event (イベント) オブジェクトのリファレンスに記載されているように、連結アカウントの各イベントには、最上位の account プロパティーも含まれます。このプロパティーは、Webhook の送信先のアカウントと、そのアカウントが属する data[object] を識別します。これらのオブジェクトは別のアカウントに属しているため、アクセスするには、対応する連結アカウントとして API リクエストを行う必要があります。

{
  "id": 
"{{EVENT_ID}}"
,
  "livemode": true,
  "object": "event",
  "type": "customer.created",
  "account": 
"{{CONNECTED_ACCOUNT_ID}}"
,
  "pending_webhooks": 2,
  "created": 1349654313,
  "data": {...}
}

アカウントに関連するイベントでリッスンが推奨されるものを以下に示します。

イベントdata.object type説明
account.application.deauthorizedapplication連結アカウントがプラットフォームから連結を解除すると発生します。これを使用してサーバーでクリーンアップをトリガーできます。Stripe ダッシュボードにアクセスできる連結アカウント (Standard アカウントを含む) に適用されます。
account.external_account.updatedcard やbank_account などの外部口座連結アカウントに関連付けられた銀行口座またはデビットカードが更新された場合に発生し、入金に影響することがあります。プラットフォームで管理される連結アカウントに適用されます。これには、Custom アカウントと Express アカウント、およびプラットフォーム管理が有効な Standard アカウントが含まれます。
account.updatedaccount連結アカウントの要件に対する変更とステータスの変化を監視できます。すべての連結アカウントで利用可能です。
balance.availablebalanceStripe の残高が更新されたときに発生します (銀行口座から追加した資金が連結アカウントへの送金に利用できるようになったときなど)。
payment_intent.succeededpayment_intent支払いインテント (PaymentIntent) で支払いが成功した場合に発生します。デスティネーション支払いとダイレクト支払いを含むすべての支払いで利用可能です。
payout.failedpayoutOccurs when a payout fails. When a payout fails, the external account involved is disabled, and no automatic or manual payouts can be processed until the external account is updated.
person.updatedpersonPersons API を使用すると、個人の要件の変更とステータスの変更を監視できるようになります。プラットフォームで管理される連結アカウントに適用されます。これには、Custom アカウントと Express アカウント、およびプラットフォーム管理が有効な Standard アカウントが含まれます。
server.rb
# Using Sinatra.
require 'sinatra'
require 'stripe'

set :port, 4242

# 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_09l3shTSTKHYCzzZZsiLl2vA'


# If you are testing your webhook locally with the Stripe CLI you
# can find the endpoint's secret by running `stripe listen`
# Otherwise, find your endpoint's secret in your webhook settings in
# the Developer Dashboard
endpoint_secret = 'whsec_...'

post '/webhook' do
  payload = request.body.read
  sig_header = request.env['HTTP_STRIPE_SIGNATURE']

  event = nil

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

  if event['type'] == 'account.application.deauthorized'
    application = event['data']['object']
    connected_account_id = event['account']
    handle_deauthorization(connected_account_id, application)
  end

  status 200
end

def handle_deauthorization(connected_account_id, application)
  # Clean up account state.
  puts 'Connected account ID: ' + connected_account_id
  puts application.to_s
end

上記のイベントは、構築済みの Connect でリッスンが推奨される典型的なイベントですが、その他多くのイベントタイプもご利用いただけます。

Webhook をローカルでテストする

Stripe CLI を使用して、Webhook をローカルでテストできます。

  1. まだインストールしていない場合は、マシンに Stripe CLI をインストールします。

  2. Stripe アカウントにログインし、コマンドラインで stripe login を実行して CLI を設定します。

  3. 1 つの端末ウィンドウで stripe listen --forward-to localhost:{PORT}/webhook を実行し、別の端末ウィンドウで stripe trigger {{EVENT_NAME}} を実行することにより、ローカルホストがシミュレーションされたイベントを連結アカウントで受信できるようにします。

注

Connect Webhook では、stripe listen で –forward-connect-to を使用し、stripe trigger で –stripe-account を使用します。

参照情報

このページはお役に立ちましたか。
はいいいえ
お困りのことがございましたら 、サポートにお問い合わせください。
早期アクセスプログラムにご参加ください。
Stripe の製品変更ログを確認してください。
ご不明な点がございましたら、お問い合わせください。
Powered by Markdoc