Get started - including Sandbox

In just a few steps you can register and start developing using our APIs and Sandbox.

1. Read the API and Sandbox overview

Based on the information provided about our available APIs, decide which of these seem appropriate for your service. The technical documentation describing these APIs, including our Sandbox, can be found under Documentation (see also step 3 below).

2. Create an account

Have you found a suitable API and want to get started? Great. First, create an account on the Developer Portal. After receiving an activation email, log in to Developer Portal using your username and password. Here you can access further technical documentation for our APIs and Sandbox. You'll also find a sample project to help you start building your interface (see step 3). Use of Developer Portal account is subject to Terms of Use, these must be accepted and a copy of the terms can be downloaded here.

The first person to create an account on behalf of an organisation is assigned the role of account coordinator and Organisation Administrator by default. With this account, developer roles may be requested for your organisation along with requests for the actual use of APIs through one or more Application definitions. Multiple Organisation Administrator roles may be assigned, but this must be agreed within your organisation. When creating account roles, it is important to use personal business email addresses as contacts for the Organisation Administrators, so that we can make quick and personal contact in the event of any problem arising.

3. Start developing

With the help of the technical documentation on this site and Developer Portal you can start building your interface with our APIs. On Developer Portal we offer swagger files and test (Sandbox)APIs, so that you can test your work immediately. The Sandbox APIs will be available upon request per Application definition.

Using the API Explorer on the Developer Portal, APIs may be tested, and all information, resources, methods and parameters needed for the query obtained. When executing the API, this data is displayed by means of a JSON file, as well as the API results, including the errors. If a query string is used, this can also be translated into different programming languages.

4. Apply for our Sandbox and take our APIs into production

Is the development phase complete? Now you are ready to request access to our Sandbox or production APIs via Developer Portal (this can be done via your Organisation Administrator: see step 2 and the instruction below).

We advise you to apply for a Sandbox Application first. As opposed to the access to and use of the production APIs, it is not necessary for your organization to already have a PSD2 license for access to and use of the Sandbox APIs. You can build and test Sandbox PIS, AIS or CAF services as long as your organization applied for a license from or registration with De Nederlandsche Bank or a competent authority in another EU country. In that case, when requesting access to a Sandbox API you will be asked to provide de Volksbank with the necessary information about the application by your organization for this license and/or registration. If your organization does not yet have a PSD2 license, it is possible to use another valid certificate. You will then be asked to send your certificate (issued by a QTSP) to de Volksbank. Please note that a self-signed certificate is not allowed.

For the production APIs you have to use a valid PSD2 certificate according to the European Trusted List Browser https://webgate.ec.europa.eu/tl-browser/#/search/type/1.

Upon successful completion of the application, the 'client id' and so-called 'client secret' can be downloaded on the Developer Portal . These enable you to set up a secure communication with our Gateway. You are now ready to receive our Sandbox or production APIs.

How to request Sandbox or production APIs through Developer Portal:

  1. Log in with your account details and go to ‘dashboard’. Select ‘Publish’, click on ‘Apps’ and then click ‘Add Application’. For building a Sandbox Application, only select the desired Sandbox APIs.
  2. Define your Application:
    • fill in your organisation’s recognised name for the Application (Application Name field);
    • describe what your API means (Public Description field);
    • enter your National Identification Number (eg Chamber of Commerce) (NationalID field);
    • enter the trade name of your organisation (Field Company Commercial Name);
    • also enter the statutory name (field Company Legal Name);
    • finally select the country code of residence (field Country);
  3. Then you can see in ‘API Management’ which APIs you may select for this Application: choose the APIs that you want to link to your application (for your Sandbox Application: only select Sandbox APIs). Click on 'Next' to confirm this selection. Then a pop-up screen will invite you to accept the API Terms & Conditions: these apply to the production of your Application, you can download a copy here. Click on 'I Accept the Terms & Conditions' and you will return to the 'API Management' screen. Click on 'Next';
    Here you can enter the same definition for multiple APIs. You can select APIs per brand or as a group ‘de Volksbank’ (in the latter case you link all three brands to your Application).
  4. De Volksbank uses a redirect model with the OAuth2 protocol (see also under 'Documentation'). That is why we ask you to enter in the 'OAuth' screen, under 'Callback / Redirect URL (s)', the URL we have to offer as our response. When you enter multiple URLs, please use comma separation. Sandbox: enter the URL of your test environment we have to offer our test response.

    Please note:

    • Under 'Scope' you fill in AIS, PIS, CAF or a combination of these (depending on which APIs are linked to your Application). When you enter more services, please use a space as separation between e.g. AIS and PIS instead of a comma. Mandatory format is then AIS<space>PIS.
    • Under 'Type' always choose 'Confidential'.
  5. Finally, click on 'Create' and your request for a production application can then be handled by de Volksbank.

Before we approve your application request you will receive a request to send your certificate by email. Please note: attach your certificate as a zipfile in your reply to us. Once your certificate is installed by us, you will receive an email stating that your application has been approved. Then you can download the 'client id and secret' on the Portal: via Develop > View all applications > your application > Configuration. This allows you to set up a secure connection via our Gateway for the relevant API and receive the requested services.
For using your Sandbox Application we refer to the User Manual on the page Documentation.

Download API Terms & Conditions

Download Developer Portal De Volksbank Terms & Conditions

Can’t find what you are looking for?
Let us help you...