> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boomfi.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Payment Links

> Create, share, and manage crypto payment links (one-time or recurring).

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

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

<img src="https://mintcdn.com/boom-fi/yPLvmX4qzaQfr3uG/payments/images/paylinks-list-boomfi.png?fit=max&auto=format&n=yPLvmX4qzaQfr3uG&q=85&s=1bf1e136494c8b2799fb04305a4dfc29" alt="BoomFi payment links list" width="1440" height="900" data-path="payments/images/paylinks-list-boomfi.png" />

<img src="https://mintcdn.com/boom-fi/yPLvmX4qzaQfr3uG/payments/images/paylinks-create-boomfi.png?fit=max&auto=format&n=yPLvmX4qzaQfr3uG&q=85&s=dabae3ac0e0586740299dc542f203a56" alt="BoomFi create payment link" width="1440" height="900" data-path="payments/images/paylinks-create-boomfi.png" />

## Create via API

```bash theme={null}
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](/payments/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](/payments/paylink-features). |

## List and manage

```bash theme={null}
# 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](/payments/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](/webhooks/event-types).

## Next steps

* [Paylink Features](/payments/paylink-features) (prefill, redirects, variants)
* [Account-Specific Paylinks](/payments/account-specific-paylinks)
* [Checkout](/payments/checkout)
* [Cookbook: Sell a Product](/payments/cookbook-sell-product)
* [Cookbook: Offer Crypto as a PSP](/payments/cookbook-psp-paylinks)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.