Obtenir la liste des comptes
Ce service permet de lister tous les comptes éligibles* à la DSP2.
NB (*) : comptes de paiements actifs et accessibles en ligne, soit des comptes de dépôt pour les clients particuliers, et des comptes courants pour les professionnels et entreprises.
➤ Prérequis
Pour procéder à cette requête, il est nécessaire de remplir les prérequis d’éligibilité et d'avoir récupéré le jeton d'accès OAUTH2 (voir la rubrique "Vue d'ensemble" > "Récupérer votre jeton").
➤ Requête
Requête "GET /accounts"
Voir aussi la spécification de place STET
➤ Paramètres obligatoires ou facultatifs du body requis pour l'appel de ce service
Aucun paramètre spécifique n'est requis pour l'appel de ce service.
➤ Résultat retourné
En cas de première utilisation de cette requête (et donc si vous n'avez pas transmis au préalable d'information via la méthode PUT /consents), ou que tous les comptes consentis ont été révoqués suite à une appel avec la méthode PUT /consents à blanc (= pas de compte consenti transmis) :
- Cet appel permet au TPP de récupérer la liste de tous les comptes éligibles* DSP2 du client sans les données ou liens associées (= sans les URI pour les méthodes GET /balances, GET /transactions, etc ...)
Si vous avez transmis au préalable au moins un compte consenti par le client via la méthode PUT /consents, et qu'il n'a pas été révoqué avec la méthode PUT /consents à blanc (= pas de compte consenti transmis), alors cet appel :
- permet de récupérer la liste de tous les comptes consentis du client détenteur avec :
- L'URI pour la méthode GET /balances si le/les IBAN font partie de la liste "balances" transmise via la méthode PUT /consents
- L'URI pour la méthode GET /transactions si le/les IBAN font partie de la liste "transactions" transmise via la méthode PUT /consents
+ un lien self pour le détail des transactions /!\ nouveauté V1.6.2
- L'URI pour la méthode GET /overdrafts si le/les IBAN font partie de la liste "overdrafts" transmise via la méthode PUT /consents /!\ nouveauté V1.6.2
- permet de récupérer les nouveaux comptes (sans les données, cf. premier appel ci-dessus) sans avoir à effectuer un PUT /consents à blanc /!\ nouveauté V1.6.2
- ne vous permet pas de récupérer les informations pour les comptes non consentis ou non éligibles DSP2 (par exemple les comptes d'épargne)
Vos accès à cette méthode sont limités à 4 accès batch maximum par jour, pour un client donné / un compte donné / par ASPSP / par TPP . En revanche, le nombre d'accès n'est pas limité lorsque c'est le client connecté qui interroge directement ses comptes.
➤ Exemple
Un exemple de requête est fourni dans la rubrique "Comment tester l'API ?" > "Assemblage sandbox".
Les jeux de données de tests sont décrits dans la rubrique "Comment tester l'API ?" > "Tester nos personas".
Remarque :
- Le champ "currency" a été déplacé au niveau de l'"accountId".
Voir aussi la spécification de place STET
➤ Tests d'acceptance
Ces cas de tests ont pour objectif de vous permettre d'effectuer un minimum de tests afin de prendre en main cette API et d'y accéder depuis votre application.
Ils devront être validés avant tout déploiement applicatif en production.
Le scope OAuth2 = aisp sauf indication contraire.
Description du test | Jeu de données et Résultat attendu |
---|---|
Récupération de toutes les transactions d'un PSU Sur un compte autorisé | Persona : GEORGES Résultat : historique des transactions retourné |
Récupération des transactions sur un compte non authorisé (ou inconnu) d'un PSU | Persona : LEA Résultat : HTTP code 404 - AccountId inconnu |
Requête HTTP avec un jeton d'accès non autorisé pour la ressource (scope erroné) | Persona : LEA Prérequis : scope OAuth2 <> aisp Résultat : message d'erreur HTTP code 403 => accès à la ressource refusé |
Passage d'une mauvaise requête HTTP POST | Persona : LEA Résultat : message d'erreur HTTP code 405 => méthode non autorisée |
Récupération des transactions avec le paramètre "dateFrom" | Persona : GEORGES Résultat : historique des transactions retourné à partir de la date spécifiée en paramètre d'entrée |
Récupération des transactions avec le paramètre "dateTo" | Persona : GEORGES Résultat : historique des transactions retourné jusqu'à la date spécifiée en paramètre d'entrée |
Récupération des transactions avec les paramètres "dateFrom" et "dateTo" | Persona : GEORGES Résultat : historique des transactions retourné entre les dates spécifiées en paramètres d'entrée |
Récupération des transactions avec le champ optionnel "entryReference" vide | Persona : GEORGES Résultat : historique des transactions retourné avec le champs spécifié vide |
Récupération des transactions avec le paramètre d'entrée "dateFrom" supérieur à 62 jours | Persona : LEA Résultat : message d'erreur HTTP code 400 |
Pas de transactions disponible | Persona : CLAIRE / account FR7617515900000400358074026 Resultat : message HTTP code 204 |