Retrieve Balance History
Use this endpoint to retrieve the state of a specific balance at a given point in time (point-in-time query).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The authorization token. This header is required if your environment has Access Manager enabled.
The type of media of the resource. Recommended value is application/json.
A unique identifier used to trace and track each request.
Path Parameters
The unique identifier of the Organization associated with the Ledger.
The unique identifier of the associated Ledger.
The unique identifier of the balance that you want to retrieve.
Query Parameters
The date and time to query the balance state. Format: yyyy-mm-dd hh:mm:ss (e.g., 2026-01-15 10:30:00).
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$Response
Indicates that the request was successful and the response contains the balance state at the specified point in time.
The state of a balance at a specific point in time. Does not include allowSending and allowReceiving fields.
The unique identifier of the Balance.
The unique identifier of the Organization.
The unique identifier of the Ledger.
The unique identifier of the Account.
The alias for the account (e.g., @conta_corrente).
The unique key for the balance in the context of the account (e.g., default, asset-freeze).
The code of the asset (e.g., BRL, USD).
The available balance at the queried point in time.
The on-hold (reserved) balance at the queried point in time.
The balance version at the queried point in time.
The type of the account (e.g., deposit, creditCard).
Timestamp of balance creation (UTC).
Timestamp of last update at the queried point in time (UTC).