Digiteal API API Reference

Welcome to the Digiteal technical documentation.

The Digiteal API contains 2 parts. We provide services that allow you to

  • create invoices and store related documents
  • handle payments

This reference contains the technical details of the rest services exposed by the Digiteal platform.

If you want a high level overview please consult the following page

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

Invoices

This api is responsible for creating/updating invoice requests

Invoices

Create/Update invoice.

POST /api/v1/invoice-request
InvoiceCreationRequest

invoiceCreationRequest

Request Content-Types: application/json
Request Example
{
  "amountInCents": "string",
  "bic": "string",
  "creationDate": "string (date-time)",
  "creditorReference": "string",
  "currency": "string",
  "customerAddressCity": "string",
  "customerAddressCountry": "string",
  "customerAddressNumber": "string",
  "customerAddressStreet": "string",
  "customerAddressZip": "string",
  "customerEmail": "string",
  "customerFirstName": "string",
  "customerInternalId": "string",
  "customerLastName": "string",
  "customerMobile": "string",
  "customerVAT": "string",
  "dueDate": "string (date-time)",
  "format": "string",
  "iban": "string",
  "invoiceInternalId": "string",
  "language": "string",
  "publicationStatus": "string",
  "purpose": "string",
  "remittanceInfo": "string",
  "requesterID": "integer (int64)",
  "requesterVAT": "string",
  "secondaryLanguage": "string",
  "size": "integer (int32)"
}
200 OK

OK

Headers:

  • deliveryMethod:

    if the value is S2P then the client has chosen for Digiteal as a solution, if the value is null then the client is unkown to Digiteal or has not performed an optin

  • uuid:

    unique identifier for the payment request

type
object
400 Bad Request
ErrorMessage

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error
ErrorMessage

Internal server error occured

Response Content-Types: image/png, */*
Response Example (200 OK) 
"object"
Response Headers (200 OK)
deliveryMethod

if the value is S2P then the client has chosen for Digiteal as a solution, if the value is null then the client is unkown to Digiteal or has not performed an optin

 string
uuid

unique identifier for the payment request

 string
Response Example (400 Bad Request) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (500 Internal Server Error) 
{
  "errorCode": "string",
  "errorMessage": "string"
}

payment-button-image-api-controller

Payment Button Image API Controller

payment-button-image-api-controller

createB2BPayButton

GET /api/v1/payment-request/b2b-pay-button
language
in query
string

(no description)

creditorName
in query
string

(no description)

creditorReference
in query
string

(no description)

remittanceInfo
in query
string

(no description)

creditorEmail
in query
string

(no description)

creditorIBAN
in query
string

(no description)

amountInCents
in query
integer (int64)

(no description)

errorURL
in query
string

(no description)

confirmationURL
in query
string

(no description)

200 OK
ResponseEntity

OK

Response Content-Types: */*
Response Example (200 OK) 
{
  "body": "object",
  "statusCode": "string",
  "statusCodeValue": "integer (int32)"
}
payment-button-image-api-controller

Create a payment button.

GET /api/v1/payment-request/pay-button
invoiceUUID
in query
string

the identifier of the invoice as received when created with Digiteal

requesterVAT
in query
string

(no description)

iban
in query
string

(no description)

amountInCents
in query
integer (int64)

(no description)

language
in query
string

(no description)

creditorReference
in query
string

(no description)

remittanceInfo
in query
string

(no description)

customerInternalId
in query
string

(no description)

customerEMail
in query
string

(no description)

errorURL
in query
string

(no description)

confirmationURL
in query
string

(no description)

200 OK
ResponseEntity

OK

Response Content-Types: image/png, */*
Response Example (200 OK) 
{
  "body": "object",
  "statusCode": "string",
  "statusCodeValue": "integer (int32)"
}

Trusted payment

This api is accessible for our trusted payment integrators and allows them to generate a trusted payment with Digiteal.

Trusted payment

Create a new trusted payment

POST /api/v1/transfers
TransferCreationData

transferCreationData

Request Content-Types: application/json
Request Example
{
  "amountInCents": "integer (int64)",
  "creditorIBAN": "string",
  "creditorVAT": "string",
  "endDate": "string",
  "minumumAmountInCents": "integer (int64)",
  "projectName": "string",
  "releaseCondition": "string"
}
200 OK
TransferCreationResult

OK

Response Content-Types: application/json
Response Example (200 OK) 
{
  "creditorReference": "string",
  "transferID": "string"
}
Trusted payment

Execute the trusted payment = transfer the total amount to the creditor

POST /api/v1/transfers/execute
TransferExecutionData

transferExecutionData

Request Content-Types: application/json
Request Example
{
  "comment": "string",
  "transferID": "string",
  "validate": false
}
200 OK

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error
ErrorMessage

Internal server error occured

Response Content-Types: */*
Response Example (500 Internal Server Error) 
{
  "errorCode": "string",
  "errorMessage": "string"
}

