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

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

Serverseitig

Für diese Integration sind Endpoints auf Ihrem Server erforderlich, die mit der Stripe-API kommunizieren können. Nutzen Sie diese offiziellen Bibliotheken für den Zugriff auf die Stripe-API von Ihrem Server aus:

# Available as a gem
sudo gem install stripe

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

Clientseitig

Das Stripe iOS SDK ist Open Source, vollständig dokumentiert und kompatibel mit Apps, die iOS 13 oder höher unterstützen.

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.

Der Kunde/Die Kundin verlässt ggf. Ihre App, um sich zu authentifizieren (z. B. in Safari oder einer Banking-App). Damit sie nach der Authentifizierung automatisch zu Ihrer App zurückkehren können, konfigurieren Sie ein benutzerdefiniertes URL-Schema und richten Sie Ihren App-Delegate so ein, dass die URL an das SDK weitergeleitet wird. Stripe unterstützt keine universellen Links.

// This method handles opening custom URL schemes (for example, "your-app://stripe-redirect")
func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let url = URLContexts.first?.url else {
        return
    }
    let stripeHandled = StripeAPI.handleURLCallback(with: url)
    if (!stripeHandled) {
        // This was not a Stripe url – handle the URL normally as you would
    }
}

Bevor der Financial Connections-Ablauf angezeigt wird, sollte Ihre Seite die Schaltfläche Finanzkonto verbinden enthalten, um die Nutzeroberfläche von Stripe anzuzeigen.

Rufen Sie in Ihrer App das Client-Geheimnis der FinancialConnectionsSessionund den veröffentlichbaren Schlüssel von dem Endpoint ab, den Sie im vorherigen Schritt erstellt haben. Legen Sie Ihren veröffentlichbaren Schlüssel mit StripeAPI.shared fest und initialisieren Sie FinancialConnectionsSheet. Übergeben Sie die returnURL, die Sie im vorherigen Schritt eingerichtet haben.

import StripeFinancialConnections

class ViewController: UIViewController {
  @IBOutlet weak var connectFinancialAccountButton: UIButton!
  var financialConnectionsSheet: FinancialConnectionsSheet?
  let backendCheckoutUrl = URL(string: "Your backend endpoint")! // Your backend endpoint

  override func viewDidLoad() {
    super.viewDidLoad()

    connectFinancialAccountButton.addTarget(self, action: #selector(didTapConnectFinancialAccountButton), for: .touchUpInside)
    connectFinancialAccountButton.isEnabled = false

    // MARK: Fetch the FinancialConnectionsSession client secret and publishable key
    var request = URLRequest(url: backendCheckoutUrl)
    request.httpMethod = "POST"
    let task = URLSession.shared.dataTask(with: request, completionHandler: { [weak self] (data, response, error) in
      guard let data = data,
            let json = try? JSONSerialization.jsonObject(with: data, options: []) as? [String : Any],
            let clientSecret = json["client_secret"] as? String,
            let publishableKey = json["publishable_key"] as? String,
            let self = self else {
        // Handle error
        return
      }

      // MARK: Set your Stripe publishable key - this allows the SDK to make requests to Stripe for your account
      STPAPIClient.shared.publishableKey = publishableKey

      self.financialConnectionsSheet = FinancialConnectionsSheet(
        financialConnectionsSessionClientSecret: clientSecret,
        returnURL: "https://your-app-domain.com/stripe-redirect"
      )

      DispatchQueue.main.async {
        self.connectFinancialAccountButton.isEnabled = true
      }
    })
    task.resume()
  }

  @objc
  func didTapConnectFinancialAccountButton() {
      // implemented in the next steps
  }
}

Wenn der/die Kund/in auf die Schaltfläche Finanzkonto verbinden tippt, rufen Sie FinancialConnectionsSheet#present auf, um das Financial Connections-Formular anzuzeigen. Nachdem der/die Kund/in den Financial Connections-Ablauf abgeschlossen hat, wird das Formular verworfen und der Abschlussblock wird mit einem FinancialConnectionsSheetResult aufgerufen.

@objc
func didTapConnectFinancialAccountButton() {
  // MARK: Start the financial connections flow
  financialConnectionsSheet?.present(
    from: self,
    completion: { result in
        switch result {
        case .completed(session: let financialConnectionsSession):
            let accounts = financialConnectionsSession.accounts.data.filter { $0.last4 != nil }
            let accountInfos = accounts.map { "\($0.institutionName) ....\($0.last4!)" }
            print("Completed with \(accountInfos.joined(separator: "\n")) accounts")
        case .canceled:
            print("Canceled!")
        case .failed(let error):
            print("Failed!")
            print(error)
        }
  })

}

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.