Payment Link API
Payment Link API on Singapay Payment Gateway
Payment Link is a payment method that allows you to create a shareable URL for customers to complete payments. One Payment Link can receive multiple payments over time, with each payment recorded as a separate Payment Link History. Support multiple payment methods including Virtual Account, QRIS, and E-Wallet.
💡 Payment Link Flow
Payment Link vs Payment Link Histories
Understanding the relationship:
Payment Link (Parent)
- • Reusable payment URL
- • Contains items & pricing
- • Can whitelist payment methods
- • Has usage limit & expiration
Payment Link History (Child)
- • Individual payment records
- • Each has different payment method
- • Tracks status & settlement
- • One Link = Multiple histories
Example: Payment Link INV-001 receives 3 payments via VA BRI, QRIS, and GoPay → 3 Payment Link History records
Important Notes
- • One Link, Multiple Payments: A single Payment Link can receive multiple payments. Each payment is tracked separately as a Payment Link History.
- • Flexible Payment Methods: Support VA (BRI, BNI, BCA, Maybank, Danamon), QRIS, and E-Wallet options.
- • Payment Method Whitelist: You can restrict which payment methods are available for each Payment Link.
- • Customer Detail Collection: Optionally require customer information (name, email, phone) before payment.
- • Usage Limit: Control how many times a Payment Link can be used using max_usage parameter.
- • Expiration: Set optional expiration date to limit the Payment Link validity period.
- • Cannot Delete with Histories: Once a Payment Link has received payments, it cannot be deleted to maintain transaction history integrity.
- • Item Details: Include itemized breakdown (name, quantity, unit price) for better customer experience and accounting.
Use Cases
- • Invoicing: Send payment links to customers for invoice payments via email or WhatsApp.
- • E-Commerce Checkout: Use as a simple checkout alternative without complex integration.
- • Donations & Crowdfunding: Accept donations from multiple donors using a single link.
- • Event Registration: Collect payments for event tickets with usage limits.
- • Marketplace Sellers: Allow customers to pay for orders from multiple sellers.