Invoice Documents

This api allows you to upload a document related to an invoice created with the InvoiceCreationApi

Invoice Documents

Retrieve the document related to a specific invoice id

GET /api/v1/invoice-getDocumentList
billId
in query
string

billId

requestedBy
in query
integer (int64)

requestedBy

200 OK
DocumentDetails

OK

type
DocumentDetails
Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "comment": "string",
    "fileName": "string",
    "id": "integer (int64)",
    "url": "string",
    "uuid": "string"
  }
]
Invoice Documents

Using the invoice UUID

POST /api/v1/invoice-sendDoc
document
in formData
file

document

uuid
in query
string

uuid

name
in query
string

name

comment
in query
string

comment

requesterID
in query
integer (int64)

requesterID

200 OK
ResponseEntity

OK

Headers:

  • uuid:

    unique identifier of the uploaded document

400 Bad Request
ErrorMessage

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error
ErrorMessage

Internal server error occured

Response Content-Types: */*
Response Example (200 OK) 
{
  "body": "object",
  "statusCode": "string",
  "statusCodeValue": "integer (int32)"
}
Response Headers (200 OK)
uuid

unique identifier of the uploaded document

 string
Response Example (400 Bad Request) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (500 Internal Server Error) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Invoice Documents

Using the issuer internal id

POST /api/v1/invoice-sendDocWithBillerId
document
in formData
file

document

billId
in query
string

billId

name
in query
string

name

comment
in query
string

comment

requesterID
in query
integer (int64)

requesterID

200 OK
ResponseEntity

OK

Headers:

  • uuid:

    unique identifier of the uploaded document

400 Bad Request
ErrorMessage

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error
ErrorMessage

Internal server error occured

Response Content-Types: */*
Response Example (200 OK) 
{
  "body": "object",
  "statusCode": "string",
  "statusCodeValue": "integer (int32)"
}
Response Headers (200 OK)
uuid

unique identifier of the uploaded document

 string
Response Example (400 Bad Request) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (500 Internal Server Error) 
{
  "errorCode": "string",
  "errorMessage": "string"
}

integrators

This api accessible for our integrators

integrators

request information about a specific company.

POST /api/v1/integrator/company-info
companySearch

companySearch

Request Content-Types: application/json
Request Example
{
  "vatNumber": "string"
}
200 OK
CompanyInfo

Success

400 Bad Request
ErrorMessage

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found
ErrorMessage

Not Found

500 Internal Server Error
ErrorMessage

Internal server error occured

Response Content-Types: application/json, */*
Response Example (200 OK) 
{
  "status": "string",
  "vatNumber": "string"
}
Response Example (400 Bad Request) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (404 Not Found) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (500 Internal Server Error) 
{
  "errorCode": "string",
  "errorMessage": "string"
}

Payments

This api is responsible for handling payment requests

Payments

Create a payment request.

POST /api/v1/payment-request
PaymentCreationRequest

paymentCreationRequest

Request Content-Types: application/json
Request Example
{
  "amountInCents": "string",
  "bic": "string",
  "confirmationURL": "string",
  "creationDate": "string (date-time)",
  "creditorReference": "string",
  "currency": "string",
  "customerAddressCity": "string",
  "customerAddressCountry": "string",
  "customerAddressNumber": "string",
  "customerAddressStreet": "string",
  "customerAddressZip": "string",
  "customerEmail": "string",
  "customerFirstName": "string",
  "customerInternalId": "string",
  "customerLastName": "string",
  "customerMobile": "string",
  "customerVAT": "string",
  "errorURL": "string",
  "iban": "string",
  "language": "string",
  "purpose": "string",
  "remittanceInfo": "string",
  "requesterID": "integer (int64)",
  "requesterVAT": "string",
  "secondaryLanguage": "string",
  "validityInMinutes": "string (byte)"
}
200 OK

OK

Headers:

  • payment-web-url:

    url to perform payment in web browser

  • uuid:

    unique identifier for the payment request

type
object
400 Bad Request
ErrorMessage

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error
ErrorMessage

Internal server error occured

Response Content-Types: image/png, */*
Response Example (200 OK) 
"object"
Response Headers (200 OK)
payment-web-url

