Create Payment Link

post

https://mapi.boomfi.xyz/v1/paylinks

The Create Payment Link endpoint enables you to generate a new payment link for a specific product or service within the BoomFi platform. This link can be customized with various parameters, such as the amount, currency, and description, facilitating payments for a wide range of offerings. Use this endpoint to quickly create payment links you can share with customers to collect payments seamlessly.

Note

When creating a payment link, you can implicitly create a plan by providing details such as amount and currency.

Account-specific Paylinks

Create an account-specific paylink by adding either account_ref or account_ids. Its important to note that you cannot add both.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

account_ids

array of integers

A list of account IDs to associate with the payment link. Use this to attach specific accounts to the payment link, making it account-specific. ⚠️ Either account_ids or account_ref should be used, not both. ⚠️

account_ids

account_ref

string

An account reference to associate with the payment link. Use this to attach accounts with the specified account reference to the payment link, making it account-specific. ⚠️ Either account_ids or account_ref should be used, not both. ⚠️

name

string

required

The name of the payment link.

amount

string

required

The amount associated with the payment link.

currency

string

required

The currency of the payment link.

reference

string

The reference for the payment link.

description

string

A description of the payment link.

interval

string

enum

The recurring interval for the payment link:

Week
Month
Year

Allowed:

intervalCount

integer

The number of intervals for the recurring payment link.

trial_period

string

The trial period for the payment link in a valid duration format. For example, for 1 day use 24h.

image_url

string

An image URL to be used as the cover image for the payment link at the checkout.

available_quantity

number

Limits the number of times the payment link can be used. When set to a positive non-zero value, the payment link becomes limited-usage.

For example, set available_quantity to 1 to create a one-time use payment link.

A successful or failed payment decreases the counter by one.
A canceled payment reverts the counter (quantity is restored).
When the counter reaches zero, the payment link becomes invalid and no further checkouts are accepted.

expires_at

date-time

Sets an expiration date and time for the payment link. Any checkout attempt after this timestamp will fail, as the payment link is no longer valid.

metadata

object

Responses

200OK

400Bad Request

500Internal Server Error