POST /account/web/get_total_balance

Retrieve the combined balance across all active accounts in your business via the Dashboard API. Returns a single aggregated total amount.

Use this endpoint to get a single consolidated figure representing the sum of balances across all active accounts in your business. This is useful for high-level treasury views or dashboard widgets that display your total available funds without listing individual accounts.

Endpoint

POST /api/v1/account/web/get_total_balance

Authentication

Include your JWT access token in the Authorization header.

Authorization: Bearer <access_token>

Obtain a token via POST /auth/web/login.

Request body

This endpoint does not require a request body. You can send an empty JSON object or omit the body entirely.

Example request

curl --request POST \
  --url https://baasapi.payrepmfb.com/api/v1/account/web/get_total_balance \
  --header "Authorization: Bearer <access_token>" \
  --header "Content-Type: application/json"

Response

A successful request returns a single object with the aggregated balance.

status · boolean

true when the request succeeds.

response_code · string

"00" on success.

data · object

The total balance object.

Show data fields

total_balance · string

The sum of balances across all active accounts, expressed as a decimal string (e.g., "1750000.00").

{
  "status": true,
  "response_code": "00",
  "message": "Total balance fetched successfully",
  "data": {
    "total_balance": "1750000.00"
  }
}

Error codes

Response code	Meaning
41	Customer not found — your session credentials are invalid.