Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
accounts
/
{account_id}
/
balances
Consultar Saldos por Conta
curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/balances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>'
{ "id": "string", "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9", "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7", "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9", "alias": "string", "key": "string", "assetCode": "string", "available": "1000.00", "onHold": "50.00", "version": 0, "accountType": "string", "allowSending": true, "allowReceiving": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "deletedAt": null }

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser 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.

account_id
string
obrigatório

O identificador único da conta da qual você deseja consultar os saldos.

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

id
string

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 utilizada na operação.

key
string

O identificador único do saldo no contexto da conta.

assetCode
string

O nome do ativo utilizado na operação.

available
string

Previous available balance.

onHold
string

Amount on hold/reserved.

version
integer

Versão do saldo, que é atualizada a cada transação.

accountType
string

O tipo da conta.

allowSending
boolean

Se verdadeiro, indica que o saldo pode ser usado para enviar transações.

allowReceiving
boolean

Se verdadeiro, indica que o saldo pode ser usado para receber transações.

createdAt
string<date-time>

Data e hora de criação (UTC).

updatedAt
string<date-time>

Data e hora da última atualização (UTC).

deletedAt
string<date-time> | null

Data e hora da exclusão lógica, se aplicável (UTC).

metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.