Manage checkout links
Let's look at all available features for managing a checkout link object. The endpoint list below demonstrates how various APIs can be used to manage checkout links.
The following are the checkout link API endpoints for creating, deactivating, retrieving, updating checkout links, and much more.
- Create a checkout link →
POST
→ /checkout-links - Retrieve a checkout link→
GET
→ /checkout-links/{Id} - Deactivate a checkout link→
POST
→ /checkout-links/{id}/deactivate - List all checkout links→
GET
→ /checkout-links - List all payments of a checkout link →
GET
→ /checkout-links/{Id}/payments - Filter all checkout links→
GET
→ /checkout-links/filter - Search checkout links→
GET
→ /search/checkout-links - Update a checkout link→
POST
→ /checkout-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. To ensure that you can receive both on-chain and lightning payments, remember to keep the “BTC On-chain” payment method enabled in the Speed web application. 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 checkout 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 7 days ago