LuniPay Docs

API Reference · Payment Links

Create a payment link

Creates a reusable or one-time payment link.

POST/v1/payment-links

Pick `SINGLE` for a one-shot invoice-style link or `MULTI` for a reusable donation-style link. The returned `url` is public — share it anywhere.

Returnspayment_link object

Body parameters

amountintegerRequired

Amount to charge per payment, in the smallest currency unit.

currencystringRequired

Lowercase 3-letter ISO 4217 code.

typestringdefault: SINGLE

Link type.

Allowed values: SINGLE MULTI

namestring

Internal dashboard name.

slugstring

Custom URL slug. Defaults to a generated short id.

descriptionstring

Shown to the customer on the checkout page.

collect_namebooleandefault: true

Collect the customer name.

collect_emailbooleandefault: true

Collect the customer email.

collect_phonebooleandefault: false

Collect the customer phone.

quantity_limitinteger

Close the link after N successful payments.

expires_atinteger

Unix timestamp after which the link stops accepting payments.

metadataobject

Up to 20 key/value pairs.

Errors

400
parameter_missing

`amount` or `currency` not supplied.

409
slug_already_taken

Another link in the same organization already uses that slug.