Crédit Coopératif – Account information – (STET STANDARD V1.4.2)

How to aggregate data ?

A customer having different accounts in various banks is willing to agregate his data.

Using this API “Account information” setup by banks (ASPSP), you can ask for real-time data authorized by the customer without asking for online banking credentials.

The API resources can only be consumed if you have obtained the Account Information Services Provider (“AISP”) role status. This prerequisite is described in section “Eligibility“.

Once done, the overall process is as follows :

The customer agreed to use your service. He needs to select his ASPSP through your interface.

During the first set of data exchanges, you will request for an authorization token (and a refresh one). For this AISP role, you need these tokens BEFORE consuming API resources. These tokens are issued by the ASPSP AFTER an identification and authorization process of the bank accound holder.

The ASPSP will :

• check your certificates and on-going agreement delivered by the Comptent Authority
• identify and authorize the customer using the “redirect” mode in order to issue the tokens.

If the above access is granted by the customer, you can then get these OAUTH2 tokens thru secure exchanges (see use case “Get your token“).

Whenever you present this token to the BPCE API gateway, you will be able to consume this API resources in order to :

• request for the list of eligible accounts (see use case “List accounts“)
• forward customer’s consent to the ASPSP (see use case “Forward customer’s consent“)
• securely access to granted customer’s data (see use case “Access to data“)

If the regulated 180-day token validity period expires, this process needs to be started again (see use case “Refresh your token“)

NB : any ASPSP can refuse the access to customer’s data for any justified reason (non compliant API call, blocked account, …).

Access to data

In order to query an API, the API version is included in the URI such as : /stet/psd2/v1.4.2/accounts.

The features are described hereafter only from a functional standpoint. The technical aspects are included in the section « Technical use cases ». You also need to be familiar with PSD2 terminology. You may also use the Frequently Asked Questions (FAQ) or our the virtual assistant .

As a reminder, this API is designed to give access to payment accounts (and to a predefined set of data) authorised by the customer :

• balance
• and/or transactions history
• and/or customer (name and first name)

Some of these services may have some contraints or may not be available if not present in the online banking environment.

In sandbox assembly mode, access to tests data can be done thru the endpoint www.<codetab>.sandbox.api.89C3.com (see use case « Test our API »).

In production, acces to live data can be done through the endpoint www.<codetab>.live.api.89C3.com (see use case « Limits»).

Get the list of eligible payment accounts

Description

This first call allows to get the list of eligible payment accounts when the user of payment services (PSU) is using services from a third party provider (TPP AISP) connected to the bank account holder (ASPSP).

Prerequisites

• TPP has an agreement for the AISP role from any european competent authority ;
• TPP and PSU have service contract ;
• A OAUTH2 access token has been delivered to the TPP by the ASPSP ;
• TPP and ASPSP have been performed a mutual authentication ;
• TPP has delivered his OAUTH2 access token to be able to consume the API resources.

Transaction flow

TPP is interacting with the customer thru its interfaces. TPP sends a GET request to ASPSP infrastructure to get this list of accounts, which returns the eligible payment accounts

Customer consent

Description

This second request is mandated by the ASPSP : TPP has requested the customer to give his consent on the accounts he wants to use (ans which data).

This information (list of authorized accounts and data) needs to be sent back by the TPP to the the bank (ASPSP) for recording this customer consent. This “consent” record is linked only to a given PSU + given TPP AISP + given authorized payment account(s) + given authorized data for each account. The ASPSP will verifiy each TPP access request to the accounts vs. this record.

This consent can be modiifed at any time by calling again this service.

Prerequisites

TPP has requested the list of accounts for the first time.

PSU give his consent to AISP.

Transaction flow

TPP AISP forward these authorized data to the bank (ASPS) using a PUT request.

Get balance

Description

This call allows to get the accountable balance (“CLBD” in STET specifications).

Prerequisites

TPP has requested the list of accounts and sent PSU consent to ASPSP.

Transaction flow

AISP requests the ASPSP to send back the balance of one of the authorized accounts.

Get transactions history

Description

This call allows to get the 90-day transactions history.

Prerequisites

TPP has requested the list of accounts and sent PSU consent to ASPSP.

Transaction flow

AISP requests the ASPSP to send the transaction histroy with some criteria.

Get PSU identity

You can get account holder identity using GET /end-user-identity (please refer to the technical use case).

How to use the fallback mode

Principle

In order to comply with PSD2 regulations, banks available on this BPCE API developer portal have setup contingency measures in case of unplanned unavailability of the dedicated API interface.

The principle of this « fallback » solution is explained below:

This fallback mechanism meets PSD2 regulatory requirements (article 33/RTS). It can be used with the same conditions and prerequisites applicable for the dedicated API interface which are specified in the “Eligibility” use case.

Roadmap

Please do find below our estimated roadmap :

(*) Main features :

• Use the same API dedicated interface endpoint. The list of our banking institutions and the possible values ​​of <bkcode> are specified in the “Limitations” use case

• A parameter (header ‘fallback:1’ present or absent) managed directly by the TPP allows do differentiate any « Fallback » request from dedicated interface PSD2 API requests

• Use of same TPP eIDAS certificate (QWAC) to be presented for mutual TLS authentication

• Use the same PSU authentication procedure and means for accessing online banking services

• This fallback solution is always active, even so the dedicated interface API must be used systematically in first priority. Its usage is subject to strict conditions as described in Article 33 of RTS, and can’t be used as the main access for PSD2 features. It will be monitored as such and every abuse will be automatically reported to our national competent authority

Example

1. If PSD2 API are not available due to unplanned unavailability or systems breakdown (see RTS Art. 33), TPP should use the following request qith <codetab>=17515 as an example :

POST https://www.17515.live.api.89c3.com/stet/psd2/oauth/token

with :

