Generate Payment Button

get

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

Create a payment button

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

invoiceUUID

string

The identifier of the invoice as received when created with Digiteal

trustedPaymentUUID

string

The identifier of the trusted payment as received when created with Digiteal

paymentRequestUUID

uuid

The internal identifier of the SinglePaymentRequest, associated to the payment as known by the creditor. When it is defined, it will not consider the other parameters of the request to use only the ones from the referenced payment request except for language and mobile that define the user context of the payment.

requesterVAT

string

The VAT number of the creditor

requesterIdentificationNumber

string

Identification number of the company. Please use one of vatNumber, iban or identificationNumber (see the company identification number documentation)

iban

string

The IBAN of the creditor. It if is not provided, the default IBAN of the requester will be used.

amountInCents

int64

The amount to pay (in cents)

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)

language

string

The language of the button to be displayed (EN, NL or FR). Default is EN.

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

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

customerInternalId

string

The identifier of the debtor as defined by the creditor

customerEMail

string

The email of the debtor

multiple

boolean

Defaults to false

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

errorURL

string

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.

confirmationURL

string

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.

type

string

enum

Define the format of the output image. Default is PNG.

Allowed:

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

Defaults to false

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.

paymentInternalId

string

The internal identifier of the payment as known by the creditor

mobile

boolean

Defaults to false

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

emailOptin

boolean

Defaults to false

Triggers the email optin retrieval in the payment flow.

Response

200Success