Create a Payment Link

post https://api.pay-link.eu/v1.0/Invoice/

📘
Use Invoice with Modal Box
To connect the created Invoice with the payment (Transaction), you must use the link provided in the response from POST as href of your modal box markup or build it yourself from the also provided hash.
Using the referenceId for that purpose will not work as expected, even when the demo results suggest that in some vague way.

👍
Connecting your application with our Paylink payment
If you have set up a webshop and would like to integrate Paylink as your payment solution then it is necessary for you to create an invoice in the Paylink system which you can then display as a payment form to the customer.
The response generates an Invoice ID which you can use to identify the successful payment. (see the chapter "Webhooks" for more information)

Query Params

instance

string

required

Your Paylink instance name

Form Data

title

string

required

This is the page title which will be shown on the payment page.

description

string

required

This is a description which will be shown on the payment page.

referenceId

string

required

An internal reference id used by your system.

purpose

string

required

The purpose of the payment.

amount

int32

required

The amount of the payment.

vatRate

float

VAT Rate Percentage

currency

string

required

The currency of the payment.

psp

string

The psp which should be used for the payment. (Can be an array of integers.)

array of strings

List of payment mean names to display

sku

string

Product stock keeping unit

preAuthorization

boolean

Whether charge payment manually at a later date (type authorization).

reservation

boolean

Whether charge payment manually at a later date (type reservation).

name

string

This is an internal name of the payment page. This name will be displayed to the administrator only.

fields

array of strings

The contact data fields which should be displayed. See fields for more

fields

hideFields

boolean

Defaults to false

Hide the whole contact fields section on invoice page

concardisOrderId

string

Only available if the custom ORDERID option is activated in PSP settings in Paylink administration. This ORDERID will be transferred to the Payengine. Only alphanumeric characters allowed.

buttonText

string

Custom pay button text.

expirationDate

date

Expiration date for link.

successRedirectUrl

string

Redirect url after successful payment

failedRedirectUrl

string

Redirect url after failed payment

subscriptionState

boolean

State of the subscription

subscriptionInterval

string

The subscription interval as string. (see PHP documentation of DateInterval for format)

subscriptionPeriod

string

Duration of the subscription. (see PHP documentation of DateInterval for format)

subscriptionCancellationInterval

string

Duration in which the subscription can be canceled. (see PHP documentation of DateInterval for format)

attachements

file

Provide your customers file attachments.

Response

Create a Payment Link

📘
Use Invoice with Modal Box

👍
Connecting your application with our Paylink payment

📘Use Invoice with Modal Box

👍Connecting your application with our Paylink payment

200200

📘
Use Invoice with Modal Box

👍
Connecting your application with our Paylink payment