• its live eIDAS QWAC certificate
• fallback:”1″ parameter in the header

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. If all checks are successful, the TPP will receive in the header of the response with url online (allowing to access banking login web page) as well as the JWT token to be used also in the rediction process.

HTTP/1.1 302 Found

Date: Tue, 25 May 2021 21:46:59 GMT

Location: https://www.caisse-epargne.fr/se-connecter/sso?service=dei&cdetab=17515&fallback=eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6ImhF…

Content-Length: 870

Connection: close

Content-Type: text/html; charset=iso-8859-1

</head><body>

<h1>Found</h1>

<p>The document has moved <a >here</a>.</p>

</body></html>

3. Once redirected, the TPP can then apply its proprietary login process using PSU credentials.

For more details about POST request, see STET specifications

Please note the following constraints which apply on this fallback mechanism :

Please note the following constraints which apply on this fallback mechanism :

• No re-use of the API dedicated interface context, neither any of 180-day validity access token generated for AISP role

• Only online internet banking features are used as a reference (excl’d mobile banking features) and are accessible thru the fallback mode. As an example, online banking doesn’t propose any e-commerce transactions to customers. PISP could NOT propose this feature in fallback mode

• The user of payment services (PSU) must be connected to PSP app. So no AISP batch process is possible

• PSD2 also imposes a reinforcement of strong customer authentication (SCA) for accessing direct online banking services. Therefore fallback mechanism leverages on reinforced PSU online banking authentication procedures and means such as (non exhaustive list) :
  • Soft token Secur’Pass on smartphone
  • Password + OTP SMS
  • Physical token (corporate market)

Get your token

Principle

Access to PSD2 API features is granted by the bank with an authorization token (or access token) issued using OAUTH2 standardized process.

How it works

See also STET / Part I

1- The customer (PSU) provides the identity of the bank which holds his accounts (ASPSP) to the TPP.

2- The TPP initiates an OAUTH2 access token request sequence by redirecting the customer to the ASPSP’s authorization infrastructure using GET /authorize

3- ASPSP will :

• • Identify and authenticate the PSU

• • Check your role and validity of your eIDAS certificates and agreement

4- Once checks are done and correct, ASPS will redirect the PSU to your site using “call-back” URL given in the GET /authorize and to ASPSP for the Go Live process.

You will find in the response of this request a one-time-token with a short life period.

5- You can then call the ASPSP in order to request the OAUTH2 token (and refresh one) using POST /token with previously received data (incl’d the one-time-token).

Note : these /token requests for getting the Authorization Code flow shall be sent WITHOUT the « scope » parameter.

6- ASPSP will :

• • Check your role and validity of your eIDAS certificates and agreement

• • Checks the direct or indirect matching between the Authorization Number within the eIDAS certificate and the [client_id] value

7- Once checks are done and correct, ASPSP returns a response HTTP200 (OK) with data including the access token.

8- As soon as you get the OAUTH2 access token (and a 180-day valid refresh token) issued by the bank, you can use it for each API request within the “Authorization” header, prefixed by the token type “Bearer”.

The [client_id] that is linked to the access token must directly or indirectly match with the Authorisation Number that is located within the TPP’s eIDAS certificate (QWAC).

If the access token is expired, the request will be rejected with HTTP401 with an error equal to “invalid_token”.

The request can be replayed once the access token has been refreshed suing the use case “Refresh your token“.

If your refresh token is about to expire, you will have to perform again all this process, meaning also redirect to ASPSP for customer’s strong autentication (PSU SCA).

For more details, see also OAUTH 2.0 Authorization Framework : https://tools.ietf.org/html/rfc6749#section-4.1

Example

You can find an example of this request in section “Test our API” and then “Sandbox“.

Refresh your token

Principle

The refresh token issued by the bank ASPSP is valid up to 180 days and needs to be renewed before it expires. Please also note that :

• Authorization and refresh tokens can be revoked at any moment ;
• If the Authorization token is revoked, then the refresh one is automatically revoked (and the other way round) ;
• The access token has a shorter life cycle (10 to 15min) on standalone device.

How it works ?

1. You request for a refresh token using POST /token

2. ASPSP :

• Identifies and authenticates the TPP through the presented eIDAS certificate (QWAC)
• Checks the direct or indirect matching between the Authorization Number within the eIDAS certificate and the [client_id] value.
• Controls last PSU SCA date (< 180 jours).

3. If correct, ASPSP then answers through a HTTP200 (OK) that embeds a new autorization token and refresh token that can replace the previous one. You need to store safely these tokens.

4. ASPSP de facto revokes the previous refresh token :

• After timeout of the by-law specified delay between two SCAs ;
• After timeout of the ASPSP specified delay based on internal rules if any ;
• After reject of a request for insufficient scope in order to allow the AISP to request another token with the desired scope ;
• On request of a PSU wanting to revoke the TPP access on his/her account data.

Please also note that, as a TPP, you are able to ask for the revocation of the refresh token through a POST /revoke request.

Revoke the token

A revoke process of the refresh access token (before its expiration @180 days) is possible, see STET specification V1.4.2 / part 1 “Framework” / paragraph 3.4.2.8 “Refresh token revocation”.

Example

You can find an example of this request in the section”Test our API” and then “Sandbox“.

Trigger App2App feature

Introduction

This service allows you to activate automatically (without PSU action) the banking app on PSU smartphone for identification and authentification process.

Prerequisites

The PSU has to load and to use at leat once the latest retail banking mobile app (V6.4.0 and higher) available on Android and Apple app stores.

Note : PRO & ENT customer segments are not yet activated

The callback universal link (same principe as url callback) shall be definied in advance by the TPP :

• if this link/url already exists on our BPCE API gateways, there is nothing else to do

• otherwise the TPP shall declare it using our API Register

