API Reference
Sign UpLog In

Subaccount Management

With Brick’s Subaccount feature, you can manage multiple operational entities—such as clients or business units—under a single Brick account. Each subaccount operates independently, with its own balance, transaction history, and API credentials. This is especially useful for businesses that serve multiple clients or operate across multiple locations.

Who should use Subaccount?

1. Businesses Managing Multiple Clients and Multi-Location

Subaccounts are designed for businesses managing multiple entities or operating across various branches, franchises, or brands. They allow you to keep data isolated and secure for each entity, streamline transaction reconciliation, generate entity-level reports without data overlap, configure API keys and callback URLs per subaccount, and maintain centralized oversight while ensuring operations remain clearly segmented. 🚀

How to create a subaccount?

  1. Go to the Settings page in your Brick Dashboard (located at the bottom of the sidebar)
  2. Select the Sub-Account tab
  3. Click the Add Sub-Account button and follow the guided form

Once created, you can switch between the main account and subaccounts via the dropdown in the top-left corner of the dashboard.

Subaccount Specifications

  • Each subaccount has its own:
    • Balance
    • Top-up VA number
    • Transaction history
    • API credentials
  • Subaccounts are logically and operationally separated
  • Switching views in the dashboard changes the context: data shown belongs only to the active account
  • All users within your Brick organization have access to all subaccounts
  • Currently, subaccounts are only manageable via the dashboard (API access coming soon)

Subaccount Types

  1. Full-Access Subaccount

    1. Can have its own API credentials (client ID and secret)
    2. Can activate its API key after completing KYB verification
    3. API key status (active/inactive) is controlled by the main account

  2. Ledger-Only Subaccount

    1. Created by default
    2. Cannot use APIs directly but can perform transactions via the dashboard

API Integration: Subaccount Example

Let’s say you're a payroll company managing 3 clients: Company A, Company B, and Company C. Here’s how you’d set it up with Brick:

  1. Create one subaccount for each client from the dashboard.
  2. For each subaccount, switch to it using the top-left dropdown, then:
    1. Go to Configuration → API Credentials and note the client_id and client_secret
    2. Set your Callback URL under the Callback URL tab (e.g., Disbursement Callback URL), then click Save
  3. Repeat step 2 for all subaccounts
  4. In your backend system:
    1. Pair each subaccount’s credentials with the corresponding client profile
    2. Use the assigned credentials when calling Brick APIs per client
  5. For each subaccount, top up their balance individually:
    1. Each has a separate virtual account number
    2. You’ll need to top up balances separately in Live Mode
    3. In Testing Mode, use the Add Test Balance button on each subaccount homepage to simulate funds

Subaccounts make scaling your operations more modular, auditable, and secure—without complicating your infrastructure.