Consultar Saldos por Alias de Conta

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "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": "customer-brl-1",
      "key": "default",
      "assetCode": "BRL",
      "available": "1000",
      "onHold": "0",
      "version": 1,
      "accountType": "deposit",
      "allowSending": true,
      "allowReceiving": true,
      "direction": "credit",
      "overdraftUsed": "0",
      "settings": null,
      "position": {
        "available": "1000",
        "onHold": "0",
        "overdraftLimitAvailable": "0"
      },
      "createdAt": "2026-02-25T21:06:37.197596Z",
      "updatedAt": "2026-02-25T21:06:38.420934Z",
      "deletedAt": null
    }
  ],
  "limit": 10
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

accounts

alias

{alias}

balances

Consultar Saldos por Alias de Conta

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "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": "customer-brl-1",
      "key": "default",
      "assetCode": "BRL",
      "available": "1000",
      "onHold": "0",
      "version": 1,
      "accountType": "deposit",
      "allowSending": true,
      "allowReceiving": true,
      "direction": "credit",
      "overdraftUsed": "0",
      "settings": null,
      "position": {
        "available": "1000",
        "onHold": "0",
        "overdraftLimitAvailable": "0"
      },
      "createdAt": "2026-02-25T21:06:37.197596Z",
      "updatedAt": "2026-02-25T21:06:38.420934Z",
      "deletedAt": null
    }
  ],
  "limit": 10
}

Cabeçalhos

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.

Authorization

string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

organization_id

string<uuid>

obrigatório

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

ledger_id

string<uuid>

obrigatório

O identificador único do Ledger associado.

alias

string

obrigatório

O alias da conta utilizada na operação.

Resposta

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

items

object[]

Show child attributes

limit

integer

O número máximo de itens incluídos na resposta.

Consultar Saldos por Conta

Consultar o Saldo de uma Conta Externa

⌘I