API-Onboarding

Die folgenden Faktoren wirken sich auf die Onboarding-Anforderungen für Ihre verbundenen Konten aus:

• Das Ursprungsland der verbundenen Konten
• Art des Rahmenvertrags, der für die verbundenen Konten gilt
• Für die verbundenen Konten angeforderte Funktionen
• Der business_type (zum Beispiel Einzelperson oder Unternehmen) und die company.structure (zum Beispiel public_corporation oder private_partnership)

Verwenden Sie das interaktive Formular, um festzustellen, wie sich das Ändern dieser Faktoren auf die Anforderungen auswirkt.

Als Best Practice empfiehlt es sich, die erforderlichen Parameter in Ihrem Onboarding-Prozess in logischen Gruppierungen oder Formularen zu organisieren. Sie können eine Zuordnung zwischen den Stripe-Parametern und den logischen Gruppierungen kodieren. Vorgeschlagene logische Gruppierungen für Parameter werden in der ersten Spalte der Beispielanforderungstabelle angezeigt.

Nachdem Sie die erforderlichen Parameter in Ihrer Anwendung kodiert haben, generieren Sie Nutzeroberflächen für die Parameter, die diesen Anforderungen entsprechen. Entwickeln Sie für jeden Parameter eine Nutzeroberfläche, die Folgendes enthält:

• Parameterbezeichnung, lokalisiert für jedes unterstützte Land und jede unterstützte Sprache
• Parameterbeschreibung, lokalisiert für jedes unterstützte Land und jede unterstützte Sprache
• Parametereingabefelder mit Datenvalidierungslogik und Hochladen von Dokumenten (sofern erforderlich)

Wenn Sie Ihre Anwendungslogik entwickeln, sollten Sie auch mögliche zukünftige Parameter im Hinterkopf behalten. Es kann zum Beispiel sein, dass Stripe im Laufe der Zeit neue Parameter, neue Verifizierungen oder neue Schwellenwerte einführt, die Sie in Ihr eigenes Onboarding integrieren müssen.

Wenn Sie einen der Faktoren ändern, der die Anforderungen Ihrer verbundenen Konten bestimmt, müssen Sie auch Ihre Zahlungsformulare an die geänderten Anforderungen anpassen. Land und Art des Rahmenvertrags sind unveränderlich, wohingegen Funktionen und Unternehmenstyp geändert werden können.

• Um ein unveränderliches Feld zu ändern, erstellen Sie ein neues verbundenes Konto mit den neuen Werten, um das vorhandene Konto zu ersetzen.
• Um ein veränderbares Feld zu ändern, aktualisieren Sie das verbundene Konto.

Fügen Sie die Allgemeinen Geschäftsbedingungen von Stripe bei

Ihre verbundenen Konten müssen die allgemeinen Geschäftsbedingungen von Stripe akzeptieren, bevor sie aktiviert werden können. Sie können die Allgemeinen Geschäftsbedingungen von Stripe in Ihre eigenen Bedingungen integrieren.

Erstellen Sie ein Konto, bei dem Ihre Plattform für negative Salden haftet, Stripe die Gebühren von Ihrem Plattformkonto einzieht und Ihre verbundenen Konten keinen Zugriff auf ein von Stripe gehostetes Dashboard haben. Fordern Sie alle Funktionen an, die Ihre verbundenen Konten benötigen. Füllen Sie den Unternehmenstyp und alle anderen verfügbaren Informationen aus, die Ihren Anforderungen entsprechen.

Alternativ können Sie ein verbundenes Konto erstellen, dessen type auf custom und die gewünschten Funktionen festgelegt ist.

Wenn Sie das Land und den Typ des Rahmenvertrags nicht angeben, werden ihnen die folgenden Standardwerte zugewiesen:

• Das Land für country ist standardmäßig das gleiche wie das Ihrer Plattform.
• Der Typ des Rahmenvertrags (tos_acceptance.service_agreement) ist standardmäßig auf full festgelegt.

