---
title: "Retrieve an account balance"
method: GET
path: "/v1/accounts/{accountId}/balance"
tags: ["Accounts and money"]
---

# Retrieve an account balance

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

## Request

- Base URL: `https://hyperscale0.ai`
- URL: `https://hyperscale0.ai/v1/accounts/{accountId}/balance`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Reads the account's live posted and pending counters from the ledger and returns settled and available balances without persisting balance truth outside the ledger.

## Path parameters

- `accountId` string, required: Hyperscale account ID

## Query parameters

- `productId` string: Hyperscale product ID

## Headers

- `X-Hyperscale-Environment` 'sandbox' | 'live'

## Response `200`

Success

- AccountBalanceRetrieveOutput
  - `accountId` string, required: Hyperscale account ID
  - `asOf` string, date-time, required: When the balance holds. A sandbox Product account uses its Product's clock, which can run ahead of wall time.
  - `observedAt` string, date-time, required: Wall time of the read.
  - `available` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `creditsPending` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `creditsPosted` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `currency` 'SAR', required
  - `debitsPending` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `debitsPosted` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `environment` 'sandbox' | 'live', required
  - `normalBalance` 'debit' | 'credit', required
  - `pending` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `settled` string, required: Non-negative minor-unit integer amount serialized as a string (at most 18 digits)
  - `tenantId` string, required: Organization tenant ID
  - `productId` string: Hyperscale product ID

## Other responses

- `default`: ErrorResponse. See x-error-codes and x-errors for codes, HTTP statuses and retry guidance.

---

[API](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api.md) · [All operations](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hyperscale0/apis/hyperscale-product-api/revisions/e9e8faa044d5?raw)