Our “Universal links” links have been declared on iOS & Android platforms. It is not worthwhile to access to them e. g. using https://www.<codetab>.live.api.caisse-epargne.fr/89C3api/accreditation/v2/.well-known/apple-app-site-association which sends back an error code.

Request

PSU banking app activation can be achieved in live production using a current STET API request (initiated by the TPP app on the same smartphone device) with the following endpoints :

Brand	App2App endpoint
	www.40978.live.api.palatine.fr/stet/psd2/oauth/authorize
	.live.api.banquepopulaire.fr/stet/psd2/oauth/authorize” >www.<codetab>.live.api.banquepopulaire.fr/stet/psd2/oauth/authorize (see <codetab> values on Banque Populaire API product data sheet)
	www.10548.live.api.banque-de-savoie.fr/stet/psd2/oauth/authorize
	www.<codetab>.live.api.caisse-epargne.fr/stet/psd2/oauth/authorize (see <codetab> values on Caisse d’Epargne API product data sheet)
	www.12579.live.api.banquebcp.fr/stet/psd2/oauth/authorize
	www.42559.live.api.credit-cooperatif.coop/stet/psd2/oauth/authorize
	www.30258.live.api.btp-banque.fr/stet/psd2/oauth/authorize
	www.18919.live.api.natixis.com/stet/psd2/oauth/authorize

Otherwise, a webview will be displayed on PSU smartphone web browser if :

• the banking app is not present on PSU device nor App2App compliant (not the latest version uploaded, see prerequisites)

or

• the other endpoint format is used www.<codetab>.live.api.89c3.com/stet/psd2/oauth/authorize (can be used as a backup in case of App2App problem)

Regulatory publications

/stet/psd2/v1.4.2/accounts/{accountResourceId}/balances

accountsBalances

Abstract

Retrieval of an account balances report (AISP)

DESCRIPTION

This call returns a set of balances for a given PSU account that is specified by the AISP through an account resource Identification – The TPP has been registered by the Registration Authority for the AISP role – The TPP and the PSU have a contract that has been enrolled by the ASPSP – At this step, the ASPSP has delivered an OAUTH2 “Authorization Code” or “Resource Owner Password” access token to the TPP (cf. § 3.4.2). – The TPP and the ASPSP have successfully processed a mutual check and authentication – The TPP has presented its OAUTH2 “Authorization Code” or “Resource Owner Password” access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. § 3.4.2) if any. – The ASPSP takes into account the access token that establishes the link between the PSU and the AISP. – The TPP has previously retrieved the list of available accounts for the PSU The AISP requests the ASPSP on one of the PSU’s accounts. The ASPSP answers by providing a list of balances on this account. – The ASPSP must provide at least the accounting balance on the account. – The ASPSP can provide other balance restitutions, e.g. instant balance, as well, if possible. – Actually, from the PSD2 perspective, any other balances that are provided through the Web-Banking service of the ASPSP must also be provided by this ASPSP through the API.

SCOPES

• aisp
• extended_transaction_history
• cbpii

PARAMETERS

RETURN CODE

OUTPUT

application/hal+json; charset=utf-8

application/json; charset=utf-8

AVAILABLE AUTHENTIFICATION

OAuth 2.0

/stet/psd2/v1.4.2/accounts

accounts

ABSTRACT

Retrieval of the PSU accounts (AISP)

DESCRIPTION

This call returns all payment accounts that are relevant the PSU on behalf of whom the AISP is connected. Thanks to HYPERMEDIA, each account is returned with the links aiming to ease access to the relevant transactions and balances. The result may be subject to pagination (i.e. retrieving a partial result in case of having too many results) through a set of pages by the ASPSP. Thereafter, the AISP may ask for the first, next, previous or last page of results. – The TPP has been registered by the Registration Authority for the AISP role. – The TPP and the PSU have a contract that has been enrolled by the ASPSP – At this step, the ASPSP has delivered an OAUTH2 “Authorization Code” or “Resource Owner Password” access token to the TPP (cf. § 3.4.2). – The TPP and the ASPSP have successfully processed a mutual check and authentication – The TPP has presented its OAUTH2 “Authorization Code” or “Resource Owner Password” access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. § 3.4.2) if any. – The ASPSP takes into account the access token that establishes the link between the PSU and the AISP. The TPP sends a request to the ASPSP for retrieving the list of the PSU payment accounts. The ASPSP computes the relevant PSU accounts and builds the answer as an accounts list. The result may be subject to pagination in order to avoid an excessive result set. Each payment account will be provided with its characteristics.

SCOPES

• extended_transaction_history
• cbpii
• aisp

PARAMETERS

RETURN CODE

OUTPUT

application/hal+json; charset=utf-8

application/json; charset=utf-8

AVAILABLE AUTHENTIFICATION 

OAuth 2.0

/stet/psd2/v1.4.2/accounts/{accountResourceId}/transactions

accountsTransactions

ABSTRACT

Retrieval of an account transaction set (AISP)

DESCRIPTION

This call returns transactions for an account for a given PSU account that is specified by the AISP through an account resource identification. The request may use some filter parameter in order to restrict the query – on a given imputation date range – past a given incremental technical identification The result may be subject to pagination (i.e. retrieving a partial result in case of having too many results) through a set of pages by the ASPSP. Thereafter, the AISP may ask for the first, next, previous or last page of results. – The TPP has been registered by the Registration Authority for the AISP role – The TPP and the PSU have a contract that has been enrolled by the ASPSP – At this step, the ASPSP has delivered an OAUTH2 “Authorization Code” or “Resource Owner Password” access token to the TPP (cf. § 3.4.2). – The TPP and the ASPSP have successfully processed a mutual check and authentication – The TPP has presented its OAUTH2 “Authorization Code” or “Resource Owner Password” access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. § 3.4.2) is any. – The ASPSP takes into account the access token that establishes the link between the PSU and the AISP. – The TPP has previously retrieved the list of available accounts for the PSU The AISP requests the ASPSP on one of the PSU’s accounts. It may specify some selection criteria. The ASPSP answers by a set of transactions that matches the query. The result may be subject to pagination in order to avoid an excessive result set. The default transaction set, in the absence of filter query parameter, has to be specified and documented by the implementation.

