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

# Quickstart

> Create your first paylink with the Merchants API and prepare for webhooks.

This quickstart creates a one-time payment link and points you at settlement and webhooks for a complete first payment.

## Prerequisites

1. [Create an Account](/create-account)
2. [Authentication](/authentication) from `https://merchants.zbx.boomfi.xyz/dashboard/settings/api-keys`
3. Prefer configuring [Settlement Overview](/settlement/overview) so customers can complete crypto payment

## Create a paylink

```bash theme={null}
curl -X POST "https://mapi.zbx.boomfi.xyz/v1/paylinks" \
  -H "X-API-KEY: sk_test_xxx" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "Sample product",
    "amount": "25.00",
    "currency": "USD",
    "description": "Quickstart charge",
    "reference": "quickstart_order_1"
  }'
```

Required fields: `name`, `amount`, `currency`. Optional fields include `type` (`OneTime` or `Recurring`), `interval` / `intervalCount` for subscriptions, `account_ids` or `account_ref` for settlement accounts, `available_quantity`, and `expires_at`.

The response includes a payment-link identifier and a URL customers can open for checkout. See [Payment Links](/payments/paylinks).

## Listen for payment success

When the customer pays, ZBX delivers webhook events such as `Payment.Updated` with status `Succeeded`. Configure your endpoint and verify signatures before trusting payloads:

1. [Configure Webhooks](/webhooks/setup)
2. [Verify Webhook Signatures](/webhooks/verify-signatures)

## Deposit path instead

For permanent user deposit addresses (balances / iGaming), use the [Deposit Accounts Overview](/deposits/overview) cookbook after your [Virtual Accounts](/settlement/virtual-accounts) is ready. That path requires request signing headers.

## Next steps

* [Choose Your Integration](/choose-integration)
* [Merchant Dashboard Overview](/dashboard/overview)
* [Cookbook: Sell a Product](/payments/cookbook-sell-product)
* [Cookbook: User Balance Deposits](/deposits/cookbook-user-balance)