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 à vue pour les professionnels et entreprises gérés par ce teneur de compte.
➤ Prérequis
Cet appel permet de récupérer la liste des comptes paiement du PSU (usager d'un service de paiement) pour lequel l'AISP (prestataire de service de paiement) est connecté.
Chaque compte est retourné avec les liens permettant de consulter les soldes ou les encours ainsi que les transactions associées à celui-ci.
Une pagination de la liste renvoyée peut être faite si le nombre de comptes est élevé, dans ce cas des liens de navigation donnant accès à la première page, la précédente, la suivante et la dernière page faciliteront la consultation des résultats.
Un lien self sera également présent pour revenir à la page obtenue juste après exécution de la requête.
Les accès à cette méthode sont limités à 4 accès batch maximum par jour calendaire, pour un TPP sans connexion du client, hors pagination.
➤ Requête
"GET /accounts"
➤ Paramètre
Aucun paramètre spécifique n'est requis lors de l'appel à ce service (en dehors du jeton oauth2).
➤ Exemple
Requête
GET www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts
Résultat
Status code : HTTP 200
Body
{ "_links": { "last": { }, "self": { }, "first": { } }, "accounts": [ { "cashAccountType": "CACC", "accountId": { "iban": "FR353000799999A40166510BB25" }, "balances": { "balanceType": "CLBD", "name": "Solde en capital", "referenceDate": "2019-3-5", "balanceAmount": { "amount": "18217563.75", "currency": "EUR" } }, "ressourceId": "EURFR353000799999A40166510BB25", "usage": "ORGA", "name": "Compte client 1", "bicFi": "NATXFRPP", "currency": "EUR", "links": { "balances": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/EURFR353000799999A40166510BB25/balances" }, "transactions": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/EURFR353000799999A40166510BB25/transactions" } } }, { "cashAccountType": "CACC", "accountId": { "iban": "FR203000799999A40166510CC89" }, "balances": { "balanceType": "CLBD", "name": "Solde en capital", "referenceDate": "2019-3-5", "balanceAmount": { "amount": "7255.44", "currency": "EUR" } }, "ressourceId": "EURFR203000799999A40166510CC89", "usage": "ORGA", "name": "Compte client 2", "bicFi": "NATXFRPP", "currency": "EUR", "links": { "balances": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/EURFR203000799999A40166510CC89/balances" }, "transactions": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/EURFR203000799999A40166510CC89/transactions" } } }, { "cashAccountType": "CACC", "accountId": { "iban": "FR053000799999A40166510DD56" }, "balances": { "balanceType": "CLBD", "name": "Solde en capital", "referenceDate": "2019-3-5", "balanceAmount": { "amount": "158789.33", "currency": "EUR" } }, "ressourceId": "EURFR053000799999A40166510DD56", "usage": "ORGA", "name": "Compte client 3", "bicFi": "NATXFRPP", "currency": "EUR", "links": { "balances": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/EURFR053000799999A40166510DD56/balances" }, "transactions": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/EURFR053000799999A40166510DD56/transactions" } } }, { "cashAccountType": "CACC", "accountId": { "iban": "FR533000799999A661665104443" }, "balances": { "balanceType": "CLBD", "name": "Solde en capital", "referenceDate": "2019-3-5", "balanceAmount": { "amount": "56754.45", "currency": "USD" } }, "ressourceId": "USDFR533000799999A661665104443", "usage": "ORGA", "name": "Compte client 4", "bicFi": "NATXFRPP", "currency": "USD", "links": { "balances": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/USDFR533000799999A661665104443/balances" }, "transactions": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/USDFR533000799999A661665104443/transactions" } } }, { "cashAccountType": "CACC", "accountId": { "iban": "FR823000700999A40166510EE50" }, "balances": { "balanceType": "CLBD", "name": "Solde en capital", "referenceDate": "2019-3-5", "balanceAmount": { "amount": "-4367.78", "currency": "EUR" } }, "ressourceId": "EURFR823000700999A40166510EE50", "usage": "ORGA", "name": "Compte client 5", "bicFi": "NATXFRPP", "currency": "EUR", "links": { "balances": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/EURFR823000700999A40166510EE50/balances" }, "transactions": { "templated": false, "href": "https://www.30007.sandbox.api.89c3.com/stet/psd2/v1.6.2/accounts/EURFR823000700999A40166510EE50/transactions" } } } ], "connectedPsu": "Marc" } |
➤ Tests d'acceptance
Ces tests ont pour objectif de s'assurer que l'API respecte la norme STET. Ils devraient être validés avant tout déploiement applicatif.
Description du test | Nature du test | Jeu de données |
Récupération de tous les comptes d'un PSU
scope OAuth2 = aisp | Obligatoire | Persona : Utilisateur : WUBUPA57 Résultat : Restitution de 5 comptes de paiement |
Récupération de tous les comptes d'un PSU non accessible =>Un code HTTP 404 est renvoyé | Obligatoire | Persona : MOVEZY48 Résultat : Un message d'erreur HTTP404 est retourné - Pas de compte trouvé |