Onboarding Ihres verbundenen Kontos
Laden Sie Ihre verbundenen Konten zum Onboarding in Ihrem Marktplatz ein.
Nachdem Sie ein verbundenes Konto erstellt und vorab ausgefüllt haben, erstellen Sie einen Konto-Link und senden Sie diesen an die/den Kontonutzer/in, damit diese/r den Onboarding-Prozess abschließen kann. Ein Konto-Link ist eine einmalig verwendbare URL, über die ein verbundenes Konto auf den Connect-Onboarding-Prozess zugreifen kann.
Alternativ können Sie auch einen benutzerdefinierten Onboarding-Prozess mithilfe eingebetteter Komponenten oder der API erstellen. Um Compliance und Wartung zu optimieren, verwenden Sie Konto-Links oder erstellen Sie Ihren eigenen Onboarding-Prozess mit eingebetteten Komponenten. In diesem Leitfaden werden Konto-Links verwendet.
Der Connect-Onboarding-Prozess fordert Ihr verbundenes Konto nicht zur Eingabe von Informationen auf, die Sie bereits vorab ausgefüllt haben. Allerdings wird das verbundene Konto aufgefordert, die vorab ausgefüllten Informationen zu bestätigen, bevor es den Connect-Rahmenvertrag akzeptiert.
Hinweis
Von Stripe gehostetes Onboarding wird nur in Webbrowsern unterstützt. Sie können es nicht in eingebetteten Webansichten in mobilen oder Desktop-Anwendungen verwenden.
Entscheiden, ob alle Informationen sofort erfasst werden sollen
Sie als Plattform müssen entscheiden, ob die erforderlichen Informationen von den verbundenen Konten vorab oder inkrementell erfasst werden sollen. Beim Onboarding im Voraus werden die eventually_-Anforderungen für das Konto erfasst, während beim inkrementellen Onboarding nur die currently_-Anforderungen erfasst werden.
| Onboarding-Typ | Vorteile |
|---|---|
| Im Voraus |
|
| Inkrementell |
|
Um zu bestimmen, ob Sie das Onboarding im Voraus oder inkrementelles Onboarding nutzen möchten, überprüfen Sie die Anforderungen für die Standorte und Funktionen Ihrer verbundenen Konten. Auch wenn Stripe versucht, etwaige Auswirkungen auf verbundene Konten zu minimieren, können sich Anforderungen im Laufe der Zeit ändern.
Für verbundene Konten, bei denen Sie für den Einzug der Anforderungen verantwortlich sind, können Sie das Verhalten von future requirements mit dem Parameter collection_ anpassen. Um die zukünftigen Anforderungen des Kontos zu erfassen, setzen Sie collection_options.future_requirements auf include.
Konto-Link erstellen
Erstellen Sie einen Konto-Link unter Verwendung der ID des verbundenen Kontos und fügen Sie eine use_case.account_onboarding.refresh_url und eine use_case.account_onboarding.return_url hinzu.
Stripe leitet das verbundene Konto zur Aktualisierungs-URL weiter, wenn die Konto-Link-URL bereits aufgerufen wurde, abgelaufen oder aus anderen Gründen ungültig ist. Stripe leitet sie zur Rückgabe-URL weiter, wenn sie den Onboarding-Prozess abgeschlossen oder verlassen haben.
Zusätzlich geben Sie, abhängig davon, ob Sie alle Informationen sofort oder schrittweise erfassen möchten, entweder eventually_ oder currently_ in use_ an. In diesem Beispiel wird eventually_ verwendet, um sowohl die currently_- als auch die eventually_-Anforderungen direkt im Rahmen des vollständigen Onboardings zu erfüllen. Für schrittweises Onboarding geben Sie currently_ an, um nur die currently_-Anforderungen sofort zu erfassen.
| Parameter | Wert | Beschreibung |
|---|---|---|
| account | Die ID des verbundenen Kontos | Bitte geben Sie hier die ID des verbundenen Kontos an, für das Sie einen Konto-Link erstellen möchten. |
| use_case.type | account_ | Stellt ein Formular bereit, um alle erforderlichen Informationen zu erfassen. |
| use_case.account_onboarding.configurations | recipient | Legt die Konfigurationen für das verbundene Konto fest. In diesem Fall bedeutet die recipient-Konfiguration, dass Sie Gelder an das verbundene Konto auszahlen können. |
| use_case.account_onboarding.return_url | Eine gültige URL | Die URL, zu der die Nutzerin/der Nutzer weitergeleitet werden soll, nachdem sie/er den Onboarding-Prozess verlassen oder abgeschlossen hat. |
| use_case.account_onboarding.refresh_url | Eine gültige URL | Die URL, zu der die Nutzerin/der Nutzer weitergeleitet wird, wenn der Konto-Link abgelaufen ist, zuvor besucht wurde oder aus anderen Gründen ungültig ist. Verwenden Sie diese URL, um einen neuen Konto-Link mit denselben Parametern zu generieren, die Sie zum Erstellen des ursprünglichen Konto-Links verwendet haben. |
Leiten Sie Ihr verbundenes Konto zum Onboarding-Prozess weiter
Geben Sie die Konto-Link-URL an, um Ihr verbundenes Konto an den Onboarding-Prozess weiterzuleiten. Jede Konto-Link-URL kann nur einmal verwendet werden, da sie Zugriff auf die persönlichen Daten der Kontoinhaberin/des Kontoinhabers gewährt.
Sicherheitshinweis
Versenden Sie keine Konto-Link-URLs per E-Mail, Textnachricht oder anderweitig außerhalb Ihrer Plattformanwendung. Stellen Sie die URLs Ihren authentifizierten Kontoinhaberinnen und Kontoinhabern stattdessen in Ihrer Anwendung zur Verfügung.
Aktualisierungen der Anforderungen identifizieren und adressierenServerseitig
Richten Sie Ihre Integration so ein, dass Änderungen der Kontoanforderungen überwacht werden. Sie können den Umgang mit neuen Anforderungen (und wie diese möglicherweise Zahlungen und Auszahlungen deaktivieren) mit den Test-Auslöserkarten testen.
Senden Sie ein verbundenes Konto über das Onboarding zurück, wenn es currently_- oder eventually_-Anforderungen erfüllt. Sie müssen die spezifischen Anforderungen nicht identifizieren, da die Onboarding-Schnittstelle weiß, welche Informationen sie erfassen muss. Wenn beispielsweise ein Tippfehler die Verifizierung der Identität des Kontoinhabers/der Kontoinhaberin verhindert, fordert das Onboarding ihn/sie auf, ein Identitätsdokument hochzuladen.
Stripe benachrichtigt Sie über alle bevorstehenden Aktualisierungen der Anforderungen, die sich auf Ihre verbundenen Konten auswirken. Sie können diese Informationen proaktiv erfassen, indem Sie die Anforderungen Ihrer Konten überprüfen, die einen requested_reasons.code von future_ aufweisen.
Für verbundene Konten, bei denen Stripe für das Erfassen von Anforderungen verantwortlich ist, erhalten Sie keine Updates mehr für Identitätsangaben, nachdem Sie einen Konto-Link oder eine Kontositzung erstellt haben.
Konten speichern Identitätsinformationen im Hash identity.
Migrieren eines Marktplatzes von Accounts v1 zu Accounts v2
Erstellen Sie für neue Konten ein Ereignisziel, um auf v2.core.account[requirements].updated-Ereignisse zu achten. Ihre vorhandenen verbundenen Konten lösen sowohl v1- als auch v2-Ereignisse aus, sodass Ihre Integration diese verwalten kann, indem sie auf v1.-v2-Ereignisse anstelle von account.-v1-Ereignisse achtet.
Verifizierungsfehler handhaben
Achten Sie auf das Ereignis v2.core.accounts[Anforderungen].updated. Enthält das Konto Anforderungen mit einem minimum_deadline.Status von currently_, wird beim Erreichen der Frist die entsprechende Funktionalität deaktiviert und diese Status werden zu past_.
Lassen Sie Ihre Konten die Verifizierungsanforderungen regeln, indem Sie sie an das von Stripe gehostete Onboarding-Formular leiten.
Rückkehr der Nutzer/innen zu Ihrer Plattform abwickeln
Connect Onboarding verlangt, dass Sie sowohl eine return_ als auch eine refresh_ übergeben, um alle Fälle steuern zu können, in denen die Nutzer/innen an Ihre Plattform zurückgeleitet werden. Es ist wichtig, dass Sie diese URLs korrekt implementieren, um Ihren Nutzern/innen die bestmögliche Erfahrung zu bieten.
Hinweis
Sie müssen HTTPS für Ihre return_ und refresh_ verwenden, sowohl in Produktions- als auch in Testumgebungen (z. B. zum Testen mit localhost). Die Erstellung des Konto-Links schlägt fehl, wenn Sie HTTP verwenden.
Rückgabe-URL
Stripe leitet das verbundene Konto zurück zu dieser return_url, wenn sie den Onboarding-Ablauf abschließen oder an einer beliebigen Stelle des Ablaufs auf Für später speichern klicken. Dies bedeutet nicht, dass alle Informationen erfasst wurden oder dass es keine ausstehenden Anforderungen für das Konto gibt. Es bedeutet lediglich, dass der Ablauf ordnungsgemäß gestartet und verlassen wurde.
Diese URL überträgt keinen Status. Nachdem ein verbundenes Konto zur return_ weitergeleitet wurde, prüfen Sie, ob das Konto das Onboarding abgeschlossen hat, indem Sie entweder:
- Abrufen des Kontos und Überprüfen desAnforderungs-Hash für ausstehende Anforderungen.
- Den Status des Kontos in Ihrer Anwendung zwischenspeichern und durch Abhören des
v2.-Ereignisses aktuell halten.core. account[requirements]. updated
Wenn das Onboarding unvollständig ist, stellen Sie in Ihrer Anwendung Hinweise bereit, damit das Konto das Onboarding später fortsetzen kann.
URL aktualisieren
Stripe leitet den Kontobenutzer in den folgenden Fällen zur refresh_url weiter:
- Der Link ist abgelaufen (einige Minuten sind seit der Erstellung des Links vergangen).
- Die Nutzerin/der Nutzer hat die URL bereits aufgerufen (sie/er hat die Seite aktualisiert oder auf die Zurück/Vorwärts-Schaltfläche im Browser geklickt).
- Ihre Plattform hat keinen Zugang mehr zu diesem Konto.
- Der Link wurde in einer Anmeldeformular eines Drittanbieters freigegeben, z. B. in einem Messaging-Client, der versucht, auf die URL zuzugreifen, um eine Vorschau anzuzeigen. Viele Kunden besuchen automatisch Links, was dazu führt, dass ein Konto-Link abläuft.
- Das Konto wurde abgelehnt.
Konfigurieren Sie die refresh_ so, dass sie eine Methode auf Ihrem Server aufruft, die einen neuen Konto-Link mit denselben Parametern erstellt und das verbundene Konto anschließend zur neuen Konto-Link-URL weiterleitet.
Behandeln von Nutzerinnen und Nutzern, die das Onboarding noch nicht abgeschlossen haben
Ein/e Kontonutzer/in, die/der zu Ihrer return_ weitergeleitet wird, hat den Onboarding-Prozess möglicherweise nicht abgeschlossen. Verwenden Sie den Endpoint /v2/core/accounts, um das Account-Objekt abzurufen und zu prüfen, ob configuration.recipient.capabilities.stripe_balance.stripe_transfers.status auf active gesetzt ist. Wenn der Status nicht active ist und configuration.recipient.capabilities.stripe_balance.stripe_transfers.status_details.code den Wert requirements_ hat, zeigen Sie in Ihrer Nutzeroberfläche Hinweise an, damit die/der Kontonutzer/in das Onboarding über einen neuen Konto-Link fortsetzen kann. Behandeln Sie andere Codes entsprechend.
Aktualisierungen verbundener Konten verwaltenServerseitig
Das von Stripe gehostete Onboarding unterstützt außerdem Updates, die vom verbundenen Konto selbst initiiert werden, um bereits bereitgestellte Informationen zu aktualisieren. Beachten Sie das v2.-Ereignis, das an Ihren Webhook-Endpoint gesendet wird, um benachrichtigt zu werden, wenn das Konto die Anforderungen erfüllt.
Wenn Sie einen Konto-Link erstellen, setzen Sie den type auf account_. Konto-Links dieses Typs stellen ein Formular bereit, um ausstehende Anforderungen einzugeben. Verwenden Sie ihn, wenn Sie ein neues verbundenes Konto einbinden oder wenn ein bestehendes Konto neue Anforderungen hat (z. B. wenn Sie eine neue Funktion anfordern, die zusätzliche Informationen erfordert).
Nächste Schritte
Aktivieren Sie anschließend die Zahlungsmethoden, die Sie unterstützen möchten.