Rétablir l'accès aux données d'un compte Financial Connections avec l'autorisation de votre utilisateurVersion bêta publique

Créer une session Financial Connections

Créez une session Financial Connections et indiquez les éléments suivants :

1. Définissez account_holder[customer] sur l’id du client.
2. Définissez le paramètre de données permissions pour inclure payment_method et toutes les données que vous souhaitez récupérer sur le compte. Le paramètre permissions est un tableau contenant des valeurs, notamment[payment_method, balances, ownership, transactions]. Pour protéger la confidentialité des données de votre utilisateur, seules les données de compte que vous avez spécifiées dans le paramètre permissions sont accessibles. Définissez les données requises pour répondre à votre cas d’usage et demandez l’autorisation d’accéder uniquement aux données dont vous avez besoin. À l’issue du flux d’authentification, votre utilisateur voit s’afficher les données que vous avez spécifiées à partir du paramètre permissions, et consent à partager ces données. L’exemple de code suivant montre comment collecter les valeurs balances et payment_method.
3. Définissez relink_options[authorization] sur l’ID d’autorisation pour cibler l’autorisation du compte dont vous souhaitez rétablir l’accès aux données.
4. Définissez filters[account_subcategories] sur checking, savings.
5. Définissez limits[accounts] sur 1.

Pour accepter les paiements par prélèvement automatique ACH avec Stripe, vous ne pouvez ajouter qu’un seul compte débitable.

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

La requête renvoie une réponse semblable à ce qui suit :

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

Associer à nouveau un compte Financial Connections

Utilisez la client_secret renvoyée avec Stripe.js pour permettre à l’utilisateur de réassocier 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 stripe.collectFinancialConnectionsAccounts pour collecter un compte.

// 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" });

Stripe.js charge le flux d’authentification, c’est-à-dire l’interface utilisateur de Stripe.js côté client, qui permet à vos utilisateurs d’afficher et de consentir à partager les données auxquelles vous avez demandé l’accès à partir du paramètre permissions, et de réassocier leur compte bancaire à votre plateforme et à Stripe.

Le flux d’authentification peut se présenter comme suit :

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 :

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.
    }
  });

Si votre utilisateur a associé un compte pour le partage de données, la longueur des accounts est > 0.

Dans les flux OAuth de la banque de vos utilisateurs finaux, ces derniers peuvent sélectionner un compte différent de celui initialement associé. Le champ is_new inclura le nouvel ID de compte si votre utilisateur a associé un compte différent de celui initialement associé. Effectuez les étapes permettant de convertir le nouveau compte Financial Connections en moyen de paiement.

Si l’utilisateur n’a pas de compte débitable, la longueur des accounts est de 0.

Créer une session

Créez une session Financial Connections et indiquez les éléments suivants :

1. Définissez account_holder[customer] sur l’id du client.
2. Définissez le paramètre de données permissions pour inclure payment_method et toutes les données que vous souhaitez récupérer sur le compte. Le paramètre permissions est un tableau contenant des valeurs, notamment[payment_method, balances, ownership, transactions]. Pour protéger la confidentialité des données de votre utilisateur, seules les données de compte que vous avez spécifiées dans le paramètre permissions sont accessibles. Définissez les données requises pour répondre à votre cas d’usage et demandez l’autorisation d’accéder uniquement aux données dont vous avez besoin. À l’issue du flux d’authentification, votre utilisateur voit s’afficher les données que vous avez spécifiées à partir du paramètre permissions, et consent à partager ces données. L’exemple de code suivant montre comment collecter les valeurs balances et payment_method.
3. Définissez relink_options[authorization] sur l’ID d’autorisation pour cibler l’autorisation du compte dont vous souhaitez rétablir l’accès aux données.

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

La requête renvoie une réponse semblable à ce qui suit :

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

Associer à nouveau un compte Financial Connections

Utilisez la client_secret renvoyée avec Stripe.js pour permettre à l’utilisateur de réassocier 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 stripe.collectFinancialConnectionsAccounts pour collecter un compte.

// 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" });

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 :

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.
    }
  });

Si votre utilisateur a associé un compte pour le partage de données, la longueur des accounts est > 0.

Dans les flux OAuth de la banque de vos utilisateurs finaux, ces derniers peuvent sélectionner un compte différent de celui initialement associé.