Payment API

Initiate payments from a Belfius payment account.

Introduction

PISP

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

Consumes
  • application/json
Produces
  • application/json

Hosts

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

https://psd2.b2b.belfius.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***


Parameters

Response

{
  "transaction_status": "RCVD"
}
Headers
  • Response-ID:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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"
}

SEPA transfer.

The initiating party [customer/PISP] sends a create payment message to the forwarding agent or debtor agent that specifies the payment initiation request. Some of these offered services are paying services. You can consult our website to know the exact charges due.


Request

Name Type Description
iban string Account IBAN.
name string Account Name.
iban string National Account number.
bic string Bank Identifier Code.

Parameters

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"
Code-Challenge-Method Header optional string

Conditional: PKCE code-challenge-method as per RFC https://tools.ietf.org/html/rfc7636. It is mandatory if there is no valid Authorization header present..

example:

"plain"
Code-Challenge Header optional string

Conditional: PKCE code-challenge as per RFC https://tools.ietf.org/html/rfc7636. It is mandatory if there is no valid Authorization header present..

example:

"E9Melhoa2OwvFrEMTJguCHaoeK1t8URWbuGJSstw"
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. It's a JWT containing JWS in signatue section(representing the signature of payment payload) and the actual payload in JWT body. Recommended Algorithm - ECDSA using P-256 and SHA-256.

Response

{
  "payment_id": "1232424kw54u1iu12o4141",
  "transaction_ref": "123132123"
}

No definition found.

Headers
  • Response-ID:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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/sepa-credit-transfers

Request example

{
  "origin_account": {
    "iban": "BE54063301200997"
  },
  "remote_account": {
    "name": "Shaun",
    "iban": "BE54063301200998",
    "bic": "BBVAESMM"
  },
  "amount": "-123.12",
  "currency": "EUR",
  "communication": "help friend",
  "communication_type": "FREETEXT",
  "execution_date": "2017-05-17",
  "payment_id": "1232424kw54u1iu12o4141",
  "payment_treatment_type": "NORMAL"
}

Response example

{
  "payment_id": "1232424kw54u1iu12o4141",
  "transaction_ref": "123132123"
}
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"
}
{
  "error": "string",
  "error_code": "string",
  "error_description": "string"
}

Cancels an uncompleted payment initiation.

The initiating party [customer/PISP] sends a cancel payment message in order to delete an uncompleted payment initiation.


Parameters

Response

Headers
  • Request-ID:

No definition found.

Headers
  • Response-ID:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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/sepa-credit-transfers/{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"
}