API ReferenceIntegrationsKnowledge Base

Payment Links

Payment Links help you to receive payments from customers by sending them links via email, SMS, chatbots and more. You can easily set up and use Payment Links with our APIs.

How do I know which version to use#

Check your Dashboard to see which API version you should integrate.

  • If the New API tag is shown on Dashboard, integrate with our New API Contracts. The screenshot below shows the New API tag on the Dashboard.
  • If no tag is shown, integrate with our Legacy API Contracts. The screenshot below shows the absence of the tag on the Dashboard.

Webhook Events to Subscribe to#

If you are using the new APIs, you must subscribe to the following webhook events for Payment Links:

Webhook Events for New API

Webhook Events for Legacy API

payment_link.paid

invoice.paid

payment_link.partially_paid

invoice.partially_paid

payment_link.expired

invoice.expired

payment_link.cancelled

×