Paylink Features

Prefill, customer_ident, redirects, variants, and managing payment links.

Payment links support query parameters and variant URLs so you can tailor checkout without creating a new link for every customer.

Topics:

• Prefill customer data
• Connect a customer (customer_ident)
• Redirect after payment
• Change amount and currency (variants)
• Manage pay links in the dashboard

Your base pay link URL is returned when you create a pay link (hosted checkout host + link id). Hosted checkout for this environment is rooted at https://pay.zbx.boomfi.xyz. Below, <PAYLINK_URL> means that full URL (for example https://pay.zbx.boomfi.xyz/<PAYLINK_ID>).

Prefill customer data

Append identity query parameters so the customer does not re-type data you already hold:

<PAYLINK_URL>?name=Tamara&email=[e-mail]

Field	Description	Required
name	Full name	Yes when prefilling
email	Email address	Yes when prefilling
dateOfBirth	ISO 8601 YYYY-MM-DD	Conditional*
placeOfBirth	Country / place of birth	Conditional*
address1	Address line 1	Conditional*
address2	Address line 2	Conditional*
city	City	Conditional*
state	State / province	Conditional*
postalCode	Postal / ZIP code	Conditional*
country	Country	Conditional*
phoneNumber	Phone in international format	Conditional*

*Required only when the merchant enabled that field at paylink / checkout configuration.

Connect a customer

Bind the session to a customer id you already store with customer_ident:

<PAYLINK_URL>?customer_ident=<YOUR_CUSTOMER_ID>

Webhook and dashboard activity can then use this identifier consistently.

Redirect after a successful payment

Pass redirect_to with a URL-encoded destination. If the pay link itself has no redirect configured, the query value is used.

<PAYLINK_URL>?redirect_to=<REDIRECT_URL>

Skip redirect delay

By default a short countdown (about 10 seconds) runs before redirect. Skip it with:

<PAYLINK_URL>?redirect_to=<REDIRECT_URL>&skip_redirect_delay=1

Payment id on redirect

The redirect destination receives a pid query parameter with the payment id so you can fetch payment details from the API:

https://your.example.com/thanks?pid=<PAYMENT_ID>

Use the payment-by-id endpoint on https://mapi.zbx.boomfi.xyz/v1 with your API credentials. See the Payments operations in the API reference.

Change amount and currency

Generate a variant URL when the quoted amount or currency must change at send time (top-ups, tips in addition to a base amount, alternate quote currency):

• Call the Generate variant URL paylink endpoint (see API reference)
• Pass amount and/or currency
• Optionally pass customer_ident and redirect_to

Manage pay links

Open:

https://merchants.zbx.boomfi.xyz/dashboard/pay-links

From a pay link detail page you can:

• Inspect main, link, and checkout settings
• Review transactions on that link
• Edit most fields via the overflow menu, or deactivate the link

You cannot change a one-time link into recurring (or vice versa) after creation: create a new link instead.

Related

• Payment Links
• Account-Specific Paylinks
• Checkout