Get List of Available Top Up Options

Allows you to retrieve list of available top up options through API integration.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint returns the available bank top-up options for your registered company account.

Use it before displaying top-up instructions to an operator or customer. The response includes the supported bank names, bank short codes, and VA numbers that can be used to top up your Brick balance.

How to Use It

  1. Generate a new public access token.
  2. Send the registered company email in the query parameter.
  3. Display the returned top-up options in your dashboard or internal tool.
  4. Use Get Balance or Get Top Up History to reconcile balance movement after payment.

Response Data

FieldDescription
bankNameFull bank name.
bankShortCodeBrick bank short code.
vaNumberVirtual account number used for balance top-up.
Query Params
string
required

Your company's email account registered during registration process

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json