LuniPay Docs

API Reference

Payment Links

Payment links are reusable URLs that collect one-off or recurring payments without any backend work. Create one, share it over WhatsApp, Instagram bio, or print it as a QR code.

Two types: SINGLE (expires after one successful payment) and MULTI (stays active until you disable it). Multi links track view count, payment count, and running total, and support source attribution (`DIRECT`, `EMBED`, `WHATSAPP`, `QR`) for analytics.

The payment_link object

idstring

Unique identifier, prefixed with `pl_`.

objectstring

Always `"payment_link"`.

livemodeboolean

True if created with a live-mode key.

typestring

SINGLE expires after one payment; MULTI is reusable.

Values: SINGLE MULTI

namestringnullable

Internal name for the dashboard.

slugstringnullable

URL slug used for the pretty link path.

urlstring

Public checkout URL — share this.

statusstring

Link lifecycle state.

Values: ACTIVE COMPLETED CANCELLED

amount_centsinteger

Amount charged per successful payment.

currencystring

Lowercase 3-letter ISO 4217 code.

descriptionstringnullable

Shown to the customer on the payment page.

customer_idstringnullable

Attached customer, if any.

collect_nameboolean

Whether to collect the customer's name on the payment page.

collect_emailboolean

Whether to collect email.

collect_phoneboolean

Whether to collect phone number.

installment_enabledboolean

Whether the link offers installment payment.

quantity_limitintegernullable

Hard cap on total successful payments. When reached, the link flips to COMPLETED.

view_countinteger

How many times the hosted page has been loaded.

payment_countinteger

Total successful payments through this link.

total_collected_centsinteger

Running total in the link currency.

expires_atintegernullable

Unix timestamp after which the link stops accepting payments.

metadataobjectnullable

Up to 20 arbitrary key/value pairs.

createdinteger

Creation timestamp (unix).

updatedinteger

Last-updated timestamp (unix).

{
  "id": "pl_01JRZKB6SDE2HVKX8WCTNY4FRG",
  "object": "payment_link",
  "livemode": false,
  "type": "MULTI",
  "name": "April 2026 donation drive",
  "slug": "april-drive",
  "url": "https://lunipay.io/p/rentelio/april-drive",
  "status": "ACTIVE",
  "amount_cents": 2500,
  "currency": "usd",
  "description": "Suggested donation — every bit helps.",
  "customer_id": null,
  "collect_name": true,
  "collect_email": true,
  "collect_phone": false,
  "installment_enabled": false,
  "quantity_limit": null,
  "view_count": 318,
  "payment_count": 42,
  "total_collected_cents": 105000,
  "expires_at": null,
  "metadata": null,
  "created": 1713100800,
  "updated": 1713100800
}

Endpoints