SCOPES

• extended_transaction_history
• cbpii
• aisp

PARAMETERS

RETURN CODE

OUTPUT

application/hal+json; charset=utf-8

application/json; charset=utf-8

AVAILABLE AUTHENTIFICATION 

OAuth 2.0

/stet/psd2/v1.4.2/consents

consents

ABSTRACT

Forwarding the PSU consent (AISP)

DESCRIPTION

In the mixed detailed consent on accounts – the AISP captures the consent of the PSU – then it forwards this consent to the ASPSP This consent replaces any prior consent that was previously sent by the AISP. – The TPP has been registered by the Registration Authority for the AISP role. – The TPP and the PSU have a contract that has been enrolled by the ASPSP – At this step, the ASPSP has delivered an OAUTH2 “Authorization Code” or “Resource Owner Password” access token to the TPP (cf. § 3.4.2). – The TPP and the ASPSP have successfully processed a mutual check and authentication – The TPP has presented its OAUTH2 “Authorization Code” or “Resource Owner Password” access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. § 3.4.2) if any. – The ASPSP takes into account the access token that establishes the link between the PSU and the AISP. The PSU specifies to the AISP which of his/her accounts will be accessible and which functionalities should be available. The AISP forwards these settings to the ASPSP. The ASPSP answers by HTTP201 return code.

SCOPES

• extended_transaction_history
• cbpii
• aisp

PARAMETERS

RETURN CODE

INPUT

application/json

OUTPUT

application/hal+json; charset=utf-8

application/json; charset=utf-8

AVAILABLE AUTHENTIFICATION 

OAuth 2.0

/stet/psd2/v1.4.2/end-user-identity

endUserIdentity

Abstract

Retrieval of the identity of the end-user (AISP)

Description

This call returns the identity of the PSU (end-user). – The TPP has been registered by the Registration Authority for the AISP role. – The TPP and the PSU have a contract that has been enrolled by the ASPSP – At this step, the ASPSP has delivered an OAUTH2 “Authorization Code” or “Resource Owner Password” access token to the TPP (cf. § 3.4.2). – The TPP and the ASPSP have successfully processed a mutual check and authentication – The TPP has presented its OAUTH2 “Authorization Code” or “Resource Owner Password” access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. § 3.4.2) if any. – The ASPSP takes into account the access token that establishes the link between the PSU and the AISP. The AISP asks for the identity of the PSU. The ASPSP answers with the identity, i.e. first and last names of the end-user.

Scopes

• aisp
• cbpii
• extended_transaction_history

Parameters

Return codes

Output

application/hal+json; charset=utf-8

application/json; charset=utf-8

Available Authentification 

OAuth 2.0

/stet/psd2/v1.4.2/funds-confirmations

fundsConfirmations

ABSTRACT

Payment coverage check request (CBPII)

DESCRIPTION

The CBPII can ask an ASPSP to check if a given amount can be covered by the liquidity that is available on a PSU cash account or payment card. – The TPP has been registered by the Registration Authority for the CBPII role – The TPP and the PSU have a contract that has been registered by the ASPSP – At this step, the ASPSP has delivered an “Authorization Code”, a “Resource Owner Password” or a “Client Credential” OAUTH2 access token to the TPP (cf. § 3.4.2). – Each ASPSP has to implement either the “Authorization Code”/”Resource Owner Password” or the “Client Credential” OAUTH2 access token model. – Doing this, it will edit the [security] section on this path in order to specify which model it has chosen – The TPP and the ASPSP have successfully processed a mutual check and authentication – The TPP has presented its OAUTH2 “Authorization Code”, “Resource Owner Password” or “Client Credential” access token which allows the ASPSP to identify the relevant PSU. The CBPII requests the ASPSP for a payment coverage check against either a bank account or a card primary identifier. The ASPSP answers with a structure embedding the original request and the result as a Boolean.

SCOPES

• cbpii
• extended_transaction_history
• aisp

PARAMETERS

RETURN CODE

INPUT

application/json

OUTPUT

application/hal+json; charset=utf-8

application/json; charset=utf-8

AVAILABLE AUTHENTIFICATION 

OAuth 2.0

/stet/psd2/v1.4.2/payment-requests/{paymentRequestResourceId}/o-confirmation

paymentRequestOConfirmation

ABSTRACT

Confirmation of a payment request or a modification request using an OAUTH2 Authorization code grant (PISP)

DESCRIPTION

The PISP confirms one of the following requests or modifications: – payment request on behalf of a merchant – transfer request on behalf of the account’s owner – standing-order request on behalf of the account’s owner The ASPSP answers with a status of the relevant request and the subsequent Credit Transfer. – The TPP has been registered by the Registration Authority for the PISP role – The TPP was provided with an OAUTH2 “Client Credential” access token by the ASPSP (cf. § 3.4.2). – The TPP has previously posted a Request which has been saved by the ASPSP (cf. § 4.5.3) – The ASPSP has answered with a location link to the saved Payment Request (cf. § 4.5.4) – The TPP has retrieved the saved request in order to get the relevant resource Ids (cf. § 4.6). – The PSU has been authenticated by the ASPSP through an OAUTH2 authorization code grant flow (REDIRECT approach) and the PISP got the relevant token – The TPP and the ASPSP have successfully processed a mutual check and authentication – The TPP has presented its “OAUTH2 Authorization Code” access token Once the PSU has been authenticated through an OAUTH2 authorization code grant flow (REDIRECT approach), it is the due to the PISP to confirm the Request to the ASPSP in order to complete the process flow. The ASPSP must wait for confirmation before executing the subsequent Credit Tranfer.

