# ZBX

## Docs

- [Introduction](https://docs.zbx.boomfi.xyz/introduction.md): Overview of the ZBX payments platform for developers.
- [Create an Account](https://docs.zbx.boomfi.xyz/create-account.md): Sign up, create your organisation, and prepare the merchant dashboard.
- [Authentication](https://docs.zbx.boomfi.xyz/authentication.md): API keys, request signing secrets, and how secured Merchants API calls work.
- [Quickstart](https://docs.zbx.boomfi.xyz/quickstart.md): Create your first paylink with the Merchants API and prepare for webhooks.
- [Choose Your Integration](https://docs.zbx.boomfi.xyz/choose-integration.md): Decide between checkout paylinks, subscriptions, and permanent deposit accounts.
- [Merchant Dashboard Overview](https://docs.zbx.boomfi.xyz/dashboard/overview.md): Navigate Settings, payments, customers, and integrations in the ZBX merchant dashboard.
- [Business Settings](https://docs.zbx.boomfi.xyz/dashboard/business.md): Organisation profile, webhook endpoint, and public key for ZBX.
- [Team and Roles](https://docs.zbx.boomfi.xyz/dashboard/team.md): Invite teammates and understand Owner, Admin, Member, and Accountant permissions.
- [Payments Settings](https://docs.zbx.boomfi.xyz/dashboard/payments-settings.md): Configure crypto settlement chains and underpayment tolerance.
- [Transactions](https://docs.zbx.boomfi.xyz/dashboard/transactions.md): View, filter, and export payments; open explorer details and download receipts.
- [Customers](https://docs.zbx.boomfi.xyz/dashboard/customers.md): Manage payers linked to wallets and paylinks, including manual registration.
- [Customer Portal](https://docs.zbx.boomfi.xyz/dashboard/customer-portal.md): How end customers view transactions and manage subscriptions.
- [Settlement Overview](https://docs.zbx.boomfi.xyz/settlement/overview.md): Configure where crypto payment proceeds land before you accept payments.
- [Settlement Accounts](https://docs.zbx.boomfi.xyz/settlement/settlement-accounts.md): List, create, and manage merchant settlement accounts via dashboard or API.
- [Virtual Accounts](https://docs.zbx.boomfi.xyz/settlement/virtual-accounts.md): Create and manage the org virtual account hierarchy, balances, and chains.
- [Payments Overview](https://docs.zbx.boomfi.xyz/payments/overview.md): Accept fixed-price crypto payments with payment links and hosted checkout.
- [Payment Links](https://docs.zbx.boomfi.xyz/payments/paylinks.md): Create, share, and manage crypto payment links (one-time or recurring).
- [Paylink Features](https://docs.zbx.boomfi.xyz/payments/paylink-features.md): Prefill, customer_ident, redirects, variants, and managing payment links.
- [Account-Specific Paylinks](https://docs.zbx.boomfi.xyz/payments/account-specific-paylinks.md): Bind paylinks to settlement accounts with account_ids or account_ref.
- [Checkout](https://docs.zbx.boomfi.xyz/payments/checkout.md): Hosted customer checkout for payment links.
- [Subscriptions](https://docs.zbx.boomfi.xyz/payments/subscriptions.md): Bill customers on a recurring schedule with crypto and handle renewals.
- [Cookbook: Sell a Product](https://docs.zbx.boomfi.xyz/payments/cookbook-sell-product.md): End-to-end fixed-price crypto sale with paylinks and webhooks.
- [Cookbook: Recurring Billing](https://docs.zbx.boomfi.xyz/payments/cookbook-recurring.md): End-to-end subscription setup with invoices and lifecycle webhooks.
- [Deposit Accounts Overview](https://docs.zbx.boomfi.xyz/deposits/overview.md): Permanent crypto deposit addresses for user balances with automatic sweep to your virtual account.
- [Create a Deposit Address](https://docs.zbx.boomfi.xyz/deposits/create-address.md): Create a permanent pay-in crypto wallet for a customer reference.
- [Cookbook: User Balance Deposits](https://docs.zbx.boomfi.xyz/deposits/cookbook-user-balance.md): Map users to permanent deposit addresses and credit balances from verified events.
- [Trading Overview](https://docs.zbx.boomfi.xyz/trading/overview.md): Partner guide to the ZBX Trading API for crypto conversion and crypto–fiat flows.
- [Core Concepts](https://docs.zbx.boomfi.xyz/trading/core-concepts.md): Accounts, assets, quotes, orders, and lifecycle for the Trading API.
- [Trading API Guide](https://docs.zbx.boomfi.xyz/trading/api-guide.md): Accounts, Quick Trade, Sweep Trade, orders, discovery, and errors for partner trading.
- [Advanced RFQ](https://docs.zbx.boomfi.xyz/trading/advanced-rfq.md): Lower-level request-for-quote and accept endpoints under the Trading API.
- [Integration Playbook](https://docs.zbx.boomfi.xyz/trading/integration-playbook.md): Partner patterns for off-ramp, custody delivery, errors, reconciliation, and go-live.
- [Webhooks Overview](https://docs.zbx.boomfi.xyz/webhooks/overview.md): Receive real-time Plan, Subscription, Payment, Invoice, and related events from ZBX.
- [Configure Webhooks](https://docs.zbx.boomfi.xyz/webhooks/setup.md): Set your webhook URL and manage the webhook signing public key in the dashboard or API.
- [Verify Webhook Signatures](https://docs.zbx.boomfi.xyz/webhooks/verify-signatures.md): Verify RSA signatures on outbound webhook deliveries using your org public key.
- [Event Types](https://docs.zbx.boomfi.xyz/webhooks/event-types.md): Catalog of webhook event Type.Action values and payload conventions.
- [Event History and Replay](https://docs.zbx.boomfi.xyz/webhooks/event-history-and-replay.md): Inspect webhook deliveries in the dashboard, retry failed events, and use the Events API.
- [Webhook Best Practices](https://docs.zbx.boomfi.xyz/webhooks/best-practices.md): Idempotency, security, and operational patterns for reliable webhook handlers.
- [Integrations Overview](https://docs.zbx.boomfi.xyz/integrations/overview.md): Connect ZBX crypto checkout to billing platforms and storefronts.
- [Stripe Billing](https://docs.zbx.boomfi.xyz/integrations/stripe-billing.md): Add ZBX crypto paylinks to Stripe Billing invoices and subscriptions.
- [Chargebee](https://docs.zbx.boomfi.xyz/integrations/chargebee.md): Add ZBX crypto paylinks to Chargebee invoices and subscriptions.
- [WooCommerce](https://docs.zbx.boomfi.xyz/integrations/woocommerce.md): Accept crypto on WooCommerce invoices with the ZBX plugin.
- [WHMCS](https://docs.zbx.boomfi.xyz/integrations/whmcs.md): Offer crypto checkout in WHMCS with one-time and recurring pay links.
- [Pricing and Fees](https://docs.zbx.boomfi.xyz/pricing/fees-and-pricing.md): Processing fees for payment gateway, exchange, and related products.
- [Networks and Currencies](https://docs.zbx.boomfi.xyz/pricing/networks-and-currencies.md): Supported blockchain networks, cryptocurrencies, payment rails, and fiat currencies.
- [Account Verification and Limits](https://docs.zbx.boomfi.xyz/pricing/account-verification-limits.md): KYC and KYB verification levels and transaction limits for OTC and card products.
- [Unsupported Countries](https://docs.zbx.boomfi.xyz/pricing/unsupported-countries.md): Jurisdictions where ZBX regulated or software services are unavailable.
- [Unsupported Business Activities](https://docs.zbx.boomfi.xyz/pricing/unsupported-business-activities.md): Goods and services that cannot use ZBX products.
- [Service Level Agreement](https://docs.zbx.boomfi.xyz/pricing/service-level-agreement.md): Uptime targets, support response times, and customer responsibilities for ZBX.
- [API Overview](https://docs.zbx.boomfi.xyz/api/overview.md): How the Merchants REST API is structured and what you need before calling it.
- [Authentication](https://docs.zbx.boomfi.xyz/api/authentication.md): Authenticate Merchants API requests with an API key and optional request signatures.
- [Response Patterns](https://docs.zbx.boomfi.xyz/api/response-patterns.md): Standard success, pagination, and error envelopes for the Merchants API.
- [List Paylinks](https://docs.zbx.boomfi.xyz/api-reference/paylinks/list-paylinks.md): List paylinks with optional search and status filters
- [Create Paylink](https://docs.zbx.boomfi.xyz/api-reference/paylinks/create-paylink.md): Create payment link.
- [Get Paylink](https://docs.zbx.boomfi.xyz/api-reference/paylinks/get-paylink.md): Retrieve a payment link by paylink ID or plan ID
- [Update Paylink](https://docs.zbx.boomfi.xyz/api-reference/paylinks/update-paylink.md): Update a paylink's enabled status, metadata, or plan fields
- [Delete Paylink](https://docs.zbx.boomfi.xyz/api-reference/paylinks/delete-paylink.md): Soft-delete a payment link by ID
- [Batch Update Paylinks](https://docs.zbx.boomfi.xyz/api-reference/paylinks/batch-update-paylinks.md): Update multiple paylinks in a single request
- [Batch Delete Paylinks](https://docs.zbx.boomfi.xyz/api-reference/paylinks/batch-delete-paylinks.md): Delete multiple paylinks in a single request
- [Generate Paylink Variant URL](https://docs.zbx.boomfi.xyz/api-reference/paylinks/generate-paylink-variant-url.md): Generate a variant URL for a payment link
- [List Plans](https://docs.zbx.boomfi.xyz/api-reference/plans/list-plans.md): List plans
- [Create Plan](https://docs.zbx.boomfi.xyz/api-reference/plans/create-plan.md): Create plan.
- [Get Plan](https://docs.zbx.boomfi.xyz/api-reference/plans/get-plan.md): Get plan.
- [List Subscriptions](https://docs.zbx.boomfi.xyz/api-reference/subscriptions/list-subscriptions.md): List subscriptions with optional status and customer filters
- [List Subscriptions By Customer](https://docs.zbx.boomfi.xyz/api-reference/subscriptions/list-subscriptions-by-customer.md): List subscriptions for a customer belonging to the authenticated org
- [Cancel Subscription](https://docs.zbx.boomfi.xyz/api-reference/subscriptions/cancel-subscription.md): Cancel subscription
- [Create Subscription Invoice](https://docs.zbx.boomfi.xyz/api-reference/subscriptions/create-subscription-invoice.md): Create (or return existing same-due-date) invoice for a WHMCS subscription
- [List Customers](https://docs.zbx.boomfi.xyz/api-reference/customers/list-customers.md): Retrieve a paginated list of customers for a given organisation, with optional sorting and filtering parameters
- [Create Customer](https://docs.zbx.boomfi.xyz/api-reference/customers/create-customer.md): Create a customer
- [Get Customer](https://docs.zbx.boomfi.xyz/api-reference/customers/get-customer.md): Get customer
- [Update Customer](https://docs.zbx.boomfi.xyz/api-reference/customers/update-customer.md): Update customer fields. Only non-empty fields are applied. Returns the updated customer record (unwrapped).
- [Delete Customer](https://docs.zbx.boomfi.xyz/api-reference/customers/delete-customer.md): Delete customer
- [List Invoices](https://docs.zbx.boomfi.xyz/api-reference/invoices/list-invoices.md): List invoices with optional customer, plan, and payment-type filters
- [Get Invoice](https://docs.zbx.boomfi.xyz/api-reference/invoices/get-invoice.md): Get invoice by id or reference
- [List Payments](https://docs.zbx.boomfi.xyz/api-reference/payments/list-payments.md): List payments with optional filters for invoice, customer, method, status, paylink, and plan.
- [Get Payment](https://docs.zbx.boomfi.xyz/api-reference/payments/get-payment.md): Get payment
- [Cancel Payment](https://docs.zbx.boomfi.xyz/api-reference/payments/cancel-payment.md): Cancel a Processing ProxyWallet one-time payment with zero paid amount
- [List Events](https://docs.zbx.boomfi.xyz/api-reference/events/list-events.md): Retrieve a paginated list of events for a given organisation, with optional sorting and filtering parameters
- [Get Organisation](https://docs.zbx.boomfi.xyz/api-reference/organisation/get-organisation.md): Get the authenticated organisation's settings, including webhook public key when configured.
- [Update Organisation](https://docs.zbx.boomfi.xyz/api-reference/organisation/update-organisation.md): Update organisation name, logo, webhook URL, fee payer, underpay tolerances, and email notification settings.
- [Update Display Currency](https://docs.zbx.boomfi.xyz/api-reference/organisation/update-display-currency.md): Set the organisation display/billing currency
- [Get Signing Secret](https://docs.zbx.boomfi.xyz/api-reference/secrets/get-signing-secret.md): Get the org request-signing secret (HMAC)
- [Rotate Signing Secret](https://docs.zbx.boomfi.xyz/api-reference/secrets/rotate-signing-secret.md): Rotate the org request-signing secret and return the new value
- [Rotate Webhook Secret](https://docs.zbx.boomfi.xyz/api-reference/secrets/rotate-webhook-secret.md): Rotate the org webhook signing key pair and return the updated org
- [List Accounts](https://docs.zbx.boomfi.xyz/api-reference/accounts/list-accounts.md): List settlement accounts for the organisation. Optional reference filter matches account.reference exactly.
- [Create Account](https://docs.zbx.boomfi.xyz/api-reference/accounts/create-account.md): Create an account
- [Get Account](https://docs.zbx.boomfi.xyz/api-reference/accounts/get-account.md): Get a settlement account by ID
- [Update Account](https://docs.zbx.boomfi.xyz/api-reference/accounts/update-account.md): Update an account
- [Delete Account](https://docs.zbx.boomfi.xyz/api-reference/accounts/delete-account.md): Delete an account
- [List fiat external accounts](https://docs.zbx.boomfi.xyz/api-reference/bank-address-book/list-fiat-external-accounts.md): List registered fiat settlement (bank) accounts for the organisation. Used for fiat off-ramp settlement destinations.
- [Register fiat external account](https://docs.zbx.boomfi.xyz/api-reference/bank-address-book/register-fiat-external-account.md): Register a bank account for fiat off-ramp settlement (one enabled account per settlement currency). Starts Pending/disabled until verified. When authenticated with a Bearer session, requires X-Step-Up-Token.
- [Get fiat external account](https://docs.zbx.boomfi.xyz/api-reference/bank-address-book/get-fiat-external-account.md): Get a registered fiat settlement (bank) account by id. Pass reveal=true to decrypt account_number and account_holder_name (audit-logged).
- [Update fiat external account](https://docs.zbx.boomfi.xyz/api-reference/bank-address-book/update-fiat-external-account.md): Update a registered fiat settlement (bank) account. When authenticated with a Bearer session, requires X-Step-Up-Token.
- [Delete fiat external account](https://docs.zbx.boomfi.xyz/api-reference/bank-address-book/delete-fiat-external-account.md): Soft-delete a registered fiat settlement (bank) account. When authenticated with a Bearer session, requires X-Step-Up-Token.
- [Get Virtual Account](https://docs.zbx.boomfi.xyz/api-reference/virtual-accounts/get-virtual-account.md): Get the org's primary virtual account (empty reference) with crypto sub-accounts
- [Create Virtual Account](https://docs.zbx.boomfi.xyz/api-reference/virtual-accounts/create-virtual-account.md): Create the org's managed virtual account with crypto wallets on supported networks
- [Update Virtual Account](https://docs.zbx.boomfi.xyz/api-reference/virtual-accounts/update-virtual-account.md): Update virtual account: add/enable chains with currencies, disable chains
- [List Virtual Account Balances](https://docs.zbx.boomfi.xyz/api-reference/virtual-accounts/list-virtual-account-balances.md): List balances across the org's primary virtual account hierarchy
- [Create Pay-In Deposit Wallet](https://docs.zbx.boomfi.xyz/api-reference/virtual-accounts/create-pay-in-deposit-wallet.md): Create a permanent pay-in wallet under the merchant's virtual account. Deposits to this sub-account are automatically swept to the parent account.
- [Create Payout](https://docs.zbx.boomfi.xyz/api-reference/virtual-accounts/create-payout.md): Create a payout to a crypto wallet address. Requires request signature headers. When authenticated with a Bearer session, also requires X-Step-Up-Token.
- [Get Account By Reference](https://docs.zbx.boomfi.xyz/api-reference/partners/get-account-by-reference.md): Get account by reference
- [List Account Balances](https://docs.zbx.boomfi.xyz/api-reference/partners/list-account-balances.md): List account balances by reference
- [List Deposit Account Balances](https://docs.zbx.boomfi.xyz/api-reference/partners/list-deposit-account-balances.md): List balances for a pay-in deposit wallet under a virtual account, aggregated per chain from succeeded Deposit/Payout payments.
- [Create Pay-In Deposit Wallet](https://docs.zbx.boomfi.xyz/api-reference/partners/create-pay-in-deposit-wallet.md): Create a permanent pay-in wallet for account. Deposit to this sub-account will be automatically swept to the parent account. Currency and deposit_splits are optional.
- [Create Payout](https://docs.zbx.boomfi.xyz/api-reference/partners/create-payout.md): Create a payout to a crypto wallet address
- [Create Virtual Account](https://docs.zbx.boomfi.xyz/api-reference/partners/create-virtual-account.md): Create virtual account with managed crypto wallets over supported networks
- [Get Account By ID](https://docs.zbx.boomfi.xyz/api-reference/partners/get-account-by-id.md): Get account by ID
- [Update Virtual Account](https://docs.zbx.boomfi.xyz/api-reference/partners/update-virtual-account.md): Update virtual account: add/enable chains with currencies, disable chains
- [Get Virtual Account](https://docs.zbx.boomfi.xyz/api-reference/partners/get-virtual-account.md): Get a virtual account and its sub-accounts by reference
- [List Automations](https://docs.zbx.boomfi.xyz/api-reference/partner-automations/list-automations.md): List automations for a virtual account identified by reference
- [Create Automation](https://docs.zbx.boomfi.xyz/api-reference/partner-automations/create-automation.md): Create an automation for a virtual account identified by reference
- [Get Automation](https://docs.zbx.boomfi.xyz/api-reference/partner-automations/get-automation.md): Get a single automation by ID for a virtual account identified by reference
- [Update Automation](https://docs.zbx.boomfi.xyz/api-reference/partner-automations/update-automation.md): Update an automation for a virtual account identified by reference
- [Delete Automation](https://docs.zbx.boomfi.xyz/api-reference/partner-automations/delete-automation.md): Soft-delete an automation for a virtual account identified by reference
- [List Automation Runs](https://docs.zbx.boomfi.xyz/api-reference/partner-automations/list-automation-runs.md): List runs for a specific virtual account automation
- [List Balance Monitoring](https://docs.zbx.boomfi.xyz/api-reference/partner-balance-monitoring/list-balance-monitoring.md): List maintain-balance automations for an account
- [Create Balance Monitoring](https://docs.zbx.boomfi.xyz/api-reference/partner-balance-monitoring/create-balance-monitoring.md): Create a maintain-balance automation for an account
- [Update Balance Monitoring](https://docs.zbx.boomfi.xyz/api-reference/partner-balance-monitoring/update-balance-monitoring.md): Update a maintain-balance automation for an account
- [Delete Balance Monitoring](https://docs.zbx.boomfi.xyz/api-reference/partner-balance-monitoring/delete-balance-monitoring.md): Delete a maintain-balance automation for an account and currency
- [List Currencies](https://docs.zbx.boomfi.xyz/api-reference/instruments/list-currencies.md): List currencies and payment methods available for OTC/trading
- [Update Instrument Spread](https://docs.zbx.boomfi.xyz/api-reference/instruments/update-instrument-spread.md): Updates the spread (in basis points) for a trade venue instrument. Only accessible by the OTC org.
- [List Instruments](https://docs.zbx.boomfi.xyz/api-reference/instruments/list-instruments.md): Lists all trade venue instruments. Only accessible by the OTC org.
- [List Swap Targets](https://docs.zbx.boomfi.xyz/api-reference/instruments/list-swap-targets.md): Returns every currency/network reachable (any number of hops) from the given starting asset.
- [Request Quote](https://docs.zbx.boomfi.xyz/api-reference/quotes/request-quote.md): Request a firm or estimate RFQ quote
- [Accept Quote](https://docs.zbx.boomfi.xyz/api-reference/quotes/accept-quote.md): Accept an RFQ quote and create an order
- [Reject Quote](https://docs.zbx.boomfi.xyz/api-reference/quotes/reject-quote.md): Reject an RFQ quote (requires OTC feature)
- [List Quote History](https://docs.zbx.boomfi.xyz/api-reference/quotes/list-quote-history.md): List RFQ quotes for the org (requires OTC feature)
- [List Orders](https://docs.zbx.boomfi.xyz/api-reference/orders/list-orders.md): List RFQ orders for the authenticated organisation
- [Create Quick Trade](https://docs.zbx.boomfi.xyz/api-reference/orders/create-quick-trade.md): Request a quote and immediately accept it (or dry-run estimate)
- [Create Sweep Trade](https://docs.zbx.boomfi.xyz/api-reference/orders/create-sweep-trade.md): Consolidate eligible balances into a target currency via quote+accept (or dry-run)
- [List Trades](https://docs.zbx.boomfi.xyz/api-reference/trades/list-trades.md): List trades for the organisation

## OpenAPI Specs

- [openapi](https://docs.zbx.boomfi.xyz/openapi.yaml)