Brick API Documentation
Brick API

Balance

Server

Check available Brick balance before creating disbursements, processing payouts, or reconciling operational funds. Balance checks help finance and product systems prevent insufficient-fund failures.


Get Balance API

GET
https://sandbox.onebrick.io
/v2/payments/gs/balance
publicAccessToken (header)

Check the latest available Brick account balance before creating payouts or running scheduled disbursement jobs. Use this endpoint as a guardrail to prevent insufficient-fund failures and to show current operational funds in internal tools. The response should be reconciled with top-up history and ledger records when investigating balance changes.

Get Balance API › Responses

200

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