Topup & Balance
Get Balance API
This API enable you to check your current balance.
🚧 API Documentation Update – Effective 10 June 2025
This document replaces the previous version, which will be officially deprecated starting 10 June 2025.
🔄 Key Changes:
- brickFlex section has been removed from the response.
- brickPay is now separated into:
- usableBalance
- pendingBalance
- Same Day Settlement (SDS) information is now included in the response.
Please ensure your integration is updated accordingly. Let us know if you need support with the transition.
📘 Environment for End Point URL
- Sandbox: https://sandbox.onebrick.io/v2/payments/gs
- Production: https://api.onebrick.io/v2/payments/gs
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 |
|---|---|---|
| balance | Object | Contains key fields related to your account balance: usableBalance, pendingBalance, and totalBalance. |
| usableBalance | Number | The available balance that can be used immediately for transactions. Always ≥ 0. |
| pendingBalance | Number | Funds that have been received but are still pending settlement. Always ≥ 0. |
| totalBalance | Number | The sum of usableBalance and pendingBalance. |
| sameDaySettlement | Object | Describes your Same Day Settlement (SDS) settings. Includes isActive and earlySettlementBalanceQuota. |
| isActive | Boolean | Indicates whether Same Day Settlement is currently active for your account. |
| earlySettlementBalanceQuota | Number | The amount of balance (in your local currency) available for same-day settlement usage today. Always ≥ 0. |
Last modified on