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:
-
Join the Merchant Dashboard: Sign up and maintain an active account on the BoomFi dashboard. This is your central hub for managing your organization's interactions with the BoomFi platform.
-
Set Up Your Settlement Account: Configure your settlement account to handle payments. This step is crucial for enabling your organization to receive payouts seamlessly.
-
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:
Authentication
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.
BoomFi's API Response Pattern
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.
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:
Organization
Manage your organization’s settings, including retrieving and updating details such as name, logo, and webhook configurations.
Accounts
Retrieve and manage settlement accounts configured for each supported blockchain network within the BoomFi platform.
Paylinks
Create, manage, and modify payment links, including listing all pay links and generating variants with custom pricing.
Payments
Retrieve and manage payment transactions, including listing all payments and accessing details of specific transactions.
Plans
Manage subscription plans, including creating, listing, and retrieving details for specific plans.
Subscriptions
Retrieve and manage active subscriptions, including listing subscriptions and canceling specific ones.
Customers
Manage customer data, including creating, listing, retrieving, and deleting customer records.
Integrations
Access and manage integrations, including enabling, disabling, and setting up webhooks for real-time notifications.
Events
Retrieve a list of events associated with your organization, such as subscription updates and payment transactions.