SCOPES

• pisp
• aisp
• extended_transaction_history
• cbpii

PARAMETERS

RETURN CODE

INPUT

application/json

OUTPUT

application/hal+json; charset=utf-8

application/json; charset=utf-8

AVAILABLE AUTHENTIFICATION 

OAuth 2.0

/stet/psd2/v1.4.2/trusted-beneficiaries

trustedBeneficiaries

ABSTRACT

Retrieval of the trusted beneficiaries list (AISP)

DESCRIPTION

This call returns all trusted beneficiaries that have been set by the PSU. Those beneficiaries can benefit from an SCA exemption during payment initiation. The result may be subject to pagination (i.e. retrieving a partial result in case of having too many results) through a set of pages by the ASPSP. Thereafter, the AISP may ask for the first, next, previous or last page of results. – The TPP has been registered by the Registration Authority for the AISP role. – The TPP and the PSU have a contract that has been enrolled by the ASPSP – At this step, the ASPSP has delivered an OAUTH2 “Authorization Code” or “Resource Owner Password” access token to the TPP (cf. § 3.4.2). – The TPP and the ASPSP have successfully processed a mutual check and authentication – The TPP has presented its OAUTH2 “Authorization Code” or “Resource Owner Password” access token which allows the ASPSP to identify the relevant PSU and retrieve the linked PSU context (cf. § 3.4.2) if any. – The ASPSP takes into account the access token that establishes the link between the PSU and the AISP. The AISP asks for the trusted beneficiaries list. The ASPSP answers with a list of beneficiary details structure.

SCOPES

• cbpii
• aisp
• extended_transaction_history

PARAMETERS

RETURN CODE

OUTPUT

application/hal+json; charset=utf-8application/json; charset=utf-8

AVAILABLE AUTHENTIFICATION 

OAuth 2.0

Get account list

Principle

Using this service, you can get access various data from a payment account authorized by the customer :

• list all eligible online accessible payment accounts ;
• retrieve accounting balance ;
• get URI for the GET /end-user-identity method ;
• get URI for GET /accounts/balances and GET /accounts/transactions methods.

Access to this method is limited to a maximum of 4 batch per day for one given TPP and PSU (except if the PSU is connected and has requested this operation).

Prerequisites

In order to proceed, TPP needs to fulfill all eligibility criteria and to present a valid OAUTH2 Authorization token (see use case “Get your token“).

Request

Method “GET /accounts”

See also STET V1.4.2.17 / Part II / section 4.2 page 27

Returned result

IF YOU USE THIS METHOD FOR THE FIRST TIME

(therefore if you didn’t send previously any information using PUT /consents, OR if all granted accounts have not been revoked using PUT /consents – see use case “Forward customer’s consent“) :

This call allows you to list all eligible online accessible authorized payment accounts from our customer (without balances, URI or ressourceID) for the following methods GET /accounts/balances, GET /accounts/transactions and GET /end-user-identity.

IF YOU HAVE ALREADY FORWARDED AT LEAST ONE CONSENT FROM THE CUSTOMER

(therefore if you have used previously PUT /consents request, OR if all granted accounts have not been revoked using PUT /consents – see use case “Forward customer’s consent“) : this call allows you to retrieve all eligible online accessible authorized payment account with the following additional data :

• Accounting balance if this account is flagged in the “balances” parameter in PUT /consents method
• URI for the GET /accounts/balances method if this account is flagged in the “balances” parameter in PUT /consent
• URI for the GET /accounts/transactions method if this account is flagged in the “transactions” parameter in PUT /consent
• Get payment account holder identity if the field “psuIdentity” has been setup at TRUE value in the PUT /consents.

Note

The « currency » paramater is now inserted in « accountId » field

Example

You can find an example of this request in section “Test our API” and then “Use our sandbox“.

Acceptance tests

The purpose of these tests is to ensure that the API complies with the STET standard. They should be validated before any application deployment.

Forward customer's consent

Introduction

This service is mandatory as required by Caisse d’Epargne ASPSP as part of the “Mixed” model.

Prerequisites

It is necessary to fulfill the eligibility prerequisites and to have retrieved the OAUTH2 access token (see the “Overview“> “Recover your token” section).

You can retrieve the list of the customer’s eligible payment accounts after calling the GET / accounts request for the first time: you will find the IBAN associated with each account, ie “accountId”: {“iban”: ” “}.

However, if you already know the IBAN (s) for the customer’s payment accounts, you can send them to us directly via the PUT / consents method.

WARNING: as long as you have not communicated to the account keeper (ASPSP) at least one account authorized with the PUT / consents method, or if no account is authorized, the GET / accounts method will not return the information requested but only the list of all current accounts (principle of “AISP mixed consent”).

Request

Method “PUT /consents”

See also STET specification V1.4.2.17 / Part II / section 4.4. / page 15.

The PSU specifies to the AISP which of his/her accounts will be granted and which data should be available : it gives his consent and included four access types (or operation types) :

• balances : access to one or many PSU accounts balance report
• transactions : access to one or many PSU accounts transactions history
• psuIdentity : access to PSU identity (name & surname for retail customer, ot corporate ID for a company)
• trustedBeneficiaries : access to the trusted beneficiaries list that have been set by the PSU => this feature is not supported by the ASPSP online banking. So whatever value is used (True/False), it won’t be used.

The AISP forwards details of PSU consent to the ASPSP through this call. The consent is recorded by the ASPSP for one given PSU, one given AISP, one given operation and one given account (except for the psuIdentity and the trustedBeneficiairies access types).

Each new API request calls the ASPSP consent service, for one given PSU, replaces any prior consent that was previously sent by the AISP.

