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://app.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.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",
    "after_completion": {
      "type": "redirect",
      "redirect_url": "https://merchant.example/checkout/success",
      "failure_redirect_url": "https://merchant.example/checkout/failed"
    }
  }'

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
`after_completion`	Checkout outcome: `type` (`hosted` or `redirect`), `redirect_url` (success), `failure_redirect_url` (expired link or Failed payment). Redirect URLs are max 512 characters. Extra keys are stored and returned. Also present on get and list paylink responses.
`metadata.customer_fields`	Extra identity fields collected at checkout: `address`, `date_of_birth`, `email`, `name`, `nationality`, `phone`, `place_of_birth`. Name and email are always collected. Prefill names and the nationality code format are in Paylink Features.

List and manage

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

# Get one — response includes after_completion when configured
curl "https://mapi.boomfi.xyz/v1/paylinks/{paylinkId}" \
  -H "X-API-KEY: sk_test_xxx"

# Update
curl -X PATCH "https://mapi.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
Cookbook: Offer Crypto as a PSP

Get Started

Dashboard

Settlement

Payments

Deposit Accounts

External Account

Webhooks

Payouts

Integrations

Pricing and Policies

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