> ## 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.

# API Overview

> How the Merchants REST API is structured and what you need before calling it.

The Merchants API is a REST interface over HTTPS. Request and response bodies use JSON. Use standard HTTP methods (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`).

Base URL:

```
https://mapi.boomfi.xyz/v1
```

## Initial setup

1. Create or join an organisation in the [merchant dashboard](https://app.boomfi.xyz/login).
2. Configure [Settlement Overview](/settlement/overview) so collections can complete.
3. Create an API key. See [Authentication](/api/authentication).

For a first end-to-end call, follow the [Quickstart](/quickstart).

## Guides

<CardGroup cols={2}>
  <Card title="Authentication" href="/api/authentication">
    API keys (`X-API-KEY`) and when HMAC request signing is required.
  </Card>

  <Card title="Response Patterns" href="/api/response-patterns">
    Success envelopes, paginated lists, errors, and common HTTP status codes.
  </Card>
</CardGroup>

## Endpoint groups

The API reference groups operations by product area:

| Area | Use for |
| - | - |
| Paylinks | Create and manage payment links and variants |
| Plans / Subscriptions / Invoices | Recurring products and subscription billing |
| Customers | Customer records linked to payments |
| Payments | List and inspect payment transactions |
| Events | Delivery history for organisation events |
| Organisation / Secrets | Org profile, API and signing secrets |
| Accounts | Settlement accounts |
| Virtual Accounts | Deposit accounts, permanent pay-in addresses, balances, payouts |
| Partners | Multi-merchant partner workflows |

Interactive request samples and schemas are on each endpoint page in the groups that follow.

## Related

* [Introduction](/introduction)
* [Authentication](/authentication)
* [Create an Account](/create-account)
* [Webhooks Overview](/webhooks/overview)


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