Collecter des informations de compte pour créer des produits basés sur des données

Une fois que vous avez accès au mode production sur votre compte, inscrivez-vous à Financial Connections.

Côté serveur

Cette intégration exige des endpoints sur votre serveur qui communiquent avec l’API Stripe. Utilisez nos bibliothèques officielles pour accéder à l’API Stripe depuis votre serveur :

# Available as a gem
sudo gem install stripe

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

Côté client

Le SDK iOS de Stripe est disponible en open source et fait l’objet d’une documentation complète. Il est également compatible avec les applications prenant en charge iOS 13 et les versions ultérieures.

Créez un objet Customer lorsque les utilisateurs créent un compte auprès de votre entreprise. En fournissant une adresse email, vous permettez à Financial Connections d’optimiser le flux d’authentification en présentant de manière dynamique une interface utilisateur simplifiée, pour les utilisateurs existants de Link.

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

Pour que vous puissiez récupérer des données sur le compte bancaire d’un utilisateur avec Financial Connections, votre utilisateur doit au préalable authentifier son compte avec le flux d’authentification.

L’utilisateur lance le flux d’authentification lorsqu’il souhaite connecter son compte à votre site ou votre application. Insérez un bouton ou un lien sur votre site ou dans votre application pour permettre à l’utilisateur d’associer ses comptes : par exemple, « Associer votre compte bancaire ».

Créez une session Financial Connections en envoyant une requête POST à /v1/financial_connections/sessions :

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. Définissez account_holder[customer] sur l’id du client.
2. Définissez le paramètre de données permissions afin d’inclure les données nécessaires à votre cas d’usage.
3. (Facultatif) Définissez le paramètreprefetch pour récupérer les données lors de la création du compte.

Le paramètre permissions détermine les données du compte auxquelles vous pouvez accéder. Vous devez demander au moins une autorisation. Après s’être soumis au flux d’authentification, votre utilisateur peut voir les données auxquelles vous avez demandé l’accès et donner son accord pour qu’elles soient partagées.

Réfléchissez aux données dont vous aurez besoin pour votre cas d’usage, et demandez uniquement l’accès aux données nécessaires. Le fait de demander des autorisations dont vous n’avez pas besoin pour votre application risque d’éroder la confiance que vous accordent vos utilisateurs quant à la manière dont vous utilisez leurs données. Par exemple, si vous créez une application de gestion financière personnelle ou un produit de location, vous pouvez demander les données transactions d’un utilisateur. Si vous cherchez à réduire les risques de fraude et à empêcher les usurpations de comptes, vous pouvez demander les données ownership.

Une fois que l’utilisateur a authentifié son compte, vous ne pouvez étendre les autorisations d’accès aux données qu’en créant une nouvelle session Financial Connections et en spécifiant une nouvelle valeur pour le paramètre permissions. Votre utilisateur doit se soumettre à nouveau au flux d’authentification dans lequel il peut consulter les données supplémentaires auxquelles vous souhaitez accéder et autoriser le partage de ses données.

Le paramètre prefetch facultatif contrôle les données que vous récupérez immédiatement après que l’utilisateur s’est connecté à son compte. Utilisez cette option si vous savez que vous voulez toujours un certain type de données. Il n’est pas nécessaire d’effectuer un appel supplémentaire à l’API pour lancer une actualisation des données.

Pour conserver la possibilité d’accepter les paiements par prélèvement automatique ACH, demandez l’autorisation payment_method.

Le client peut quitter votre application pour s’authentifier (par exemple, dans Safari ou dans son application bancaire). Pour lui permettre de revenir automatiquement sur votre application après s’être authentifié, configurez un schéma d’URL personnalisé et configurez votre délégué d’application pour qu’il transmette l’URL au SDK. Stripe ne prend pas en charge les liens universels.

// 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
    }
}

Avant d’afficher le flux de Financial Connections, le bouton Connecter le compte financier doit être inclus dans votre page afin d’afficher l’interface utilisateur de Stripe.

Dans votre application, récupérez la clé secrète du client et la clé publiable de la FinancialConnectionsSession à partir du endpoint que vous avez créé à l’étape précédente. Définissez votre clé publiable à l’aide de StripeAPI.shared et initialisez FinancialConnectionsSheet. Transmettez la returnURL configurée à l’étape précédente.

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
  }
}

Lorsque le client touche le bouton Connecter le compte financier, appelez FinancialConnectionsSheet#present pour afficher le formulaire Financial Connections. Une fois le flux Financial Connections finalisé par le client, le formulaire se ferme et le bloc de finalisation est appelé avec un FinancialConnectionsSheetResult.

@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)
        }
  })

}

Une fois que votre utilisateur a terminé le flux d’authentification, mettez à jour ou accédez aux données du compte que vous avez précisé dans le paramètre permissions de la session Financial Connections.

Pour protéger la confidentialité des données de votre utilisateur, vous n’avez accès qu’aux données indiquées dans le paramètre permissions.

Suivez les instructions des guides consacrés aux soldes, à la propriété et aux transactions pour commencer à récupérer les données d’un compte.