Account API

Access account balance and transaction history of a customer in total security.

Error codes

The table below lists the possible exceptions (error scenarios), either caused by your request or by the API.


Using version 1 of get /accounts/{logical-ID} API and version 1.2 of get/accounts/{logical-ID}/transactions

http status codes

Error

Error-code

Error-description

Scenario

400

missing_input

10001

Missing required input 'INPUT'

Request received without a mandatory parameter

 

invalid_input

10002

Input 'INPUT' is not valid. DETAILS OF WHAT IS WRONG.

Request received with bad parameters (invalid format) values

 

invalid_access_token

10006

access_token is not valid

Request received with invalid access_token

 

invalid_access_token

10006

sca token is not valid

Request received with invalid SCA token when retrieving transactions that occured more than 90 days in the past

 

invalid_sca_token

10006

access_token is not valid in this scope

Request received with an access_token not valid for the given scope e.g. AIS, PIS and CAF

 

SCA_required

20007

SCA is required. Please follow the URL in the response body in order to receive a valid SCA token.

Request received when the PSU wants to consult transactions that occurred more than 90 days in the past. An additionnal SCA is required.

 

SCA_required

20008

Client authentication is expired. Please follow the URL in the response body in order to renew the client authentication

Request received when associated client authentication has expired

 

invalid_inputd

10109

The Client-ID / Api-Key is invalid

Request received with invalid Client-ID or TPP-ID

 

invalid_input

10110

Quota exceeded for non-interactive calls

Request received when the TPP have perform more than 4 unattended calls per 24 hours

 

failed_security_validation

GEN-1203-100008

Validation failed for security related parameters  <INPUT-1>

Request sent with invalid security parameter

401

invalid_token

100010

JWT Token is invalid

JWT Token is invalide

403

blocked_tpp

20001

No Active TPP found.

Request received with a Client-ID which is not active

 

invalid_account

20002

No Account found

Request received with non-Belfius account

 

channel_not_permitted

20003

This account can not be consultated via electronical channel

Request received for an account that is not consultable with electronic channel

 

account_not_supported

20004

This account is not allowed for this type of request

Request received for an account that is 'not allowed for PSD2'

 

no_active_consent

20005

User/System has deactivated the consent. Tpp has to start over with /consent-uris

Request received with the consent which has been deactivated by the user/system

 

access_denied

20006

Access is not ok for this account. Please contact customer support.

Request received with an account for which access has been disabled by provider. Please contact Belfius customer service

404

resource_not_found

10004

Specific version not found. Supported versions are [X,..].

Request received with invalid version in Accept header

 

resource_not_found

10007

No account found with given logicalId

Request received with invalid logicalId

 

account_not_found

10007

No account found with given logicalId

Request received with invalid logicalId

 

resource_not_found

10102

Requested resource was not found.

Request received with unsupported HTTP verb

405

method_not_allowed

10103

The requested HTTP method is not allowed

Request received with restricted HTTP verbs

406

unacceptable_media_type

10004

Server can not return the response In the format mentioned in the request. Supported type is application/vnd.belfius.api+json;.

Request received with invalid type in Accept header

 

quota_limit_exceded

10110

Quota exceeded for non-interactive calls

Request received when the TPP have perform more than 4 unattended calls per 24 hours

495

ssl_validation_error

10020

error during client authentication

SSL certificate error. Mutual TLS can not be established. It may occur when an unregistered client( or a client with an invalid/expired certificate) trying to access a secure api

500

internal_server_error

20020

Internal error occurred

Internal server error

503

service_unavailable

GEN-1204-100001

Service unavailable

Planned down-time in currently on going

 

service_unavailable

10109

Service unavailable, please try in 24 hours

Client request falls in the configured 'restrict day period' frame


Using version 2 of account APIs

http status codes

Error

Error-code

Error-description

Scenario

400

MISSING_INPUT

GEN-1201-100001

Missing required header input 'INPUT'

Request received without a mandatory input in the header

 

MISSING_INPUT

GEN-1201-100002

