Payment API

Initiate payments from a payment account.

Error codes

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


Using version 1 of the payments APIs

http status codes

Error

Error-code

Error-description

Scenario

302

Payment has to be signed

20010

signature_required

Valid payment request which needs to be signed by Belfius Application. Client must follow the Location header in response to sign the payment.

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_input

10008

Execution date must be in future

Request received with execution-date in past

 

invalid_input

10009

Amount must be bigger than 0

Request received with amount <=  0

 

invalid_input

10010

Currency has to be EUR

Request received with currency other than EUR

 

invalid_input

10011

Sender and receiver account must not be same

Request received with same account for sender and receiver

 

invalid_input

10012

Invalid payment treatment type value: 'payment_treatment_type'

Request received with an invalid value (permitted value are NORMAL or URGENT) for payment_treatment_type

 

invalid_input

10013

Communication must be of exact 20 chars length for STRUCTURED communication

Request received with commuication where communication_type='STRUCTURED' and communication length is different than 20

 

invalid_input

10014

Incorrect structured communication

Request received with an incorrect structured communication field value

 

invalid_checkdigit

10018

Either Order/Beneficiary account is not in correct format OR structured communication is not valid

Request received with Incorrect Order/Beneficiary account OR incorrect structured communication

 

invalid_input

10019

Execution date is not valid

Request received with invalid execution-date (weekend e.g.)

 

invalid_input

10021

Urgent Payment is not permitted when the order and the beneficiary account are both Belfius account

Urgent payment request received when both order and beneficiary accounts are Belfius accounts

 

invalid_input

10022

It is too late to perform an urgent payment now (hour limit)

Urgent payment request should be executed before xxx

 

invalid_input

10021

Urgent payment is not allowed for this type of account

Request received for an account for which urgent payment is not allowed

 

invalid_input

10006

access_token is not valid

Request received with invalid access_token

 

invalid_access_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

 

invalid_input

10109

The Client-ID / Api-Key is invalid

Request received with invalid Client-ID or TPP-ID

 

failed_security_validation

GEN-1203-100008

Validation failed for security related parameters  <INPUT-1>

Request sent with invalid security parameter

 

failed_security_validation

GEN-1203-100002

Signature is invalid

Request signed with an invalid signature

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(TPPID) 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 with account 'not consultable with electronic channel'

 

account_not_supported

20004

This account is not allowed for this type of request

Request received with account 'not allowed for PSD2'

 

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

 

forbidden

20008

Transaction is already cancelled

Request received with transaction id which is already cancelled

 

forbidden

20008

Transaction is not initiated successfully

Request received with transaction id which is not initiated successfully

 

duplicate_payment_id

20009

Duplicate payment-id

Request received with already used payment-id

 

invalid_account

20015

Order account is not allowed for this transaction

Request received with an Order account which is not allowed to do the specified or given type of transaction

 

limit_reached

20016

Transaction - limit has been reached for the day / week

Client has reached the maximum limit of transactions for the day or week

 

more_signature_required

20017

This transaction needs more than one signature

Request transaction needs multiple level of signatures or authorizations

 

invalid_payment

20023

Instant payment initiation between Belfius' accounts is not possible

Request received with orderer and beneficiary account at Belfius. Instant payment initiation is not possible in this case, a sepa-credit-transfer should be used

 

invalid_payment

20024

The beneficiary bank does not support instant payment. Instant payment initiation to this beneficiary account is therefore not possible.

Request received with a beneficiary account in a bank that does not support instant payment. Instant payment initiation is not possible in this case, a sepa-credit-transfer should be used

 

invalid_payment

20025

Instant payment should be executed directly. Execution date cannot be in the future.

Request received with an incorrect execution date (should not be in the future)

 

INVALID_REFERENCE

B15909-2180-000000

No transaction found

Request received with invalid transaction reference

404

resource_not_found

10004

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

Request received with invalid version in Accept header

 

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

429

rate_limit_exceeded

10107

Rate limit exceeded for Tpp Id : <TPPID>. Please try again later.

Request received during Sepa Payment API call with client-ID which has exceeded the rate limit

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 is unavailable

Planned down-time in currently on going


Using version 2 of post /payments/{payment-product} and delete /payments/{payment-product}/{payment-ID} and version 1 of get /payments/{payment-product}/{payment-ID}/status

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

 

MISSING_INPUT

B14821-1200-000000

Missing mandatory input fields

Request received without a mandatory input field. Please check if endtoend_identification is filled in

 

INVALID_INPUT

B14821-1227-000000

Beneficiary's country is not allowed

Request received with a country code that is not allowed

 

INVALID_INPUT

B14821-1227-000000

Beneficiary's country is not allowed

Request received with a country code that is not allowed

 

INVALID_INPUT

B14821-1231-000000

The amount must be higher than 0

Request received with an incorrect amount. The amount should be greater than 0.

 

