CAF API - Belfius Developer Portal

Confirmation of funds request

Creates a confirmation of funds request at the ASPSP. Checks whether a specific amount is available at point of time of the request on an account linked to a given IBAN.

Parameters

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. CAF] and given IBAN. Token itself should be passed as bearer token in Authorization header, like:"Bearer 987tghjkiu6trfghjuytrghj".

example:

"Bearer 987tghjkiu6trfghjuytrghj"

Request-ID Header required string

ID of the request, unique to the call, as determined by the initiating party. It has to be a valid UUID in V04 format.

example:

"99391c7e-ad88-49ec-a2ad-99ddcb1f7721"

Accept Header required string

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

example:

"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]. Note that during redirection, Belfius screens are only available in French (fr) and in Dutch (nl).

example:

"fr"

Content-Type Header required string

It should be application/json.

example:

"application/json"

Client-ID Header required string

Client ID of registered TPP.

Request

Name	Type	Description
account	object	Reference to an account by IBAN.	required
iban	string	IBAN of an account. Note that this IBAN must be same as the one used during consent creation, with CAF scope.	required
instructed_amount	object		required
currency	string	ISO 4217 Alpha 3 currency code.	required
amount	string	The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. Example: Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78	required

Response

{
  "funds_available": "boolean"
}

Headers

Response-ID: Same as Request-ID, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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, received in request.

Structure of the generic error message object.

example:

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

ErrorModel

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)

Post /funds-confirmations

Request example

{
  "account": {
    "iban": "FR7612345987650123456789014"
  },
  "instructed_amount": {
    "currency": "EUR",
    "amount": "5877.78"
  }
}

Response example

{
  "funds_available": "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"
}

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

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

Introduction

Hosts

Example screen

Navigate to an endpoint to see sample code

Confirmation of funds request

Parameters

Authorization Header required string

Request-ID Header required string

Accept Header required string

Accept-Language Header required string

Content-Type Header required string

Client-ID Header required string

Request

Response

200 OK

400 Bad Request

Headers

error (string)

error_code (string)

error_description (string)

401 Unauthorized / authentification failure

Headers

error (string)

error_code (string)

error_description (string)

403 Forbidden

Headers

error (string)

error_code (string)

error_description (string)

404 Not found

Headers

error (string)

error_code (string)

error_description (string)

405 Method Not Allowed

Headers

error (string)

error_code (string)

error_description (string)

406 Not Acceptable

Headers

error (string)

error_code (string)

error_description (string)

408 Request Timeout

Headers

error (string)

error_code (string)

error_description (string)

409 Conflict

Headers

error (string)

error_code (string)

error_description (string)

415 Unsupported Media Type

Headers

error (string)

error_code (string)

error_description (string)

429 Too Many Requests

Headers

error (string)

error_code (string)

error_description (string)

500 Internal Server Error

Headers

error (string)

error_code (string)

error_description (string)

503 Service Unavailable

Headers

error (string)

error_code (string)

error_description (string)

Request example

Response example