Skip to main content

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.

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.

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
  1. Go to Payment Links in the dashboard
  2. Click New Payment Link
  3. Configure the link:
FieldRequiredDescription
AmountYesFixed amount in NPR (e.g. Rs. 500)
TitleYesShown on the checkout page
DescriptionNoAdditional details for the customer
Reference IDNoYour internal reference (e.g. invoice_123) - used for tracking
ExpiryNoDate after which the link stops working
Max usesNoMaximum number of successful payments (e.g. 50 for event tickets)
ProviderNoPre-select a payment provider, or let the customer choose
Collect shipping addressNoWhen enabled, customers fill in their address before paying. The address is included in the payment_link.paid webhook payload as customer_address.
  1. Click Create - PayBridgeNP generates a URL like:
https://paybridgenp.com/pay/lnk_...

Tracking payments

Use the reference ID to look up payments made through a link:
curl "https://api.paybridgenp.com/v1/public/payment-status?query=invoice_123"
Or with the full link URL format:
curl "https://api.paybridgenp.com/v1/public/payment-status?query=ref_abc123"
This endpoint requires no authentication - you can call it from the browser or from a customer-facing page. See Check payment status for the full response schema.

Webhooks

Payment link payments fire a payment_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.
StatusMeaning
ActiveAccepting payments
ExpiredPast the expiry date - no longer accepts payments
Limit reachedMax uses hit - no longer accepts payments
DisabledManually turned off from the dashboard
You can disable or re-enable a link at any time 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/checkout API
  • Links do not support custom returnUrl or cancelUrl - customers are shown a PayBridgeNP result page after payment