Die Accounts v2 API in Ihrer vorhandenen Integration verwenden
Sie erfahren, wie Sie Integrationen aktualisieren, die auf Accounts v1 und Customers v1 basieren.
Befolgen Sie diesen Leitfaden, wenn Sie die Integration Ihrer Accounts v1- und Customers v1 Connect-Plattformintegration aktualisieren möchten, um Zugriff auf die folgenden Accounts v2-Funktionen zu erhalten:
- Verknüpfen Sie Ihre verbundenen Konten mit Zahlungen, die sie an Ihre Plattform leisten, ohne Customer-Objekte zu erstellen.
- Vermeiden Sie Netzwerkkosten, indem Sie verbundenen Konten erlauben, Ihre Plattform mit ihrem Stripe-Guthaben zu bezahlen.
- Aktivieren Sie in Ihren verbundenen Konten, dass sie Gelder auf Ihrer Plattform mit v2 Financial Accounts halten dürfen.
Wenn Sie keine Accounts v2-Funktionen benötigen, können Sie weiterhin Ihre Accounts v1 und Customers v1-Plattformintegration verwenden.
v2-Endpoints für alle Ihre Konten verwenden
Sie können die Accounts v2 API mit Ihren bestehenden v1-Accounts verwenden, ohne diese zu ändern.
Verzögerung bei der Kontoerstellung
Es kann bis zu 10 Minuten dauern, bis ein neues v1-Account mit einem Accounts v2-Endpoint verwendet werden kann. Wenn das Account bereit ist, API v2-Anfragen zu empfangen, sendet es das Webhook-Ereignis v2..
Kundenkonfiguration hinzufügen
Durch Hinzufügen der customer-Konfiguration zu einem Account-Objekt können Sie die Account ID in jeder API-Anfrage angeben, die eine Customer ID akzeptiert, z. B. beim Erstellen eines Abos. Anstatt eine Customer ID im Parameter customer anzugeben, geben Sie die Account ID im Parameter customer_ an.
Im folgenden Beispiel wird die Accounts v2 API verwendet, um die customer-Konfiguration zu einem bestehenden v1 Account hinzuzufügen, und dann ein bestehendes Abo zur Abbuchung vom Konto über das Stripe-Guthaben aktualisiert.
- Aktualisieren Sie das
Account-Objekt, um diecustomer-Konfiguration hinzuzufügen.
- Retrieve the connected account to confirm it has the
card_capability in the merchant configuration. This capability must be active in order to use the Stripe balance as a payment method.payments
- Add the connected account’s Stripe balance as a payment method.
- Create a subscription that charges the connected account using its Stripe balance.
Sie müssen kein separates Customer-Objekt mehr führen, um Abozahlungen von diesem verbundenen Konto zu akzeptieren.
Ihre Integration schrittweise umstellen
Da Sie sowohl die Accounts v1 API als auch die v2 API mit Ihren Accounts verwenden können, können Sie Ihre Integration in dem Tempo aktualisieren, wie es für Ihr Unternehmen passt. Beispielsweise können Sie:
- Rufen Sie
/v2/core/accounts-Endpoints fürAccountsauf, die mit API v1 erstellt wurden. - Rufen Sie
/v1/accounts-Endpoints fürAccountsauf, die mit API v2 erstellt wurden. - Rufen Sie
/v1/customers-Endpoints fürAccountsmit der Kundenkonfiguration auf. - Verwenden Sie die Events API v2, um auf Änderungen an Objekten zu warten, die mit einer der beiden API-Versionen erstellt wurden.
Mit diesen Kompatibilitäten können Sie Ihre Integration schrittweise aktualisieren, ohne mehrere Versionen gleichzeitig in der Produktion beizubehalten oder Ihre gesamte Integration auf einmal zu aktualisieren.
Wir empfehlen, Ihre Integration in dieser Reihenfolge zu aktualisieren:
- Richten Sie einen neuen Endpoint ein, um auf v2-Ereignisse zu warten.
- Ändern Sie Ihre
create-Aufrufe fürAccountundCustomer, umAccountsmit Kundenkonfiguration unter Verwendung von/v2/core/accountszu erstellen. - Ändern Sie Ihre
update-Aufrufe fürAccountundCustomer, um/v2/core/accountszu verwenden. - Ändern Sie Ihre
retrieve-Aufrufe fürAccountundCustomer, um/v2/core/accountszu verwenden.
v2-Account-Objekte in v1-Endpoints verwenden
Wenn Sie in v1-Endpoints auf v2-Objekte verweisen, gibt die Antwort die v2-Daten in der v1-Objektstruktur zurück. Beispiel:
- Durch Verweisen auf ein v2-
Account-Objekt in einem Endpoint/v1/accountswerden die Daten in der Struktur eines v1-Account-Objekts zurückgegeben. - Durch Verweisen auf ein v2-
Account-Objekt in einem Endpoint/v1/customerswerden die Daten in der Struktur eines v1-Customer-Objekts zurückgegeben, die sowohl diecustomerID als auch diecustomer_ID enthält.account
Sie können Account-Objekte mit Kundenkonfiguration in der Customers v1 API verwenden, aber Sie können in der Accounts v2 API nicht auf v1-Customer-Objekte verweisen. Sie müssen Kundendaten entweder in ein neues Account-Objekt mit Kundenkonfiguration migrieren oder ein bestehendes verbundenes Konto aktualisieren, um die customer-Konfiguration hinzuzufügen.
Webhook-Ereignisse
Accounts senden sowohl v1-Ereignisse (Snapshot) als auch v2-Ereignisse (Thin). Wir empfehlen, einen neuen Endpoint einzurichten, um Accounts v2-Ereignisse zu überwachen.
- Öffnen Sie in Ihrem Stripe-Dashboard das Menü „Entwickler/innen“, indem Sie in der Fußzeile des Navigationsmenüs auf Entwickler/innen klicken und dann Webhooks auswählen.
- Klicken Sie auf + Ziel hinzufügen.
- Wählen Sie im Abschnitt Ereignisse aus die Option Verbundene Konten aus.
- Wählen Sie Erweiterte Optionen anzeigen aus. Wählen Sie im Abschnitt „Nutzlast-Stil“ die Option Thin aus.
- Wählen Sie im Feld „Ereignisse“ ein oder mehrere Ereignisse aus, die der Version des
Account-Objekts entsprechen:- Geben Sie für v1 „v1“ ein, um nach v1-Objektereignistypen zu suchen. Wählen Sie v1.account.updated aus.
- Geben Sie für v2 „v2“ ein, um nach v2-Objektereignistypen zu suchen. Wählen Sie v2.core.account.updated oder ein anderes v2.core.account[*].updated-Ereignis aus.
- Fahren Sie mit der Einrichtung Ihres Ereignisziels fort, indem Sie dem interaktiven Webhook-Endpoint-Generator folgen.
Beispielsweise kann bei der Aktualisierung eines Account-Objekts einer der Versionen Folgendes gesendet werden:
- Ein v1-Ereignis
account.updated - Ein v2-Ereignis
v1.account. updated - Ein v2-Ereignis
v2.core. account. updated
Unterschiede der Account-Version in der Events v2 API
Die meisten Ereignistypen von v2. entsprechen nicht direkt den Ereignistypen von v1.. Wenn Sie beispielsweise eine Eigenschaft für ein Account ändern, wird das Ereignis v1. ausgelöst. Dieselbe Aktion kann jedoch eigenschaftenspezifische Ereignisse für v2 auslösen, wie z. B. v2. oder v2..
Wir senden das Ereignis v2. nur für Aktualisierungen von Top-Level-Eigenschaften wie dashboard oder display_, die keines der spezifischeren Aktualisierungsereignisse auslösen.
Einschränkungen der Accounts API v2
In den folgenden Fällen müssen Sie Accounts v1 verwenden:
- Mit OAuth verbundene Konten
- Konten, für die ein Rahmenvertrag für Empfänger/innen unterzeichnet wurde
- Zur Anfrage oder Verwaltung der folgenden Funktionen:
treasurycard_issuing_ * - eingestellte Funktionen wie
legacy_payments - eingestellte Zahlungsmethoden
- Zahlungsmethoden in der öffentlichen oder privaten Vorschau
Grenzüberschreitende Auszahlungen
Verwenden Sie Global Payouts für grenzüberschreitende Auszahlungen.