Payment links are shareable URLs that let customers pay without any code on your side. Each link points to a hosted PayBridgeNP checkout page - you configure the amount, description, and expiry in the dashboard, then share the URL anywhere.Documentation Index
Fetch the complete documentation index at: https://docs.paybridgenp.com/llms.txt
Use this file to discover all available pages before exploring further.
Use cases
- Invoicing - send a payment link in an email or SMS
- Donations - embed a payment link on a website or social media
- Event tickets - sell a fixed number of seats by setting a max use limit
- Subscriptions alternative - recurring manual billing for small businesses
Creating a payment link
- Go to Payment Links in the dashboard
- Click New Payment Link
- Configure the link:
| Field | Required | Description |
|---|---|---|
| Amount | Yes | Fixed amount in NPR (e.g. Rs. 500) |
| Title | Yes | Shown on the checkout page |
| Description | No | Additional details for the customer |
| Reference ID | No | Your internal reference (e.g. invoice_123) - used for tracking |
| Expiry | No | Date after which the link stops working |
| Max uses | No | Maximum number of successful payments (e.g. 50 for event tickets) |
| Provider | No | Pre-select a payment provider, or let the customer choose |
| Collect shipping address | No | When enabled, customers fill in their address before paying. The address is included in the payment_link.paid webhook payload as customer_address. |
- Click Create - PayBridgeNP generates a URL like:
Tracking payments
Use the reference ID to look up payments made through a link:Webhooks
Payment link payments fire apayment_link.paid event (and also payment.succeeded). The webhook payload includes the metadata attached to the payment link, a payment_link_id field, and - when address collection is enabled - a customer_address object.
Set up a webhook endpoint in the dashboard to receive these events.
Link lifecycle
| Status | Meaning |
|---|---|
| Active | Accepting payments |
| Expired | Past the expiry date - no longer accepts payments |
| Limit reached | Max uses hit - no longer accepts payments |
| Disabled | Manually turned off from the dashboard |
Limitations
- Payment links are created and managed from the dashboard only - there is no API endpoint to create them programmatically
- Each link has a fixed amount set at creation time - dynamic amounts require the
POST /v1/checkoutAPI - Links do not support custom
returnUrlorcancelUrl- customers are shown a PayBridgeNP result page after payment