---
updatedAt: 2025-09-08T22:29:49.000Z
agentTools:
  projectIndex: https://boomfi.readme.io/llms.txt
---

# Overview

BoomFi's API has been implemented around RESTful. Our API uses standard HTTP protocols where JSON payloads are returned in response to HTTP requests. All operations can be performed via GET, POST, PUT, PATCH, and DELETE requests.

## Initial Setup

Before you can effectively interact with the BoomFi API, ensure the following steps are completed:

1. **Join the Merchant Dashboard:** Sign up and maintain an active account on the [BoomFi dashboard](https://test.boomfi.xyz/dashboard). This is your central hub for managing your organization's interactions with the BoomFi platform.

2. **Set Up Your Settlement Account:** Configure your settlement account to handle payments. This step is crucial for enabling your organization to receive payouts seamlessly.

3. **Generate API Keys:** Obtain your API keys from the dashboard. These keys are required to authenticate all API requests and ensure secure communication between your application and BoomFi's services.

> 👍 Quick Start
>
> Follow the **Initial Setup** steps to get up and running with the BoomFi API and ensure your account and settlement configurations are ready.

## Authentication and API Response Patterns

Explore the following pages for guidance on how to effectively interact with BoomFi's API **Authentication** and **API Response Patterns**:

<HTMLBlock>{`
<style>
  .card_shelf1 {
    gap: 10px;
    display: grid;
    grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));

    .card {
      display: flex;
      padding: 30px 18px;
      flex-direction: column;
      align-items: flex-start;
      gap: 12px;
      border-radius: 6px;
      border: 1px solid #DCDCDC;
      background: #FFF;
      text-decoration: none !important;
      transition: all 0.3s ease, border 0.1s ease;

      .card_content {
        font-feature-settings: 'clig' off, 'liga' off;
        font-family: Inter;
        font-style: normal;
        line-height: 18px;

        h3 {
          display: flex;
          color: #383838;
          font-size: 17.5px;
          font-weight: 700;
          margin-top: 0;

          span {
            display: flex;
            align-items: center;
            align-self: center;
            justify-content: center;
            justify-self: center;
            flex-shrink: 0;
            color: #FFF !important;
            text-align: center;
            font-size: 8px;
            font-weight: 700;
            text-transform: uppercase;
            width: 40px;
            height: 16px;
            flex-shrink: 0;
            border-radius: var(--border-radius-lg);
            margin: 0 0 0 15px;
          }

          .get {
            background: #0e9b71;
            text-shadow: 1px 1px 0 #0d8d67, 0 1px 0 #0d8d67, 1px 0 0 #0d8d67;
          }

          .post {
            background: #0171c2;
            text-shadow: 1px 1px 0 #0168b3, 0 1px 0 #0168b3, 1px 0 0 #0168b3;
          }

          .put {
            background: #674ead;
            text-shadow: 1px 1px 0 #604aa2, 0 1px 0 #604aa2, 1px 0 0 #604aa2;
          }

          .del {
            background: #c71b29;
            text-shadow: 1px 1px 0 #b91926, 0 1px 0 #b91926, 1px 0 0 #b91926;
          }
        }

        p {
          color: #676767;
          font-size: 14px;
          font-weight: 400;
          margin-bottom: 5px;
        }

        .link {
          color: #5F00E7;
          font-size: 14px;
          font-weight: 500;
          line-height: 18px;

          svg {
            fill: #5F00E7;
          }
        }

        .link:hover {
          text-decoration: underline;
        }
      }
    }

    .card:hover {
      border: 1px solid #5F00E7;
      box-shadow: 0px 0px 9.7px 0px rgba(0, 0, 0, 0.21);

      h3 {
        color: #5F00E7;
      }
    }
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .card {
      border: 1px solid #556974;
      background: #242E34;

      .card_content {

        h3,
        p {
          color: #FFF;
        }

        .link {
          color: #842bff;

          svg {
            fill: #842bff;
          }
        }
      }
    }

    [data-color-mode="system"] .card:hover {
      h3 {
        color: #FFF;
      }
    }
  }

  [data-color-mode="dark"] .card {
    border: 1px solid #556974;
    background: #242E34;

    .card_content {

      h3,
      p {
        color: #FFF;
      }

      .link {
        color: #842bff;

        svg {
          fill: #842bff;
        }
      }
    }
  }

  [data-color-mode="dark"] .card:hover {
    h3 {
      color: #FFF;
    }
  }
</style>

<body>
  <div class="card_shelf1">
    <a class="card" href="/reference/authentication">
      <div class="card_content">
        <h3>Authentication</h3>
        <p>Learn how to authenticate your API requests using API keys securely. This page explains the API key security
          schema and provides examples of including your API key in requests.</p>
      </div>
    </a>

    <a class="card" href="/reference/api-response-patterns">
      <div class="card_content">
        <h3>BoomFi's API Response Pattern</h3>
        <p>Learn the API response patterns BoomFi uses, including single-item responses, paginated data, and error
          handling. This page also covers the range of HTTP response codes and how to interpret them in your
          applications.</p>
      </div>
    </a>

  </div>
</body>
`}</HTMLBlock>

## Endpoints Overview

BoomFi’s API is organized into several key areas, each designed to manage specific aspects of your interaction with the platform. Below is an overview of the available endpoint areas:

<HTMLBlock>{`
<body>
  <div class="card_shelf1">
    <a class="card" href="/reference/organization">
      <div class="card_content">
        <h3>Organization</h3>
        <p>Manage your organization’s settings, including retrieving and updating details such as name, logo, and
          webhook configurations.</p>
      </div>
    </a>

    <a class="card" href="/reference/settlement-accounts">
      <div class="card_content">
        <h3>Accounts</h3>
        <p>Retrieve and manage settlement accounts configured for each supported blockchain network within the BoomFi
          platform.</p>
      </div>
    </a>

    <a class="card" href="/reference/paylinks">
      <div class="card_content">
        <h3>Paylinks</h3>
        <p>Create, manage, and modify payment links, including listing all pay links and generating variants with custom
          pricing.</p>
      </div>
    </a>

    <a class="card" href="/reference/payments">
      <div class="card_content">
        <h3>Payments</h3>
        <p>Retrieve and manage payment transactions, including listing all payments and accessing details of specific
          transactions.</p>
      </div>
    </a>

    <a class="card" href="/reference/plans">
      <div class="card_content">
        <h3>Plans</h3>
        <p>Manage subscription plans, including creating, listing, and retrieving details for specific plans.</p>
      </div>
    </a>

    <a class="card" href="/reference/subscriptions">
      <div class="card_content">
        <h3>Subscriptions</h3>
        <p>Retrieve and manage active subscriptions, including listing subscriptions and canceling specific ones.</p>
      </div>
    </a>

    <a class="card" href="/reference/customers">
      <div class="card_content">
        <h3>Customers</h3>
        <p>Manage customer data, including creating, listing, retrieving, and deleting customer records.</p>
      </div>
    </a>

    <a class="card" href="/reference/integrations">
      <div class="card_content">
        <h3>Integrations</h3>
        <p>Access and manage integrations, including enabling, disabling, and setting up webhooks for real-time
          notifications.</p>
      </div>
    </a>

    <a class="card" href="/reference/events">
      <div class="card_content">
        <h3>Events</h3>
        <p>Retrieve a list of events associated with your organization, such as subscription updates and payment
          transactions.</p>
      </div>
    </a>

  </div>
</body>
`}</HTMLBlock>

<br />

<HTMLBlock>{`
<style>
  :root {
    --callout-border: 0;
    --callout-border-radius: 4px;
    --text-color: #000000;

    /* Info Callout Colors */
    --info-light-bg: #DAF8FF;
    --info-light-border: #7CCEDF;
    --info-light-header: #57B3C7;
    --info-light-text: #283652;
    --info-light-link: #57B3C7;
    --info-dark-bg: #DAF8FF;
    --info-dark-border: #7CCEDF;
    --info-dark-header: #57B3C7;
    --info-dark-text: #97B5BC;
    --info-dark-link: #57B3C7;

    /* Okay Callout Colors */
    --okay-light-bg: #DFFFE8;
    --okay-light-border: #116E5F;
    --okay-light-header: #116E5F;
    --okay-light-text: #116E5F;
    --okay-light-link: #61AEA0;
    --okay-dark-bg: #DFFFE8;
    --okay-dark-header: #5BB2A4;
    --okay-dark-text: #7B9792;
    --okay-dark-link: #61AEA0;

    /* Default Callout Colors */
    --default-light-bg: #e8e8e8;
    --default-light-border: #ACACAC;
    --default-light-text: #8A8A8A;
    --default-dark-bg: #e8e8e8;
    --default-dark-text: #FFFFFF;

    /* Warn Callout Colors */
    --warn-light-bg: #fff9c2;
    --warn-light-border: #FFB293;
    --warn-light-header: #FF966B;
    --warn-light-text: #80776C;
    --warn-light-link: #FF966B;
    --warn-dark-bg: #fff9c2;
    --warn-dark-header: #FF966B;
    --warn-dark-text: #989693;
    --warn-dark-link: #FF966B;

    /* Error Callout Colors */
    --error-light-bg: #ffdada;
    --error-light-border: #FA94A6;
    --error-light-header: #FF728B;
    --error-light-text: #B56978;
    --error-light-link: #FF728B;
    --error-dark-bg: #ffdada;
    --error-dark-header: #FF728B;
    --error-dark-text: #C6A5AB;
    --error-dark-link: #FF728B;
  }

  .field-description blockquote,
  .markdown-body blockquote {
    border-left: 0;
  }

  .callout {
    border-radius: var(--callout-border-radius);
    border: var(--callout-border);
  }

  .callout .callout-heading p,
  .callout p,
  .callout ul {
    color: var(--text-color) !important;
  }

  @media (prefers-color-scheme: dark) {

    [data-color-mode="system"] .callout .callout-heading p,
    [data-color-mode="system"] .callout p,
    [data-color-mode="system"] .callout ul {
      color: var(--text-color) !important;
    }
  }

  [data-color-mode="dark"] .callout .callout-heading p,
  [data-color-mode="dark"] .callout p,
  [data-color-mode="dark"] .callout ul {
    color: var(--text-color) !important;
  }

  /* INFO CALLOUT */
  .callout.callout_info {
    background: var(--info-light-bg);
  }

  .callout.callout_info a {
    color: var(--info-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_info {
      background-color: var(--info-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_info a {
      color: var(--info-dark-link) !important;
    }
  }

  [data-color-mode="dark"] .callout.callout_info {
    background-color: var(--info-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_info a {
    color: var(--info-dark-link) !important;
  }

  /* INFO CALLOUT */

  /* OKAY CALLOUT */
  .callout.callout_okay {
    background: var(--okay-light-bg);
  }

  .callout.callout_okay a {
    color: var(--okay-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_okay {
      background-color: var(--okay-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_okay a {
      color: var(--okay-dark-link) !important;
    }
  }

  [data-color-mode="dark"] .callout.callout_okay {
    background-color: var(--okay-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_okay a {
    color: var(--okay-dark-link) !important;
  }

  /* OKAY CALLOUT */

  /* DEFAULT CALLOUT */
  .callout.callout_default {
    background: var(--default-light-bg);
  }

  .callout.callout_default a {
    color: var(--text-color) !important;
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_default {
      background-color: var(--default-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_default a {
      color: var(--text-color) !important;
    }

  }

  [data-color-mode="dark"] .callout.callout_default {
    background-color: var(--default-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_default a {
    color: var(--text-color) !important;
  }

  /* DEFAULT CALLOUT */

  /* WARN CALLOUT */
  .callout.callout_warn {
    background: var(--warn-light-bg);
  }

  .callout.callout_warn a {
    color: var(--warn-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_warn {
      background-color: var(--warn-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_warn a {
      color: var(--warn-dark-link);
    }
  }

  [data-color-mode="dark"] .callout.callout_warn {
    background-color: var(--warn-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_warn a {
    color: var(--warn-dark-link);
  }

  /* WARN CALLOUT */

  /* ERROR CALLOUT */
  .callout.callout_error {
    background: var(--error-light-bg);
  }

  .callout.callout_error a {
    color: var(--error-light-link);
  }

  @media (prefers-color-scheme: dark) {
    [data-color-mode="system"] .callout.callout_error {
      background-color: var(--error-dark-bg) !important;
    }

    [data-color-mode="system"] .callout.callout_error a {
      color: var(--error-dark-link);
    }
  }

  [data-color-mode="dark"] .callout.callout_error {
    background-color: var(--error-dark-bg) !important;
  }

  [data-color-mode="dark"] .callout.callout_error a {
    color: var(--error-dark-link);
  }

  /* ERROR CALLOUT */

  img {
    border-radius: 14px !important;
    box-shadow: 0px 0px 4px rgba(0, 0, 0, 0.15);
  }

  .Sidebar-listWrapper6Q9_yUrG906C.rm-Sidebar-section:nth-child(3),
  .rm-Sidebar-section:nth-child(3), .rm-Sidebar-section:nth-child(4) {
    display: none;
  }

  .Select option {
    color: var(--color-input-text);
  }
</style>
`}</HTMLBlock>