Invoice request

Create or update an invoice

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
date

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

string

The language of the client (NL, FR or EN)

string

A secondary language of the client

string

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

string

The purpose based on the ISO 20022 standard

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

string
length between 0 and 140

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

string
length between 0 and 255

Client first name

string
length between 0 and 255

Client last name

string

Client VAT number (if applicable) with the country code

string
length between 0 and 255

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

string
length between 0 and 255

the mobile phone of the customer with the national prefix

string
length between 0 and 250

street name of the client address

string
length between 0 and 250

street number

string
length between 0 and 20

Zipcode

string
length between 0 and 250

City

string
length between 0 and 250

Country (ISO 3166-1 alpha-2)

string

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

string

BIC number

int64

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

string

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

string

The national identification number of the Requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication (see the company identification number documentation)

string
length between 0 and 255

The email of the requester. The requesterID, the requesterVAT, the requesterIdentificationNumber or the requestorEmail needs to be filled in if the payment is generated through another provider or without authentication

boolean

True if documents should be attached to this invoice, false if no document should be attached. Default is true.

string
required

amount expressed in cents that has to be paid

date
required

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

string
enum

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.

Allowed:
int32

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

string
required
length between 0 and 255

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

string
enum

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

Allowed:
string
required
length between 0 and 255

The internal identifier of the invoice as known by the issuer. It must be unique per issuer.

string
enum

Format of the image you want to receive, default value = PNG

Allowed:
boolean

Triggers the email optin retrieval in the payment flow.

languages
array of strings
languages
Headers
string
enum
Defaults to image/png

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*