CAF API - Belfius Developer Portal

Parameters

amount Query required number

Amount which has to be queried. It must be a positive number >0. For decimal seperator, only '.' is allowed. It is currency-independent. Thousands seperators are not supported. Precision is available upto 2 decimal.

currency Query required string

Currency of the amount which has to be queried. 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 CAF 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.

example:

"fr"

Client-ID Header required string

Client ID of registered TPP.

Redirect-URI Header required string

Redirect-URI of the client.

Response

{
  "funds_available": "True"
}

Headers

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

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 passed in the request.

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 passed in the request.

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 passed in the request.

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 passed in the request.

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 passed in the request.

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 passed in the request.

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)

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 passed in the request.

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 passed in the request.

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)

Introduction

Hosts

Example screen

Navigate to an endpoint to see sample code

Endpoint to check funds availability.

Parameters

amount Query required number

currency Query required string

logical-id Path required string

Authorization Header required string

Request-ID Header required string

Accept Header required string

Accept-Language Header required string

Client-ID Header required string

Redirect-URI Header required string

Response

200 Returns response if funds are available or not.

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 Resource 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 Unacceptable media type.

Headers

error (string)

error_code (string)

error_description (string)

429 Too many requests.

Headers

error (string)

error_code (string)

error_description (string)

495 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.

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