Furthermore, upon the PSU’s request, the consent may be updated subsequently for an operation type : for example, access to transactions can be revoked while access to balances stay active.

• If no account is transmitted with the PUT /consents method and that consent was given for some accounts with a previous call to this method, then it means that the customer is revoking all his accounts.
• If no account is consented, or if the customer has revoked all this consented accounts, the GET /accounts method allows to get all the accounts list but access to related data (balances, transactions) is NOT possible anymore.
• In order to get any new account, a PUT /consents with no data is necessary.

Example

You can find an example of this request in the section “Test our API” and then “Use our sandbox“. The test data sets are described in the section “Test our API” and then “Test with persona“.

See also STET specification V1.4.0.47 / Part III / section 5.3 / page 7

Acceptance tests

The purpose of these tests is to ensure that the API complies with the STET standard. They should be validated before any application deployment.

Get account balance

Introduction

Using this service, you can get the accounting balance data (“CLBD” in STET) on a payment account authorized by the customer.

It follows the return of the list of current accounts for a customer : a resource identifier corresponding to an account must be provided to obtain the corresponding accounting balance.

Access to this method is limited to a maximum of 4 batch per day for one given TPP and PSU (except if the PSU is connected and has requested it).

Prerequisites

The TPP has previously retrieved the list of available accounts for the PSU :

• Customer’s IBAN should have been forwarded to ASPSP in the “transactions” list of the PUT /consents method (see use case “Forward customer’s consent“)
• The “accountResourceId” is sent in the GET /accounts response / field “resourceId” for this IBAN
• URI or accessing this method is given using the field “_links”: {“transactions”: {“href”: …}} as a response of the GET /accounts using above “AccountresourceId”

Request

Method “GET /accounts/{accountResourceId}/balances”

See also STET V1.4.2.17 / Part III / section 6.4/ page 9

Mandated parameter

“accountResourceId” : current account for which you want to retrieve transactions history.

This field corresponds to the field “resourceId” obtained in the get/accounts request result page.

Example

You can find an example of this request in section “Test our API” and then “Use our sandbox“.

See also STET V1.4.2.17 / Part II / section 4.3.4 / page 31

Acceptance tests

The purpose of these tests is to ensure that the API complies with the STET standard. They should be validated before any application deployment.

Get transactions history

Introduction

Using this service, you can get the transactions history data on a payment account authorized by the customer.

The type of account is either a deposit account for individuals, or a current account for professionals and legal entities.

Prerequisites

The TPP has previously retrieved the list of available accounts for the PSU :

• • Customer’s IBAN should have been forwarded to ASPSP in the “transactions” list of the PUT /consents method (see use case “Forward customer’s consent“)

• • The “accountResourceId” is sent in the GET /accounts response / field “resourceId” for this IBAN

• • URI or accessing this method is given using the field “_links”: {“transactions”: {“href”: …}} as a response of the GET /accounts using above “AccountresourceId”

Request

Method “GET /accounts/{accountResourceId}/transactions”

See also STET V1.4.2.17 / Part II / section 4.4 / page 34

Mandated Parameter

“accountResourceId” : current account for which you want to retrieve transactions history.

This field corresponds to the field “resourceId” obtained in the get/accounts request result page.

Optional parameters

• dateFrom : start date to search for transactions (date included)
• dateTo : end date to search for transactions (date NOT included)
• PSU-IP-ADDRESS => to be inserted in the header if the PSU is connected to AISP services
• entryReferenceFrom=> NOT used by this API

• entryReferenceTo => NOT used by this API

The date format for dateFrom et dateTo is based on ISO 8601 standards with the three following allowed formats :

• YYYY-MM-DDTHH:MM:SS.SSS or YYYY-MM-DDTHH:MM:SS.SSSZ
• YYYY-MM-DDTHH:MM:SS.SSS+HHMM
• YYYY-MM-DDTHH:MM:SS.SSS+HH:MM

Data Returned

As a reminder :

• « BOOK » means the transaction was booked and affects the closing booked balance (status used by this API)
• « PDNG » means the transaction is about to be booked and does not affect the closing booked balance (status NOT used by this API)
• « OTHR » means the transaction is not booked and does not affect the closing booked balance or the instant balance (status used by this API)

In addition to mandatory data returned, the optional STET data “entryReference” has been added for all transactions knowing that it is :

• unique value in differed debit transaction life cycle (*)
• identical value before & after transaction settlement (from status “OTHR” to “BOOK”)

(*) Note 1 : except for all schedules of a standing order (considered as one transaction overall)

Note 2 : other types of operations (e. g. Paylib) have this data only for “BOOK” status., except for those rejected

The “entryReference” format is different depending on the type of operations :

The optional STET data “Bank Transaction Code ” (BTC) has been added ONLY for professional & corporate segement clients (CE Net subscribers or equivalent), e.g. for a SEPA SCT Core :

“bankTransactionCode”: {

“domain”: “PMNT”,

“family”: “RCDT”,

“subFamily”: “ESCT”,

“code”: “05”,

“issuer”: “SI MYSYS – Caisse d’Epargne”

}

Example

You can find an example of this request in section “Test our API” and then “Use our sandbox“.

See also STET V1.4.2.17 / Part III / section 6.5 / page 10

Example

The purpose of these tests is to ensure that the API complies with the STET standard. They should be validated before any application deployment.

Expected Scope = aisp otherwise specified.

Get PSU's identity

Introduction

This service allows you to retrieve the connected PSU’s identity who has given you their consent to do so (who is not necessarely the customer having the account).

Prerequisites

To proceed with this request, it is necessary to fulfill the eligibility prerequisites and to have retrieved the OAUTH2 access token (see in the section “Overview” > “Get your access token“).

To get the PSU’s identity, you need :

