Top Up Balance
Get Topup History
Use this endpoint to retrieve top-up history and reconcile balance movements in your Brick account.
The response includes top-up references, bank destination information, dates, amounts, and transaction metadata. Use it together with the balance endpoint to confirm whether a top-up has been reflected in your account.
When to Use This Endpoint
- Reconcile balance after a bank transfer top-up.
- Display top-up activity in an internal dashboard.
- Investigate missing or delayed balance movement.
Filtering
Use the optional type query parameter when you need to filter the response to top-up transactions only.
Request parameters
| Key Parameters | Data Type | Description |
|---|---|---|
| publicAccessToken | String | One time access-token generated using the auth token API |
Response parameters
| Key Parameters | Data type | Description |
|---|---|---|
| refNumber | String | Generate reference number for Top-up |
| bank | Number | Top-up bank destination |
| date | String | Date of Topup settle |
| amount | String | The amount of Top-up |
| transactionType | String | Indicates the transaction type, including virtual account and top-up transactions |
| accountNo | String | Top-up account number |
| accountDisplayName | String | Account display name of Top-up account |
Last modified on