Create a Paylink

Time	Status	User Agent
Retrieving recent requests…

Query Params

instance

string

required

Your Shop & Pay 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 in cents.

vatRate

float

Defaults to null

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

Defaults to false

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

reservation

boolean

Defaults to false

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 for Concardis PSP and if the custom ORDERID option is activated in PSP settings in Shop & Pay administration. This ORDERID will be transferred to the Payengine.

buttonText

string

Custom pay button text.

expirationDate

date

Expiration date for link.

successRedirectUrl

string

URL to redirect to after successful payment.

failedRedirectUrl

string

URL to redirect to after failed payment.

subscriptionState

boolean

Defaults to false

Defines whether the payment should be handled as subscription.

subscriptionInterval

string

Payment interval

subscriptionPeriod

string

Duration of the subscription

subscriptionCancellationInterval

string

Defines the period, in which a subscription can be canceled.

attachments

file

Provide your customers file attachments.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

200200