Payment Links API
We do not recommend rendering our payment link
inside iframe as we attach
X-Frame-Options: DENY header for security purposes.
See more about the header .
You can see the API reference for payment links at Payment Links API Specification, and a full detailed example of a payment link integration guide at Payment Links API Integration Guide.
Sample Diagram of a Payment Link Flow
Here is an example diagram of Payment Links API usage in case that payment is successful.
You can redirect customer to a custom URL after the payment is completed by providing the redirectUrl field in the
payment link creation request.
You can read more details about the webhook in the Webhook guide.
Create a Payment Link
Payment links can be created via your merchant account in Lighthouse or via API calls to Beam. For more information regarding creating payment links via API calls, please refer to the API Reference.
After creating a payment link, it cannot be deleted or modified. However, you can disable an ACTIVE payment link to
prevent the payment link from being used for payment processing.