Skip to Content
Payment LinksPayment Links API

Payment Links API

The Payment Links API lets you create and manage hosted checkout URLs programmatically. The following operations are available:

  • Create Payment Link (POST /api/v1/payment-links) — generate a new checkout URL.
  • Get Payment Link by ID (GET /api/v1/payment-links/{paymentLinkId}) — look up the current status and order details.
  • Disable Payment Link by ID (POST /api/v1/payment-links/{paymentLinkId}/disable) — prevent an ACTIVE link from being paid.

Payment links can also be created from your merchant account in Lighthouse . Once created, a payment link cannot be deleted or modified — disable is the only mutation.

For request and response shapes, see the Payment Links API Specification. For a walkthrough of a full integration, see the Integration Guide.

Last updated on
Payment LinksIntegration Guide