Payment Links

Payment links (paylinks) collect crypto payment without building your own checkout UI. Create them in the dashboard or via the API, then share the URL.

Dashboard

Open https://merchants.zbx.boomfi.xyz/dashboard/pay-links
Create a pay link and enter name, amount, currency, payment type (one-time or recurring), and after-completion behaviour
Share the generated URL with your customer

Create via API

curl -X POST "https://mapi.zbx.boomfi.xyz/v1/paylinks" \
  -H "X-API-KEY: sk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "ZenBlend Aromatherapy Diffuser",
    "description": "One-time purchase",
    "amount": "29.99",
    "currency": "USD",
    "reference": "sku_diffuser_001",
    "type": "OneTime"
  }'

Notable fields

Field	Description
`name`, `amount`, `currency`	Required
`type`	`OneTime` or `Recurring` (defaults from interval if omitted)
`interval`, `intervalCount`	Recurring cadence (`Day`, `Week`, `Month`, `Year`, …)
`account_ids` / `account_ref`	Settlement targets: see Account-Specific Paylinks
`available_quantity`	Remaining purchases; `1` for single-use
`expires_at`	Future expiry timestamp
`image_url`, `description`, `reference`, `metadata`	Presentation and bookkeeping

List and manage

# List
curl "https://mapi.zbx.boomfi.xyz/v1/paylinks" \
  -H "X-API-KEY: sk_test_xxx"

# Get one
curl "https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}" \
  -H "X-API-KEY: sk_test_xxx"

# Update
curl -X PATCH "https://mapi.zbx.boomfi.xyz/v1/paylinks/{paylinkId}" \
  -H "X-API-KEY: sk_test_xxx" \
  -H "Content-Type: application/json" \
  -d '{"enabled": false}'

Batch update/delete endpoints are also available under /paylinks/batch. Variant URLs can be generated for specialised checkout flows (/paylinks/generate-variant/{paylinkId}): see Paylink Features.

Events

Successful customer payment arrives as Payment.Updated with status Succeeded. Creating or updating plans/paylinks can emit Plan.Created / Plan.Updated. See Event Types.

Next steps

Paylink Features (prefill, redirects, variants)
Account-Specific Paylinks
Checkout
Cookbook: Sell a Product

Get Started

Dashboard

Settlement

Payments

Deposit Accounts

Trading

Webhooks

Integrations

Pricing and Policies

Payment Links

Dashboard

Create via API

Notable fields

List and manage

Events

Next steps

​Dashboard

​Create via API

​Notable fields

​List and manage

​Events

​Next steps

Dashboard

Create via API

Notable fields

List and manage

Events

Next steps