Utiliser l’API Accounts v2 dans votre intégration existante
Découvrez comment mettre à jour les intégrations basées sur Accounts v1 et Customers v1.
Suivez ce guide pour mettre à jour votre intégration Connect reposant sur Accounts v1 et Customers v1 et profiter des fonctionnalités proposées par Accounts v2 :
- Reliez vos comptes connectés aux paiements effectués sur votre plateforme, sans avoir besoin de créer des objets Customer.
- Évitez les coûts de réseau en permettant à vos comptes connectés de payer votre plateforme avec leur solde Stripe.
- Permettez à vos comptes connectés de conserver des fonds sur votre plateforme en utilisant les Comptes financiers v2.
Si vous n’avez pas besoin des fonctionnalités d’Accounts v2, vous pouvez continuer à utiliser votre intégration de plateforme basée sur Accounts v1 et Customers v1.
Utilisez les endpoints v2 pour l’ensemble de vos comptes
L’API Accounts v2 fonctionne avec vos Accounts v1 existants, sans nécessiter aucune modification.
Délai de création d’un compte
Un nouveau Account v1 peut nécessiter jusqu’à 10 minutes avant de pouvoir être utilisé avec un endpoint Accounts v2. Lorsque l’Account est prêt pour les requêtes API v2, il envoie un événement webhook v2..
Ajouter une configuration client
En ajoutant la configuration Customer à un Account, vous pouvez utiliser l’identifiant Account dans toute requête API qui accepte un identifiant Customer, par exemple pour créer un abonnement. Plutôt que de renseigner le paramètre customer avec un identifiant Customer, vous indiquez le paramètre customer_ avec l’identifiant Account.
Dans cet exemple, l’API Accounts v2 permet d’ajouter la configuration Customer à un Account v1 existant, puis de mettre à jour un abonnement pour que le compte soit facturé via son solde Stripe.
- Mettez à jour l’
Accountpour ajouter la configurationcustomer.
- Retrieve the connected account to confirm it has the
card_capability in the merchant configuration. This capability must be active in order to use the Stripe balance as a payment method.payments
- Add the connected account’s Stripe balance as a payment method.
- Create a subscription that charges the connected account using its Stripe balance.
Il n’est plus nécessaire de créer un objet Customer séparé pour recevoir les paiements d’abonnement de ce compte connecté.
Adaptez votre intégration progressivement, étape par étape
Comme vous pouvez utiliser à la fois les API Accounts v1 et v2 avec vos Accounts, vous pouvez mettre à jour votre intégration selon le rythme qui convient le mieux à votre activité. Par exemple, vous pouvez :
- Appelez les endpoints
/v2/core/accountspour lesAccountscréés avec l’API v1. - Appelez les endpoints
/v1/accountspour lesAccountscréés avec l’API v2. - Appelez les endpoints
/v1/customerspour lesAccountsdisposant de la configuration client. - Utilisez l’API Événements v2 pour écouter les modifications des objets, qu’ils soient créés via la version v1 ou v2 de l’API.
Grâce à ces compatibilités, vous pouvez adapter votre intégration progressivement, sans avoir à maintenir plusieurs versions en production ni à mettre à jour l’intégralité de votre intégration d’un coup.
Nous recommandons de mettre à jour votre intégration dans l’ordre suivant :
- Configurez un nouveau endpoint pour écouter les Événements v2.
- Modifiez vos appels de
createAccountetCustomerpour créer desAccountsconfigurés comme client en utilisant/v2/core/accounts. - Modifiez vos appels de
updateAccountetCustomerpour utiliser/v2/core/accounts. - Modifiez vos appels de
retrieveAccountetCustomerpour utiliser/v2/core/accounts.
Utilisez des Accounts v2 dans des endpoints v1
Lorsque vous utilisez des objets v2 dans des endpoints v1, les données sont renvoyées au format d’un objet v1. Par exemple :
- Lorsque vous référencez un
Accountv2 dans un endpoint/v1/accounts, les données sont renvoyées au format d’unAccountv1. - Lorsque vous référencez un
Accountv2 dans un endpoint/v1/customers, les données sont renvoyées au format d’unCustomerv1 et contiennent à la fois l’identifiantcustomeret l’identifiantcustomer_.account
Vous pouvez utiliser des Accounts configurés avec Customer dans l’API Customers v1, mais vous ne pouvez pas référencer des Customers v1 dans l’API Accounts v2. Vous devez soit migrer les données client vers un Account configuré avec Customer, soit mettre à jour un compte connecté existant pour ajouter la configuration Customer.
Événements de webhook
Les Comptes génèrent des événements v1 (snapshot) et v2 (thin). Nous vous conseillons de créer un nouveau endpoint dédié afin de recevoir les événements Accounts v2.
- Dans votre Dashboard Stripe, ouvrez le menu des développeurs en cliquant sur Développeurs au bas du menu de navigation, puis sélectionnez Webhooks.
- Cliquez sur + Ajouter une destination.
- Dans la section Événements de, sélectionnez Comptes connectés.
- Sélectionnez Afficher les options avancées. Dans la section Style de charge utile, sélectionnez Léger.
- Dans le champ Événements, sélectionnez un ou plusieurs événements correspondant à la version de l’objet
Account:- Pour v1, entrez « v1 » pour filtrer les types d’événements des objets v1, puis choisissez v1.account.updated.
- Pour v2, entrez « v2 » pour filtrer les types d’événements des objets v2. Choisissez v2.core.account.updated ou l’un des événements v2.core.account[*].updated correspondants.
- Poursuivez la configuration de votre destination d’événements en suivant les instructions du générateur d’endpoint de webhook interactif.
Par exemple, la mise à jour d’un Account, quelle que soit sa version, peut générer :
- Un événement v1
account.updated - Un événement v2
v1.account. updated - Un événement v2
v2.core. account. updated
Différences de version des Comptes dans l’API Événements v2
La majorité des événements v2. ne correspondent pas directement aux événements v1.. Par exemple, toute modification d’une propriété d’un Account déclenche un événement v1., tandis que la même modification peut produire des événements ciblés pour v2, comme v2. ou v2..
L’événement v2. est envoyé uniquement lorsque des propriétés de premier niveau, comme dashboard ou display_, sont mises à jour, sans déclencher les événements de mise à jour plus spécifiques.
Limitations de l’API Accounts v2
Vous devez utiliser Accounts v1 dans les cas suivants :
- Comptes connectés via OAuth
- Des comptes ayant signé un contrat d’utilisation du service du bénéficiaire
- Pour demander ou gérer les fonctionnalités suivantes :
treasurycard_issuing_ * - Fonctionnalités obsolètes telles que
legacy_payments - moyens de paiement obsolètes
- moyens de paiement en aperçu public ou privé
Virements transfrontaliers
Utilisez Virements internationaux pour effectuer des virements transfrontaliers.