url to perform payment in web browser

 string
uuid

unique identifier for the payment request

 string
Response Example (400 Bad Request) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (500 Internal Server Error) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Payments

Create a invoice payment request.

POST /api/v1/payment-request/invoice
InvoicePaymentRequest

contains the requesterID and the internal id of the invoice

Request Content-Types: application/json
Request Example
{
  "confirmationURL": "string",
  "errorURL": "string",
  "invoiceInternalId": "string",
  "requesterID": "integer (int64)",
  "uuid": "string"
}
200 OK

OK

Headers:

  • payment-url-intent:

    url intent to perform payment on mobile device

  • payment-web-url:

    url to perform payment in web browser

  • uuid:

    unique identifier for the payment request

type
object
400 Bad Request
ErrorMessage

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error
ErrorMessage

Internal server error occured

Response Content-Types: image/png, */*
Response Example (200 OK) 
"object"
Response Headers (200 OK)
payment-url-intent

url intent to perform payment on mobile device

string
payment-web-url

url to perform payment in web browser

 string
uuid

unique identifier for the payment request

 string
Response Example (400 Bad Request) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (500 Internal Server Error) 
{
  "errorCode": "string",
  "errorMessage": "string"
}

payment-button-execution-api-controller

Payment Button Execution API Controller

payment-button-execution-api-controller

executeB2BPayButton

GET /api/v1/payment-request/b2b-pay-button/execute
language
in query
string

(no description)

creditorName
in query
string

(no description)

creditorReference
in query
string

(no description)

remittanceInfo
in query
string

(no description)

creditorEmail
in query
string

(no description)

creditorIBAN
in query
string

(no description)

amountInCents
in query
integer (int64)

(no description)

errorURL
in query
string

(no description)

confirmationURL
in query
string

(no description)

200 OK

OK

type
string
Response Content-Types: */*
Response Example (200 OK) 
"string"
payment-button-execution-api-controller

Create a payment button.

GET /api/v1/payment-request/pay-button/execute
invoiceUUID
in query
string

the identifier of the invoice as received when created with Digiteal

requesterVAT
in query
string

(no description)

iban
in query
string

(no description)

amountInCents
in query
integer (int64)

(no description)

language
in query
string

(no description)

creditorReference
in query
string

(no description)

remittanceInfo
in query
string

(no description)

customerInternalId
in query
string

(no description)

customerEMail
in query
string

(no description)

errorURL
in query
string

(no description)

confirmationURL
in query
string

(no description)

200 OK

OK

type
string
Response Content-Types: image/png, */*
Response Example (200 OK) 
"string"

Auto payments

This api is responsible for requesting an autoPayment

Auto payments

request an auto payment.

POST /api/v1/autopay-request
AutoPaymentRequest

autoPaymentRequest

Request Content-Types: application/json
Request Example
{
  "amountInCents": "string",
  "bic": "string",
  "creationDate": "string (date-time)",
  "creditorReference": "string",
  "currency": "string",
  "customerAddressCity": "string",
  "customerAddressCountry": "string",
  "customerAddressNumber": "string",
  "customerAddressStreet": "string",
  "customerAddressZip": "string",
  "customerEmail": "string",
  "customerFirstName": "string",
  "customerInternalId": "string",
  "customerLastName": "string",
  "customerMobile": "string",
  "customerVAT": "string",
  "iban": "string",
  "language": "string",
  "purpose": "string",
  "remittanceInfo": "string",
  "requesterID": "integer (int64)",
  "requesterVAT": "string",
  "secondaryLanguage": "string"
}
200 OK
AutoPaymentResult

Success

400 Bad Request
ErrorMessage

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found
ErrorMessage

Not Found

500 Internal Server Error
ErrorMessage

Internal server error occured

Response Content-Types: application/json, */*
Response Example (200 OK) 
{
  "originBankAccount": "string",
  "paymentConfirmationDate": "string",
  "paymentID": "string",
  "paymentRequestDate": "string",
  "status": "string"
}
Response Example (400 Bad Request) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (404 Not Found) 
{
  "errorCode": "string",
  "errorMessage": "string"
}
Response Example (500 Internal Server Error) 
{
  "errorCode": "string",
  "errorMessage": "string"
}