Missing required body/path/query input 'INPUT'

Request received without a mandatory input in the body/path/query

 

INVALID_INPUT

GEN-1202-100001

Invalid request header input.

Request received with bad input (invalid format) values in the header

 

INVALID_INPUT

GEN-1202-100002

Invalid request body/path/query input.

Request received with bad input (invalid format) values in the body/path/query

401

FAILED_SECURITY_VALIDATION

GEN-1203-100003

Invalid access token

Request received with invalid access_token.

 

FAILED_SECURITY_VALIDATION

GEN-1203-100008

Validation failed for security related parameters 

Request sent with invalid security parameter

 

FAILED_SECURITY_VALIDATION

GEN-1203-100009

Invalid Api-Key/Client-ID

Request received with invalid Client-ID or TPP-ID

 

FAILED_SECURITY_VALIDATION

GEN-1203-100010

Invalid JWT

Request received with an incorrect JWT token. This error can be linked to an incorrect logical-ID, an incorrect SCA token or PIS token

 

SCA_REQUIRED

B14800-0PLC-REDRCT

SCA is required. Please follow the corresponding URL in the response body.

In AIS context, this error can be linked to an SCA that should be renewed (to access the account transaction) or because the PSU wants to access transactions that happend more than 90 days in the past. In PIS context, a SCA should be performed to sign the payment initiation"

403

INVALID_TPP

B14663-2100-000000

No Active TPP found.

Request received with a Client-ID which is not active

 

INVALID_ACCOUNT

B14800-3002-000000

No Account found.

Request received with non-Belfius account if Belfius end point is used.
Request received with non-Banx account if Banx end point is used.

 

ACCESS_DENIED

B14800-3004-000000

Access is not ok for this account. Please contact customer support.

Request received with an account for which access has been disabled by provider. Please contact Belfius customer service

 

CHANNEL_NOT_PERMITTED

B14800-3007-000000

This account can not be consultated via electronical channel.

Request received for an account that is not consultable with electronic channel or request received for a Banx account using the Belfius endpoint or vice versa (Belfius account using Banx endpoints).

 

ACCOUNT_NOT_SUPPORTED

B14800-3008-000000

This account is not allowed for this type of request.

Request received for an account that is 'not allowed for PSD2'

 

NO_ACTIVE_CONSENT

B14800-3013-000000

User has deactivated its consent in the channel. Tpp has to start over with /consent-uris flow

Request received with the consent which has been deactivated by the user within its Belfius or Banx channel

 

NO_ACTIVE_CONSENT

B14765-2100-000000

User did not enroll its account for this scope

 

404

OTHER_API_ERRORS

GEN-1206-100001

Requested resource was not found.

Request received with unsupported HTTP verb

 

OTHER_API_ERRORS

GEN-1206-100002

Specific version not found. Supported versions are  'INPUT'

Request received with invalid version in Accept header

 

OTHER_API_ERRORS

GEN-1206-100007

No account found with given logicalId.

Request received with invalid logicalId

405

OTHER_API_ERRORS

GEN-1206-100003

Method not allowed

Request received with restricted HTTP verbs

406

OTHER_API_ERRORS

GEN-1206-100006

Server can not return the response In the format mentioned in the request. Supported type is: 'INPUT'

Request received with invalid type in Accept header

429

API_USAGE_LIMIT_REACHED

GEN-1205-100002

Quota limit exceeded

Request received when the TPP have perform more than 4 unattended calls per 24 hours

495

FAILED_SECURITY_VALIDATION

GEN-1203-100001

SSL validation error

SSL certificate error. Mutual TLS can not be established. It may occur when an unregistered client( or a client with an invalid/expired certificate) trying to access a secure api

500

OTHER_API_ERRORS

GEN-1206-100004

Internal error occurred

Internal server error

500

OTHER_API_ERRORS

GEN-1206-100008

Internal error occurred with reason :

Internal error occurred with reason :

503

SERVICE_UNAVAILABLE

GEN-1204-100001

Service is unavailable

Planned down-time in currently on going