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
2. Authentication from https://merchants.zbx.boomfi.xyz/dashboard/settings/api-keys
3. Prefer configuring Settlement Overview so customers can complete crypto payment

Create a paylink

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.

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
2. Verify Webhook Signatures

Deposit path instead

For permanent user deposit addresses (balances / iGaming), use the Deposit Accounts Overview cookbook after your Virtual Accounts is ready. That path requires request signing headers.

Next steps

• Choose Your Integration
• Merchant Dashboard Overview
• Cookbook: Sell a Product
• Cookbook: User Balance Deposits