What is this site ? What is it used for ?
- This is the PSD2 API Developer Portal of La Banque Postale.
- La Banque Postale has chosen to create a dedicated interface, the API channel.
- This Portal gives access to the documentation to use APIs related to the Directive and made available to the market.
Why is it necessary to create an account on this Portal before using the APIs ?
- The Portal allows you to exchange technical information to use our APIs (client id, callback URL).
- You will also have access to all the documentation of our PSD2 APIs.
How to create an account ?
- Click on "Create an account".
- Complete the different fields then click on "create new account".
- Once the account is created, you will receive an email to activate your account on the email address that you have indicated.
What should I do on this Portal before I can use the APIs ?
- Prerequisite: Create and activate your account.
- Register a new application to give us the callback URL.
- Once your app is created, we provide you with the client ID.
- Subscribe to the application to your app (sign up to the plan).
- Once done, it will appear in your application within the "apps" tab
- Now you are ready to request our APIs with the client ID.
How to register an application ?
- When you add an application you are provided with a client ID for the application. You must supply the client ID when you call an API that requires you to identify your application by using a client ID, and a client secret.
- In order to meet the need expressed by the TPP and to improve the experience of its users, La Banque Postale is implementing a “Dynamic Client Registration" API inspired by RFC 7591.
- This API standardizes the process of registering the TPP (of their apps or their agents) ant it guarantees a better security for access to the PSD2 APIs.
- To register an application, simply use the product « API PORTAL REGISTER » available in our catalog.
How to subscribe to an API ?
- Prerequisite: Create your application.
- Click on “API Products” and select the API of your choice.
- Click on “Subscribe” and choose which application you want to sign up to the plan.
How can I test a PSD2 API ? What features are open within the sandbox ?
- You will be able to test our APIs with the sandbox put at your disposal. This sandbox is regulatory within PSD2.
- The regulatory sandbox allows you to test the functioning of the calls to our APIs.
- This sandbox does not allow to test a complete user journey, ie without strong authentication.
- The data in the regulatory sandbox is fictitious data that does not come from the calling context (ie, whatever the product requested as payment initiation, the response will always consider it to be a classic SEPA transfer).
What can I find in the documentation of La Banque Postale PSD2 APIs ?
- You will have access to the description of our APIs based on the STET standard as well as our implementation choices.
- When looking at the details of an API you will see a table of the operations contained in the API. This will show what method they are (GET, POST, PUT, DELETE, PATCH, HEAD or OPTIONS) and what path the Resource uses.
- If you click on the Resource you will see more information about it, what parameters it might take,what it returns, what possible return codes it might use and what they mean.
- There is also a 'Try' button which enables you to try the Resource out direct from the Developer Portal.
On which API standard are the PSD2 La Banque Postale APIs developed ?
- APIs are developed according to STET 1.4.2.6
What are plans ?
- A plan is collection of API resources or subsets of resources from one or more API. A plan can contain a mixture of HTTP GET, PUT, POST, and DELETE verbs from different APIs or it can contain all the GET verbs from various APIs.
- La Banque Postale proposes 2 plans : a PSD2 sandbox and our PSD2 APIs .
