Brick API Documentation
Brick API

Topup

Server

Review available top-up options and top-up history for funding Brick balance. These endpoints help operations teams prepare funds before running disbursement workflows.


Get List of Available Top Up Options

GET
https://sandbox.onebrick.io
/v2/payments/gs/top-up/bank/list
publicAccessToken (header)

Retrieve the available bank transfer options for topping up your Brick balance. Use this endpoint before funding Send Money workflows so finance or operations users know which destination bank, account number, and instructions to use. The response can be shown in an internal dashboard or used to guide balance funding before payout batches.

Get List of Available Top Up Options › query Parameters

email
​string · required

Your company's email account registered during registration process

Get List of Available Top Up Options › Responses

200

status
​integer
Default: 0
​object
​object
error
​

Get Topup History

GET
https://sandbox.onebrick.io
/v2/payments/gs/get-top-up-history
publicAccessToken (header)

Retrieve historical top-up records for a selected period so your team can reconcile balance funding activity. Use the response to match bank transfers, operational funding events, and Brick balance movements. This endpoint is useful for finance dashboards, audit checks, and support investigations when disbursement funds do not match expectations.

Get Topup History › query Parameters

type
​string

If type set as topup will filter only topup transactions

Default: topup

Get Topup History › Responses

200

status
​integer
Default: 0
​object
​object
error
​

Create Manual Transfer Top Up

POST
https://sandbox.onebrick.io
/v2/payments/acceptance/top-up/unique-code
publicAccessToken (header)

Create a manual bank-transfer top-up and receive the unique transfer code and expiry time. Transfer the returned totalAmount to the selected destination bank before the top-up expires.

Create Manual Transfer Top Up › Request Body

amount
​number · required

Top-up amount before the unique code is added.

bankDestination
​string · required

Destination bank for the manual transfer.

Create Manual Transfer Top Up › Responses

Manual transfer top-up created.

status
​integer
​object
hashcode
​string

Confirm Manual Transfer Top Up

POST
https://sandbox.onebrick.io
/v2/payments/acceptance/top-up/unique-code/confirmation
publicAccessToken (header)

Submit the manual transfer details and proof of transfer for a previously created top-up. The response indicates whether the transfer was automatically verified and approved.

Confirm Manual Transfer Top Up › Request Body

refId
​string · required

Reference ID returned when the manual transfer top-up was created.

transferDate
​string · required

Date and time of the bank transfer in YYYY-MM-DD HH:mm:ss format.

transferProof
​string · binary · required

Image file containing the transfer proof.

Confirm Manual Transfer Top Up › Responses

200

Manual transfer confirmation processed.

status
​integer
​object
hashcode
​string