Obtenez les découverts autorisés d'un compte à vue !

➤ Cas d'usage

Ce service permet de récupérer les découverts autorisés d'un compte à vue.

Ce service fait suite à la restitution de la liste des comptes : un resourceId correspondant à un compte doit être fourni pour obtenir la liste des découverts autorisés du compte.

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

En résumé, ce service permet de récupérer les découverts autorisés d'un compte à vue du client.

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

Pour récupérer les découverts autorisés d'un compte à vue :

• L'IBAN du compte à vue doit nous avoir été transmis dans la liste "overdrafts" 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 "overdrafts")

• L "accountResourceId" permettant d'interroger cette méthode pour ce compte à vue, est récupéré via le résultat de la requête GET /accounts dans la rubrique "resourceId" pour le compte à vue correspondant à cet IBAN, c'est à dire "accountId": {"iban":"<IBAN du compte à vue>" }

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

➤ Requête

GET /account/{accoundResourceId}/overdrafts

 Voir aussi la spécification de place STET V1.6.2.0 / Part II / section 4.7.4 / page 45

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

Paramètres obligatoires : accountResourceId => compte à vue pour lequel on veut consulter les opérations ou carte à débit différé pour laquelle on veut consulter les facturettes.

Paramètres facultatifs :

• PSU-IP-ADDRESS => à alimenter si le client est connecté

➤ Résultat retourné

Cet appel permet de récupérer :

• le montant des découverts autorisés

Un lien self sera également présent pour revenir à la page obtenue juste après exécution de la requête.

Vos accès à cette méthode sont limités à 4 accès batch maximum par jour calendaire, pour un client et pour un compte à vue ou une carte à débit différé donnés (modulo la pagination éventuelle). En revanche, lorsque c'est le client connecté qui interroge directement ses comptes à vue, le nombre d'accès n'est pas limité.

➤ Exemple

Requête

GET /stet/psd2/v1.4.2/accounts/038-CPT30319665741/overdrafts

Un exemple plus complet de requête est fourni dans la rubrique "Comment tester l'API ?" > "Assemblage sandbox".

 Voir aussi la spécification de place STET V1.6.2.0 / Part III / Section 6.6 / page 10

Résultat

Status code : 200

Body

(cas du persona Adam - D0999994I0)

Codes erreurs

Voici la liste de descriptions des codes erreurs de ce service. Il y a une annotation rouge pour ceux étant définis CFONB.

Lien vers la description de la méthode et des codes retour http

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