curl https://api.stripe.com/v1/accounts \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "controller[losses][payments]"=application \
  -d "controller[fees][payer]"=application \
  -d "controller[stripe_dashboard][type]"=none \
  -d "controller[requirement_collection]"=application \
  -d "capabilities[card_payments][requested]"=true \
  -d "capabilities[transfers][requested]"=true \
  -d business_type=individual \
  -d country=US

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.

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.

Bei verbundenen Konten, bei denen Sie für die Anforderungserfassung verantwortlich sind, können Sie das Verhalten zukünftiger Anforderungen mithilfe des Parameters collection_options anpassen. Um die zukünftigen Anforderungen des Kontos zu erfassen, setzen Sie collection_options.future_requirements auf include.

Um Ihre Onboarding-Strategie umzusetzen, überprüfen Sie den Anforderungs-Hash des verbundenen Kontos, das Sie erstellt haben. Der Anforderungs-Hash bietet eine vollständige Liste der Informationen, die Sie erfassen müssen, um das verbundene Konto zu aktivieren.

• Überprüfen Sie für das inkrementelle Onboarding den Hash currently_due im Anforderungs-Hash und erstellen Sie einen Onboarding-Ablauf, der nur diese Anforderungen erfasst.
• Überprüfen Sie für das Onboarding im Voraus die Hashes currently_due und eventually_due im Anforderungs-Hash und erstellen Sie einen Onboarding-Ablauf, der diese Anforderungen erfasst.

{
  ...
  "requirements": {
    "alternatives": [],
    "current_deadline": null,
    "currently_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "disabled_reason": "requirements.past_due",
    "errors": [],
    "eventually_due": [
      "business_profile.product_description",
      "business_profile.support_phone",
      "business_profile.url",
      "external_account",
      "tos_acceptance.date",
      "tos_acceptance.ip"
    ],
    "past_due": [],
    "pending_verification": []
  },
  ...
}

Ein Konto kann ein oder mehrere Person-Objekte haben, die einen proof_of_liveness erfordern. Eine proof_of_liveness-Anforderung kann die Erfassung eines elektronischen Identitätsnachweises wie MyInfo in Singapur oder die Verwendung von Stripe Identity zur Erfassung eines Dokuments oder eines Selfies erfordern. Wir empfehlen die Verwendung von Stripe gehostetem oder eingebettetem Onboarding, um alle Varianten der Anforderung proof_of_liveness zu erfüllen.

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

Aktualisieren Sie das Account-Objekt mit neuen Informationen, während Ihr verbundenes Konto die einzelnen Schritte des Onboarding-Ablaufs durchläuft. Dadurch kann Stripe die Informationen validieren, sobald sie hinzugefügt werden. Nachdem Stripe die Annahme unserer Allgemeinen Geschäftsbedingungen bestätigt hat, löst jede Änderung am Account eine erneute Verifizierung aus. Wenn Sie beispielsweise den Namen oder die ID-Nummer des verbundenen Kontos ändern, führt Stripe die Verifizierungen erneut durch.

