Obtenir les soldes d'un compte

Ce service permet de lister les soldes d'un compte de paiement d'un client.

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 nous avoir été transmis dans la liste "balances" de la méthode PUT /consents et ne doit pas avoir été révoqué depuis (<=> pas d'annule et remplace via PUT /consents sans cet IBAN dans la liste "transactions")
  • L'"accountResourceId" permettant d'interroger cette méthode pour ce compte courant, est récupéré via le résultat de la requête GET /accounts dans la rubrique "resourceId" pour le compte correspondant à cet IBAN, c'est-à-dire tel que "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"

book picto 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 : compte pour lequel on veut consulter le solde. 

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 la liste des soldes d'un compte 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 correspondant à un compte doit être fourni pour obtenir la liste des soldes.

Un seul type de solde sera retourné dans le cas d'un compte passé en paramètre : le solde Comptable ("CLBD" dans la norme STET).

Il correspond au solde comptable en fin de période (fin de semaine, fin de mois, fin de trimestre, fin de semestre, fin d’année).

Vos accès à cette méthode sont limités à 4 accès batch maximum par jour, pour un client et pour un compte. 

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

book picto 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.

 

Description du testJeu de données et Résultat attendu

Récupération du solde d'un compte

=> Vérification du solde négatif

Contexte de prise en charge du PSU = BY-AISP
scope OAuth2 = aisp

Persona : LEA

Résultat : restitution du solde d'un compte de dépôt

Récupération du solde liés à un compte inconnu

=> Un code HTTP 404 est renvoyé : compte inconnu

Persona : Inconnu - 038-CPT30014684067

Résultat : un message d'erreur HTTP 404 est retourné

Requête HTTP avec un jeton d'accès non autorisé pour la ressource (scope erroné)

=> L'accès à la ressource est refusé : code HTTP 403

Persona : LEA

Résultat : un message d'erreur HTTP 403 est retourné

Passage d'une requête HTTP POST

=> Un code HTTP 405 est renvoyé

Persona : LEA

Résultat : un message d'erreur HTTP 405 est retourné

Récupération du solde d'un compte

=> Vérification du solde nul

Contexte de prise en charge du PSU = BY-AISP
scope OAuth2 = aisp

Persona : CLAIRE - FR7617515900000400358074026

Résultat : restitution du solde d'un compte de dépôt

Récupération du solde d'un compte

=> Vérification du solde positif 

Contexte de prise en charge du PSU = BY-AISP
scope OAuth2 = aisp

Persona : CLAIRE - FR7617515900000800358074006

Résultat : restitution du solde d'un compte de dépôt