INVALID_INPUT

B14821-1232-000000

The transaction's currency is invalid or not authorised

Request received with an incorrect transaction currency.

 

INVALID_INPUT

B14821-1236-000000

BBAN-structure in combination of a BIC code is not authorised

Request received with an account in BBAN structured and a BIC code. This is not authorized

 

INVALID_INPUT

B14821-2102-000000

Beneficiary's BIC is invalid or is missing

Request received with the BIC code that does not match with the mentionned beneficiary IBAN or without a BIC code. Beneficiary BIC code can be a mandatory input for some country/currency. Please check our "flow" section for more information.

 

MISSING_INPUT

B14821-2103-000000

Fedwire (bank_national_id) is mandatory for this country/currency

Request received without a Fedwire (Nat-ID). This is a mandatory input for some country/currency. Please check our "flow" section for more information.

 

MISSING_INPUT

B14821-2104-000000

Communication is a mandatory field for this country

Request received without a communication field. This is a mandatory input for some country/currency. Please check our "flow" section for more information.

 

MISSING_INPUT

B14821-2105-000000

Beneficiary's name is missing

Request received without a beneficiairy's name.

 

INVALID_INPUT

B14821-2106-000000

This currency is not authorised for this country

Request received with an unauthorized currency for this country. Please check our "flow" section for more information.

 

MISSING_INPUT

B14821-2107-000000

The purpose code is a mandatory field for this country

Request received without a purpose code. This is a mandatory input for some country/currency. Please check our "flow" section for more information.

 

INVALID_INPUT

B14821-2110-000000

The charge bearer should be "SHAR" for payment initiation within the EEA

Request received with an incorrect charge bearer. For payment initiation within the EEA, "SHAR" should be used

 

INVALID_INPUT

B14821-2111-000000

The country code filled in the beneficiary's addree does not match the entered BIC

Request received with a country code that does not match the entered BIC code. BIC code of the beneficiary should refer to a bank present in the country of the beneficiairy

 

MISSING_INPUT

B14821-2113-000000

BIC code is mandatory for payment to the US with currency other than USD

Request received without a BIC code for the beneficiary account. This is mandatory for all payment to the US done with a currency other than USD. Please check our "flow" section for more information.

 

MISSING_INPUT

B14821-2114-000000

BIC code or Fedwire (bank_national_id) is mandatory for payment to the US with currency USD

Request received without a BIC code or a Fedwire (bank_national_id) for the beneficiary account. This is mandatory for all payment to the US done with a currency USD. Please check our "flow" section for more information.

 

INVALID_INPUT

B14821-2117-000000

The transaction amount should be higher than 0

Request received with an incorrect transaction amount.

 

INVALID_INPUT

B14821-2118-000000

Number of decimal for the transaction amount is exceed

Request received with to many decimal in the transaction amount

 

MISSING_INPUT

B14821-2119-000000

The beneficiary country is mandatory

Request received without a country.

 

INVALID_INPUT

B14821-2124-000000

The ordering account is invalid or unusable

Request received with an invalid or incorrect ordering account or with an account that cannot be used for PSD2 or with an account that is be closed

 

INVALID_INPUT

B14821-2125-000000

The fedwire (bank_national_id) and BIC do not refer to the same bank

Request received with a fedwire (national_bank_id) and BIC that do not refer to the same bank.

 

MISSING_INPUT

B14821-2126-000000

All the beneficiary's address data must be filled out for this country

Request received with an incomplete address data. For some destination country, the complete beneficiary's adress should be given. Please check our "flow" section for more information.

 

INVALID_INPUT

B14821-2134-000000

This currency is not allowed for this ordering account

Request received with an orderering currency that is not allowed for this account. The ordering account does not have a compartment of this currency

 

INVALID_INPUT

B14821-2170-000000

Incorrect beneficiary account

Request received with incorrect beneficiary account

 

INVALID_INPUT

B14821-2171-000000

Incorrect currency for this payment product

Request received with incorrect currency for the requested payment product

 

INVALID_INPUT

B14821-2173-000000

Execution date invalid or is not allowed

Request received with an execution date which is not allowed or invalid (should be in the future - maximum one year in the future- and should be an open business day)

 

INVALID_INPUT

B14821-2174-000000

Incorrect structured communication

Request received with an incorrect structured communication field value

 

INVALID_CHECKDIGIT

GEGC0001-INPU-CHKDG

Either the account or the structured communication contains an invalid checksum

Request received with Incorrect Order/Beneficiary account OR incorrect structured communication

 

INVALID_INPUT

GEGC0001-INPU-LENGTH

The length of the field is incorrect

Request received with a field that has an incorrect length

 

INVALID_INPUT

GEGC0001-BASU-BTCONV

The introduced amount is too big

Request received with an invalid amount (too big)

 

BACKEND_ERROR_OCCURED

B14821-2160-000000