curl https://api.stripe.com/v1/accounts/
{{CONNECTED_ACCOUNT_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  --data-urlencode "business_profile[url]"="https://furever.dev" \
  -d "tos_acceptance[date]"=1609798905 \
  -d "tos_acceptance[ip]"="8.8.8.8"

Bei der Aktualisierung eines verbundenen Kontos müssen Sie alle Verifizierungsfehler oder HTTP-Fehlercodes bearbeiten.

Nachdem die Daten des verbundenen Kontos übermittelt wurden, verifiziert Stripe diese. Dieser Vorgang kann je nach Art der Verifizierung Minuten oder Stunden dauern. Während der Ausführung dieses Vorgangs befinden sich die angeforderten Funktionen im status pending.

Status prüfen

Sie können den Status der Funktionen Ihres verbundenen Kontos wie folgt abrufen:

• Der Funktions-Hash des Account-Objekts wird auf die relevante Funktion hin geprüft.
• Funktionen werden direkt von der Capabilities API angefordert und der Status der relevanten Funktion wird überprüft.
• Ereignisse des Typs account.updated werden in Ihrem Webhook-Endpoint überwacht und der Hash capabilities wird auf die entsprechende Funktion überprüft.

Nachdem die Verifizierungen abgeschlossen sind, wird eine Funktion active und steht dem verbundenen Konto zur Verfügung. Kontoverifizierungen werden kontinuierlich durchgeführt, und wenn eine zukünftige Verifizierung fehlschlägt, kann eine Funktion aus dem Status active heraus wechseln. Überwachen Sie account.updated-Ereignisse, um Änderungen am Funktionsstatus zu erkennen.

Bestätigen Sie, dass Ihre Connect-Integration konform und betriebsbereit ist, indem Sie überprüfen, ob charges_enabled und payouts_enabled für das Konto beide „true“ sind. Sie können die API verwenden oder Ereignisse des Typs account.updated überwachen. Details zu anderen relevanten Feldern finden Sie im Hash Anforderungen des Kontos. Sie können die Integration nicht anhand eines einzelnen Werts bestätigen, da die Status je nach Anwendung und verwandten Richtlinien variieren können.

• charges_enabled bestätigt, dass Ihr vollständiger Zahlungspfad, einschließlich Zahlung und Überweisung, korrekt funktioniert, und prüft, ob die Funktionen card_payments oder transfers aktiv sind.
• payouts_enabled gibt Auskunft darüber, ob Ihr verbundenes Konto Auszahlungen an ein externes Konto vornehmen kann. Je nach Ihren Risikorichtlinien können Sie zulassen, dass Ihr verbundenes Konto Transaktionen ausführt, auch wenn es noch keine Auszahlungen aktiviert hat. Sie müssen die Auszahlungen jedoch zu einem späteren Zeitpunkt aktivieren, um Gelder an Ihre verbundenen Konten auszahlen.

Sie können die folgende Logik als Ausgangspunkt für die Definition einer Statusübersicht verwenden, die Ihrem verbundenen Konto angezeigt wird.

# Set your secret key. Remember to switch to your live secret key in production.
# See your keys here: https://dashboard.stripe.com/apikeys
Stripe.api_key = 
'sk_test_BQokikJOvBiI2HlWgH4olfQ2'

def account_state(account)
  reqs = account.requirements

  if reqs.disabled_reason && reqs.disabled_reason.include?("rejected")
    "rejected"
  elsif account.payouts_enabled && account.charges_enabled
    if reqs.pending_verification
      "pending enablement"
    elsif !reqs.disabled_reason && !reqs.currently_due
      if !reqs.eventually_due
        "complete"
      else
        "enabled"
      end
    else
      "restricted"
    end
  elsif !account.payouts_enabled && account.charges_enabled
    "restricted (payouts disabled)"
  elsif !account.charges_enabled && account.payouts_enabled
    "restricted (charges disabled)"
  elsif reqs.past_due
    "restricted (past due)"
  elsif reqs.pending_verification
    "pending (disabled)"
  else
    "restricted"
  end
end

accounts = Stripe::Account.list(limit: 10)

accounts.each do |account|
    puts "#{account.id} has state: #{account_state(account)}"
end

Ü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.

Erstellen Sie ein Formular mit klaren Anweisungen, die das Konto verwenden kann, um die Angaben zu korrigieren. Benachrichtigen Sie das Konto und übermitteln Sie die korrigierten Angaben mithilfe der Accounts API.

Wenn Sie alle Ihre Verifizierungsfehler mit benutzerdefinierten Abläufen beheben möchten:

• Überprüfen Sie die Details zu allen möglichen Verifizierungsfehlern und deren Handhabung.
• Verifizierungsstatus testen