Schema Definitions

InvoicePaymentRequest: object

Model representing the data necessary for requesting an invoice payment request

confirmationURL: string

defines the url where digiteal has to redirect the user when the payment has been completed succesfully

errorURL: string

defines the url where digiteal has to redirect the user when the payment has not been completed successfully

invoiceInternalId: string

the internal identifier of the invoice as know to the emitter

requesterID: integer (int64)

The id of the Requester. Needs to be filled in if the payment is generated through another provider

uuid: string

uuid of the invoice as determined by Digiteal. If this value is used the invoiceInternalId are ignored.

Example
{
  "confirmationURL": "string",
  "errorURL": "string",
  "invoiceInternalId": "string",
  "requesterID": "integer (int64)",
  "uuid": "string"
}

TransferCreationData: object

Model representing the data necessary for creating a trusted payment

amountInCents: integer (int64)

the maximum amount of the trusted payment. If this amount is reached the total amount will be transfered to the creditor

creditorIBAN: string

IBAN value of the creditor on which the the amount will be wired when the minimum requirements are met

creditorVAT: string

VAT number of the creditor

endDate: string

the end date of the trusted payment. If the amount requirements are not met before this date the transfer is canceled and the clients are reimbursed. Format: dd/MM/yyyy

minumumAmountInCents: integer (int64)

the minimum amount of the trusted payment. If this amount is reached on the end date of the trusted payment the total amount will be transfered to the creditor

projectName: string

project name of the trusted payment

releaseCondition: string

MINIMUM_AMOUNT_BEFORE_END_DATE = if the minimum amount is reached on the give end date then the amount will be transfered. If before the end date the maximum amount is reached then the total amount will be transfered. or TRANSFER_CONFIGURATOR_CONFIRMATION: the trusted payment creator can start the transfer when the minimum amount is present

Example
{
  "amountInCents": "integer (int64)",
  "creditorIBAN": "string",
  "creditorVAT": "string",
  "endDate": "string",
  "minumumAmountInCents": "integer (int64)",
  "projectName": "string",
  "releaseCondition": "string"
}

InputStream: object

Example
"object"

InvoiceCreationRequest: object

Model representing the data necessary for creating a new invoice

amountInCents: string

amount expressed in cents that has to be paid

bic: string

BIC number

creationDate: string (date-time)

The date the bill was emitted. The default value is today. The expected format is YYYY-MM-DD

creditorReference: string

The structured reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined

currency: string

The currency of the amount to be paid based on the ISO 4217-alpha standard. The default value is EUR

customerAddressCity: string

City

customerAddressCountry: string

Country (ISO 3166-1 alpha-2)

customerAddressNumber: string

street number

customerAddressStreet: string

street name of the client address

customerAddressZip: string

Zipcode

customerEmail: string

email address. This is important to provide so that we can match this customer to the DigiTeal registered users.

customerFirstName: string

Client first name

customerInternalId: string

The id used by the requester his internal billing system. This is mandatory when creating an invoice

customerLastName: string

Client last name

customerMobile: string

the mobile phone of the customer with the national prefix.

customerVAT: string

Client VAT number (if applicable)

dueDate: string (date-time)

The date before which the payment must be performed. If it is provided, it can be used to show which bills are overdue or will soon be overdue. The payment slip will display a memo-date one week before the due date if that date is still in the future at generation time. The expected format is YYYY-MM-DD

format: string PAYMENT_SLIP, PAYMENT_SLIP_WITH_QR, QR, QR_EXPLAINED, PAYMENT_SLIP_WITH_BANNER, BANNER, NONE

format of the image you want to receive, default value = QR

iban: string

IBAN number, if you have registered multiple IBAN numbers on your account then this field is required!

invoiceInternalId: string

the internal identifier of the invoice as know to the emitter

language: string

The language of the client

publicationStatus: string PUBLISHED, DRAFT, DELETED

An invoice can have one of two statusses:PUBLISHED (default value) : if generated the payment request can no longer be modified DRAFT : if generated the payment request can still be updated.

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

requesterID: integer (int64)

The id of the Requester. The requesterID or the requesterVAT needs to be filled in if the payment is generated through another provider or without authentication

requesterVAT: string

The VAT number of the Requester. The requesterID or the requesterVAT needs to be filled in if the payment is generated through another provider or without authentication

