Brick API Documentation
Introduction

Meet BrickI - Your Integration & Support Assistant

BrickI, short for Brick Integration Assistant, is an AI-powered virtual assistant that helps Brick clients with integration, transaction monitoring, and service-related questions from supported messaging platforms.

Mention @BrickI in your message and BrickI responds with contextual information to help you use Brick products, review transaction information, and find the right documentation path faster.

What BrickI Helps With

BrickI is designed as a frontline technical assistant for common integration and operational questions.

CapabilityHow BrickI helps
API integration guidanceExplains endpoints, parameters, request formats, response structures, common errors, and relevant documentation links.
Transaction status checksRetrieves live status using a transaction ID, reference ID, or provider ID and explains whether the transaction is successful, failed, or pending.
Historical transaction analysisProvides transaction insights based on time range, amount, destination bank, and product type.
General product guidanceAnswers operational questions and points you to the right Brick dashboard or documentation flow.

Example Questions

Use clear product, transaction, or time-range context when asking BrickI a question.

TopicExample question
API integration guidance@BrickI, what is the difference between regular and BI-FAST disbursement API?
API integration guidance@BrickI, how can I use Brick's QR Code?
Transaction status checks@BrickI, what is the status of transaction ID XXXXXX?
Transaction status checks@BrickI, is transaction ID XXXXXX still processing?
Historical transaction analysis@BrickI, how many transactions happened yesterday?
Historical transaction analysis@BrickI, what was the most common disbursement destination last week?
General product guidance@BrickI, how can I enable Virtual Account services?
General product guidance@BrickI, what is the process to switch to production credentials?

Limitations

BrickI provides real-time support and read-only insight, but it cannot perform every support action.

  • BrickI can only answer transaction inquiries for main account transactions. Subaccount transaction inquiries are not supported yet.
  • BrickI cannot update API credentials, routing settings, user permissions, or other account configuration.
  • BrickI cannot access or modify sensitive data such as balances, credentials, or personal user information.
  • BrickI does not support media attachments, file uploads, or screenshots.
  • BrickI provides guidance and insight only. Actions must still be completed through the dashboard or the appropriate support channel.

For configuration changes, account updates, or escalation requests, BrickI will guide you to the appropriate team, dashboard section, or support path.

How To Use BrickI

  1. Open a supported messaging channel.
  2. Start your message with @BrickI.
  3. Add the product, transaction identifier, time range, or action you need help with.

Examples:

  • @BrickI, check transaction 9381828391
  • @BrickI, how do I activate Closed VA?
  • @BrickI, how many disbursement transactions happened last month?

BrickI responds with the relevant information or step-by-step guidance.

Why Use BrickI

BenefitWhat it means
Instant responsesGet guidance without waiting in a ticket queue.
24/7 availabilityAsk operational and integration questions whenever you need support.
Reliable contextUse an assistant connected to Brick documentation and operational context.
Faster support flowReduce back-and-forth when finding the right product, API, or dashboard path.

Activation

Access to BrickI may depend on your client tier or onboarding status. If you do not have access yet and want to enable BrickI for your account, contact your Account Manager or submit a request through the client portal.

Last modified on