Skip to main content
Developer portal
Switch Language

API endpoints

Link

Resource

Endpoints

SEPA Payment

SEPA Payment

POST…/payments/sepa-credit-transfers
GET…/payments/sepa-credit-transfers/{paymentId}/status

Cross border Payment Cross border Payment POST…/payments/cross-border-credit-transfers
GET…/payments/cross-border-credit-transfers/{paymentId}/status

SEPA Periodic Payment

SEPA Periodic Payment

POST…/periodic-payments /sepa-credit-transfers
GET…/periodic-payments /sepa-credit-transfers/{paymentId}/status

Bulk Payments

Pain.001

POST…/bulk-payments/pain.001

GET…/bulk-payments/pain.001/{paymentId}/status

 

How does it work for a Sepa Payment (Functional description)?

KBC/CBC has developed its APIs according to the Berlin Group NextGenPSD2 Framework Implementation Guidelines. The terminology is therefore based on those guidelines.

Step 1: agree payment order initiation

  • The process begins with a PSU giving its consent to a payment.
  • The consent is between the PSU and the PISP.

Step 2: set up payment order authorisation

  • The PISP connects to KBC/CBC’s API Gateway and creates a payment order
  • This informs KBC/CBC that one of its PSUs intends to make a payment order.
  • KBC/CBC responds with a PaymentId, which is the  unique identifier for the payment order
  • This step includes a POST request to the payment order t

Step 3: authorisation

  • The PISP requests the PSU to authorise a payment transaction
  • The PISP redirects the PSU to the ASPSP.
  • The redirection includes the PaymentId that was generated in the previous step.
  • This allows KBC/CBC to correlate the payment order initiation.
  • KBC/CBC authenticates the PSU.
  • The PSU can consult the payment details to be signed or cancelled.  
  • KBC/CBC updates the status of the payment order initiation to indicate that the payment has been authorised.
  • Once the payment has been authorised or cancelled, the PSU is redirected back to the PISP.

Step 4: get status

  • The PISP can check the status of the payment initiation by using the paymentId.
  • It does this by making a GET status request.

 

How does it work for a Sepa Bulk Payment (Pain.001 file) (Functional description)?

KBC/CBC has developed its APIs according to the Berlin Group NextGenPSD2 Framework Implementation Guidelines. The terminology is therefore based on those guidelines.

Step 1: agree bulk payment order initiation

  • The process begins with a PSU giving its consent to a PISP to initiate a bulk payment (Pain.001 file).
  • The consent is between the PSU and the PISP.

Step 2: Initiate bulk payment order

  • This step includes a POST request to the bulk payment endpoint.
  • The PISP connects to KBC/CBC’s API Gateway to initiate a bulk payment order. One API-call can include up to 5 XML bulk payment orders (Pain.001 files), for a total of 10MB all together.
    • one pain.001 file: content type can be ‘application/XML’ or ‘multipart/form-data’
    • two to five pain.001 files: content type must be ‘multipart/form-data’
  • This informs KBC/CBC that one of its PSUs intends to initiate a bulk payment order.
  • KBC/CBC responds with a redirect URL including the PaymentId, which is the unique identifier for the bulk payment order. For each bulk payment order in the API-call a PaymentID is returned.

Step 3: confirmation of the initiated bulk payment order(s)

  • The PISP redirects the PSU to KBC/CBC to confirm the initiated bulk payment order(s).
  • The redirection includes the PaymentId(s) that was generated in the previous step.
  • This allows KBC/CBC to correlate the bulk payment order initiation.
  • KBC/CBC authenticates the PSU.
  • The PSU gets a view of the initiated bulk payment order(s): only the file name(s) are visible:
    • In case content type = ‘application XML’: filename is determined by KBC/CBC = ‘name PISP + timestamp’
    • In case content type = ‘multipart/form-data’: filename = ‘name received from PISP’

         The PSU can confirm or cancel the payment order(s) (all or nothing).

  • KBC/CBC updates the status of the payment order initiation to indicate that the payment has been confirmed or cancelled
  • Once the bulk payment order(s) has been confirmed, the PSU is redirected back to the PISP including the link to sign bulk payment order(s).

Step 4: sign bulk payment order(s)

  • PISP uses the sign redirect below to lead the PSU to KBC/CBC to sign the bulk payment order(s). After confirmation of the bulk payment order(s) by the PSU, it can take up to 30 minutes for they are present in the space for the PSU to sign.

       KBC:
       https://businessdashboard.kbc.be/ACD/A065/resources/0001/en/app/?function=be.kbc.psd2bulkpaymentsign

      CBC:
      https://businessdashboard.cbc.be/ACD/A065/resources/0002/en/app/?function=be.cbc.psd2bulkpaymentsign

      KBCBXL: https://businessdashboard.kbcbrussels.be/ACD/A065/resources/0001/en/app/?function=be.kbcbrussels.psd2bulkpaymentsign

      Language: can be: en, nl, fr or de

  • Bulk payment order(s) will be processed without feedback to PISP (both in the case of signed, partially signed or unsigned file)

Step 4: get status

  • The PISP can check the status of the bulk payment initiation by using the paymentId (only one paymentId at a time).
  • It does this by making a GET status request

 

How does it work for a Sepa Periodic Payment (Functional description)?

KBC/CBC has developed its APIs according to the Berlin Group NextGenPSD2 Framework Implementation Guidelines. The terminology is therefore based on those guidelines.

Step 1: agree periodic payment order initiation

  • The process begins with a PSU giving its consent to a periodic payment.
  • The consent is between the PSU and the PISP..

Step 2: set up periodic payment order authorisation

  • The PISP connects to KBC/CBC’s API Gateway and creates a periodic payment order
  • This informs KBC/CBC that one of its PSUs intends to make a periodic payment order.
  • KBC/CBC responds with a PaymentId, which is the  uniqueidentifier for the periodic payment order
  • This step includes a POST request to the periodic payment order

Step 3: authorisation

  • The PISP requests the PSU to authorise a periodic payment.
  • The PISP redirects the PSU to the ASPSP.
  • The redirection includes the PaymentId that was generated in the previous step.
  • This allows KBC/CBC to correlate the periodic payment order initiation.
  • KBC/CBC authenticates the PSU.
  • The PSU can consult the periodic payment details to be signed or cancelled. The PSU chooses the debtor account.
  • KBC/CBC updates the status of the periodic payment order initiation to indicate that the payment has been authorised.
  • Once the periodic payment has been authorised or cancelled, the PSU is redirected back to the PISP.

Step 4: get status

The PISP can check the status of the periodic payment

Request access

Do you want to start developing right away?

 

Get your API key

About us

KBC Open Banking & Insurance fosters innovation
to take your business to the next level.

Contact us

Solution based questions : +32 2 4480 187 (on working days from 8 a.m. to 6 p.m.)

Technical based questions : Contact