Von Stripe gehostetes Onboarding
Das von Stripe gehostete Onboarding übernimmt die Erfassung der Informationen zur Verifizierung des Unternehmens und zur Identitätsprüfung von verbundenen Konten. Es handelt sich dabei um ein von Stripe gehostetes Webformular, das sich dynamisch an die Funktionen, das Land und den Unternehmenstyp jedes verbundenen Kontos anpasst. Das von Stripe gehostete Onboarding ist die empfohlene Lösung für Plattformen, bei denen Stripe das Onboarding mit wenig Aufwand für die Plattform übernehmen soll.
Das Formular für gehostetes Onboarding in der Beispielintegration von Stripe, Rocket Deliveries.
Onboarding-Formular anpassenDashboard
Navigieren Sie zur Seite mit Connect-Einstellungen im Dashboard, um die visuelle Darstellung des Formulars mit dem Namen, der Farbe und dem Symbol Ihrer Marke anzupassen. Diese Informationen sind für das von Stripe gehostetete Onboarding erforderlich. Stripe empfiehlt außerdem die Erfassung der Bankkontodaten von Ihren verbundenen Konten bei deren Onboarding.
Konten erstellen und Informationen vorab angebenServerseitig
Erstellen Sie ein verbundenes Konto mit den standardmäßigen Controllereigenschaften. Weitere Informationen zu Controllereigenschaften finden Sie unter Konzipieren einer Integration. Alternativ können Sie ein verbundenes Konto durch Angabe eines Kontotyps erstellen.
Wenn Sie das Land für Ihr verbundenes Konto kennen, können Sie diese Informationen bei der Kontoerstellung angeben. Wenn Sie keine Angaben machen, ist das Land standardmäßig das gleiche wie Ihre Plattform.
Wenn Sie Funktionen für Ihr verbundenes Konto anfordern müssen, können Sie diese bei der Kontoerstellung angeben, und die Onboarding-Nutzeroberflächen von Stripe erfassen die erforderlichen Informationen für diese Funktionen. Fordern Sie nur Funktionen an, die Sie benötigen, um den Onboarding-Aufwand zu reduzieren. Wenn Sie Funktionen auslassen und Ihr verbundenes Konto über Zugriff auf das Express-Dashboard verfügt, nutzt das von Stripe gehostete Onboarding die Konfigurationseinstellungen, um Funktionen automatisch je nach Land des Kontos anzufordern.
Wenn Sie über Informationen über den Kontoinhaber/die Kontoinhaberin verfügen (zum Beipiel der Name, die Adresse oder andere Details), können Sie diese beim Erstellen oder Aktualisieren des Kontos proaktiv bereitstellen. Beim von Stripe gehosteten Onboarding wird der Kontoinhaber/die Kotoinhaberin gebeten, die vorausgefüllten Informationen zu bestätigen, bevor er/sie den Connect-Rahmenvertrag akzeptiert. Durch die Angabe weiterer Informationen über die API wird die Anzahl der Eingabeaufforderungen reduziert und der Onboarding-Ablauf für Ihr verbundenes Konto verbessert.
Wenn Sie das Onboarding eines Kontos ohne seine eigene Website durchführen und Ihren Plattform dem Konto eine URL zur Verfügung stellt, füllen Sie außerdem die business_profile.url des Kontos vorab aus. Wenn das Konto keine URL hat, können Sie stattdessen seine business_profile.product_description vorab ausfüllen.
Verwenden Sie beim Testen Ihrer Integration Testdaten, um verschiedene Ergebnisse zu simulieren, zum Beispiel Identitätsprüfung, Verifizierung der Unternehmensinformationen, Auszahlungsfehler und mehr.
Die zu erfassenden Informationen bestimmen
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_due
Anforderungen für das Konto erfasst, während beim inkrementellen Onboarding nur die currently_due
Anforderungen erfasst werden.
Onboarding im Voraus | Inkrementelles Onboarding | |
---|---|---|
Vorteile |
|
|
Nachteile |
|
|
Um zu bestimmen, ob Sie das Onboarding im Voraus oder inkrementelles Onboarding nutzen möchten, lesen Sie die erforderlichen Informationen für die Länder, in denen sich Ihre verbundenen Konten befinden, um die Anforderungen zu verstehen, die letztendlich fällig werden. Auch wenn Stripe versucht, etwaige Auswirkungen auf verbundene Konten zu minimieren, können sich Anforderungen im Laufe der Zeit ändern.
Konto-Link erstellenServerseitig
Erstellen Sie einen Konto-Link mithilfe der ID des verbundenen Kontos und fügen Sie eine Aktualisierungs-URL und eine Rückgabe-URL ein. Stripe leitet das verbundene Konto an die Aktualisierungs-URL weiter, wenn die Konto-Link-URL bereits aufgerufen wurde, abgelaufen ist oder aus anderen Gründen ungültig ist. Stripe leitet verbundene Konten an die Rückgabe-URL weiter, wenn sie den Onboarding-Ablauf abgeschlossen oder beendet haben. Übergeben Sie außerdem je nach den zu erfassenden Informationen entweder currently_due
oder eventually_due
für collection_options.fields
. In diesem Beispiel wird eventually_due
übergeben, um Onboarding im Voraus zu nutzen. Legen Sie currently_due
für inkrementelles Onboarding fest.
Ihr verbundenes Konto an die Konto-Link-URL weiterleiten
Leiten Sie das verbundene Konto an die Konto-Link-URL weiter, um es an den Onboarding-Ablauf zu senden. Jede Konto-Link-URL kann nur einmal verwendet werden, da sie Zugriff auf die persönliche Daten des Kontoinhabers/der Kontoinhaberin gewährt. Authentifizieren Sie das Konto in Ihrer Anwendung, bevor Sie es an diese URL weiterleiten.
Umgang mit neuen Anforderungen, die fällig werdenServerseitig
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 Testmodus-Auslöserkarten testen. Stripe benachrichtigt Sie, wenn bevorstehende Aktualisierungen der Anforderungen Ihre verbundenen Konten betreffen.
Sie können proaktiv Informationen sammeln, um zukünftige Anforderungen zu erfüllen. Ausgehend von den Verifizierungsanforderungen Ihrer Anwendung senden Sie das verbundene Konto je nach Bedarf zurück an das Onboarding, um die Anforderungen currently_due
oder eventually_due
zu erfüllen. Sie können dies als Signal dafür verwenden, wann Sie Ihr verbundenes Konto zurück in den Ablauf schicken müssen.
Sie müssen sich keine Gedanken über die Anforderungen machen – wenn Sie das verbundene Konto zum Onboarding zurücksenden, werden die richtigen Informationen erfasst. Wenn Ihr verbundenes Konto beispielsweise seine Daten falsch eingibt und nicht verifiziert werden kann, wird es möglicherweise gebeten, ein Identitätsdokument vorzulegen (zum Beispiel einen Führerschein in den USA). Wenn Sie diese/n Nutzer/in an das Onboarding senden, wird er/sie aufgefordert, zur Verifizierung ein solches Dokument hochzuladen.
Verifizierungsfehler handhaben
Überwachen Sie das Ereignis account.updated. Wenn das Konto zum Zeitpunkt der current_deadline
Felder mit der Bezeichnung currently_due
enthält, wird die entsprechende Funktion deaktiviert und diese Felder werden zu past_due
hinzugefügt.
Lassen Sie Ihre Konten die Verifizierungsanforderungen regeln, indem Sie sie an das von Stripe gehostete Onboarding-Formular leiten.
Rückkehr des verbundenen Kontos zu Ihrer Plattform steuern
Der Konto-Link benötigt eine refresh_url
und return_url
, um alle Fälle bearbeiten zu können, in denen das verbundene Konto zurück zu Ihrer Plattform geleitet wird. Es ist wichtig, diese korrekt zu implementieren, um Ihren verbundenen Konten den besten Onboarding-Ablauf zu bieten.
Notiz
Sie können HTTP für Ihre refresh_url
und return_url
verwenden, während Sie sich im Test-Modus befinden (zum Beispiel für lokalen Test). Für den Live-Modus wird jedoch nur HTTPS akzeptiert. Vergewissern Sie sich, dass Sie vor der Live-Schaltung alle Test-URLs gegen HTTPS-URLs ausgetauscht haben.
Aktualisierungs-URL
Ihr verbundenes Konto wird an die refresh_url
weitergeleitet, wenn:
- Der Link ist abgelaufen (seit Erstellung des Links sind ein paar Minuten vergangen).
- Der Link wurde bereits aufgerufen (das verbundene Konto hat die Seite aktualisiert oder auf die Zurück- oder Vorwärts-Schaltfläche geklickt).
- Der Link wurde in einer Drittanbieteranwendung (z. B. einem Messaging-Client) geteilt, die versucht hat, auf die URL zuzugreifen und sie in der Vorschau anzuzeigen. Viele Clients rufen Links automatisch auf. Dies kann jedoch dazu führen, dass die Links ablaufen.
Die refresh_url
sollte eine Methode auf Ihrem Server aufrufen, um einen neuen Konto-Link mit denselben Parametern zu erstellen und das verbundene Konto an die neue Konto-Link-URL weiterzuleiten.
Rückgabe-URL
Stripe leitet das verbundene Konto an diese URL zurück, wenn sie den Onboarding-Ablauf abschließen oder an einer beliebigen Stelle im Ablauf auf Für später speichern klicken. Dies bedeutet nicht, dass alle Informationen erfasst wurden oder dass keine offenen Anforderungen für das Konto bestehen. Es bedeutet lediglich, dass ordnungsgemäß an dem Verfahren teilgenommen und das Verfahren beendet wurde.
Mit dieser URL wird kein Status übergeben. Nachdem ein verbundenes Konto an die return_url
weitergeleitet wurde, ermitteln Sie, ob das Konto das Onboarding abgeschlossen hat. Rufen Sie das Konto ab und prüfen Sie das Attribut requirements auf ausstehende Anforderungen. Oder überwachen Sie das an Ihren Webhook-Endpoint gesendete Ereignis account.updated
und speichern Sie den Status des Kontos in Ihrer Anwendung zwischen. Wenn das Konto das Onboarding noch nicht abgeschlossen hat, können Sie in Ihrer Anwendung Eingabeaufforderungen bereitstellen, damit das Onboarding später fortgesetzt werden kann.
Von verbundenen Konten initiierte Aktualisierungen verarbeiten
Das von Stripe gehostete Onboarding unterstützt auch von verbundenen Konten initiierte Aktualisierungen der bereits bereitgestellten Informationen. Wenn Sie einen Konto-Link erstellen, können Sie den type
entweder auf account_onboarding
oder account_update
festlegen.
Onboarding von Konten
Konto-Links dieser Art bieten ein Formular zur Eingabe ausstehender Anforderungen. Verwenden Sie es, wenn Sie das Onboarding eines neuen verbundenen Kontos durchführen oder wenn ein/e bestehende/r Nutzer/in neue Anforderungen hat (zum Beispiel wenn ein verbundenes Konto bereits genügend Informationen bereitgestellt hat, Sie jedoch eine neue Funktion angefordert haben, für die zusätzliche Informationen erforderlich sind). Senden Sie sie an diese Art von Konto-Link, um nur die neuen Informationen zu erfassen, die Sie benötigen.
Aktualisierung des Kontos
Konto-Links dieses Typs sind für Konten aktiviert, bei denen Ihre Plattform für die Erfassung der Anforderungen zuständig ist. account_update
-Links zeigen die Attribute an, die bereits für das Kontoobjekt mit Daten gefüllt sind und ermöglichen es Ihrem verbundenen Konto, zuvor angegebene Informationen zu bearbeiten (z. B. muss ihre Adresse aktualisiert werden). Stellen Sie in Ihrer Anwendung eine Option (zum Beispiel „Mein Profil bearbeiten“ oder „Meine Verifizierungsinformationen aktualisieren“) zur Verfügung, mit der verbundene Konten selbst Aktualisierungen vornehmen können.
Unterstützte Browser
Von Stripe gehostete Onboarding unterstützt:
- Die letzten 20 Hauptversionen von Chrome und Firefox
- Die letzten beiden Hauptversionen von Safari und Edge
- Die letzten beiden Hauptversionen von Safari für iOS
Von Stripe gehostetes Onboarding wird nicht unterstützt, wenn es in Webansichten eingebettet ist. Es wird nur in eigenständigen Browsern unterstützt.