Payment API

Initiate payments from a payment account.

Introduction

Payment Initiation Service (PIS)

These endpoints provide the tpp possibilities for initiating payments, requesting a payment status, cancelling a payment.

Consumes
  • application/json
  • application/xml
Produces
  • application/json

Hosts

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

psd2.b2b.belfius.be:8443

psd2.b2b.banx.be:8443

Click the button below to download the open API specification.

Download

Example screen

Navigate to an endpoint to see sample code


Payment initiation status request.

Check the transaction status of a payment initiation. There are the following **payment products**: - ***sepa-credit-transfers*** - ***instant-sepa-credit-transfers*** - ***cross-border-credit-transfers***


Parameters

payment-product Path required string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - cross-border-credit-transfers

payment-id Path required string

Payment reference.

example:

"1234-wertiq-983"
Authorization Header optional string

Access token to be passed as a header. Scope of this access-token is limited to a given type [e.g. PIS]. 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"
Client-ID Header required string

Client ID of registered TPP.

example:

"XXXYYYYXXZZZWWWWW"
payment-id-type Query optional string

Type of Payment ID. Following Types are supported: - INTERNAL: Belfius provided reference - EXTERNAL: Reference provided by TPP

example:

""

Response

{
  "transaction_status": "RCVD"
}
Headers
  • Response-ID: Same as Request-ID, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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 /payments/{payment-product}/{payment-id}/status

Request example

There is no example request provided

Response example

{
  "transaction_status": "RCVD"
}
{
  "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"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

Payment initiation request.

This method is used to initiate a payment at the ASPSP. There are the following **payment products**: - ***sepa-credit-transfers*** - ***instant-sepa-credit-transfers*** - ***cross-border-credit-transfers***


Parameters

payment-product Path required string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers - cross-border-credit-transfers

Authorization Header optional string

Access token to be passed as a header. Scope of this access-token is limited to a given type [e.g. PIS]. 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=2].

example:

"application/vnd.belfius.api+json; version=2"
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.

example:

"XXXYYYYXXZZZWWWWW"
Redirect-URI Header required string

Redirect-URI of the client.

example:

"https://www.clientapp.com/someurrl"
Signature Header required string

Signature of the request created by API-Consumer (draft-cavage-http-signatures-10). Please see the docs for more details.

Digest Header required string

SHA256 of the body (draft-cavage-http-signatures-10). Please see the docs for more details.

Date Header required string

Current date in HTTP Date RFC format(https://tools.ietf.org/html/rfc7231#section-7.1.1.2). We will tolerate a drift of +-1 minutes. Please note that drift is the allowed difference between the exact time when the call was received at Belfius’ side, and the content of DATE header. If the DATE headers time value differs by more than +-1 minute, request will be considered as Invalid.

example:

"Tue, 15 Nov 1994 08:12:31 GMT"

Request

Name Type Description
iban string IBAN of an account. Note that the 2 letters identifying the IBAN's country should be upper case. required
currency string Payment currency. * sepa-credit-transfers : MUST be EUR. EUR is default if not provided. * instant-sepa-credit-transfers : MUST be EUR. EUR is default if not provided. * cross-border-credit-transfers : Please refer to the "flow" section of the portal for accepted currencies. optional
iban string IBAN of an account. Note that the 2 letters identifying the IBAN's country should be upper case. * sepa-credit-transfers : required. * instant-sepa-credit-transfers : required. * cross-border-credit-transfers : conditional. Please refer to documentation in the "flow" section of portal for details. optional
bban string BBAN. * sepa-credit-transfers : n/a. * instant-sepa-credit-transfers : n/a. * cross-border-credit-transfers : conditional. Please refer to documentation in the "flow" section of the portal for details. optional
bic string Bank Identifier Code. * sepa-credit-transfers : optional. * instant-sepa-credit-transfers : optional. * cross-border-credit-transfers : conditional. Please refer to documentation in the "flow" section of the portal for details. optional
bank_national_id string Bank National ID. * sepa-credit-transfers : optional. * instant-sepa-credit-transfers : optional. * cross-border-credit-transfers : conditional. Please refer to documentation in the "flow" section of the portal for details. optional
currency string Payment currency. * sepa-credit-transfers : MUST be EUR. EUR is default if not provided. * instant-sepa-credit-transfers : MUST be EUR. EUR is default if not provided. * cross-border-credit-transfers : Please refer to the "flow" section of the portal for accepted currencies. required
amount string The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot. **Example:** Valid representations with up to two decimals are: * 1056 * 5768.2 * 5877.78 required
street string optional
building_number string optional
city string optional
postal_code string optional
country string ISO 3166 ALPHA2 country code. required
reference string required
reference_type string required
reference_issuer string required

Response

{
  "transaction_status": "RCVD",
  "payment-id": "1234-wertiq-983",
  "endtoend_identification": "1234-wertiq-983",
  "_links": {
    "sca_redirect": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "status": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "cancel": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }
}
Headers
  • Response-ID: Same as Request-ID, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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)

