Comment agréger les données ?
Un client multi bancarisé souhaite accéder à l’ensemble de ses données afin d’en avoir une vision consolidée.
Via cette API « information sur compte » mise à disposition par les teneurs de comptes, vous pouvez demander en temps réel l’accès à l’une et/ou l’autre des données que le client a autorisé SANS lui demander ses identifiants de connexion en ligne.
Les ressources de cette API ne peuvent être consommées que si vous avez obtenu le rôle de prestataire de Services d’Information sur les Comptes (« TPP AISP »), ce prérequis étant décrit dans voir la rubrique « Éligibilité« .
Le processus global est le suivant :
Le client souhaite utiliser vos services afin de consolider des informations d’un ou plusieurs comptes de paiement détenus auprès de banques, dont l’une d’entre-elles est la Banque BCP. Il vous l’indique donc laquelle à travers vos interfaces.
Lors de ce premier échange, vous allez faire une demande de jeton d’autorisation (et un jeton de rafraichissement). Le principe de base est, qu’en tant que TPP AISP, vous devez obtenir ces jetons AVANT de consommer des ressources de l’API. Ce jeton est généré par le teneur de compte (ASPSP) APRES avoir identifié et authentifié le client.
En tant que teneur de compte :
- nous allons vérifier vos certificats et agréments
- et via le jeu de la redirection, nous allons identifier et authentifier fortement le client afin de pourvoir générer le jeton d’accès
Si l’autorisation est accordée par le client, vous pourrez alors récupérer les jetons OAUTH2 via des échanges sécurisés avec la plateforme BPCE API (voir la rubrique « Vue d’ensemble » > « Récupérer votre jeton« ).
En présentant ce jeton d’autorisation, vous pourrez alors consommer les ressources de l’API « information sur compte » afin de :
- demander la liste des comptes éligibles
- nous transmettre le consentement client
- accéder de manière sécurisée aux données dont l’accès a été autorisé (voir la rubrique « Vue d’ensemble » > « Comment consommer l’API ?« ).
Au bout du délai réglementaire de 180 jours, ce processus devra être reconduit (voir la rubrique « Vue d’ensemble » > « Rafraîchir votre jeton« ).
NB : le gestionnaire de compte ASPSP a la possibilité de vous refuser l’accès pour différents motifs justifiés (API non conforme, compte bloqué entre-temps, etc.).
Utiliser le fallback
Principe
Conformément à la réglementation, les établissements du Groupe BPCE ont mis en place une interface dédiée aux prestataires de services de paiement : il s’agit des API REST DSP2 publiées.
Si l’infrastructure de production « passerelle BPCE API Live » exposant les API DSP2 est défaillante, le prestataire des services de paiements pourra utiliser la solution couvrant les « mesures d’urgence applicables à une interface dédiée » (ou « fallback ») dont le principe est le suivant :
Cette solution répond aux exigences règlementaires de la DSP2 (article 33 des RTS). Vous pourrez l’utiliser avec les mêmes conditions et pré-requis décrits dans la rubrique « Eligibilité« .
Roadmap
Retrouvez ci-dessous les éléments de notre trajectoire prévisionnelle :
| Version | Fonctionnalités | Sandbox
Date de déploiement API Dev Portal & Sandbox |
Live
Date de déploiement Live API Gateway |
| toute les version API DSP2 | Fallback (*) | Non applicable | Fin septembre 2019 |
(*) Fonctionnalités Principales :
Utilisation par le TPP du même endpoint que l’interface dédiée.
Un paramètre de requête (header « fallback:1 » présent ou absent) ajouté par le TPP permet de distinguer une requête « Fallback » d’une requête API via l’interface dédiée qui doit être utilisée systématiquement
Authentification du TPP via authentification mutuelle TLS par un certificat eIDAS (QWAC)
Sécurisation identique à celle d’un accès à la banque en ligne du PSU (même interface utilisée par le PSU qu’en accès direct, et mêmes moyens d’authentification du client)
Dans le cadre de la montée en charge de l’usage de l’interface dédiée (API), il n’est pas mis en place de bascule dynamique : la solution fallback est toujours active
La solution de fallback est une solution de secours ne devant pas être utilisée comme moyen principal d’accès pour proposer les services DSP2. Son usage en est monitoré et tout usage abusif par un/des TPP sera automatiquement reporté auprès de l’autorité nationale compétente.
Exemple
1. Dans le cas où les API DPS2 sont indisponible de façon imprévue ou le système tomberait en panne (voir critères dans le texte RTS Art. 33), le TPP peut alors envoyer la requête :
POST https://www.17515.live.api.89c3.com/stet/psd2/oauth/token
avec :
- son certificat eIDAS QWAC de production
- le paramètre header (fallback: »1″)
POST /stet/psd2/oauth/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
X-Request-ID: 1234
fallback: 1
User-Agent: PostmanRuntime/7.16.3
Accept: */*
Cache-Control: no-cache
Host: www.17515.live.api.caisse-epargne.fr
Accept-Encoding: gzip, deflate
Content-Length: 67
Connection: keep-alive
client_id=PSDFR-ACPR-12345&grant_type=client_credentials&scope=aisp
2. Si les vérifications sont positives, nous allons vous renvoyer dans le header une url de type à utiliser dans le cadre de la redirection vers l’environnement de la banque en ligne, et qui contient un jeton JWT (champs « &fallback= ») qui doit être aussi utilisé dans ce cadre :
HTTP/1.1 302 Found
Date: Tue, 25 May 2021 21:46:59 GMT
Content-Length: 870
Connection: close
Content-Type: text/html; charset=iso-8859-1
</head><body>
<h1>Found</h1>
<p>The document has moved <a href= »/www.17515.live.api.caisse-epargne.fr&fallback=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6ImhF… »>here</a>.</p>
</body></html>
3. Une fois redirigé, le TPP doit utiliser ensuite les identifiants du PSU via sa méthode propriétaire
Pour plus de détails sur la requête POST, voir spécifications STET
Limites
Les contraintes de cette solution sont les suivantes :
- Pas de réutilisation du contexte de l’interface dédiée, ni du jeton d’accès (valable 180 jours actuellement)
- Seules les fonctionnalités DSP2 présentes sur la banque en ligne (référence: banque à distance sur internet fixe) sont accessibles via le fallback. Par exemple, les services de banque en ligne ne proposent pas de paiement e-commerce (cette fonctionnalité PISP n’est donc pas disponible en mode fallback)
- Le client utilisateur des services (PSU) doit être connecté à l’application du TPP (pas de possibilité de traitement batch AISP pour venir récupérer les données consenties du client). La DSP2 imposant également un renforcement des moyens d’authentification forte (AF/SCA) systématique pour les accès à la banque à distance/en ligne, les moyens d’authentification fournis aux clients PSU seront utilisés (liste non exhaustive) :
- Soft token Sécur’Pass
- OTP SMS
- Clé physique (pour les entreprises)
Activer l'App2App
Introduction
Cette fonctionnalité permet d’activer automatiquement l’app bancaire du client à toutes fins d’identification et d’authentification.
Prérequis
Le client doit avoir chargé et utilisé au moins une fois la dernière version de l’application bancaire sur les magasins d’applications Android et Apple (version V6.4.0 et plus).
Note : les segment clients PRO & ENT ne sont pas activés
Le lien de retour (Universal link) doit être définie en avance par le TPP sur le même principe qu’une url de callback :
- si ce lien / cette url a déjà été déclarée sur notre passerelle BPCE API, il n’y a rien d’autre à faire
- sinon le TPP doit le déclarer en utilisant notre API Register
Nos liens « Universal links » ont été déclarés sur les plateformes iOS et Android. Ce n’est pas la peine d’y accéder via par exemple https://www.<codetab>.live.api.caisse-epargne.fr/89C3api/accreditation/v2/.well-known/apple-app-site-association qui renverra une erreur.
Requête
L’activation de la fonctionnalité App2App s’effectuera en production via l’envoi d’une requête par l’app du TPP au format STET suivant :
| Brand | App2App endpoint |
 |
http://www.40978.live.api.palatine.fr/stet/psd2/oauth/authorize |
 |
http://www.<codetab>.live.api.banquepopulaire.fr/stet/psd2/oauth/authorize
(voir la liste des <codetab> sur la fiche produit API Banque Populaire) |
 |
http://www.10548.live.api.banque-de-savoie.fr/stet/psd2/oauth/authorize |
 |
http://www.<codetab>.live.api.caisse-epargne.fr/stet/psd2/oauth/authorize
(voir la liste des <codetab> sur la fiche produit API Caisse d’Epargne) |
 |
http://www.12579.live.api.banquebcp.fr/stet/psd2/oauth/authorize |
 |
http://www.42559.live.api.credit-cooperatif.coop/stet/psd2/oauth/authorize |
 |
http://www.30258.live.api.btp-banque.fr/stet/psd2/oauth/authorize |
 |
http://www.18919.live.api.natixis.com/stet/psd2/oauth/authorize |
Sinon, une webview sera affichée via le navigateur du smartphone du client dans les cas suivants :
- si l’app bancaire n’est pas chargée sur le smartphone du client
ou
- si l’app bancaire chargée n’est pas compatible avec l’App2App (voir les prérequis)
ou
- si l’autre format d’appel des point d’accès a été utilisé http://www.<codetab>.live.api.89c3.com/stet/psd2/oauth/authorize (ce qui peut être utile comme backup en cas de problème avec l’App2App)
Assemblage Sandbox
Introduction
La sandbox BPCE API peut être utilisée de 2 manières :
- soit via le Try-it du portail BPCE-API (se référer à la rubrique « Comment tester l’API ? » > « Console Try-it« )
- soit directement via votre application : c’est le mode assemblage décrit ci-après
Les données utilisées sont fictives (voir la rubrique « Comment tester l’API ? » > « Tester nos personas« ).
Elles permettront de choisir des profils spécifiques de façon à mieux cibler vos tests.
Prérequis
Vous devez déclarer votre APP sur le portail BPCE API (menu « Mes applications« ) et nous transmettre :
- votre identifiant fourni par votre autorité compétente (Organization Identifier = OID)
- les clés publiques de vos certificats QWAC et QSEALC (jeu de certificats de production dédié aux tests)
- votre uri de redirection (redirect_uri) qui sera appelée par l’ASPSP :
- si le PSU a autorisé la récupération de ses données par l’AISP
- ou en cas de refus du consentement
- ou si la cinématique ci-dessous est interrompue (par exemple : timeout sur les écrans)
Rappel : vous devez être accrédité pour le rôle « AISP ».
Enchaînement des étapes
1ère étape : demande de jeton d’accès
Ceci est nécessaire afin d’obtenir un jeton d’accès à toutes fins de consommer les ressources de l’API, et permet de déclencher la redirection du PSU chez l’ASPSP.
La description de la fonctionnalité est décrite dans la rubrique « Vue d’ensemble » > « Récupérer votre jeton« .
NB : Le PSU peut domicilier ses comptes dans plusieurs banques du Groupe BPCE. Il vous faudra un jeton différent pour accéder à chacune de ces banques –> cet appel est donc à répéter pour chacun des établissements concernés.
Notre point d’entrée dépend du code établissement : http://www.<cdetab>.sandbox.api.89C3.com , et pour l’assemblage sandbox, le <cdetab> de la Banque BCP est 12579.
Exemple de requête en assemblage sandbox :
GET https://www.12579.sandbox.api.89C3.com/stet/psd2/oauth/authorize
Headers :
Content-Type:application/x-www-form-urlencoded; charset=utf-8
Params:
response_type:code
client_id:PSDFR-ACPR-13807
redirect_uri:https://myAPP.fr/Home/OAuth2Callback
scope:aisp
Remarque sur l’alimentation des champs :
- client_id: identifiant fourni par votre autorité nationale compétente (PSDXX-YYYY-ZZZZZ)
- redirect_uri: URL de redirection prédéclarée dans votre application consommatrice ET à communiquer à l’ASPSP pour toute une demande d’assemblage ou de Go Live
2ème étape : redirection vers les écrans d’authentification forte (AF/SCA)
Une fois redirigé vers l’ASPSP, celui-ci va afficher des écrans d’identification et d’authentification au PSU.
La cinématique nominale des enchaînements de ces écrans est résumée par le schéma ci-dessous :
1. Le PSU est redirigé vers un écran d’identification proposé par ASPSP
L’identifiant banque à distance du PSU est à saisir :
NB : si le PSU est un professionnel ou une entreprise, il y aura un numéro d’usager à saisir en sus de l’identifiant banque à distance.
2. Le PSU se voit afficher alors un écran d’authentification forte (AF/SCA) proposé par l’ASPSP pour valider son identité.
La cinématique dépend aussi de la méthode AF/SCA mise à disposition par l’ASPSP (exemple d’un OTP par SMS, voir exemple ci-dessous):
ou pour la sandbox
NB : Dans certains cas, une notification peut être envoyée vers le PSU afin qu’il active son moyen d’AF/SCA sur son smartphone pour terminer cette étape :
3ème étape : récupération du jeton d’accès / access_token
Cet appel permet à l’AISP de récupérer le jeton d’accès pour pouvoir accéder aux données. Auparavant, il faudra que l’AISP demande au PSU connecté à quelles données il peut accéder.
La description de la fonctionnalité est décrite dans la rubrique « Vue d’ensemble » > « Récupérez votre jeton« .
Le certificat QWAC est à fournir dans cette requête POST /stet/psd2/oauth/token pour établir l’authentification mutuelle avec l’ASPSP. Le certificat doit correspondre à celui-ci que le PSP a fourni:
- lors de l’étape goAssemblage (resp. goLive en production) si le TPP a été enregistré par la procédure via le portail BPCE API
- ou via l’API REGISTER si le TPP (auto-enrôlement automatisé, voir la fiche produit : https://www.api.89c3.com/fr/nos-produits/item/522-api-register-fr)
Si le client vous a autorisé à récupérer ses données pour un établissement, vous trouverez dans la réponse à l’appel précédent, le code à utilisation unique qui permet de récupérer un access_token.
Cet access_token est valable 1h et est un prérequis pour chaque accès à l’une des méthodes de l’API d’information sur compte. La description de la fonctionnalité et des champs de la requête est décrite dans le cas d’usage « Récupérer votre jeton« .
Ce jeton est accompagné d’un refresh_token valable 180 jours que vous devez conserver. Lorsque votre access_token arrive à expiration, vous pouvez en redemander un nouveau en suivant la cinématique « Rafraîchir votre acces_token » ci-après.
Au bout de 180 jours votre refresh_token arrive à expiration. Pour en récupérer un nouveau, vous devez reprendre la cinématique « Récupérer un jeton d’accès » et passer par une nouvelle étape d’authentification forte du client auprès de l’établissement bancaire.
Exemple de requête en assemblage sandbox :
POST https://www.12579.sandbox.api.89C3.com/stet/psd2/oauth/token
Header:
Content-Type:application/x-www-form-urlencoded; charset=utf-8
Params:
client_id:PSDFR-ACPR-13807
grant_type:authorization_code
code:NnZx1hqHY2CLkCFjiTwhJeflgFedCBa
redirect_uri:https://myAPP.fr/Home/OAuth2Callback
Remarques sur l’alimentation des champs :
- client_id : numéro donné par votre autorité compétente lors de votre demande d’agrément (PSDXX-YYYY-ZZZZZ)
- code : récupéré dans l’url de callback
- redirect_uri : il faut que cette « redirect_uri » soit identique à celle envoyée dans la requête GET /authorize !!!
- le certificat eiDAS QWAC doit être envoyé avec cette requête.
Réponse :
{
« access_token »: »KXZyspFBZ1R6NqWQdmsZhfdo1nbjK7MoI0Kr2rSi1mSCFNehAs6iLw »,
« token_type »: »Bearer »,
« expires_in »:3600,
« scope »: »aisp offline_access »,
« refresh_token »: »KUZyspFBZ1R6NqWQdmsZhfdo1nbjK7MoD0Kr2rSi1mSCFNehAs6iLa »
}
4ème étape : consommation des méthodes de l’API
1) Obtenir la liste des comptes à vue d’un PSU
Une fois le jeton d’accès récupéré après l’authentification forte du PSU, cet appel vous permet de lister les comptes du PSU connecté lors de la première connexion.
La description de la fonctionnalité est décrite dans le cas d’usage « Obtenir la liste des comptes« , notamment sur la pemière utilisation de cette méthode avant un PUT /consents.
La séquence est :
- GET /accounts pour récupérer les comptes sans les links vers les soldes et transactions
- affichage des comptes au client par le TPP pour récupérer son consentement
- PUT /consents pour transmettre le consentement sur les comptes
- GET /accounts pour récupérer les comptes consentis avec les links vers le solde (si donnée consentie) et/ou vers les transactions (si données consenties)
Exemple de requête en assemblage sandbox SANS la méthode PUT /Consent au préalable:
GET https://www.12579.sandbox.api.89C3.com/stet/psd2/v1.4.2/accounts
Header :
Authorization:Bearer KXZyspFBZ1R6NqWQdmsZhfdo1nbjK7MoI0Kr2rSi1mSCFNehAbCdEf
X-Request-ID:id-1234567890111121 1
Signature: keyId=\ »https://<www.myUrlPath.to>/myQsealCertificate_<empreinte sha256>\ », algorithm=\ »rsa-sha256\ », headers=\ »(request-target) psu-ip-address psu-ip-port psu-http-method psu-date psu-user-agent psu-referer psu-accept psu-accept-charset psu-accept-encoding psu-accept-language digest\ », signature=\ »LbkxgICM48J6KdWNaF9qT7OWEorNlAwWNo6R+KkP7cP4TIGkk8wxcsGQXJ9ZnC+ZiA8mjL5S8WQyL41M7iPt+vJX4xh679gdGwmlKzn7E+ZtZ1I4qalRxcdLp4gBL7fll+C2lVBNJrViMJBezFK7AYVjnSWH7t1QiMViAmthebEst=\
Psu-IP-Address:192.168.0.1
Pas de corps de requête
Remarques sur l’alimentation des champs :
- Authorization : Bearer < access_token précédemment récupéré>
- X-Request-ID : <en-tête de corrélation de la requête émise>
- Signature : <signature de la requête émise>
- Psu-Ip-Address => permet de différencier les appels batch et les appels avec le PSU connecté : ce champ est à alimenter pour un PSU connecté
Réponse : 200 (=> OK)
Header :
X-request-id:id-1234567890111121 1
Body :
{
« _links »:{
« self »:{
« templated »:false,
« href »: »/stet/psd2/v1.4.2/accounts »
}
},
« accounts »:[
{
« cashAccountType »: »CACC »,
« accountId »:{
« iban »: »FR7612579000920400430518020″
},
« usage »: »PRIV »,
« psuStatus »: »Account Holder »,
« name »: »LEA SANDBOXA »,
« currency »: »EUR »
},
{
« cashAccountType »: »CACC »,
« accountId »:{
« iban »: »FR7612579000920400851811524″
},
« usage »: »PRIV »,
« psuStatus »: »Account Holder »,
« name »: »LEA SANDBOXA »,
« currency »: »EUR »
}
]
}
Exemple de requête en assemblage sandbox AVEC la méthode PUT /Consent au préalable:
GET https://www.12579.sandbox.api.89C3.com/stet/psd2/v1.4.2/accounts
Header :
Authorization:Bearer KXZyspFBZ1R6NqWQdmsZhfdo1nbjK7MoI0Kr2rSi1mSCFNehAbCdEf
X-Request-ID:id-1234567890111121 1
Signature: keyId=\ »https://<www.myUrlPath.to>/myQsealCertificate_<empreinte sha256>\ », algorithm=\ »rsa-sha256\ », headers=\ »(request-target) psu-ip-address psu-ip-port psu-http-method psu-date psu-user-agent psu-referer psu-accept psu-accept-charset psu-accept-encoding psu-accept-language digest\ », signature=\ »LbkxgICM48J6KdWNaF9qT7OWEorNlAwWNo6R+KkP7cP4TIGkk8wxcsGQXJ9ZnC+ZiA8mjL5S8WQyL41M7iPt+vJX4xh679gdGwmlKzn7E+ZtZ1I4qalRxcdLp4gBL7fll+C2lVBNJrViMJBezFK7AYVjnSWH7t1QxinDocH1ne=\
Psu-IP-Address:192.168.0.1
Pas de corps de requête
Remarques sur l’alimentation des champs :
- Authorization : Bearer < access_token précédemment récupéré>
- X-Request-ID : <en-tête de corrélation de la requête émise>
- Signature : <signature de la requête émise>
- Psu-Ip-Address => permet de différencier les appels batch et les appels avec le PSU connecté : ce champ est à alimenter pour un PSU connecté
Réponse : 200 (=> OK)
Header :
X-request-id:id-1234567890111121 1
Body :
{
« _links »:{
« self »:{
« templated »:false,
« href »: »/stet/psd2/v1.4.2/accounts »
}
},
« accounts »:[
{
« cashAccountType »: »CACC »,
« accountId »:{
« iban »: »FR7612579000920400430518020″
},
« resourceId »: »125790009204004305180″,
« _links »:{
« balances »:{
« templated »:false,
« href »: »/stet/psd2/v1.4.2/accounts/125790009204004305180/balances »
},
« transactions »:{
« templated »:true,
« href »: »/stet/psd2/v1.4.2/accounts/125790009204004305180/transactions »
}
},
« usage »: »PRIV »,
« psuStatus »: »Account Holder »,
« name »: »LEA SANDBOXA »,
« currency »: »EUR »
},
{
« cashAccountType »: »CACC »,
« accountId »:{
« iban »: »FR7612579000920400851811524″
},
« resourceId »: »125790009204008518115″,
« _links »:{
« balances »:{
« templated »:false,
« href »: »/stet/psd2/v1.4.2/accounts/125790009204008518115/balances »
},
« transactions »:{
« templated »:true,
« href »: »/stet/psd2/v1.4.2/accounts/125790009204008518115/transactions »
}
},
« usage »: »PRIV »,
« psuStatus »: »Account Holder »,
« name »: »LEA SANDBOXA »,
« currency »: »EUR »
}
]
}
2) Transmettre la liste des comptes consentis par le PSU
Cet appel vous permet de transmettre à l’ASPSP la liste des comptes consentis par le PSU.
La description de la fonctionnalité est décrite dans le cas d’usage « Transmettre la liste des comptes« .
Exemple de requête en assemblage sandbox :
PUT https://www.12579.sandbox.api.89C3.com/stet/psd2/v1.4.2/consents
Headers :
Authorization:Bearer KXZyspFBZ1R6NqWQdmsZhfdo1nbjK7MoI0Kr2rSi1mSCFNehAbCdEf
X-Request-ID:id-1234567890111121 2
Signature: keyId=\ »https://<www.myUrlPath.to>/myQsealCertificate_<empreinte sha256>\ », algorithm=\ »rsa-sha256\ »,headers=\ »(request-target) psu-ip-address psu-ip-port psu-http-method psu-date psu-user-agent psu-referer psu-accept psu-accept-charset psu-accept-encoding psu-accept-language digest\ », signature=\ »LbkxgICM48J6KdWNaF9qT7OWEorNlAwWNo6R+KkP7cP4TIGkk8wxcsGQXJ9ZnC+ZiA8mjL5S8WQyL41M7iPt+vJX4xh679gdGwmlKzn7E+ZtZ1I4qalRxcdLp4gBL7fll+C2lVBNJrViMJBezFK7AYVjnSWH7t1QinCept10n=\
Psu-IP-Address:192.168.0.1
Body :
{
« balances »:[
{
« iban »: »FR7612579000920400430518020″
},
{
« iban »: »FR7612579000920400851811524″
}
],
« transactions »:[
{
« iban »: »FR7612579000920400430518020″
},
{
« iban »: »FR7612579000920400851811524″
}
],
« trustedBeneficiaries »:false,
« psuIdentity »:false
}
Réponse : 201 (=> created)
Headers :
X-Request-ID : id-1234567890111121 2
Pas de body
3) Obtenir le solde
Cet appel vous permet d’obtenir le solde d’un compte consenti.
La description de la fonctionnalité est décrite dans le cas d’usage « Obtenir les soldes d’un compte« , et cette information n’est remontée que si un consentement PSU a été reçu au préalable par l’ASPSP via la méthode PUT /consents.
Exemple de requête en assemblage sandbox avec un {accountResourceId} = numéro de compte ciblé :
GET https://www.12579.sandbox.api.89C3.com/stet/psd2/v1.4.2/accounts/125790009204004305180/balances
Headers :
Authorization:Bearer KXZyspFBZ1R6NqWQdmsZhfdo1nbjK7MoI0Kr2rSi1mSCFNehAbCdEf
X-Request-ID:id-1234567890111121 2
Signature: keyId=\ »https://<www.myUrlPath.to>/myQsealCertificate_<empreinte sha256>\ », algorithm=\ »rsa-sha256\ »,headers=\ »(request-target) psu-ip-address psu-ip-port psu-http-method psu-date psu-user-agent psu-referer psu-accept psu-accept-charset psu-accept-encoding psu-accept-language digest\ », signature=\ »LbkxgICM48J6KdWNaF9qT7OWEorNlAwWNo6R+KkP7cP4TIGkk8wxcsGQXJ9ZnC+ZiA8mjL5S8WQyL41M7iPt+vJX4xh679gdGwmlKzn7E+ZtZ1I4qalRxcdLp4gBL7fll+C2lVBNJrViMJBezFK7AYVjnSWH7t1Qincept10n=\
Response :
200 OK
Headers :
X-Request-ID:id-1234567890111121 2
Body :
{
« balances »: [
{
« balanceType »: « CLBD »,
« name »: « Solde comptable au 28/09/2018 »,
« balanceAmount »: {
« amount »: « -150.00 »,
« currency »: « EUR »
}
}
],
« _links »: {
« self »: {
« templated »: false,
« href »: « /stet/psd2/v1.4.2/accounts/125790009204004305180/balances »
},
},
« parent-list »: {
« templated »: false,
« href »: « /stet/psd2/v1.4.2/accounts »
}
}
}
4) Obtenir les transactions
Cet appel vous permet d’obtenir les transactions d’un compte consenti.
La description de la fonctionnalité est décrite dans le cas d’usage « Obtenez les transactions« , et cette information n’est remontée que si un consentement PSU a été reçu au préalable par l’ASPSP via la méthode PUT /consents.
Exemple de requête en assemblage sandbox avec un {accountResourceId} = numéro de compte ciblé :
GET https://www.12579.sandbox.api.89C3.com/stet/psd2/v1.4.2/accounts/125790009204004305180/transactions
Headers :
Authorization:Bearer KXZyspFBZ1R6NqWQdmsZhfdo1nbjK7MoI0Kr2rSi1mSCFNehAbCdEf
X-Request-ID:id-1234567890111121 1
Signature: keyId=\ »https://<www.myUrlPath.to>/myQsealCertificate_<empreinte sha256>\ », algorithm=\ »rsa-sha256\ »,headers=\ »(request-target) psu-ip-address psu-ip-port psu-http-method psu-date psu-user-agent psu-referer psu-accept psu-accept-charset psu-accept-encoding psu-accept-language digest\ », signature=\ »LbkxgICM48J6KdWNaF9qT7OWEorNlAwWNo6R+KkP7cP4TIGkk8wxcsGQXJ9ZnC+ZiA8mjL5S8WQyL41M7iPt+vJX4xh679gdGwmlKzn7E+ZtZ1I4qalRxcdLp4gBL7fll+C2lVBNJrViMJBezFK7AYVjnSWH7t1T0tOtuTuT1ti=\
Psu-IP-Address:192.168.0.1
Pas de body
Réponse : 200 (=> OK)
Headers :
X-Request-ID : id-1234567890111121 1
Body :
{
« _links »:{
« balances »:{
« templated »:false,
« href »: »/stet/psd2/v1.4.2/accounts/125790009204004305180/balances »
},
« self »:{
« templated »:true,
« href »: »/stet/psd2/v1.4.2/accounts/125790009204004305180/transactions »
},
« parent-list »:{
« templated »:false,
« href »: »/stet/psd2/v1.4.2/accounts »
}
},
« transactions »:{
« resourceId »:null,
« remittanceInformation »:[
« Retrait Carte »
],
« entryReference »: »257040043051802019-09-08-05.33.46.621234″,
« transactionAmount »:{
« amount »: »13.00″,
« currency »: »EUR »
},
« bookingDate »: »2019-09-05″,
« creditDebitIndicator »: »DBIT »,
« status »: »BOOK »
}
}
5) Obtenir l’identité du client
Cet appel vous permet d’obtenir l’identité du PSU connecté (qui n’est pas forcément le client possédant le compte).
La description de la fonctionnalité est décrite dans le cas d’usage « Obtenir l’identité du client« , et cette information n’est remontée que si un consentement PSU a été reçu au préalable par l’ASPSP via la méthode PUT /consents.
Exemple de requête en assemblage sandbox :
GET https://www.12579.sandbox.api.89C3.com/stet/psd2/v1.4.2/end-user-identity
6) Rafraîchir le jeton d’accès
Cet appel vous permet de rafraichir le jeton d’accès avec le refresh-token.
La description de la fonctionnalité est décrite dans la rubrique « Vue d’ensemble » > « Rafraîchir votre jeton« .
Exemple de requête en assemblage sandbox :
POSThttps://www.12579.sandbox.api.89C3.com/stet/psd2/oauth/token
Header :
Content-Type:application/x-www-form-urlencoded; charset=utf-8
Params:
client_id:PSDFR-ACPR-13807
grant_type:refresh_token
refresh_token:KUZyspFBZ1R6NqWQdmsZhfdo1nbjK7MoD0Kr2rSi1mSCFNehAbCdEf
Réponse :
{
« access_token »: »4s2Bt3MRL7nlPUZcRTPe5Tjs0v8p7ZOXOyEKs1juYesR2bel0t3v1aAp1s »,
« token_type »: »Bearer »,
« expires_in »:3600,
« scope »: »aisp offline_access »,
« refresh_token »: »KUZyspFBZ1R6NqWQdmsZhfdo1nbjK7MoD0Kr2rSi1mSCFNehAbCdEf »
}
Nos personas
Conformément à la réglementation DSP2 (cf. RTS Art. 30 (5)), nous devons en tant qu’ASPSP mettre à disposition un dispositif d’essai comprenant une assistance et permettant des tests de connexion et de fonctionnement, afin que les TPP qui ont demandé l’agrément nécessaire puissent tester les logiciels et applications qu’ils utilisent pour proposer un service de paiement aux utilisateurs.
Il est aussi demandé l’utilisation de données fictives. C’est l’objectif de ces données de tests sous forme de « persona » qui rassemblent divers clients sur base de :
- segment de clientèle (étudiant, actif, retraité, entrepreneur individuel, etc..) ;
- caractéristiques de leurs comptes (mono-compte, multi-comptes, solde qui est statique) ;
- le consentement PSU a déjà été donné ;
- données utiles attendues en entrée par les API (identifiant banque à distance, IBAN).
Ce jeu de données évoluera au cours du temps avec rajout de données additionnelles (autres clients, nombre de transactions, profondeur d’historique). Revenez régulièrement sur cette section pour être à jour !
LES IDENTIFIANTS ET DONNEES DE TEST CI-DESSOUS NE PEUVENT PAS ETRE UTILISEES EN PRODUCTION LIVE.
Persona
- Actif Entrepreneur Individuel
- 4 comptes (abonné PART) dont 2 liés à son activité professionnelle
NOUVEAU !
- 2000 transactions disponibles sur l’IBAN FR7612579007000860000716515
- 2000 transactions disponibles sur l’IBAN FR7612759007000800099862143
- 260 transactions disponibles sur l’IBAN FR7612759007000800081593745
- 200 transactions disponibles sur l’IBAN FR7612759007000800060486060
avec une variété importante des types d’opérations :
- SDD émis à crédit du compte
- SDD reçus à débit du compte
- Paiements par carte à débit du compte
- Remises commerçant à crédit du compte
- Virements émis à débit du compte
- Virements reçus à crédit du compte
- Frais divers
- Echéances de prêt
- Chèques tirés à débit du compte
- Chèques déposés à crédit du compte
NB : pour ce persona, il vous faudra saisir le code SMS = « 12345678 » dans l’écran d’authentification proposé en mode assemblage.
| Persona | Segment banque | Nouvel identifiant | Code Etablissement | Iban | Détenteur | Consentement : solde/transactions/identité | solde | devise |
| EDMÉ | Entrepreneur individuel |
9999999801 | 12579 | FR7612579007000860000716515
FR7612759007000800099862143 FR7612759007000800081593745 FR7612759007000800060486060 |
MR EDMÉ D’EIDASE
MR EDMÉ D’EIDASE MR EDMÉ D’EIDASE MR EDMÉ D’EIDASE |
OUI/OUI/NON
OUI/OUI/NON OUI/OUI/NON OUI/OUI/NON |
+470 926.57
+182 432.23 +9 803.71 +14 646.78 |
EUR
EUR EUR EUR |
Historique des versions
Version de la norme STET utilisée pour l’API
Cette API REST est conforme à la spécification interbancaire française STET (https://www.stet.eu/en/psd2/), version v.1.4.2.17, afin de répondre aux exigences règlementaires de la DSP2. Elle tient compte des limitations fonctionnelles propres aux Banques BCP.
Pour rappel :
- les textes de la directive de paiement numéro 2 (DSP2, référence UE 2015/2366 du 25/11/2015) sont rentrés en application le 13 janvier 2018 : http://eur-lex.europa.eu/legal-content/FR/TXT/?uri=CELEX:32015L2366
- ils ont été complétés par les normes techniques de réglementation (NTR, règlement délégué UE 2018/389) relatives à l’authentification forte du client et à des normes ouvertes communes et sécurisées de communication dont la date d’application se situe au 14 septembre 2019. Ces normes sont les RTS (Rules Technical Standards) : https://eur-lex.europa.eu/legal-content/FR/TXT/?toc=OJ%3AL%3A2018%3A069%3ATOC&uri=uriserv%3AOJ.L_.2018.069.01.0023.01.FRA
En France, l’ordonnance n° 2017-1252 du 9 août 2017 transpose la directive DSP2 dans la partie législative du code monétaire et financier. L’ordonnance est complétée au plan réglementaire par les décrets n° 2017-1313 et n° 2017-1314 du 31 août 2017 et les cinq arrêtés du 31 août 2017.
Les utilisateurs peuvent également consulter l’assistant virtuel en cliquant sur le pictogramme Assistant sur la page d’accueil du portail.
Description du support
Conformément à l’article 30 (5) des RTS, une assistance pour les prestataires PSP tiers est mise à disposition. Ce support est accessible via le formulaire sur ce portail BPCE API, ou via https://www.api.89c3.com/fr/nous-contacter. Les réponses se font pendant les heures de travail ouvrées.
Le principe général du support est schématisé ci-dessous en prenant en compte les délais réglementaires prévus à l’article 30 (4) des RTS :
Principaux changements effectués depuis la première version publiée
| Méthodes(s) | Date | Description de l’évolution |
| Toutes | 30 octobre 2020 | Documentation : voir toutes les évolutions éditoriales précédentes sur la fiche V1.4.0 (API version V1) |
| Toutes
GET /accounts/../transactions |
21 décembre 2020 | Rajout d’un point d’accès / voir section « limitations »
Changement du statut « PDNG » par « OTHR » |
| Toutes | 29 janvier 2021 | Rajout de segments clients / voir section « limitations » |
| GET /accounts/../transactions | 03 février 2021 | Rajout de la donnée optionnelle « entryReference » / voir cas d’usage « obtenir les transactions d’un compte » et section « limitations » |
| GET /accounts/../transactions
Fallback Rafraichir le jeton d’accès |
29 septembre 2021 | Rajout de la donnée optionnelle « bankTransactionCode » (PRO et ENT)
Précision de l’impact de la nouvelle solution de banque en ligne Précision sur la révocation des jetons |
| Roadmap | 30 octobre 2021 | Précision sur les changements sans délai non soumis au préavis réglementaire |
| Toutes | 03 janvier 2022 | Changements éditoriaux et précisions sur l’authentification forte |
| Vue d’ensemble | 25 août 2022 | Changements éditoriaux et rajout du cas App2App |
Roadmap
Politique de décommissionnement des versions de l’API
La politique du décommissionnement (= arrêt d’une version d’une API sur les environnements de production et sandbox) est fonction du cycle de vie des API, et il est prévu une phase de tuilage entre deux versions majeures d’API comme indiqué dans le schéma ci-dessous :
La communication du décommissionnement d’une version N se fera à la date de déploiement de la version N+1. Le canal de communication privilégié est le portail BPCE API dans la partie « Roadmap » de l’API impactée. Une communication via courriel vers les correspondants des prestataires enrôlés sur le portail BPCE API pourra venir compléter ce dispositif.
Planning des évolutions fonctionnelles à venir de l’API
L’API d’Information sur compte fait l’objet d’améliorations et d’évolutions*.
(*) NB : l’article 30 (4) des RTS précise que des changements significatifs de l’API peuvent intervenir sans délai. Nous appliquons cette clause dans les cas suivants :
- problème bloquant impactant de façon généralisée au moins l’un des segments de clients majeur (particuliers, professionnels, entreprises),
- problème de sécurité,
- évolutions demandées par les autorités nationales compétentes pour répondre à la trajectoire réglementaire.
Retrouvez ci-dessous notre roadmap prévisionnelle.
| Version de l’API | Version de la norme Stet | Fonctionnalités | Sandbox
Date de déploiement BPCE API DEV PORTAL & SANDBOX |
Live
Date de déploiement BPCE LIVE API GATEWAY |
Live
DATE DE DECOMMISSIONNEMENT |
| v1.4.2 | v 1.4.2.17 | API version v1:
plus :
|
17 juillet 2020 | 22 octobre 2020 | non encore annoncée |
