Get Started

Introduction

Welcome to the Belfius API Portal, your unique platform for building quality applications and solid digital services using Belfius APIs.

Programming interfaces have become a driving force in the development of businesses in all sectors and all activities throughout the world. More than ever businesses need to be able to quickly create added value and innovate all aspects of their organisation (management, processes, solutions, customer experience, etc.).

Belfius is no exception to this rule. We also do everything we can to provide quality services to our customers and partners. This API portal, accessible to authorized TPPs under PSD2, is a further step in this direction.

In addition to a getting started guide and detailed documentation, we offer a sandbox environment for testing purposes to help you as much as possible in your work.

API Marketplace

The API Marketplace showcases the different APIs available at Belfius and at Banx. For each API, the “Flow” section gives you functional information. Technical information is available in the “Documentation” and “Error codes” sections. Note that a FAQ section is also present for some APIs to help you. The APIs can have different status:

  • Coming soon These are future APIs, for which, for the time being, only documentation exists.
  • Sandboxed These can be used with a Sandbox environment to simulate calls.
  • Live These are APIs for a production environment which can be used directly from your applications.
  •   Decommissioned foreseen   These are live APIs for which a new version is already available in production. These will be non-usable in the coming months.
  •   Decommissioned   These are APIs that are no longer usable in production. Another API version is available in production.

Getting Access

Access to Live APIs has different security requirements than access to the sandbox. In both cases, you can fill in the dedicated contact form to reach out to us for API access.

If you are an authorized TPP under PSD2 and you’ve opted to use our PSD2-APIs, you will be contacted to provide your eIDAS (QWAC and QSeal certificates). After this step, Belfius will exchange with you the required credentials to call the Belfius and Banx APIs.

Sandbox

Once we have given you the credentials, you will be able to fully use our sandbox environment and access the test data of the available APIs. To make it easier for you to get started and to quickly familiarize yourself with the APIs, this environment doesn’t require certificates or authentication. You still need to fill in the mandatory parameters of the API (values don’t matter) and have valid credentials (which you receive after registering).
Please note that the sandboxes return a mocked response and won’t process any actual data.

The sandbox currently only supports the following calls:

  • PSD2 AIS (Account Information Services) to view an account’s balance and transaction history
  • PSD2 PIS (Payment Initiation Service) to initiate a payment
  • PSD2 CAF (Confirmation of the Availability of Funds) to confirm if an amount is available on the account

Testing PSD2 APIs in our sandbox is only accessible to recognised – or in the process of being recognised – TTPs under PSD2 regulation.
To request an access to our sandbox, please use this dedicated form.

Sandbox base path:

  • For Belfius account https://sandbox.api.belfius.be:8443/sandbox/psd2
  • For Banx account https://sandbox.api.banx.be:8443/sandbox/psd2

PSD2 Specific APIs

Currently only APIs linked to the Second Payment Services Directive (PSD2) are available in our live environment.
The full documentation on our PSD2 APIs can be found in the API section of our developer portal.
Belfius did not receive an exemption from the contingency mechanism as detailed in Article 33(6) of the RTS. Therefore if our PSD2 APIs are not available, our fallback solution can be used (see documentation).

Belfius PSD2 APIs can be used for all Belfius customer segments (retail, private, wealth, business, corporate, public and social). The endpoint that should be used is the following : psd2.b2b.belfius.be:8443

Banx PSD2 APIs can be used for all Banx customers. The endpoint that should be used is the following : psd2.b2b.banx.be:8443

Prerequisites for Live PSD2 APIs:

To use Belfius and Banx PSD2 APIs, you need to:

  • be recognised as a TPP under PSD2 regulation
  • have provided your eIDAS certificates (QWAC and QSeal)

To request an access to our production PSD2 APIs, please use this dedicated form

Note that the credentials to access the PSD2 Belfius APIs are also valid to access PSD2 Banx APIs. This means that if you are already onboarded by Belfius, no additional steps are necessary to call the Banx APIs.

Account Information Services (AIS) – PSD2 APIs

The PSD2 AIS APIs provide the possibility to a PSU to view their account balance and transaction history via a TPP application. PSD2 AIS APIs require the explicit authentication of the PSU, which has been implemented through redirection flows.

The TPP can then obtain an access token and a refresh token, which will allow it to access the PSU data.

All details on AIS flow can be found in the Flows section of the AIS API documentation.

Payment Initiation Services (PIS) – PSD2 APIs

The PSD2 PIS APIs provide the possibility for a PSU to initiate a payment using their Belfius/Banx account via a TPP application.

All details on PIS flow can be found in the Flows section of the PIS API documentation.

Confirmation on the Availability of Funds (CAF) PSD2 APIs

The PSD2 CAF API provides the possibility for a TPP to check if enough funds are available on a given payment account (IBAN should be provided).

All details on CAF flow can be found in the Flows section of the CAF API documentation.