secondaryLanguage: string

A secondary language of the client

size: integer (int32)

Indicates the size of the image you want to receive in pixels.

Example
{
  "amountInCents": "string",
  "bic": "string",
  "creationDate": "string (date-time)",
  "creditorReference": "string",
  "currency": "string",
  "customerAddressCity": "string",
  "customerAddressCountry": "string",
  "customerAddressNumber": "string",
  "customerAddressStreet": "string",
  "customerAddressZip": "string",
  "customerEmail": "string",
  "customerFirstName": "string",
  "customerInternalId": "string",
  "customerLastName": "string",
  "customerMobile": "string",
  "customerVAT": "string",
  "dueDate": "string (date-time)",
  "format": "string",
  "iban": "string",
  "invoiceInternalId": "string",
  "language": "string",
  "publicationStatus": "string",
  "purpose": "string",
  "remittanceInfo": "string",
  "requesterID": "integer (int64)",
  "requesterVAT": "string",
  "secondaryLanguage": "string",
  "size": "integer (int32)"
}

DocumentDetails: object

Model representing the details of an invoice document

comment: string

document comment

fileName: string

the filename of the document

id: integer (int64)

the identifier of document

url: string

the location url of the document

uuid: string

the uuid of the document

Example
{
  "comment": "string",
  "fileName": "string",
  "id": "integer (int64)",
  "url": "string",
  "uuid": "string"
}

companySearch: object

Model representing the fields that can be used to perform a search for a company

vatNumber: string

vatNumber of the company for which the information is asked

Example
{
  "vatNumber": "string"
}

ResponseEntity: object

body: object
statusCode: string 100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511
statusCodeValue: integer (int32)
Example
{
  "body": "object",
  "statusCode": "string",
  "statusCodeValue": "integer (int32)"
}

TransferExecutionData: object

Model representing the data necessary to execute the carpa transfer

comment: string

optional field for a comment

transferID: string

the transfer unique identifier received upon creation

validate: boolean

boolean indicating if you want to execute the transfer (true) or cancel the transfer(false). Canceling will reimburse the clients

Example
{
  "comment": "string",
  "transferID": "string",
  "validate": false
}

TransferCreationResult: object

Model representing the result of a carpa transfer creation

creditorReference: string

the creditor reference. Use this creditor reference when adding (wire transfer) an amount for this carpa transfer.

transferID: string

the unique identifier of the carpa transfer

Example
{
  "creditorReference": "string",
  "transferID": "string"
}

AutoPaymentResult: object

Model representing the output of a auto payment

originBankAccount: string

the bank account from where the money has been transferred

paymentConfirmationDate: string

the date on which the payment has been confirmed

paymentID: string

The unique identifier of the payment known by the requester

paymentRequestDate: string

the date on which the payment request has been sent

status: string EXECUTED, PLANNED, TRESHOLD_EXCEEDED, HIGH_RISK, NA

status of the auto payment action. This can either be planned (the client has an active auto payment configuration and the treshold has not been exceededd), treshold_exceeded(the limit set by the user has already been reached, the client has been notified of the issue), na (not applicable, the client has no auto pay configuration)

Example
{
  "originBankAccount": "string",
  "paymentConfirmationDate": "string",
  "paymentID": "string",
  "paymentRequestDate": "string",
  "status": "string"
}

ErrorMessage: object

Model representing the error output

errorCode: string

error code indicating a specific error

errorMessage: string

a more detailed message explaining the code.

Example
{
  "errorCode": "string",
  "errorMessage": "string"
}

CompanyInfo: object

Model representing information about the company

status: string

represents the status of the company within digiteal: NONE = unknown, ON_HOLD = not active as issuer , PROD = active as issuer

vatNumber: string

vatNumber of the concerned company

Example
{
  "status": "string",
  "vatNumber": "string"
}

AutoPaymentRequest: object

Model representing the data necessary for requesting an auto payment

amountInCents: string

amount expressed in cents that has to be paid

bic: string

BIC number

creationDate: string (date-time)

The date the bill was emitted. The default value is today. The expected format is YYYY-MM-DD

creditorReference: string

The structured reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined

currency: string

The currency of the amount to be paid based on the ISO 4217-alpha standard. The default value is EUR

customerAddressCity: string

City

customerAddressCountry: string

Country (ISO 3166-1 alpha-2)

customerAddressNumber: string

street number

customerAddressStreet: string

street name of the client address