• The authorization to transmit this identity information to the TPP must have been transmitted to us via the setting to true of the “psuIdentity” attribute of the PUT /consents method and must not have since been revoked (i.e. not cancel and replace via PUT /consents with a “psuIdentity” attribute set to false);
• The URI to access this method is given through the “_links“: {“endUserIdentity”: {“href”: …}} item as a result to the GET /accounts request.

Request

Method GET /end-user-identity

See also specification STET V1.4.2.17 / Part II / section 4.6.4 / page 43

Mandatory or optional settings of the body required to call this service

Mandatory settings : PSU-IP-ADDRESS => to inform if the PSU is connected.

Returned result

This call allows you to get the identity of the end customer

A self link will also be available to return to the page obtained after execution of the request.

Your access to this method are limited to a maximum of 4 batch accesses per calendar day, for a customer. However, when it is the connected customer who directly interrogates his current accounts, the number of accesses is not limited.

Example

You can find an example of this request in section “Test our API” and then “Use our sandbox“.

See also specificationSTET V1.4.2.17 / Part III / Section 6.3 / page 8

Acceptance tests

These test cases are intended to allow you to perform a minimum of tests to get started with this API and access it from your application.

Try-it mode

Principle

If you are connected on the BPCE API dev portal, you can :

• call any API through the menu in which you select your app and the access token
• then you enter the requested parameters of the method that you want to test (headers or body), those mandatory are flagged (with a “*”)

Once done, you can execute the request and get the result (incl’d error message) based on non-real persona test data as requested by the regulation (see the use case “Test with persona“).

Please note that you need to execute the request “GET /accounts” before the methods “GET /accounts/transactions” and “GET /accounts/balances” in order to retrieve the “ressourceId” parameter requierd.

Version 1.4.2

As of July 8, 2020, Try-it will only be possible for version V1.4.2.

If you have already applied for GoLive or used the self-enrolment API REGISTER , then you must create a new application and select the new STET API V1.4.2.

If you have NOT made a GoLive request, you can :

• either modify your existing application to associate it with the new STET V1.4.2 API

• either create a new application, then select the new STET V1.4.2 API

Try-it parameters for the API “Account information”

NB : for the parameter “body”, you can copy and paste the examples (left part of the screen) in the form on right part of the screen and apply your changes.

Common parameters to all methods

Parameters dedicated to GET /accounts/{}/balances

Parameters dedicated to GET /accounts/{}/transactions

Sandbox

Introduction

This test environment can be used in 2 ways :

• Try-it mode on BPCE API portal (see use case “Try-it mode“) ;
• either directly via your app : this mode is described hereafter.

Fictive data are used in this context (see use case “Test our persona“).

As this ASPSP is based on the same backed as Caisses d’Epargne (CE) one, you can use in sandbox the CE test cases as described in “https://www.api.89c3.com/en/component/bpceportal/products/452/usecases/447“.

Version History

STET Compliance

