Erfassen Sie ein Konto, um datengestützte Produkte zu entwickeln

Registrieren Sie sich für Financial Connections, nachdem wir Ihr Konto für Zugriff im Live-Modus zugelassen haben.

Verwenden Sie unsere offiziellen Bibliotheken für den Zugriff auf die Stripe-API über Ihre Anwendung:

# Available as a gem
sudo gem install stripe

# If you use bundler, you can add this line to your Gemfile
gem 'stripe'

Erstellen Sie ein Kundenobjekt, wenn Nutzer/innen ein Konto bei Ihrem Unternehmen erstellen. Durch die Angabe einer E-Mail-Adresse kann Financial Connections den Authentifizierungsablau optimieren, indem es dynamisch eine optimierte Benutzeroberfläche für wiederkehrende Link-Nutzer/innen anzeigt.

curl https://api.stripe.com/v1/customers \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d email={{CUSTOMER_EMAIL}} \
  -d name={{CUSTOMER_NAME}}

Bevor Sie mit Financial Connections Daten vom Bankkonto eines Nutzers/einer Nutzerin abrufen können, muss Ihr/e Nutzer/in sein/ihr Konto über den Authentifizierungsvorgang authentifizieren.

Der/die Nutzer/in beginnt mit dem Authentifizierungsvorgang, wenn er/sie sein/ihr Konto mit Ihrer Website oder Anwendung verbinden möchte. Fügen Sie auf Ihrer Website oder in Ihrer Anwendung eine Schaltfläche oder einen Link ein, über den ein/e Nutzer/in seine/ihre Konten verknüpfen kann – zum Beispiel “Bankkonto verknüpfen”.

Erstellen Sie eine Financial Connections-Sitzung, indem Sie sie unter /v1/financial_connections/sessions angeben:

curl https://api.stripe.com/v1/financial_connections/sessions \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d "account_holder[type]"=customer \
  -d "account_holder[customer]"=
{{CUSTOMER_ID}} \
  -d "permissions[]"=balances \
  -d "permissions[]"=ownership \
  -d "permissions[]"=payment_method \
  -d "permissions[]"=transactions

1. Legen Sie account_holder[customer] auf die Kunden-id fest.
2. Legen Sie den Parameter Daten-permissions so fest, dass er die für Ihren Use case erforderlichen Daten enthält.
3. (Optional) Legen Sie den Parameter prefetch zum Abrufen der Daten bei der Kontoerstellung fest.

Der Parameter Berechtigungen steuert, auf welche Kontodaten Sie zugreifen können. Sie müssen mindestens eine Berechtigung anfordern. Wenn Sie den Authentifizierungsablauf abschließen, können Ihre Nutzer/innen die Daten sehen, auf die Sie Zugriff beantragt haben, und ihre Zustimmung zur Weitergabe erteilen.

Überlegen Sie sorgfältig, welche Daten Sie für Ihren Use Case benötigen und fordern Sie die Berechtigung zum Zugriff nur für die von Ihnen benötigten Daten an. Wenn Sie Berechtigungen anfordern, die über den Umfang Ihrer Anwendung hinausgehen, ist es möglich, dass Nutzer/innen Ihnen nicht mehr volles Vertrauen schenken, da sie sich fragen, wie ihre Daten verwendet werden. Wenn Sie zum Beispiel eine Anwendung für die persönliche Finanzverwaltung oder ein Kreditprodukt entwickeln, möchten Sie möglicherweise die transactions-Daten anfordern. Zur Eindämmung von Betrug fordern Sie möglicherweise Details zur ownership an.

Nachdem Ihre Nutzer/innen ihr Konto authentifiziert haben, können Sie Datenberechtigungen nur erweitern, indem Sie eine neue Financial Connections-Sitzung erstellen und einen neuen Wert im Parameter permissions angeben. Ihr/e Nutzer/in muss das Authentifizierungsverfahren erneut durchführen, wobei er/sie die zusätzlichen Daten sieht, für die Sie die Zugriffsberechtigung angefordert haben, und seine/ihre Zustimmung zum Teilen der Daten erteilt.

Der optionale Prefetch-Parameter steuert, welche Daten Sie unmittelbar nach der Verbindung des Nutzers/der Nutzerin mit seinem/ihren Konto abrufen. Verwenden Sie diese Option, wenn Sie wissen, dass Sie immer eine bestimmte Art von Daten wünschen. So entfällt die Notwendigkeit, einen zusätzlichen API-Aufruf durchzuführen, um eine Datenaktualisierung zu initiieren.

Um die Option zum Annahme von ACH Direct Debit beizubehalten, fordern Sie die Berechtigung payment_method an.

Verwenden Sie das zurückgegebene client_secret mit Stripe.js, damit Ihre Nutzer/innen ihre Konten verbinden können. Ein client_secret gestattet clientseitigen Stripe SDKs Änderungen an der Financial Connections-Sitzung vorzunehmen. Es darf nicht gespeichert, protokolliert, in URLs eingebettet oder anderen Personen als Ihrem/Ihrer Endnutzer/in zugänglich gemacht werden. Stellen Sie sicher, dass TLS auf jeder Seite aktiviert ist, die das Client-Geheimnis enthält.

Verwenden Sie collectFinancialConnectionsAccounts, um ein Konto zu erfassen.

const stripe = new Stripe(
'pk_test_TYooMQauvdEDq54NiTphI7jx')
const financialConnectionsSessionResult = await stripe.collectFinancialConnectionsAccounts({
  clientSecret: "{{SESSION_CLIENT_SECRET}}",
});

Diese Methode lädt den Authentifizierungsvorgang, die clientseitige Stripe.js-Benutzeroberfläche, die Ihren Nutzerinnen und Nutzern hilft, ihre Finanzkonten mit Ihnen und Stripe zu verknüpfen.

Der Rückgabewert von stripe.collectFinancialConnectionsAccounts ist ein Promise. Wenn der/die Nutzer/in den Authentifizierungsvorgang abschließt, wird das Promise mit einem Objekt aufgelöst, das die Liste der verbundenen Konten enthält:

{
  "financialConnectionsSession": {
    "id": "fcsess_123",
    "accounts": [
      {
        "id": "fca_456",
        "object": "financial_connections.account",
        "category": "Checking",
        "display_name": "Premium Checking",
        "institution_name": "Test Bank",
        "last4": "4242"
      }
    ]
  }
}

Wenn der/die Nutzer/in keine Verbindung mit Konten herstellt oder den Authentifizierungsvorgang vorzeitig beendet, enthält die Antwort ein leeres accounts-Array.

Der erfolgreiche Abschluss des Authentifizierungsablaufs sendet auch einen financial_connections.account.created-Webhook pro verbundenem Konto.

Nachdem Ihr/e Nutzer/in das Authentifizierungsverfahren erfolgreich abgeschlossen hat, greifen Sie auf die Kontodaten zu, die Sie im Parameter permissions der Financial Connections-Sitzung angegeben haben, oder aktualisieren Sie diese.

Um die Privatsphäre der Daten Ihrer Nutzer/innen zu schützen, sind die für Sie zugänglichen Kontodaten auf die Daten beschränkt, die Sie im Parameter permissions angegeben haben.

Beachten Sie die Leitfäden für Salden, Inhaberschaft und Transaktionen, um mit dem Abrufen von Kontodaten zu beginnen.