Reusable URL
One link can receive unlimited payments, each tracked independently.
Multi-method
Supports VA (BRI, BNI, BCA, Maybank, Danamon), QRIS, and E-Wallet.
Shareable
Send via WhatsApp, email, or SMS — no redirect flow needed.
Payment Link flow
Payment Link vs Payment Link History
Understanding the parent-child relationship is key to using this API correctly.Payment Link (Parent)
Reusable and configurable. Defines what is being paid for.
- Reusable payment URL
- Contains items and pricing
- Optional payment method whitelist
- Configurable usage limit and expiration
Payment Link History (Child)
Per-payment record. Created every time a customer pays.
- Individual payment records
- Each has its own payment method
- Tracks status and settlement
- One link → multiple histories
Example: Payment Link
INV-001 receives 3 payments via VA BRI, QRIS, and GoPay → 3 separate Payment Link History records are created, each with its own status and settlement data.Important notes
One link, multiple payments
One link, multiple payments
A single Payment Link can receive multiple payments over its lifetime. Each payment is independently tracked as a Payment Link History record — including its own payment method, status, and settlement info.
Payment method whitelist
Payment method whitelist
You can restrict which payment methods are available per link. For example, allow only VA BRI and QRIS, and hide E-Wallet options entirely.
Customer detail collection
Customer detail collection
Optionally require customers to submit their name, email, and phone number before proceeding to payment — useful for invoicing and event registrations.
Usage limit and expiration
Usage limit and expiration
Control how many times a link can be used with
max_usage, and set an optional expired_at to prevent payments after a certain date.Cannot delete a link with histories
Cannot delete a link with histories
Once a Payment Link has received at least one payment, it cannot be deleted. This preserves the integrity of your transaction history.
Item details
Item details
Include an itemized breakdown (name, quantity, unit price) in each link for better customer experience and cleaner accounting records.
Use cases
Invoicing
Send payment links to customers for invoice payments via email or WhatsApp — no checkout page needed.
E-Commerce checkout
Use as a lightweight checkout alternative without a complex frontend integration.
Donations & crowdfunding
Accept contributions from multiple donors using a single persistent link.
Event registration
Collect payments for event tickets with usage limits to cap the number of attendees.
Available endpoints
List Payment Links
Paginated list of payment links for an account.
List Available Payment Methods
Active methods that support payment links.
Create Payment Link
Generate a new payment link with items and configuration.
Show Payment Link
Retrieve a single payment link by ID.
Update Payment Link
Update mutable fields on an existing link.
Delete Payment Link
Delete a link that has no payment history.
All endpoints require authentication. See Authentication.