Verknüpfen Sie den Datenzugriff auf ein Financial Connections-Konto mit der Erlaubnis Ihres/Ihrer Nutzer/in erneutÖffentliche Vorschau

Eine Financial Connections-Sitzung erstellen

Erstellen Sie eine Financial Connections-Sitzung und geben Sie Folgendes an:

1. Legen Sie account_holder[customer] auf die Kunden-id fest.
2. Legen Sie den Parameter permissions so fest, dass er payment_method und alle Daten einschließt, die Sie über das Konto abrufen möchten. Der Parameter „Berechtigungen“ ist ein Array mit Werten, wie z. B. [payment_method, balances, ownership, transactions]. Um sensible Daten Ihrer Nutzer/innen zu schützen, können Sie nur auf die Daten zugreifen, die Sie im Parameter permissions angegeben haben. Überlegen Sie genau, welche Daten für Ihr Anwendungsszenario erforderlich sind, und fordern Sie nur den Zugriff auf diese Daten an. Nach Abschluss des Authentifizierungsablaufs sehen Ihre Nutzer/innen die von Ihnen im Parameter „Berechtigungen“ angegebenen Daten und geben ihre Zustimmung zur Weitergabe dieser Daten. Das folgende Codebeispiel zeigt, wie balances und payment_method erfasst werden.
3. Legen Sie relink_options[authorization] auf die Autorisierungs-ID fest, um die Autorisierung des Kontos auszurichten, für das Sie den Datenzugriff wiederherstellen möchten.
4. filters[account_subcategories] auf checking, savings festlegen.
5. limits[accounts] auf 1 festlegen.

Sie können nur ein belastbares Konto hinzufügen, um ACH-Lastschriftzahlungen mit Stripe anzunehmen.

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 "filters[account_subcategories][]"=checking \
  -d "filters[account_subcategories][]"=savings \
  -d "limits[accounts]"=1 \
  -d "permissions[]"=payment_method \
  -d "permissions[]"=balances \
  -d "relink_options[authorization]"=fcauth_1LDYuMGxLVUXRs6HW0lrat9T

Die Anfrage gibt eine Antwort ähnlich der Folgenden zurück:

{
  "id": "fcsess_abcd",
  "object": "financial_connections.session",
  "livemode": true,
  "account_holder": {
    "customer": "cus_NfjonN9919dELB",
    "type": "customer"
  },
  "accounts": [],
  "client_secret": "fcsess_client_secret_UsESkKYzeiRcivgDJZfxZRFh",
  "filters": {
    "account_subcategories": ["checking", "savings"]
  },
  "limits": {
    "accounts": 1
  },
  "permissions": [
    "payment_method", "balances"
  ],
  "relink_options": {
    "authorization": "fcauth_1LDYuMGxLVUXRs6HW0lrat9T"
  }
}

Erneute Verknüpfung eines Financial Connections-Kontos

Verwenden Sie das zurückgegebene client_secret mit Stripe.js, damit Ihre Nutzer/innen ihre Konten erneut verknüpfen 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 stripe.collectFinancialConnectionsAccounts, um ein Konto zu erfassen.

// Fetch existing accounts on the authorization to determine whether the linked account is new.
const existing_account_ids = await fetch_existing_accounts();
const financialConnectionsSessionResult = await stripe.collectFinancialConnectionsAccounts({ clientSecret: "fcsess_client_secret_UsESkKYzeiRcivgDJZfxZRFh" });

Der Authentifizierungsvorgang wird von Stripe.js geladen, der clientseitigen Stripe.js-Nutzeroberfläche, über die Ihre Nutzer/innen die Daten, für die Sie über den permissions-Parameter Zugriffsberechtigungen angefordert haben, sehen und ihre Zustimmung zum Teilen der Daten geben können und ihre Finanzkonten mit Ihnen und Stripe verknüpfen können.

Der Authentifizierungsvorgang könnte folgendermaßen aussehen:

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 erneut verknüpften Konten enthält:

stripe.collectFinancialConnectionsAccounts(clientSecret)
  .then(({financialConnectionsSession, error}) => {
    if (error) {
      // The session failed for some reason.
      console.error(error.message);
    } else if (financialConnectionsSession.accounts.length > 0) {
      // User has authorized some account on the authorization.
      const is_new = !existing_account_ids.includes(financialConnectionsSession.accounts[0].id);
      // The user has connected a new account on the authorization.
      if (is_new) {
        // You must surface the mandate for new accounts to process ACH payments.
        return surface_mandate();
      } else {
        // User has reauthorized an existing payment account.
        reload_account(financialConnectionsSession.accounts[0].id);
        return display_success();
      }
    } else if (accounts.length == 0) {
      // The session failed to connect an account.
    }
  });

