Ce service permet de récuperer le solde d'un compte de paiement d'un client qui a donné son consentement au TPP pour pouvoir y accéder.

Ce type de compte est soit un compte de dépôt pour les particuliers, soit un compte courant pour les professionnels et les personnes morales. 

➤ Prérequis

Pour récupérer le solde d'un compte :

• L'IBAN du compte doit avoir été transmis au teneur de compte dans la liste "balances" de la méthode PUT /consents, et ne doit pas avoir été révoqué depuis (= pas de requête PUT /consents SANS IBAN)

• Un identifiant de ressource permettant d'interroger cette méthode pour ce compte de paiement, est récupéré via le résultat de la requête GET /accounts dans la rubrique "resourceId" pour le compte correspondant à cet IBAN (lui-même inclus dans "accountId": {"iban":"" })

• L'URI pour l'accès à cette méthode est donnée via la rubrique "_links": {"balances":"{"href": ...}} en résultat de la requête GET /accounts pour le "resourceId" du compte

➤ Requête

Requête "GET /accounts/{accountResourceId}/balances"

 Voir aussi la spécification de place STET 

➤ Paramètres obligatoires ou facultatifs du body requis pour l'appel de ce service

Paramètre accountResourceId : obligatoire (compte pour lequel le solde doit être consulté).

• Cette donnée correspond à la rubrique "resourceId" obtenue dans la page de résultat de la requête GET /accounts
  

• Cet appel permet de récupérer le solde d'un compte de paiements du PSU (usager d'un service de paiement) pour lequel l'AISP (prestataire de service de paiement) est connecté

• Ce service fait suite à la restitution de la liste des comptes d'un client : un identifiant de ressource ("accountResourceId") correspondant à un compte doit être fourni pour en obtenir son solde

• Seul le type de solde Comptable ("CLBD" dans la norme STET) sera retourné pour le compte passé en paramètre 
  

Les accès à cette méthode sont limités à 4 accès batch maximum par jour par TPP, pour un client et pour un IBAN donné.

En revanche, lorsque c'est notre client connecté qui interroge directement ses comptes, le nombre d'accès n'est pas limité.

➤ 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".

 Voir aussi la spécification de place STET 

➤ Test 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.