Afin d’interroger une API, la version de l’API inclut le numéro de version dans l’URI appelée, soit par exemple : /stet/psd2/v1.4.2/accounts.

La description des services proposés ci-après n’est que purement fonctionnelle. Les aspects techniques sont répertoriés dans la rubrique "Cas d’usage" qui sont plus détaillées.

Vous devez aussi être familier avec la terminologie DSP2 et les abrévations utilisées. Vous pouvez également utiliser la foire aux questions (FAQ), l'assistant virtuel ou le glossaire.

Pour rappel, il faudra que vous :

• exécutiez une authentification mutuelle avec vos certificats

• fassiez une demande de jeton d'accès (Oauth2) via le mode "redirection"

• récupéreriez la liste des comptes courants

• demandiez le consentement client et le transmettre au teneur de compte (ASPSP).

Une fois fait, l’objectif de cette API concerne l’obtention d’informations consenties en fonction des choix du client sur son ou ses comptes de paiement :

• le solde

• et/ou l'historique des transactions

• et/ou le nom et prénom du détenteur du compte

Certains de ces services peuvent présenter des limitations : s’ils ne sont pas proposés via la banque à distance, ils ne le seront pas via cette API (voir la rubrique "Limitations"), ce qui est le cas par exemple des deux derniers services listés ci-dessus.

Dans l'environnement d'assemblage/sandbox, l'accès aux données de tests se fait via le point d'entrée www.<codetab>.sandbox.api.89C3.com (voir la rubrique "Comment tester l'API ?").

Dans l'environnement de production, l'accès aux données de production se fait via le point d'entrée www.<codetab>.live.api.89C3.com (voir la rubrique "Limitations").

➤ Obtenir la liste des comptes d'un client

Description

Ce premier appel permet de récupérer la liste des comptes du client usager d'un service de paiement (PSU) chez le teneur de compte (ASPSP) pour lequel le TPP (AISP) est connecté.

Prérequis

• Le TPP est présent dans le référentiel des tiers agréés avec un rôle d'AISP

• Le TPP et le PSU sont liés à l'ASPSP par un contrat

• Lors de cette étape, un jeton d'autorisation OAUTH2 (ou token d'accès) a été délivré au TPP par l'ASPSP (voir le cas d'usage technique associé)

• Le TPP et l'ASPSP se sont mutuellement contrôlés et authentifiés

• Le TPP a fourni son jeton d'autorisation à l’ASPSP pour pouvoir consommer les ressources de cette API

Echange de données

Le TPP envoie une requête GET à l'ASPSP pour récupérer la liste des comptes du PSU. L'ASPSP obtient cette liste en retour et la présente au client afin que celui puisse choisir les comptes et données auxquels il autorise l’accès (voir le cas d'usage technique associé).

➤ Enregistrer le consentement d'un client (AISP)

Description

Cette seconde requête rendue obligatoire par le teneur de compte (ASPSP) permet de lui transmettre la liste des comptes et des données consenties afin qu’il puisse enregistrer ces informations du client (PSU) pour lequel le prestataire de service (AISP) est connecté.

Ce consentement contient le détail des accès consentis par le PSU à l’AISP.

Un enregistrement du consentement est donc réalisé pour un PSU donné, un AISP donné, une opération donnée et un compte donné.

Chaque nouvel appel de l'AISP au service d'enregistrement du consentement pour un PSU donné, annulera et remplacera le consentement précédent le cas échéant.

Par ailleurs, à la demande du PSU, le consentement pourra être modifié ultérieurement par type d'opération : par exemple, le consentement pour l'accès à l'historique des transactions peut être révoqué alors que le consentement pour les soldes reste actif.

Le consentement est vérifié à chaque requête passée d’accès à ces informations.

Prérequis

Le TPP a présenté une première demande de récupération de la liste des comptes d'un PSU et les a présentés au client pour finaliser son consentement.

Le PSU communique à l'AISP la liste des comptes et des fonctionnalités pour lesquels un consentement est donné.

Echange de données

L'AISP transmet ces informations à l'ASPS via une requête PUT en incluant la liste des comptes et des données consenties par le PSU (voir le cas d'usage technique associé).

➤ Obtenir le solde d'un compte

Description

Cet appel permet de récupérer le solde comptable ("CLBD" dans la norme STET) d'un compte du PSU pour lequel l'AISP est connecté.

Prérequis

Le TPP aura récupéré auparavant la liste des comptes disponibles pour le PSU et a transmis les informations consenties à l’ASPSP.

Echange de données

L'AISP sollicite l'ASPSP pour l’un des comptes consentis du PSU et demande le solde.

L'ASPSP doit fournir au minimum le solde comptable du compte (voir le cas d'usage technique associé).

➤ Obtenir la liste des transactions d'un client

Description

Cet appel permet de récupérer la liste des opérations d'un compte du PSU pour lequel l'AISP est connecté.

Les transactions obtenues sont inférieures ou égales à 90 jours par rapport à la date du jour.

Prérequis

Le TPP aura récupéré auparavant la liste des comptes disponibles pour le PSU et a transmis les informations consenties à l’ASPSP.

Echange de données

L'AISP sollicite l'ASPSP pour l’un des comptes à vue du PSU. Il peut fournir certains critères de sélection.

L'ASPSP répond avec une liste de transactions correspondant à la requête (voir le cas d'usage technique associé).

➤ Récupérer l’identité du client

Vous récupérez l’identité du PSU connecté via un accès à la méthode GET /end-user-identity (voir le cas d'usage technique associé).