Post /payments/{payment-product}

Request example

{
  "debtor_account": {
    "iban": "BE54063301200997",
    "currency": "EUR"
  },
  "creditor_account": {
    "iban": "BE54063301200998",
    "bban": "US1111222233334444555566666",
    "bic": "BBVAESMM",
    "bank_national_id": "XXXXXXXXX"
  },
  "instructed_amount": {
    "currency": "EUR",
    "amount": "5877.78"
  },
  "creditor_name": "Creditor Name",
  "creditor_address": {
    "street": "string",
    "building_number": "string",
    "city": "string",
    "postal_code": "string",
    "country": "SE"
  },
  "purpose_code": "string",
  "remittance_information_unstructured": "Ref Number Merchant",
  "remittance_information_structured": {
    "reference": "string",
    "reference_type": "string",
    "reference_issuer": "string"
  },
  "charge_bearer": "string",
  "requested_execution_date": "2020-09-18",
  "endtoend_identification": "1232424kw54u1iu12o4141",
  "instruction_priority": "string"
}

Response example

{
  "transaction_status": "RCVD",
  "payment-id": "1234-wertiq-983",
  "endtoend_identification": "1234-wertiq-983",
  "_links": {
    "sca_redirect": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "status": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "cancel": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }
}
{
  "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"
}

Cancels a payment initiation.

The initiating party [customer/PISP] sends a cancel payment message in order to delete a payment initiation. Only payment initiation in status RCVD, PATC and PNDG can be cancelled.


Parameters

payment-product Path required string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The following payment products are supported: - sepa-credit-transfers - instant-sepa-credit-transfers

payment-id Path required string

Payment reference.

example:

"1234-wertiq-983"
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. PIS]. 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=2].

example:

"application/vnd.belfius.api+json; version=2"
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"
Client-ID Header required string

Client ID of registered TPP.

example:

"XXXYYYYXXZZZWWWWW"
payment-id-type Query optional string

Type of Payment ID. Following Types are supported: - INTERNAL: Belfius provided reference - EXTERNAL: Reference provided by TPP

example:

""

Response

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

No definition found.

Headers
  • Response-ID: Same as Request-ID, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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)

Delete /payments/{payment-product}/{payment-id}

Request example

There is no example request provided

Response example

There is no example response provided
{
  "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"
}

Periodic Payment initiation status request.

Check the transaction status of a periodic payment initiation. There are the following **payment products**: - ***sepa-credit-transfers***


Parameters

Response

{
  "transaction_status": "RCVD"
}
Headers
  • Response-ID: Same as Request-ID, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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 /periodic-payments/{payment-product}/{payment-id}/status

Request example

There is no example request provided

Response example

