Payment requester API API Reference

API that needs to be implemented by the payment requester to receive notifications

API Endpoint
http://localhost:8180/
Contact: support@digiteal.atlassian.net
Version: 1.0

Paths

notify an auto pay configuration creation or change

POST /v1/api/payment-notification/config-change

autoPayConfiguration

Request Content-Types: application/json
Request Example
{
  "changeType": "string",
  "clientID": "string",
  "maxAmount": "integer (int64)",
  "paymentDate": "string",
  "periodicity": "string",
  "requesterID": "string"
}
200 OK

Success

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Internal server error occured

Response Content-Types: */*

notify a confirmed payment

POST /v1/api/payment-notification/confirmation

paymentConfirmationNotification

Request Content-Types: application/json
Request Example
{
  "originBankAccount": "string",
  "paidAmountInCents": "integer (int64)",
  "paymentConfirmationDate": "string",
  "paymentID": "string"
}
200 OK

Success

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Internal server error occured

Response Content-Types: */*

notify an error occured during payment

POST /v1/api/payment-notification/error
paymentID
in query
string

The unique identifier of the payment known by the requester

errorType
in query
string TECHNICAL_ERROR, SECURITY_ISSUE, CANCELED

The type of error that occured. Possible errors are technical error, client canceled payment during the flow, a security issue occured (pin code blocked, ...)

message
in query
string

detailed message concerning the error

200 OK

Success

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Internal server error occured

Response Content-Types: */*

notify a transfer of funds

POST /v1/api/payment-notification/transfer-of-funds

transferOfFundsNotification

Request Content-Types: application/json
Request Example
{
  "bankTransactionID": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "executionDate": "string",
  "originBankAccount": "string",
  "paymentRequestInformation": {
    "amountInCents": "integer (int64)",
    "clientID": "string",
    "creditorReference": "string",
    "currency": "string",
    "destinationBankAccount": "string",
    "paymentID": "string",
    "paymentRequestDate": "string",
    "paymentRequestDuedate": "string",
    "purpose": "string",
    "remittanceInfo": "string",
    "requestorID": "string"
  },
  "paymentStatus": "string"
}
200 OK

Success

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Internal server error occured

Response Content-Types: */*

Schema Definitions

TransferOfFundsNotification: object

Model representing transfer of fund notification

bankTransactionID: string

The unique identifier of the payment known by the requester

errorCode: string

Error code indication

errorMessage: string

Detailed error message

executionDate: string

the execution day of the notification

originBankAccount: string

the bank account from where the money has been transferred

paymentRequestInformation: PaymentRequestInformation

represents the basic payment request information

paymentStatus: string SUCCESS, ERROR, REIMBURSMENT_TO_CLIENT, REIMBURSMENT_FROM_DIGITEAL

the status of the payment

Example
{
  "bankTransactionID": "string",
  "errorCode": "string",
  "errorMessage": "string",
  "executionDate": "string",
  "originBankAccount": "string",
  "paymentRequestInformation": {
    "amountInCents": "integer (int64)",
    "clientID": "string",
    "creditorReference": "string",
    "currency": "string",
    "destinationBankAccount": "string",
    "paymentID": "string",
    "paymentRequestDate": "string",
    "paymentRequestDuedate": "string",
    "purpose": "string",
    "remittanceInfo": "string",
    "requestorID": "string"
  },
  "paymentStatus": "string"
}

PaymentConfirmationNotification: object

Model representing payment request information

originBankAccount: string

the bank account from where the money has been transferred

paidAmountInCents: integer (int64)

the paid amount in cents

paymentConfirmationDate: string

the date on which the payment has been confirmed

paymentID: string

The unique identifier of the payment known by the requester

Example
{
  "originBankAccount": "string",
  "paidAmountInCents": "integer (int64)",
  "paymentConfirmationDate": "string",
  "paymentID": "string"
}

AutoPayConfiguration: object

Model representing the settings of an auto pay configuration

changeType: string CREATE, SUSPEND, CANCEL, UPDATE

describes the action that has to be taken on the auto pay configuration

clientID: string

client id (known to the requestor) of the person

maxAmount: integer (int64)

the maximum allowed amount for the automatic payment

paymentDate: string DUE_DATE, ONE_WEEK_BEFORE_DUE_DATE, IMMEDIATE

defines when the payment will be executed

periodicity: string YEAR, SEMESTER, TRIMESTER, MONTH

the periodicity of the invoice

requesterID: string

the id of the requester that issued the payment request

Example
{
  "changeType": "string",
  "clientID": "string",
  "maxAmount": "integer (int64)",
  "paymentDate": "string",
  "periodicity": "string",
  "requesterID": "string"
}

PaymentRequestInformation: object

Model representing payment request information

amountInCents: integer (int64)

the amount of the payment request in cents

clientID: string

client id (known to the requestor) of the person

creditorReference: string

The reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. It can be left empty if the remittanceInfo is defined

currency: string

the currency of the payment (ISO 4217 Currency Codes)

destinationBankAccount: string

the IBAN to which the payment has been executed

paymentID: string

The unique identifier of the payment known by the requester

paymentRequestDate: string

the date on which the payment request has been sent

paymentRequestDuedate: string

the due date of the payment request

purpose: string

The purpose based on the ISO 20022 standard

remittanceInfo: string

An unstructured string that is used as communication in the payment. This information is only used if there is nol creditorReference. It can be left empty if the creditorReference is defined

requestorID: string

the id of the requester that issued the payment request

Example
{
  "amountInCents": "integer (int64)",
  "clientID": "string",
  "creditorReference": "string",
  "currency": "string",
  "destinationBankAccount": "string",
  "paymentID": "string",
  "paymentRequestDate": "string",
  "paymentRequestDuedate": "string",
  "purpose": "string",
  "remittanceInfo": "string",
  "requestorID": "string"
}