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.

Utilisez nos bibliothèques officielles pour accéder à l’API Stripe à partir de votre application :

# Available as a gem
sudo gem install stripe

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

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.

Utilisez la client_secret renvoyée avec Stripe.js pour permettre à l’utilisateur de connecter ses comptes. Un client_secret permet aux SDK Stripe côté client d’apporter des changements à la session Financial Connections. Ne la sauvegardez pas, ne l’enregistrez pas, ne l’intégrez pas aux URL et ne la dévoilez pas à d’autres personnes que votre client final. Assurez-vous d’avoir activé TLS sur toutes les pages qui comprennent la clé secrète du client.

Utilisez collectFinancialConnectionsAccounts pour collecter un compte.

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

Cette méthode charge le flux d’authentification, l’interface utilisateur Stripe.js côté client qui permet à vos utilisateurs d’associer leurs comptes financiers à vous et à Stripe.

La valeur renvoyée par stripe.collectFinancialConnectionsAccounts est une « Promise ». Au moment où l’utilisateur termine le flux d’authentification, la Promise est résolue avec un objet qui contient la liste des comptes connectés :

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

Si l’utilisateur ne connecte aucun compte, ou quitte le flux d’authentification trop tôt, la réponse contient un tableau accounts vide.

Une fois que le processus d’authentification a abouti, un webhook financial_connections.account.created est envoyé pour chaque compte connecté.

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.