{
  "transaction_status": "RCVD"
}
{
  "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"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

Periodic Payment initiation request.

This method is used to initiate a periodic payment at the ASPSP. There are the following **payment products**: - ***sepa-credit-transfers***


Parameters

payment-product Path required string

The addressed payment product endpoint, e.g. for SEPA Credit Transfers (SCT). The following payment products are supported: - sepa-credit-transfers

Authorization Header optional string

Access token to be passed as a header. Scope of this access-token is limited to a given type [e.g. PIS]. 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.

example:

"XXXYYYYXXZZZWWWWW"
Redirect-URI Header required string

Redirect-URI of the client.

example:

"https://www.clientapp.com/someurrl"
Signature Header required string

Signature of the request created by API-Consumer (draft-cavage-http-signatures-10). Please see the docs for more details.

Digest Header required string

SHA256 of the body (draft-cavage-http-signatures-10). Please see the docs for more details.

Date Header required string

Current date in HTTP Date RFC format(https://tools.ietf.org/html/rfc7231#section-7.1.1.2). We will tolerate a drift of +-1 minutes. Please note that drift is the allowed difference between the exact time when the call was received at Belfius’ side, and the content of DATE header. If the DATE headers time value differs by more than +-1 minute, request will be considered as Invalid.

example:

"Tue, 15 Nov 1994 08:12:31 GMT"

Request

Name Type Description
iban string IBAN of an account. Note that the 2 letters identifying the IBAN's country should be upper case. required
currency string Payment currency. * sepa-credit-transfers : MUST be EUR. EUR is default if not provided. optional
iban string IBAN of an account. Note that the 2 letters identifying the IBAN's country should be upper case. * sepa-credit-transfers : required. optional
currency string Payment currency. * sepa-credit-transfers : MUST be EUR. EUR is default if not provided. required
amount string The amount given with fractional digits, where fractions must be compliant to the currency definition. It is mandatory & applicable only when periodic_payment_type is FIXED. The decimal separator is a dot. **Example:** Valid representations with up to two decimals are: * 1056 * 5768.2 * 5877.78 optional
minimal_amount string Minimum amount to keep on the order account. It is only applicable if periodic_payment_type is VARIABLE. if neither minimal or maximal amount is filled in, the entire amount present on the account will be transferred. The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot. **Example:** Valid representations with up to two decimals are: * 1056 * 5768.2 * 5877.78 optional
maximal_amount string Maximum amount to transfer to beneficiary account. It is only applicable if periodic_payment_type is VARIABLE. if neither minimal or maximal amount is filled in, the entire amount present on the account will be transferred. The amount given with fractional digits, where fractions must be compliant to the currency definition. The decimal separator is a dot. **Example:** Valid representations with up to two decimals are: * 1056 * 5768.2 * 5877.78 optional
street string optional
building_number string optional
city string optional
postal_code string optional
country string ISO 3166 ALPHA2 country code. required
reference string required
reference_type string required
reference_issuer string required

Response

{
  "transaction_status": "RCVD",
  "payment-id": "1234-wertiq-983",
  "endtoend_identification": "1234-wertiq-983",
  "_links": {
    "sca_redirect": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "status": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "cancel": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }
}
Headers
  • Response-ID: Same as Request-ID, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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)

Post /periodic-payments/{payment-product}

Request example

{
  "debtor_account": {
    "iban": "BE54063301200997",
    "currency": "EUR"
  },
  "creditor_account": {
    "iban": "BE54063301200998"
  },
  "periodic_payment_type": "string",
  "instructed_amount": {
    "currency": "EUR",
    "amount": "5877.78",
    "minimal_amount": "5877.78",
    "maximal_amount": "5877.78"
  },
  "creditor_name": "Creditor Name",
  "creditor_address": {
    "street": "string",
    "building_number": "string",
    "city": "string",
    "postal_code": "string",
    "country": "SE"
  },
  "remittance_information_unstructured": "Ref Number Merchant",
  "remittance_information_structured": {
    "reference": "string",
    "reference_type": "string",
    "reference_issuer": "string"
  },
  "endtoend_identification": "1232424kw54u1iu12o4141",
  "start_date": "2020-09-18",
  "end_date": "2020-09-18",
  "frequency": "string",
  "day_of_execution": "string"
}

Response example

{
  "transaction_status": "RCVD",
  "payment-id": "1234-wertiq-983",
  "endtoend_identification": "1234-wertiq-983",
  "_links": {
    "sca_redirect": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "status": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "cancel": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }
}
{
  "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"
}

Cancels a periodic payment initiation.

The initiating party [customer/PISP] sends a cancel payment message in order to delete a payment initiation. Periodic payment contracts in status RCVD, PATC, PNDG and ACWP can be cancelled.


Parameters

Response

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

No definition found.

Headers
  • Response-ID: Same as Request-ID, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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)

