Stripe-Context-Header
Führen Sie API-Vorgänge für verbundene Konten durch.
Standardmäßig werden API-Anfragen für das Stripe-Konto ausgeführt, das den zugehörigen API-Schlüssel generiert hat. Sie können jedoch den Stripe-Context
-Header verwenden, um eine API-Anfrage im Kontext eines verbundenen Kontos durchzuführen.
Notiz
Der Stripe-Context
-Header ersetzt den Stripe-Account
-Header, was die Durchführung von API-Vorgängen für verbundene Konten erleichtert. Stripe-Context
erweitert den Umfang und die Arten der verbundenen Konten, auf die sie zugreifen können.
Umfang der API-Anfrage
Sie können API-Anfragen stellen, um in verschiedenen Bereichen zu arbeiten:
- Ihr eigenes Konto
- Alle verbundenen Konten auf Ihrer Plattform
- Jedes v2-Konto mit mindestens der Händler- oder Empfängerkonfiguration
Wenn Sie eine API-Anfrage stellen, die auf ein anderes Konto als das des API-Schlüssels abzielt, müssen Sie das gewünschte Konto ermitteln, indem Sie den Stripe-Context
-Header einfügen. Der Wert hängt von der relativen Beziehung des gewünschten Kontos zu dem für die Anfrage verwendeten API-Schlüssel ab.
Stellen Sie sich beispielsweise eine Organisation mit mehreren Plattformkonten vor, die verschiedenen Unternehmensbereichen entsprechen. Jede Plattform verfügt über verbundene Konten und ein verbundenes Konto hat ein Empfängerkonto.
Angesichts dieser Unternehmensstruktur ist es möglich, API-Anfragen mit mehreren verschiedenen Bereichen durchzuführen. Die folgende Tabelle zeigt das Stripe-Context
-Format für jeden Bereich, der Kontext basierend auf seiner Beziehung zu dem Konto benötigt, zu dem der anfordernde API-Schlüssel gehört.
Inhaber/in des API-Schlüssels anfordern | Bereich des Kontos | Stripe-Context-Format |
---|---|---|
Rocket Rides | Fahrer Smith | ID des verbundenen Kontos: acct_ |
Rocket Deliveries | Kurier Vega | ID des verbundenen Kontos: acct_ |
Rocket Rides | Kraftstoff-Stadt | ID des verbundenen Kontos/Empfänger-ID: acct_ |
Anwendungsbeispiele
Das folgende Codebeispiel zeigt eine Anfrage, mit der die US-Plattform Rocket die verfügbaren Bankkonten für den/die Empfänger/in ihres verbundenen Kontos abruft. Da es sich bei dem/der Empfänger/in um das Enkelkind der Plattform handelt, wird für den Kontext das Format <connected account ID>/<recipient ID>
verwendet.