Manage payment links
Let's look at all available features for managing a payment link object. The endpoint list below demonstrates how various APIs can be used to manage payment links.
The following are the payment link API endpoints for creating, deactivating, retrieving, updating payment links, and much more.
- Create a payment link →
POST
→ /payment-links - Retrieve a payment link →
GET
→ /payment-links/{id} - Deactivate a payment link →
POST
→ /payment-links/{id}/deactivate - List all payment links →
GET
→ /payment-links - List all payments of a payment link →
GET
→ /payment-links/{id}/payments - Filter all payment links →
POST
→ /payment-links/filter - Search payment links →
POST
→ /search/payment-links - Update a payment link→
POST
→ /payment-links/{id} - Additionally, subscribe to webhook events to receive instant notifications.
Request headers
As of now, there are two versions (2022-04-15 and 2022-10-15). Version 2022-10-15 supports both on-chain and lightning payment methods. Whereas the 2022-04-15 version only supports lightning payments. In this string header speed-version
, you can specify any version you want with all of the above APIs.
Track payments
You can check the payment link outcome on your web application, which provides detailed insights. Alternatively, you can configure notification webhooks to receive payment updates. Learn more about Webhook subscriptions.
Updated 3 months ago