Accounts and money

Retrieve an account balance

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.

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

Path parameters

accountIdstring required

Hyperscale account ID

Query parameters

productIdstring

Hyperscale product ID

Headers

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

Response

Success

accountIdstring required

Hyperscale account ID

asOfstring date-time required

When the balance holds. A sandbox Product account uses its Product's clock, which can run ahead of wall time.

observedAtstring date-time required

Wall time of the read.

availablestring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

creditsPendingstring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

creditsPostedstring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

currency'SAR' required
debitsPendingstring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

debitsPostedstring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

environment'sandbox' | 'live' required
normalBalance'debit' | 'credit' required
pendingstring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

settledstring required

Non-negative minor-unit integer amount serialized as a string (at most 18 digits)

tenantIdstring required

Organization tenant ID

productIdstring

Hyperscale product ID

Changes

No recorded changes to this operation across all 1 revision of this API.