This REST-based API is compliant with the STET specifications developed by the French market initiative (https://www.stet.eu/en/psd2/) in order to comply with PSD2 regulatory requirements. It takes into account functional limitations specific to this retail bank network (see use case ‘Limitations“).

As a reminder :

• payment services directive (PSD2, (UE) 2015/2366 of 25/11/2015) went into force on january 13, 2018 : https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=celex%3A32015L2366
• it is supplemented by regulatory technical standards for strong customer authentication (RTS, Commission Delegated Regulation (EU) No 2018/389) and common and secure open standards of communication that will apply on september14, 2019. These standards are called RTS (Rules Technical Standards) : https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=CELEX%3A32018R0389

In France, the ordinance n° 2017-1252 of August 9, 2017 implements the PSD2 directive into the regulatory section of the monetary and financial code. This ordinance has been supplemented by two decrees (n° 2017-1313 and n° 2017-1314), and five orders that were published on August 31, 2017.

You can also refer to the FAQ section and the virtual assistant about STET specifications.

Description of TPP support

According to Article 30 (5) of the RTS, a support for third-party providers is available. This support can be joined via the form on this BPCE API portal (https://www.api.89c3.com/en/contact-us). Responses are sent during office opening hours (09:00 – 18:00 Central European local Time) even so a 24h/7d monitoring process of our IT systems exists.

Its general principle is shown below, taking into account delays of Article 30 (4) of the RTS :

Relase Notes

Important changes made since the first version of this documentation was published :

Roadmap

API deprecation process

According to API product life cycle, an API version can be deprecated (meaning this API is not any more accessible on gateways and sandbox). An overlap period between two major API releases is provided as described below :

The communication on the deprecation of a version N will be done at the release date of version N+1 through this portal / “roadmap” section.

This API can evolve. Please note that API modifications can occur out of the three-month regulatory notice period (art. 30 des RTS / paragraphe 4). We apply this in case of :

• urgent functional issue to solve impacting all PSU of at least one major customers segment
• security issue
• evolutions requested by the national competent authority

Please do find below our forecast roadmap :

Limits

Functional Limits

Limits of this API version

• Apply only to active and eligible online accessible payment accounts in euro currrency (the determining criterion for the purposes of that categorisation lies in the ability to perform daily payment transactions from such an account managed by the central backend IT system, source of data sent back thru APIs)

• Use AISP-mix model (PUT /consents method is mandatory for sending customer consent to ASPSP)

• Use only authentication with redirect mode (Strong Customer Authentication required and handled by the bank which IS NOT an obstacle according to French national competent authority

Note : TPP are not allowed to send to ASPSP the PSU credentials, and only ASPSP SCA redirect screens can be used (no embeding process as clarified by European Banking Authority based on articles PSD2 #95.5 & RTS #31)

• Access to the list of trusted beneficiaries using GET /trustedBeneficiaries is NOT available (feature not implemented in Crédit Coopératif online banking service)

• Access to customer account holder identity (first name and last name) is NOT available

• Transaction history data depth is aligned on online banking services (62-day period max for retail cutomers & small professionals/entrepreneurs segments, 90-day period max for large professionals & corporates, limited to 500 operations, no paginations managed by the API in both cases)

• “aisp extended_transaction_history” mode is NOT supported

• Access to payment account is done only using IBAN as main parameter

• There are no rate limits if the PSU-IP-ADDRESS is supplied, otherwise limited to 4 calls (see PSD2 regulations) :
  • per calendar day (00h00 – 23h59:59:999)
  • per TPP OID
  • per ASPSP end point
  • per PSU ID
  • per IBAN
  • per API AIS method ( /!\ /transactions method with or without dateFrom / dateTo parameters is considered as one method)

• The optional STET data “entryReference” applies only to PART & PRO/EI customer segments (see the functional perimeter in use case “Get transactions history”) ;

Note : as this data is issued on the spot via API, the search using “entryReferenceFrom” and/or “entryReferenceto” parameters is NOT supported

Limits related to eligible payment accounts

Apply to the following customer segments :

• Retail customer who subscrided direct access “COOP@CCESS” online banking. In this case, the payment account starting with 04 is called a “deposit account”, and includes joint account, as well as attached minor to the account family.

Note 1 : the legal guardian or representative using Web Protexion solution (for managing persons under tutorship / curatorship) is not supported

Note 2 : a retail customer is a “physical individual” having the legal status of “capable adult”. He/she may have small professionals activities using the legal status “individual entrepreneur”, and is considered as a retail customer.

• Professionals & corporates & associations (using direct access “COOP@CCESS” online bank and an account starting with 08 with electronic funds transfers and direct debits activated) have the status of “legal entity”. In this case, the payment account is called “current account”.

Limits related to SCA means compliant with this API

• Retail PSU equiped with password + SMS OTP and/or CAP reader and/or Secur’pass

• Professional PSU equiped with password + SMS OTP and/or CAP reader and/or Secur’pass

• Corporate & association PSU equiped with password + SMS OTP and/or CAP reader and/or physical token TurboSign

Note : if the PSU is only equiped with a physical token, this SCA mean can’t be used on his/her mobile/smartphone

From test to live data

According to PDS2 regulation, the data set available thru this dev portal, Try-it mode and sandbox are based on fictive data (or non-real ones).These data are described in the use case “Test our API“.

In order to access to live data, please use first our API Register (see the product data sheet www.api.89c3.com/en/component/bpceportal/products/543/usecases/533).

Note : a weekly slot is reserved for a programmed maintenance (all IT infrastructure incl’d backends and API gateways) Monday morning from midnight to 06:00 am, and could generate some perturbations during this period (same for some banking batch processes initiated at the beginning or at the end of the day/month/quarter/year).

Forlive operations, the parameter “bankcode” allows TPP to send API requests to the right ASPSP backend thru a dedicated « endpoint » www.<bkcode>.live.api.89c3.com(or www.<bkcode>.live.api.credit-cooperatif.coopaligned on direct access domain name www.credit-cooperatif.coop). Once chosen, this entry point shall also be used for all subsequent requests.

Eligibility

The API resources can only be used by Payment Service Providers (PSP) having a Account Information Service Providers (AISP) role.

In order to provide a service to users of account informations services under PSD2 directive, you must be a licenced PSP such as credit institution, electronic money institution, and payment institution. This status is delivered by the financial authorities of the country where the request is made ; in France it is the “Autorité de Contrôle Prudentiel et de Résolution (ACPR), under the supervision of the Banque de France regulatory body :

https://acpr.banque-france.fr/sites/default/files/medias/documents/jch_20180403_conference_securite_des_paiements.pdf

Obtaining and maintaining such agreement requires rigorous procedures in order to give strong guarantees to the account informations services users. The forms are provided on the ACPR website : https://acpr.banque-france.fr/en/authorisation/banking-industry-procedures/all-forms

Once the agrement is granted, the Organisation Identifier (OID) given by the national authority has the following format (UPPER case):

PSDXX-YYYYYYYY-ZZZZZZZZ

“PSD” as 3 character legal person identity type reference;

2 character ISO 3166 country code representing the NCA country;

hyphen-minus “-” (0x2D (ASCII), U+002D (UTF-8)); and

2-8 character NCA identifier (A-Z uppercase only, no separator)

hyphen-minus “-” (0x2D (ASCII), U+002D (UTF-8)); andPSP identifier (authorization number as specified by NCA).

This OID is very important to identify yourself as a TPP :

• using STET API requests as OID is included in the parameter “client_ID”

• using mutual authentication (TLS) as OID is included in eIDAS certificates to be delivered to the bank (see below)

Please note that if you are using our API “Register”, an internal OID will be generated & shall be used for subsequent API requests.

You also need eIDAS (electronic IDentification And trust Services) compliant certificates delivered by a Qualified Certification Service Provider (QTSP, see list available on https://webgate.ec.europa.eu/tl-browser/#/).

In order to be able to consume PSD2 API published on our BPCE Portal, the TPP has to enroll its app and to use live certificates signed by a QTSP while sending API Register requests :

• a set of QWAC (for securing the TLS) and QSEALC (to be stored in our gateway) certificates for the sandbox

• another set of (for securing the TLS) and QSEALC (to be stored in our gateway) certificates for the live environment

A keyID shall also be provided with a correct STET format integrating the SHA256 certificate fingerprint after “_” char, see example STET V1.4.2 / Documentation Part 3: Interaction Examples / section 6. AISP Use cases / Signature : keyId=https://path.to/myQsealCertificate_612b4c7d103074b29e4c1ece1ef40bc575c0a87e.

Please embed only public keys. Controls on other data will be based on European Banking Association TPP register (https://euclid.eba.europa.eu/register/pir/disclaimer).

You can also refer to the FAQ section or our virtual assistant for any further question.