|TABLE OF CONTENTS|
Welcome to the Developer Portal!
This developer portal provides you a ready-to-use environment for accessing our APIs where you can find documentation, specifications, sandboxes and register to the services provided through a SaaS delivery model.
Signup and Login
To start developing within the Sandboxes, you only need a valid email address.
Note that for PSD2 API, the Sandbox access is restricted to authorized third party providers that have already received their QWAC and QSeal or providers that can prove that they have already submitted their application form to become an authorized third party provider in a member state of the European Union. After creating your account, you might be asked to provide such evidence to keep your Sandbox account accessible.
- 1. Fill the small registration form
- a. Username: Will be used to sign in
- b. Email Address: All emails from the system will be sent to this address. The email address is not made public and will only be used if you wish to receive a new password or certain notifications by email
- c. Consumer organization: The name of the organization under which all the users and the client applications will be grouped. If you want to join an existing consumer organization, you need to be invited by an existing member.
2. Complete your registration by clicking on the activation link sent to your email address.
3. That's it, your are now registered and you can create an application in order to subscribe to APIs.
In order to be able to call APIs, you will need to create an "Application". The credentials that you need to call an API are bound to an application, you can see the key (or client-id) in the application management section, but the secret (client-secret) is only showed once when you create the application. You need both client-id and client-secret when you call an API.
1. Create an application through the "Apps" menu
2. Keep your client-id (key) and client-secret (secret) in a safe place, these are the application credentials. The client-secret is only displayed once on this screen.
3. That's it, you can now subscribe to an API plan with this application.
Subscribe to the APIs
Explore the API marketplace and find the API of your interest, then you can subscribe to defined plans.
Once subscribed, you can use the application credentials to call the API.
The API provides an implementation of the Berlin Group version 1.3 API, which might be updated when new versions of the specification are released. Details about implementation choices and supported features are listed in the paragraphs below.
You can try the simulated version of the PSD2 available flows in the Sandbox environment. In order to authenticate to the Sandbox API endpoints you need to have either the credentials of your client application or an eIDAS certificate.
The future production environment will only be accessible to fully authorized third party providers that can present a valid QWAC in the TLS mutual authentication setup of the connection to the API endpoint.
Authentication and authorization
Berlin Group APIs that give access to PSU data require explicit consent of the end-user (PSU) that is authorized to access the given payment account. Berlin Group is proposing three different models to provide PSU credentials to the API out of which the Redirect Flow is by far the most flexible and provides support for any type of strong customer authentication method already used by the ASPSP.
All APIs provide support for the Redirect Flow. The optional OAuth2 flow as a pre-step defined by Berlin Group does not follow a proper Authorization Code Grant flow and is therefore not supported by the Sandbox.
During the authorization procedure, the PSU is required to provide his consent by performing a strong customer authentication. The Sandbox environment allows you to simulate the PSU authentication flows with sample data given hereunder.
Sandbox sample data
In order for you to simulate real scenarios, we provide you some representative data that you can use in the sandbox environment.
For some flows you might indeed need to have an account identifier, a user identifier and a user password that allow you to simulate a full PSU experience according to your use cases.
Supported flows and features
Here are the supported features offered by the PSD2 API. As a general rule, consider that a feature not present in this table is not available through the API.
Note that even if the payment products of type "Cross-Border" and "TARGET2" are not present in the list of supported features, the backoffice might however use the most suitable settlement channel when the payment is received. This complexity is therefore abstracted from the PSU / PISP who only have to create a payment (with Berlin Group Sepa CT payment product endpoint) and then the backoffice will be responsible for determining the right settlement channel.
Account Information Service Providers
AISPs can access API endpoints tagged as such in the Berlin Group API specifications. These methods provide access to account lists of a PSU, their respective balances and transaction history.
Berlin Group defines two different consent models, both of which are supported by the Berlin Group APIs provided in this portal.
- • Global consent: the TPP requests access to all of the PSUs data
- • Detailed consent: the TPP requests access to a specific subset (accounts, balances, transactions) of the PSU's data
Card Based Payment Instrument Issuers
The CBPII can access API endpoints tagged as such in the Berlin Group API specifications. These methods allows issuing card-based payment instruments that can be used to initiate a payment transaction from a payment account held with another payment service provider.