Account API

Access account balance and transaction history of Belfius customers in total security.

Introduction

AISP

These endpoints provide the possibility for a TPP to access the account information and transaction history of a Belfius Customer, provided TPP has received the required token(s) generated as a result of consent process.

Produces
  • application/json

Hosts

You can use the production host when you want to go live:

https://psd2.b2b.belfius.be:8443

Click the button below to download the open API specification.

Download

Example screen

Navigate to an endpoint to see sample code


Get authorized account details along with balance.

Returns the account-details and associated balance for a given PSU account that is specified by the AISP through an encrypted logical-id of account. In case of a multi-currency account, the returned account balance is always a balance in euro. This balance is associated to the balance of the euro compartment or the globalised amount in euro of the balance of all compartments (depending on the parameter of the account). A list of each currency compartment with its balance is also provided in the API response.


Parameters

Response

{
  "type": "current-account",
  "iban": "BE80350454678790",
  "currency": "EUR",
  "balance": "123.12",
  "multicurrency": "True",
  "other_compartments": [
    {
      "currency": "EUR",
      "balance": -123.12
    }
  ],
  "_links": {
    "self": {
      "href": "string",
      "templated": "boolean"
    },
    "transactions": {
      "href": "string",
      "templated": "boolean"
    }
  }
}
Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Get /accounts/{logical-id}

Request example

There is no example request provided

Response example

{
  "type": "current-account",
  "iban": "BE80350454678790",
  "currency": "EUR",
  "balance": "123.12",
  "multicurrency": "True",
  "other_compartments": [
    {
      "currency": "EUR",
      "balance": -123.12
    }
  ],
  "_links": {
    "self": {
      "href": "string",
      "templated": "boolean"
    },
    "transactions": {
      "href": "string",
      "templated": "boolean"
    }
  }
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

Get transactions for an authorized account.

Returns transactions for an account for a given PSU account that is specified by the AISP through an encrypted logical-id for account. The request may use some filter parameter in order to restrict the query - on a given imputation date range The result may be subject to pagination (i.e. retrieving a partial result in case of having too much results) through a set of pages by the ASPSP. Thereafter, the AISP may ask for the next page of results.


Parameters

date_from Query optional string

Inclusive minimal imputation date of the transactions in ISO_8601 UTC date format [YYYY-MM-DD]. Transactions having an imputation date equal to this parameter are included within the result.

date_to Query optional string

Exclusive maximal imputation date of the transactions in ISO_8601 UTC date format [YYYY-MM-DD]. Transactions having an imputation date equal to this parameter are not included within the result.

psu_involved Query optional boolean

If present (& with value true), it is indicating that a PSU has directly asked this account access in real-time. The PSU then might be involved in an additional consent process, if the given consent is not any more sufficient.

pagesize Query optional integer

Caller can provide the pagesize which is records per call.

next Query optional string

Populate with next_page_key present in the reply from API-GW if present.

currency Query optional string

ISO 4217 3-letter alphabatic Currency-codes.

logical-id Path required string

Encrypted Logical ID of the account which is mapped to IBAN.

Authorization Header required string

Access token to be passed as a header.Scope of this access-token is limited to a given type [e.g. AIS] and given IBAN. Token itself should be passed as bearer token in Authorization header like:"Bearer 987tghjkiu6trfghjuytrghj".

Request-ID Header required string

Request id to be passed as custom header. It will be used as sort of correlation id for logging and tracting purposes.

Accept Header required string

It must be of type application/json including version number.[Accept:application/vnd.belfius.api+json; version=1].

Accept-Language Header required string

Accept-Language header field sent by the Client terminal. It can include language in ISO 639-1 format [example-:fr]. If no Accept-Language header is present or if it is present with a language which is not at all known to server, HTTP 406[Not Accepted] will be returned.

Client-ID Header required string

Client ID of registered TPP.

Redirect-URI Header required string

Redirect-URI of the client.

Response

{
  "_embedded": {
    "transactions": "[]",
    "next_page_key": "783j23kj2hkj2h42u492424nh24924k2"
  },
  "_links": {
    "self": {
      "href": "string",
      "templated": "boolean"
    },
    "account": {
      "href": "string",
      "templated": "boolean"
    }
  }
}
Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

()

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Headers
  • Response-ID: Same as Request-ID passed in the request.

example:

{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
  • Fixed-form error tokens mapping to specific errors.

    example:

    string
    error (string)

  • Error specific code, could be used directly by consumer's software.

    example:

    string
    error_code (string)

  • Full description of the error.

    example:

    string
    error_description (string)

Get /accounts/{logical-id}/transactions

Request example

There is no example request provided

Response example

{
  "_embedded": {
    "transactions": "[]",
    "next_page_key": "783j23kj2hkj2h42u492424nh24924k2"
  },
  "_links": {
    "self": {
      "href": "string",
      "templated": "boolean"
    },
    "account": {
      "href": "string",
      "templated": "boolean"
    }
  }
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

        
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}