Backend error occured

Undefined backend error occured. Please contact the TPP support

 

BACKEND_ERROR_OCCURED

B15586-2200-000000

Backend error occured

Undefined backend error occured. Please contact the TPP support

401

FAILED_SECURITY_VALIDATION

GEN-1203-100002

Signature is invalid

Request signed with an invalid signature

 

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_REFERENCE

B15909-2180-000000

No transaction found

 

 

INVALID_REFERENCE

B15586-2180-000000

No transaction found

 

 

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'

 

LIMIT_REACHED

B14800-3018-000000

Transaction - limit has been reached for the day / week.

Client has reached the maximum limit of transactions for the day or week

 

MORE_SIGNATURE_REQUIRED

B14800-3019-000000

This transaction needs more than one signature.

Request transaction needs multiple level of signatures or authorizations

 

INVALID_PAYMENT

B14800-3024-000000

Non-Sepa payment is not allowed for Banx accounts

Request received for a Banx account for which non-sepa payment is not allowed

 

INVALID_REFERENCE

B15586-2180-000000

No transaction found

 

 

FORBIDDEN

B14821-2101-000000

The security profile from the client does not allow payments to this country

Request to a beneficiary country that is not allowed by the client (security profile)

 

FORBIDDEN

B14821-2116-000000

The transaction costs exceed the transaction amount.

This payment initiation request generates a cost that exceed the transaction amount. This error message is only given for cross-border-credit-transfer. For sepa-credit-transfer and instant-sepa-credit-transfer this information will not be given.

 

FORBIDDEN

B15586-2181-000000

Transaction is already cancelled

Request received with transaction id which is already cancelled

 

FORBIDDEN

B15586-2182-000000

Transaction is not initiated successfully.

Request received with transaction id which is ot initiated successfully

 

FORBIDDEN

B15586-2183-000000

Transaction cannot be cancelled

Request received on a transaction that cannot be cancelled. The status of the payment initiation does not allow the cancellation.

 

FORBIDDEN

B15586-2198-000000

Non Sepa payment initiation cannot be cancelled

Non Sepa payment initiation cannot be cancelled

 

DUPLICATE_REFERENCE

B14821-2150-000000

Duplicate end-to-end reference

Duplicate end-to-end reference

 

INVALID_ACCOUNT

B14821-2172-000000

Order account is not allowed to execute this payment product

Request received with an order account which is not allowed to do the payment product

 

INVALID_PAYMENT

B14821-2112-000000

Payment to this country with this purpose code is not allowed.

Request received with a combination of country/currency that is not allowed. Please check our "flow" section for more information.

 

INVALID_PAYMENT

B14821-2121-000000

Non Sepa payment is not allowed for this account

Request received for an account for which non sepa payment is not allowed

 

INVALID_PAYMENT

B14821-2128-000000

Cut-off time to initiate non sepa payment has passed

Request received outside the business hours. Non sepa payment cannot be initiated as the transaction costs cannot be calculated

 

INVALID_PAYMENT

B14821-2129-000000

The payment product is not correct. The inputs are linked to a sepa-credit-transfer

Request received with input fields linked to a sepa-credit-transfer. The payment product should be adapted in consequences.

 

INVALID_PAYMENT

B14821-2135-000000

The payment product is not correct. The inputs are linked to a cross-border-credit-transfer

Request received with input fields linked to a cross-border-credit-transfer. The payment product should be adapted in consequences.

 

INVALID_PAYMENT

B14821-2176-000000

Urgent Payment is not permitted when the order and the beneficiary account are both Belfius account Urgent payment

Request received when both order and beneficiary accounts are Belfius accounts is not permitted. The payment instruction_priority should be NORMAL

 

INVALID_PAYMENT

B14821-2177-000000

Cut-off time to initiate urgent payment has passed

Cut-off time to initiate urgent payment has passed

 

INVALID_PAYMENT

B14821-2178-000000

Instant payment initiation between Belfius or Banx accounts is not possible

Request received with the orderer and the beneficiary account that are Belfius or Banx account. Instant payment initiation is not possible in this case, a sepa-credit-transfer should be used

 

INVALID_PAYMENT

B14821-2179-000000

The beneficiary bank does not support instant payment. Instant payment initiation to this beneficiary account is therefore not possible.

Request received with a beneficiary account in a bank that does not support instant payment. Instant payment initiation is not possible in this case, a sepa-credit-transfer should be used

 

INVALID_PAYMENT

B14821-2180-000000

Instant payment should be executed directly. Execution date cannot be in the future.

Request received with an incorrect execution date (should not be in the future)

 

INVALID_PAYMENT

B14800-3023-000000

Urgent payment is not allowed for this type of account

Request received for an account for which urgent payment is not allowed

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

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-100001

Rate limit exceeded

Request received during Sepa Payment API call with client-ID which has exceeded the rate limit

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

 

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