Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
balances
/
{balance_id}
/
history
Consultar histórico de saldo
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id}/history \
  --header 'Authorization: Bearer <token>'
{ "id": "019c96a0-0c0d-7915-84b9-e497bfee9916", "organizationId": "019c96a0-0a98-7287-9a31-786e0809c769", "ledgerId": "019c96a0-0ac0-7de9-9f53-9cf842a2ee5a", "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081", "alias": "@conta_corrente", "key": "default", "assetCode": "BRL", "available": 150000, "onHold": 25000, "version": 42, "accountType": "deposit", "createdAt": "2025-06-01T10:00:00Z", "updatedAt": "2026-01-15T10:30:00Z" }

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver Access Manager habilitado.

Content-Type
string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Parâmetros de caminho

organization_id
string
obrigatório

O identificador único da Organização associada ao Ledger.

ledger_id
string
obrigatório

O identificador único do Ledger associado.

balance_id
string
obrigatório

O identificador único do saldo que você deseja consultar.

Parâmetros de consulta

date
string
obrigatório

A data e hora para consultar o estado do saldo. Formato: yyyy-mm-dd hh:mm:ss (ex.: 2026-01-15 10:30:00).

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém o estado do saldo no momento especificado.

O estado de um saldo em um momento específico no passado. Não inclui os campos allowSending e allowReceiving.

id
string<uuid>

O identificador único do Saldo.

organizationId
string<uuid>

O identificador único da Organização.

ledgerId
string<uuid>

O identificador único do Ledger.

accountId
string<uuid>

O identificador único da Conta.

alias
string

O alias da conta (ex., @conta_corrente).

key
string

A chave única do saldo no contexto da conta (ex., default, asset-freeze).

assetCode
string

O código do ativo (ex., BRL, USD).

available
integer

O saldo disponível no momento consultado.

onHold
integer

O saldo retido (reservado) no momento consultado.

version
integer

A versão do saldo no momento consultado.

accountType
string

O tipo da conta (ex., deposit, creditCard).

createdAt
string<date-time>

Timestamp de criação do saldo (UTC).

updatedAt
string<date-time>

Timestamp da última atualização no momento consultado (UTC).