API Reference

Overview

The BoomFi Partners API is a powerful tool designed for BoomFi's strategic partners, enabling them to manage sub-accounts and virtual accounts and facilitate transactions securely. This API provides advanced functionality, allowing partners to oversee and precisely control financial operations.

👍

Authentication

Refer to the Authentication page to learn how BoomFi uses a header-based authentication mechanism to ensure all requests are authorized and tamper-proof.

Key Features

  • Sub-account Management: Create, update, and retrieve details about sub-accounts and sub-merchants.
  • Virtual Accounts: Manage crypto assets and transactions through secure virtual accounts.
  • Payment Operations: Enable seamless pay-in and pay-out capabilities.
  • Secure Authentication: Ensure message integrity through robust authentication mechanisms.

Endpoints

The BoomFi Partners API provides the following endpoints for managing accounts and transactions:

Create Virtual Account POST

Set up a virtual account with managed crypto wallets across supported networks. Ideal for streamlining crypto asset management within complex account hierarchies.

Endpoint

Get Account by Reference GET

Retrieve details for a specific account using its reference. This includes account status and associated metadata, useful for verifying account existence.

Endpoint

List Account Balances by Reference GET

Retrieve the balances associated with a specific account. Includes details on available funds, locked funds, and asset types for monitoring liquidity and financial activity.

Endpoint

Create a Permanant Pay-in Wallet POST

Generate a permanent deposit wallet for account pay-ins. Funds deposited to this wallet are automatically swept into the main account for seamless aggregation.

Endpoint

Payout to a Crypto Wallet Address POST

Execute a payout to a specified crypto wallet address. Facilitates outbound payments in supported cryptocurrencies with secure tracking and transaction integrity.

Endpoint