Delete /periodic-payments/{payment-product}/{payment-id}

Request example

There is no example request provided

Response example

There is no example response provided
{
  "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"
}

Bulk Payment initiation status request.

Check the transaction status of a bulk payment initiation. There are the following **payment products**: - ***pain.001*** - ***csv***


Parameters

Response

{
  "payment_file_status": "TODO",
  "bulk_payment_list": "[]",
  "_links": {
    "payment_file_status": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "payment_file_cancel": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }
}
Headers
  • Response-ID: Same as Request-ID, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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 /bulk-payments/{bulk-payment-product}/{payment-file-id}/status

Request example

There is no example request provided

Response example

{
  "payment_file_status": "TODO",
  "bulk_payment_list": "[]",
  "_links": {
    "payment_file_status": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "payment_file_cancel": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }
}
{
  "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"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

Bulk Payment initiation request.

This method is used to initiate a bulk payment at the ASPSP. There are the following **payment products**: - ***pain.001*** - ***csv*** Please refer to documentation in the "payment" section of portal for details on supported payload schemas for each type.


Parameters

bulk-payment-product Path required string

Supported bulk payment products

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/xml (for XML based payload) or text/csv (for CSV based payload).

example:

"application/xml"
Client-ID Header required string

Client ID of registered TPP.

example:

"XXXYYYYXXZZZWWWWW"
Redirect-URI Header required string

Redirect-URI of the client.

example:

"https://www.clientapp.com/someurrl"
Signature Header required string

Signature of the request created by API-Consumer (draft-cavage-http-signatures-10). Please see the docs for more details.

Digest Header required string

SHA256 of the body (draft-cavage-http-signatures-10). Please see the docs for more details.

Date Header required string

Current date in HTTP Date RFC format(https://tools.ietf.org/html/rfc7231#section-7.1.1.2). We will tolerate a drift of +-1 minutes. Please note that drift is the allowed difference between the exact time when the call was received at Belfius’ side, and the content of DATE header. If the DATE headers time value differs by more than +-1 minute, request will be considered as Invalid.

example:

"Tue, 15 Nov 1994 08:12:31 GMT"
Payment-Information-ID Header optional string

Payment information ID.

example:

"12345-id"

Request

Name Type Description

Response

{
  "payment_file_status": "TODO",
  "payment_file_id": "1234-wertiq-983",
  "endtoend_identification": "1234-wertiq-983",
  "_links": {
    "payment_file_status": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "payment_file_cancel": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }
}
Headers
  • Response-ID: Same as Request-ID, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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)

Post /bulk-payments/{bulk-payment-product}

Request example

   MIPI-123456789RI-123456789 2017-02-14T20:23:34.000Z 1 123  PaymentInitiator DE10000000012 PISP    BIPI-123456789RI-123456789 TRF 1 123 SEPA 2017-02-15 PSU Name DE87200500001234567890 SLEV  RI-123456789 123 Merchant123  DE23100120020123456789 Ref Number Merchant-123456    

Response example

{
  "payment_file_status": "TODO",
  "payment_file_id": "1234-wertiq-983",
  "endtoend_identification": "1234-wertiq-983",
  "_links": {
    "payment_file_status": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "payment_file_cancel": {
      "href": "/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }
}
{
  "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"
}

Cancels a bulk payment initiation.

The initiating party [customer/PISP] sends a cancel payment message in order to delete a bulk payment initiation. Only payment initiation in status RCVD, PATC and PNDG can be cancelled. There are the following **payment products**: - ***pain.001*** - ***csv***


Parameters

Response

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

No definition found.

Headers
  • Response-ID: Same as Request-ID, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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, received in 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)

Delete /bulk-payments/{bulk-payment-product}/{payment-file-id}

Request example

There is no example request provided

Response example

There is no example response provided
{
  "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"
}