En-tête Stripe-Context

Effectuer des opérations d’API sur des comptes associés.

Par défaut, les requêtes API sont exécutées sur le compte Stripe qui a généré la clé API associée. Cependant, vous pouvez utiliser l’en-tête Stripe-Context pour effectuer une requête API dans le contexte d’un compte associé.

Remarque

L’en-tête Stripe-Context remplace l’en-tête Stripe-Account, ce qui facilite l’exécution d’opérations d’API sur les comptes connectés. Stripe-Context élargit le champ d’application et les types de comptes associés auxquels ils peuvent accéder.

Champ d’application de la requête API

Vous pouvez effectuer des requêtes API pour opérer dans différents champs d’application :

Votre propre compte
Tous les comptes connectés de votre plateforme
Tout compte v2 avec au moins la configuration de marchand ou de bénéficiaire

Lorsque vous effectuez une requête API ciblant un compte autre que celui de la clé API, vous devez identifier le compte visé en incluant l’en-tête Stripe-Context. La valeur dépend de la relation relative entre le compte visé et la clé API utilisée pour effectuer la requête.

Prenons l’exemple d’une organisation possédant plusieurs comptes de plateforme représentant différents secteurs d’activité. Chaque plateforme a des comptes connectés et un compte connecté a un compte de bénéficiaire.

Compte tenu de cette structure d’entreprise, il est possible d’effectuer des requêtes API à l’aide de plusieurs champs d’application différents. Le tableau suivant indique le format Stripe-Context pour chaque champ d’application nécessitant un contexte en fonction de sa relation avec le compte auquel appartient la clé API requérante.

Propriétaire de la clé API requérante	Champ d’application du compte	Format Stripe-Context
Rocket Rides	Conducteur Smith	ID du compte connecté : `acct_111a`
Rocket Deliveries	Coursier Vega	ID du compte connecté : `acct_333a`
Rocket Rides	Ville d’achat du carburant	ID du compte connecté/ID du bénéficiaire : `acct_111a/acct_111b`

Exemples de cas d’usage

L’exemple de code suivant montre une requête dans laquelle la plateforme Rocket US récupère les comptes bancaires disponibles pour le bénéficiaire de son compte connecté. Le bénéficiaire étant le petit-enfant de la plateforme, le contexte utilise le format <connected account ID>/<recipient ID>.

Command Line
curl
curl https://api.stripe.com/v2/core/vault/us_bank_accounts \
  -H "Authorization: Bearer {{PLAT_SECRET_KEY}}" \
  -H "Stripe-Version: 2025-03-31.preview" \
  -H "Stripe-Context: acct_111a/acct_111b"