Payment Links API

NOTE
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.

Creating 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.

Sample Diagram of a Payment Link Flow

payment-links

A shopper needs to pay a merchant for something they bought or a service they received.
The merchant then sends a request to create a payment link via POST /api/v1/payment-links.
Beam returns a payment link object to merchant. This contains the id of the payment link,and the URL of the payment link.
The merchant can then redirect the shopper to the checkout page by extracting the url field from the payment link object.
The shopper is directed to the checkout page by the link, pays by filling in information in the Beam-hosted checkout page.
If configured, Beam sends a charge.succeeded webhook to the merchant's server indicating that the charge has been processed successfully.
The merchant processes the webhook and returns an acknowledgment to Beam.
Beam redirects shopper to the payment completion page.

TIP
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.

Payment Links API

NOTE

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.

Creating 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.

Sample Diagram of a Payment Link Flow

A shopper needs to pay a merchant for something they bought or a service they received.

The merchant then sends a request to create a payment link via POST /api/v1/payment-links.

Beam returns a payment link object to merchant. This contains the id of the payment link,and the URL of the payment link.

The merchant can then redirect the shopper to the checkout page by extracting the url field from the payment link object.

The shopper is directed to the checkout page by the link, pays by filling in information in the Beam-hosted checkout page.

If configured, Beam sends a charge.succeeded webhook to the merchant's server indicating that the charge has been processed successfully.

The merchant processes the webhook and returns an acknowledgment to Beam.

Beam redirects shopper to the payment completion page.

TIP

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.