Stripe-Context ヘッダー
関連するアカウントに対して API 操作を実行します。
デフォルトでは、API リクエストは、付随する API キーを生成した Stripe アカウントで実行されます。ただし、Stripe-Context ヘッダーを使用して、関連するアカウントのコンテキストで API リクエストを実行することは可能です。
注
Stripe-Context ヘッダーは Stripe-Account ヘッダーよりも優先されるため、連結アカウントに対する API 操作の実行が容易になります。Stripe-Context によって、アクセスできる関連アカウントの範囲と種類が拡張されます。
API リクエストの範囲
次のように、さまざまなスコープ内で実行される API リクエストを作成できます。
- 自分のアカウント
- プラットフォームの任意の連結アカウント
- 加盟店または受取人の設定を含む任意の v2 アカウント
API キーの所有アカウント以外のアカウントに API リクエストを行う場合は、Stripe-Context ヘッダーを含めて対象のアカウントを指定する必要があります。この値は、リクエストに使用した API キーと対象アカウントの相対関係によって異なります。
さまざまな事業を代表するプラットフォームアカウントを複数持つ組織を例に考えてみましょう。各プラットフォームには連結アカウントがあり、さらに各連結アカウントには受取人アカウントがあります。
このビジネス構造では、さまざまなスコープを使用して API リクエストを実行できます。次の表は、リクエストした API キーを所有するアカウントとの関係に基づいてコンテキストが必要になるスコープの Stripe-Context 形式を示しています。
| リクエストした API キーの所有者 | アカウントのスコープ | Stripe-Context 形式 |
|---|---|---|
| Rocket Rides | Driver Smith | 連結アカウント ID: acct_ |
| Rocket Deliveries | Courier Vega | 連結アカウント ID: acct_ |
| Rocket Rides | Fuel City | 連結アカウント ID / 受取人 ID: acct_ |