Von Stripe gehostetes Onboarding für Custom-Konten

Connect Onboarding bei Custom-Konten unterstützt Onboarding im Voraus oder inkrementelles Onboarding. Beim Onboarding im Voraus werden die eventually_due-Anforderungen für das Konto erfasst, während beim inkrementellen Onboarding die currently_due-Anforderungen erfasst werden. Informationen zu den Vor- und Nachteilen der beiden Verfahren finden Sie in der Dokumentation zu den Onboarding-Verfahren.

Mit den currently_due-Anforderungen werden nur die Nutzerinformationen angefordert, die zu diesem speziellen Zeitpunkt für die Verifizierung benötigt werden. Die eventually_due-Anforderungen enthalten einen vollständigeren Satz von Fragen, die letztendlich erfasst werden müssen.

Ausgehend von den Anforderungen Ihrer Plattform übergeben Sie entweder currently_due oder eventually_due als Wert des collection_options.fields-Parameters in Ihren Aufrufen der Konto-Links. Nachfolgend finden Sie eine Beispielanfrage:

curl https://api.stripe.com/v1/account_links \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d account=
{{CONNECTED_ACCOUNT_ID}} \
  --data-urlencode refresh_url="https://example.com/reauth" \
  --data-urlencode return_url="https://example.com/return" \
  -d type=account_onboarding \
  -d "collection_options[fields]"=eventually_due

Die Antwort auf Ihre Anfrage nach Konto-Links enthält einen Wert für den Schlüssel url. Leiten Sie Ihre Nutzer/innen zu diesem Link weiter, um sie in den Ablauf zu senden. Sie können Ihre Konto-Link-URLs nur einmal verwenden, da sie Zugang zu den persönlichen Daten des Kontoinhabers/der Kontoinhaberin gewähren. Führen Sie die Authentifizierung der Nutzer/innen in Ihrer Anwendung durch, bevor Sie sie an diese URL weiterleiten. Wenn Sie die Option** Externe Kontoinformationen erfassen für Konten aktivieren, bei denen die Plattform für die Erfassung der Anforderungen verantwortlich ist** in Ihren Onboarding-Einstellungen für Auszahlungen aktivieren oder wenn die treasury-Funktion angefordert wird, muss der/die Nutzer/in eine zusätzliche Authentifizierung mit Stripe einrichten, bevor er/sie den Onboarding-Ablauf startet.

Connect Onboarding verlangt, dass Sie sowohl eine return_url als auch eine refresh_url übergeben, um alle Fälle abzuwickeln, in denen die Nutzer/innen an Ihre Plattform zurückgeleitet werden. Es ist wichtig, dass Sie diese korrekt implementieren, um Ihren Nutzer/innen die bestmögliche Erfahrung zu bieten.

return_url

Stripe gibt eine Weiterleitung zurück zu dieser URL aus, wenn die Nutzer/innen das Connect Onboarding-Verfahren abschließen oder an einer beliebigen Stelle im Verfahren 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 verlassen wurde.

Mit dieser URL wird kein Status übergeben. Nachdem ein/e Nutzer/in zu Ihrer return_url weitergeleitet wurde, überprüfen Sie den Status des Attributs requirements für sein/ihr Konto. Sie können entweder die account.updated-Webhooks überwachen oder das Account-Objekt abrufen und den Status des Attributs requirements überprüfen. Weitere Informationen finden Sie in Schritt 4 unten.

refresh_url

Ihre Nutzer/innen werden in den folgenden Fällen an die refresh_url weitergeleitet:

• Der Link ist abgelaufen (seit der Erstellung des Links sind ein paar Minuten vergangen).
• Der Link wurde bereits aufgerufen (die Nutzer/innen haben die Seite aktualisiert oder auf die Zurück/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 besuchen Links automatisch. Dies kann jedoch dazu führen, dass die Links ablaufen.

Ihre refresh_url sollte eine Methode auf Ihrem Server auslösen, um Account Links erneut mit denselben Parametern aufzurufen und Nutzer/innen an das Connect Onboarding zurückzuleiten, damit ein nahtloses Erlebnis entsteht.

Richten Sie Ihre Integration so ein, dass Änderungen der Kontoanforderungen überwacht, falls noch nicht geschehen. Wir empfehlen, dafür Webhooks zu verwenden. Sie können den Umgang mit neuen Anforderungen (und wie diese möglicherweise Zahlungen und Auszahlungen deaktivieren) mit unseren Test-Modus-Auslöserkarten testen.

Wenn anstehende Aktualisierungen der Anforderungen Ihre verbundenen Konten betreffen, benachrichtigen wir Sie.

Wenn Sie eingebettetes oder von Stripe gehostetes Onboarding verwenden, können Sie proaktiv Informationen erfassen, damit zukünftige Anforderungen automatisch erfüllt werden. Fügen Sie für das eingebettete Onboarding das Attribut collectionOptions in die eingebettete Onboarding-Komponente ein. Geben Sie für das von Stripe gehostete Onboarding beim Erstellen von Konto-Links den Parameter collection_options an.

Senden Sie die Nutzer/innen ausgehend von den Verifizierungsanforderungen Ihrer Anwendung bei Bedarf zurück an Connect Onboarding, um Anforderungen vom Typ currently_due oder eventually_due wie in Schritt 1 beschrieben zu erfüllen. Sie können dies als Signal dafür verwenden, wann Sie Ihre Nutzer/innen in das Verfahren zurückschicken. Beachten Sie, dass Sie sich bei Verwendung von Connect Onboarding nicht wirklich darum kümmern müssen, welche Anforderungen erfüllt werden müssen. Wenn Sie die Nutzer/innen zurück an Connect Onboarding schicken, werden die richtigen Informationen erfasst.

Wenn Ihr/e Nutzer/in beispielsweise seine/ihre Daten falsch eingibt und nicht verifiziert werden kann, wird er/sie möglicherweise gebeten, ein Identitätsdokument vorzulegen (zum Beispiel einen Führerschein in den USA). Wenn Sie diese/n Nutzer/in an Connect Onboarding senden, wird er/sie aufgefordert, zur Verifizierung ein solches Dokument hochzuladen.

Bei den meisten der bisher diskutierten Connect Onboarding-Anwendungen ging es darum, den Benutzer aufzufordern, neue Informationen anzugeben. Connect Onboarding unterstützt auch von Nutzer/innen initiierte Aktualisierungen der Informationen, die sie bereits im Parameter type des Account Link angegeben haben. type akzeptiert einen von zwei Werten: account_onboarding oder account_update.

account_onboarding

Dieser Wert für type stellt ein Formular für die Eingabe von ausstehenden Anforderungen zur Verfügung. Verwenden Sie es beim Onboarding neuer Nutzer/innen oder wenn vorhandene Nutzer/innen neue Anforderungen haben, z. B. wenn ein Nutzer/eine Nutzerin bereits ausreichend Informationen angegeben hat, Sie jedoch eine neue Funktion angefordert haben, die weitere Informationen benötigt. Senden Sie den Nutzer/die Nutzerin in diesem Modus an das Formular, um lediglich die benötigten neuen Informationen zu erfassen.

account_update

Dieser Wert für type zeigt die Attribute an, die bereits im Kontoobjekt ausgefüllt sind, und ermöglicht es Ihrem Benutzer, zuvor bereitgestellte Informationen zu bearbeiten. Stellen Sie einen Zugriffspunkt auf Ihrer Plattform-Website für einen type=account_update bereit, über den Nutzer/innen selbst Aktualisierungen vornehmen können (zum Beispiel, wenn sich ihre Adresse ändert). Sie können den Link als „Mein Profil bearbeiten“ oder „Meine Verifizierungsinformationen aktualisieren“ formulieren.