Payrexx Octri Demo
POST/Invoice/

Create a paylink

Creates a paylink for collecting a payment. Provide title, description, referenceId, purpose, amount, and currency; use optional fields to configure the payment page and its payment methods. A 200 response returns the created paylink details, including its link.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

26 body fields

Payment page and payment configuration. title, description, referenceId, purpose, amount, and currency are required.

amountintegerrequired
The amount of the payment in cents.
attachmentsstringoptional
Provide your customers file attachments.
buttonTextstringoptional
Custom pay button text.
concardisOrderIdstringoptional
Only available for Concardis PSP and if the custom ORDERID option is activated in PSP settings in Payrexx administration. This ORDERID will be transferred to the Payengine.
currencystringrequired
The currency of the payment.
descriptionstringrequired
This is a description which will be shown on the payment page.
expirationDatestringoptional
Expiration date for link.
failedRedirectUrlstringoptional
URL to redirect to after failed payment.
fieldsarray<string>optional
The contact data fields which should be displayed. See fields for more
hideFieldsbooleanoptional
Hide the whole contact fields section on invoice page
Default:false
isPriceExclusiveVatbooleanoptional
If set to true the Vat will be added on top of the price
namestringoptional
This is an internal name of the payment page. This name will be displayed to the administrator only.
pmarray<string>optional
List of payment mean names to display
preAuthorizationbooleanoptional
Whether charge payment manually at a later date (type authorization).
Default:false
psparray<integer>optional
The psp which should be used for the payment. (Can be an array of integers.)
purposestringrequired
The purpose of the payment.
referenceIdstringrequired
An internal reference id used by your system.
reservationbooleanoptional
Whether charge payment manually at a later date (type reservation).
Default:false
skustringoptional
Product stock keeping unit
subscriptionCancellationIntervalstringoptional
Defines the period, in which a subscription can be canceled.
subscriptionIntervalstringoptional
Payment interval
subscriptionPeriodstringoptional
Duration of the subscription
subscriptionStatebooleanoptional
Defines whether the payment should be handled as subscription.
Default:false
successRedirectUrlstringoptional
URL to redirect to after successful payment.
titlestringrequired
This is the page title which will be shown on the payment page.
vatRatenumberoptional
VAT rate percentage
Default:null

2 status codes
200Returns the created paylink data, including its payment amount, currency, identifier, link, purpose, and reference ID.
dataarray<object>optional
statusstringoptional
400Returned when a required field is missing or a supplied value fails validation.
errorobjectoptional
messagestringoptional
reasonstringoptional
statusstringoptional

Error handling

A 400 is returned when a required field is missing or a supplied value is invalid. title, description, referenceId, purpose, amount, and currency are required; expirationDate must use YYYY-MM-DD format.