---
title: "Get Account Balance"
method: GET
path: "/za/pb/v1/accounts/{accountId}/balance"
tags: ["Account information"]
---

# Get Account Balance

`GET /za/pb/v1/accounts/{accountId}/balance`

Obtain a specified account's balance.

## Path parameters

- `accountId` string, required

## Response `200`

Resource has been retrieved

- object
  - `data` object, required — Set of elements used to define the balance details.
    - `accountId` string, required — A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner.
    - `currentBalance` number, double, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
    - `availableBalance` number, double, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
    - `budgetBalance` number, double, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
    - `straightBalance` number, double, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
    - `cashBalance` number, double, required — A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217.
    - `currency` string, required — A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".
  - `links` object, required — Links relevant to the payload
    - `self` string, required
  - `meta` object, required — Meta Data relevant to the payload
    - `totalPages` integer

## Other responses

- `400` — Bad Request - The requested operation will not be carried out
- `401` — Unauthorized - The requested operation was refused access
- `403` — Forbidden - Not permitted to make this request
- `429` — Too Many Requests - To many requests in quick succession, Retry the request.
- `500` — Internal Server Error - The requested operation failed to execute

---

[API](https://skmtc.net/rijnhardtkotze/apis/sa-pb-account-information.md) · [All operations](https://skmtc.net/rijnhardtkotze/apis/sa-pb-account-information/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rijnhardtkotze/sa-pb-account-information/revisions/1ab926851d29/schema)
