For the complete documentation index, see llms.txt. This page is also available as Markdown.

Create payment links

Create, cancel, and transfer payment links from invoices, orders, and quotes.

A payment link is the URL where the customer pays at VR Payment. The app creates it through the gateway API including invoice lines (lineItems).

Document
Action

Posted sales invoice

Create payment link

Sales order

Create payment link (for example prepayment)

Sales quote

Create payment link (for example a deposit)

The print rule must allow the document, otherwise you get a clear error.

Automatically on posting

If Create payment link automatically is on, the app creates a link when you post the sales invoice. If an active link already exists on the order or quote, it is transferred to the posted invoice (source type and document number are rewritten) – a second link is not created.

Status

Status
Meaning

Active

Open link, QR code is shown.

Paid

At least one completed payment.

Expired

Valid-until passed (job queue or manual action).

Cancelled

Cancelled manually or after an external settlement.

Paid externally

Invoice settled outside VR Payment, link cancelled at VR Payment.

Further actions on the document: Update payment status, Cancel payment link, Show transactions.

externalId contains document number plus timestamp. After a cancellation you can create a new link for the same document.

Address data is passed as URL parameters and pre-filled on the payment page. billingAddressHandlingMode is NOT_REQUIRED so a missing street does not block payment. The QR code uses the short base URL without address parameters.