連結アカウントに対する API コールを実行する

連結アカウントに対して API コールを実行できます。

• リクエストごとに、Stripe-Account ヘッダーと連結アカウントの ID を使用してサーバ側で実行
• 連結アカウントの ID を引数としてクライアントライブラリに渡して、クライアント側で実行

パフォーマンスと信頼性を高めるために、Stripe では API エンドポイントに対してレート制限と割り当てを設定しています。

サーバー側で Stripe-Account ヘッダーを追加する

連結アカウントに対してサーバー側の API コールを実行するには、acct_ で始まるアカウント ID を指定した Stripe-Account ヘッダーを使用します。プラットフォームの API シークレットキーと連結アカウントの Account (アカウント) ID を使用する 4 つの例を以下に示します。

curl https://api.stripe.com/v1/payment_intents \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  -d amount=1000 \
  -d currency=usd

URL に Stripe アカウント ID を含む API リクエストのすべてで、Stripe-Account ヘッダーによる方法が必要になります。下記は、URL 内のユーザーのアカウント ID を使用してアカウントを取得する方法を示す例です。

curl https://api.stripe.com/v1/accounts/
{{CONNECTED_ACCOUNT_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

Stripe のすべてのサーバ側ライブラリでは、この方法がリクエストごとにサポートされます。

curl https://api.stripe.com/v1/customers \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -H "Stripe-Account: 
{{CONNECTED_ACCOUNT_ID}}
" \
  --data-urlencode email="person@example.com"

クライアント側の申し込みに連結アカウントの ID を追加する

クライアント側ライブラリでは、連結アカウントの ID がクライアントアプリケーションへの引数として設定されます。

var stripe = Stripe(
'pk_test_TYooMQauvdEDq54NiTphI7jx', {
  stripeAccount: 
{{CONNECTED_ACCOUNT_ID}},
});

Connect 埋め込みコンポーネントの使用

Stripe の API と直接連携する代わりに、連結する埋め込みコンポーネントを使用して、プラットフォームの UI で連結アカウントに Stripe 機能を提供できます。これらのコンポーネントでは、すべての API コールを内部で実装して処理するためのコードが少なくて済みます。

たとえば、連結アカウントに Payments データを表示するには、プラットフォームの UI に 決済コンポーネントを埋め込みます。これにより、Charges、Payment Intents、Refunds、および Disputes API を個別に呼び出す必要がなくなります。

使用可能な埋め込みコンポーネントの一覧については、対応コンポーネントをご覧ください。