Payment request

post

https://test.digiteal.eu/api/v1/payment-request

Create a payment request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

creationDate

date

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

language

string

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

secondaryLanguage

string

A secondary language of the client

currency

string

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

purpose

string

The purpose based on the ISO 20022 standard

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

remittanceInfo

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

customerFirstName

string

length between 0 and 255

Client first name

customerLastName

string

length between 0 and 255

Client last name

customerVAT

string

Client VAT number (if applicable) with the country code

customerEmail

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.

customerMobile

string

length between 0 and 255

the mobile phone of the customer with the national prefix

customerAddressStreet

string

length between 0 and 250

street name of the client address

customerAddressNumber

string

length between 0 and 250

street number

customerAddressZip

string

length between 0 and 20

Zipcode

customerAddressCity

string

length between 0 and 250

City

customerAddressCountry

string

length between 0 and 250

Country (ISO 3166-1 alpha-2)

iban

string

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

bic

string

BIC number

requesterID

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

requesterVAT

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

requesterIdentificationNumber

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)

requesterEmail

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

expectingDocumentAttached

boolean

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

amountInCents

string

required

amount expressed in cents that has to be paid

minAmountInCents

int64

The minimum amount to pay (in cents, cannot be used at the same time as amountInCents)

maxAmountInCents

int64

The maximum amount to pay (in cents, cannot be used at the same time as amountInCents)

suggestedAmountInCents

int64

The suggested amount to pay (in cents, cannot be used at the same time as amountInCents)

validityInMinutes

int32

Defines the validity of the payment request in minutes. Default value 10min

customerInternalId

string

required

length between 0 and 255

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

multiple

boolean

True if you want to accept multiple payments with this description. Default value is false.

confirmationURL

string

required

Defines the url where Digiteal has to redirect the user when the payment has been completed successfully (mandatory in case of interactive payment). Maximum length of 255 characters.

errorURL

string

required

Defines the url where Digiteal has to redirect the user when the payment has not been completed successfully (mandatory in case of interactive payment). Maximum length of 255 characters.

cancelURL

string

Defines the url where Digiteal has to redirect the user when the payment is cancelled (reverts to errorURL if it is not present). Maximum length of 255 characters.

paymentInternalId

string

The internal identifier of the payment as known by the creditor. Max length of 255

paymentMethod

string

enum

The payment method that is to be used. If it is defined, only that payment method will be available. If left empty, all the payment methods supported by the creditor will be available to the user.

allowedPaymentMethods

string

A list of comma separated values of payment method that we want to only allow for a specific payment

qrCode

boolean

If true, the QR code (for Bancontact payment method), will be displayed for example to enable the payment by a third party and not the user.

mobile

boolean

True if this is a payment to be executed on a mobile device. False by default

emailOptin

boolean

Triggers the email optin retrieval in the payment flow.

expiryDateTime

string

The exact instant the payment is due.

feeInCents

string

The applied fees expressed in cents.

feeDescription

string

A description for the applied fee.

paymentRequestUUID

uuid

length ≤ 255

The internal identifier of the SinglePaymentRequest, associated to the payment as known by the creditor.

Responses

200OK

400Bad request

401Unauthorized

403Forbidden

404Not Found

500Internal server error occurred