get https://{environment}.onebrick.io/v2/payments/gs/balance
This API enable you to check current balance of Brick Pay, Brick Flex & Total Available Balance
Environment for End Point URL
Please Replace the environment in the URL with:
When the environtment is sandbox, replace the {environment} with sandbox. so the URL will be https://sandbox.onebrick.io/v2/payments/gs
When the environment is production, replace the {environment} with api. so the URL will be 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 |
|---|---|---|
| brickPay Balance | Number | Current Balance of Brick Pay. Lowest amount is 0. Value Always positive. |
| brickFlex Balance | Number | Current Balance of Brick Pay. Lowest amount is 0. Value Always positive. |
| totalAvailableBalance | Number | The total of brickPay Balance + brickFlex Balance. All balance that available & can be used. |