Wenn Ihr/e Nutzer/in ein Konto für die gemeinsame Nutzung von Daten verknüpft hat, ist die Länge von accounts > 0.

Innerhalb der OAuth-Abläufe des Finanzinstituts Ihrer Endnutzer/innen können diese ein anderes als das ursprünglich verknüpfte Konto auswählen. Das Feld is_new enthält die neue Konto-ID, wenn Ihr/e Nutzer/in ein anderes Konto als ursprünglich verknüpft hat. Befolgen Sie die Schritte, um das neu erstellte Financial Connections-Konto in eine Zahlungsmethode zu konvertieren.

Wenn der/die Nutzer/in keine belastbaren Konten hat, ist die Länge von accounts 0.

Sitzung erstellen

Erstellen Sie eine Financial Connections-Sitzung und geben Sie Folgendes an:

1. Legen Sie account_holder[customer] auf die Kunden-id fest.
2. Legen Sie den Parameter permissions so fest, dass er payment_method und alle Daten einschließt, die Sie über das Konto abrufen möchten. Der Parameter „Berechtigungen“ ist ein Array mit Werten, wie z. B. [payment_method, balances, ownership, transactions]. Um sensible Daten Ihrer Nutzer/innen zu schützen, können Sie nur auf die Daten zugreifen, die Sie im Parameter permissions angegeben haben. Überlegen Sie genau, welche Daten für Ihr Anwendungsszenario erforderlich sind, und fordern Sie nur den Zugriff auf diese Daten an. Nach Abschluss des Authentifizierungsablaufs sehen Ihre Nutzer/innen die von Ihnen im Parameter „Berechtigungen“ angegebenen Daten und geben ihre Zustimmung zur Weitergabe dieser Daten. Das folgende Codebeispiel zeigt, wie balances und payment_method erfasst werden.
3. Legen Sie relink_options[authorization] auf die Autorisierungs-ID fest, um die Autorisierung des Kontos auszurichten, für das Sie den Datenzugriff wiederherstellen möchten.

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[]"=payment_method \
  -d "permissions[]"=balances \
  -d "relink_options[authorization]"=fcauth_1LDYuMGxLVUXRs6HW0lrat9T

Die Anfrage gibt eine Antwort ähnlich der Folgenden zurück:

{
  "id": "fcsess_abcd",
  "object": "financial_connections.session",
  "livemode": true,
  "account_holder": {
    "customer": "cus_NfjonN9919dELB",
    "type": "customer"
  },
  "accounts": [],
  "client_secret": "fcsess_client_secret_UsESkKYzeiRcivgDJZfxZRFh",
  "permissions": [
    "payment_method", "balances"
  ],
  "relink_options": {
    "authorization": "fcauth_1LDYuMGxLVUXRs6HW0lrat9T"
  }
}

Erneute Verknüpfung eines Financial Connections-Kontos

Verwenden Sie das zurückgegebene client_secret mit Stripe.js, damit Ihre Nutzer/innen ihre Konten erneut verknüpfen 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 stripe.collectFinancialConnectionsAccounts, um ein Konto zu erfassen.

// Fetch existing accounts on the authorization to determine whether the linked account is new.
const existing_account_ids = await fetch_existing_accounts();
const financialConnectionsSessionResult = await stripe.collectFinancialConnectionsAccounts({ clientSecret: "fcsess_client_secret_UsESkKYzeiRcivgDJZfxZRFh" });

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 erneut verknüpften Konten enthält:

stripe.collectFinancialConnectionsAccounts(client_secret).then(({session, error}) => {
    if (error) {
      // The session failed for some reason.
      console.error(error.message);
    } else if (session.accounts.length > 0) {
      // User has reauthorized existing Financial Connections accounts.
      reload_accounts(session.accounts);
    } else if (accounts.length == 0) {
      // The session failed to connect an account.
    }
  });

Wenn Ihr/e Nutzer/in ein Konto für die gemeinsame Nutzung von Daten verknüpft hat, ist die Länge von accounts > 0.

Innerhalb der OAuth-Abläufe des Finanzinstituts Ihrer Endnutzer/innen können diese ein anderes als das ursprünglich verknüpfte Konto auswählen.