customerAddressZip: string

Zipcode

customerEmail: string

email address. This is important to provide so that we can match this customer to the DigiTeal registered users.

customerFirstName: string

Client first name

customerInternalId: string

The id used by the requester his internal billing system. This is mandatory when creating an invoice

customerLastName: string

Client last name

customerMobile: string

the mobile phone of the customer with the national prefix.

customerVAT: string

Client VAT number (if applicable)

iban: string

IBAN number, if you have registered multiple IBAN numbers on your account then this field is required!

language: string

The language of the client

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

requesterID: integer (int64)

The id of the Requester. The requesterID or the requesterVAT needs to be filled in if the payment is generated through another provider or without authentication

requesterVAT: string

The VAT number of the Requester. The requesterID or the requesterVAT needs to be filled in if the payment is generated through another provider or without authentication

secondaryLanguage: string

A secondary language of the client

Example
{
  "amountInCents": "string",
  "bic": "string",
  "creationDate": "string (date-time)",
  "creditorReference": "string",
  "currency": "string",
  "customerAddressCity": "string",
  "customerAddressCountry": "string",
  "customerAddressNumber": "string",
  "customerAddressStreet": "string",
  "customerAddressZip": "string",
  "customerEmail": "string",
  "customerFirstName": "string",
  "customerInternalId": "string",
  "customerLastName": "string",
  "customerMobile": "string",
  "customerVAT": "string",
  "iban": "string",
  "language": "string",
  "purpose": "string",
  "remittanceInfo": "string",
  "requesterID": "integer (int64)",
  "requesterVAT": "string",
  "secondaryLanguage": "string"
}

PaymentCreationRequest: object

Model representing the data necessary for creating a new payment request

amountInCents: string

amount expressed in cents that has to be paid

bic: string

BIC number

confirmationURL: string

defines the url where digiteal has to redirect the user when the payment has been completed succesfully

creationDate: string (date-time)

The date the bill was emitted. The default value is today. The expected format is YYYY-MM-DD

creditorReference: string

The structured reference used by the biller to reconcile the payment. This is also called the structured communication in Belgium. Both BBA (Belgium) and ISO (International) types are supported. It can be left empty if the remittanceInfo is defined

currency: string

The currency of the amount to be paid based on the ISO 4217-alpha standard. The default value is EUR

customerAddressCity: string

City

customerAddressCountry: string

Country (ISO 3166-1 alpha-2)

customerAddressNumber: string

street number

customerAddressStreet: string

street name of the client address

customerAddressZip: string

Zipcode

customerEmail: string

email address. This is important to provide so that we can match this customer to the DigiTeal registered users.

customerFirstName: string

Client first name

customerInternalId: string

The id used by the requester his internal billing system. This is mandatory when creating an invoice

customerLastName: string

Client last name

customerMobile: string

the mobile phone of the customer with the national prefix.

customerVAT: string

Client VAT number (if applicable)

errorURL: string

defines the url where digiteal has to redirect the user when the payment has not been completed successfully

iban: string

IBAN number, if you have registered multiple IBAN numbers on your account then this field is required!

language: string

The language of the client

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

requesterID: integer (int64)

The id of the Requester. The requesterID or the requesterVAT needs to be filled in if the payment is generated through another provider or without authentication

requesterVAT: string

The VAT number of the Requester. The requesterID or the requesterVAT needs to be filled in if the payment is generated through another provider or without authentication

secondaryLanguage: string

A secondary language of the client

validityInMinutes: string (byte)

defines the validity of the payment request in minutes. default value 10min

Example
{
  "amountInCents": "string",
  "bic": "string",
  "confirmationURL": "string",
  "creationDate": "string (date-time)",
  "creditorReference": "string",
  "currency": "string",
  "customerAddressCity": "string",
  "customerAddressCountry": "string",
  "customerAddressNumber": "string",
  "customerAddressStreet": "string",
  "customerAddressZip": "string",
  "customerEmail": "string",
  "customerFirstName": "string",
  "customerInternalId": "string",
  "customerLastName": "string",
  "customerMobile": "string",
  "customerVAT": "string",
  "errorURL": "string",
  "iban": "string",
  "language": "string",
  "purpose": "string",
  "remittanceInfo": "string",
  "requesterID": "integer (int64)",
  "requesterVAT": "string",
  "secondaryLanguage": "string",
  "validityInMinutes": "string (byte)"
}
Documentation by Spectacle