Payment Link History API
Payment Link History API on Singapay Payment Gateway
Payment Link History represents each payment made through a Payment Link. When a customer completes payment via a Payment Link URL, a new Payment Link History record is created. Use this API to track, monitor, and reconcile all payments received through your Payment Links.
Relationship with Payment Link
Payment Link (Parent) → The shareable URL with payment configuration and items
Payment Link History (Child) → Individual payment records linked to a Payment Link
Example:
• Payment Link: https://singapay.com/b2b/INV-2024-001 (Invoice for Customer A)
• Payment Link History #1: IDR 500,000 - Paid via VA BRI on Jan 1
• Payment Link History #2: IDR 500,000 - Paid via QRIS on Jan 2
• Payment Link History #3: IDR 500,000 - Paid via GoPay on Jan 3
→ One Payment Link has multiple payment histories
Transaction Lifecycle
- 1Customer Opens Link: Customer accesses the Payment Link URL and views payment page.
- 2Selects Payment Method: Customer chooses from available methods (VA/QRIS/E-Wallet).
- 3History Record Created: Payment Link History record created with status "pending".
- 4Customer Completes Payment: Customer pays via selected method. Bank/payment provider notifies SingaPay.
- 5Processing & Reconciliation: System validates payment, reconciles transaction. Status changes to "paid".
- 6Settlement: Funds are settled to your account (bank or SingaPay Balance) based on your settlement method.
Important Notes
- • Multiple Payment Methods: One Payment Link can receive payments via different methods (VA, QRIS, E-Wallet), each recorded as separate history.
- • Customer Information: If required, customer details (name, email, phone) are captured and stored in each history record.
- • Status Tracking: Monitor payment status from "pending" to "paid" to "settled".
- • Fee Breakdown: Each history shows payment method used, vendor fee, platform margin, and net amount received.
- • QRIS Special Handling: For QRIS payments, additional MDR information is recorded in the history.
- • Settlement Information: Track when funds were reconciled and settled to your account.
- • Filtering & Search: Query histories by reference number, payment method, status, amount, or date range.
- • Transaction History: Records are retained for 1 year. Data older than 1 year is archived.