共有決済トークン非公開プレビュー

共有決済トークン (SPT) は、エージェントが回収した顧客の決済手段を企業側で受け付けるのを支援します。エージェントは使用制限と有効期限付きの SPT をあなたのビジネスに付与します。

共有決済トークンの作成

売り手は、テストヘルパーを使用して、エージェントによって付与された SPT の受け取りをシミュレーションできます。これにより、SharedPaymentToken オブジェクトが付与されます。次のコード例は、テスト用の PaymentMethod を使用してアカウントに SPT を付与し、通貨、最大金額、有効期限など、エージェントが指定できる制限をシミュレーションする方法を示します。

curl https://api.stripe.com/v1/test_helpers/shared_payment/granted_tokens \
  -u 
"sk_test_BQokikJOvBiI2HlWgH4olfQ2" \
  -d payment_method=pm_card_visa \
  -d "usage_limits[currency]"=usd \
  -d "usage_limits[max_amount]"=10000 \
  -d "usage_limits[expires_at]"={{TIME_IN_FUTURE}} \
  -d "seller_details[network_id]"=internal \
  -d "seller_details[external_id]"={{ANY_STRING}}

利用限度

usage_limits パラメーターは、最大金額と有効期限を指定します。エージェントは、取引の合計金額と一致するように最大金額を設定します。

売り手の詳細

seller_details パラメーターは、SPT の範囲をお客様または別の販売者に設定します。

• network_id: 売り手のネットワーク ID。
• external_id: SPT を特定の販売者、カート、その他の識別子に紐付ける任意の識別子です。たとえば、Connect プラットフォームとやり取りするエージェントは external_id を使用して SPT の範囲を連結アカウントに限定できます。

決済手段

payment_method パラメーターは、顧客が購入に使用するために選択した決済手段を指定します。

共有支払いトークンの使用

付与された SharedPaymentToken を受け取ったら、PaymentIntent を作成して決済を完了します。

curl https://api.stripe.com/v1/payment_intents \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d amount=10000 \
  -d currency=usd \
  -d shared_payment_granted_token=spt_123 \
  -d confirm=true

SPT で PaymentIntent を確定すると、顧客の元の決済手段から複製された新しい PaymentMethod に payment_method が設定されます。返金やレポート作成などの後続のイベントは、PaymentMethod を直接指定したかのように動作します。付与された SharedPaymentToken の詳細を取得できます。これには、使用する決済手段に関する制限付き情報 (カードブランドや末尾 4 桁など) および使用状況の制限が含まれます。

curl https://api.stripe.com/v1/shared_payment/granted_tokens/{id} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

{
  "id": "spt_1RgaZcFPC5QUO6ZCDVZuVA8q",
  "object": "shared_payment.granted_token",
  "created": 1751500820,
  "deactivated_at": null,
  "deactivated_reason": null,
  "usage_limits": {
    "currency": "usd",
    "expires_at": 1751587220,
    "max_amount": 1000
  }
}

Webhook イベントのリッスン

Stripe は、以下の場合にお客様とエージェントにイベントを送信します。

• 承認された SPT を使用して決済を受け付けます。
• エージェントは許可された SPT を取り消します。取り消した SPT で決済を作成することはできません。