Listar Saldos

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

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/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}/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}/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}/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}/balances")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/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
    }
  ],
  "next_cursor": "eyJpZCI6IjAxOWM5NmEwLTBjMGQtNzkxNS04NGI5LWU0OTdiZmVlOTkxNiIsInBvaW50c19uZXh0Ijp0cnVlfQ==",
  "prev_cursor": "eyJpZCI6IjAxOWM5NmEwLTBjMGQtNzkxNS04NGI5LWU0OTdiZmVlOTkxNiIsInBvaW50c19uZXh0IjpmYWxzZX0=",
  "limit": 10
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

balances

Listar Saldos

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

import requests

url = "https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/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}/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}/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}/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}/balances")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/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
    }
  ],
  "next_cursor": "eyJpZCI6IjAxOWM5NmEwLTBjMGQtNzkxNS04NGI5LWU0OTdiZmVlOTkxNiIsInBvaW50c19uZXh0Ijp0cnVlfQ==",
  "prev_cursor": "eyJpZCI6IjAxOWM5NmEwLTBjMGQtNzkxNS04NGI5LWU0OTdiZmVlOTkxNiIsInBvaW50c19uZXh0IjpmYWxzZX0=",
  "limit": 10
}

Encabezados

Content-Type

string

El tipo de medio del recurso. El valor recomendado es application/json.

X-Request-Id

string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization

string

Token JWT bearer para autenticación. Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino). Opcional en el modo OSS de inquilino único predeterminado. Formato: Bearer <token>

Parámetros de ruta

organization_id

string<uuid>

requerido

El identificador único de la Organización asociada al Ledger.

ledger_id

string<uuid>

requerido

El identificador único del Ledger asociado.

Parámetros de consulta

limit

integer

predeterminado:10

El número máximo de elementos a incluir en la respuesta.

Rango requerido: 1 <= x <= 100

start_date

string

El inicio del período que desea recuperar. start_date y end_date son todo o nada: proporcionar solo uno devuelve 400. Si se omiten ambos, se utiliza una ventana predeterminada del último 1 mes.

end_date

string

El final del período que desea recuperar. start_date y end_date son todo o nada: proporcionar solo uno devuelve 400. Si se omiten ambos, se utiliza una ventana predeterminada del último 1 mes.

sort_order

enum<string>

predeterminado:asc

El orden utilizado para ordenar los resultados.

Opciones disponibles:

asc,

desc

cursor

string

Un token de cursor codificado de una respuesta anterior (next_cursor o prev_cursor) para navegar hacia adelante o hacia atrás en los resultados.

Respuesta

Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.

items

object[]

Show child attributes

next_cursor

string

Cursor codificado que apunta a la siguiente página de resultados.

prev_cursor

string

Cursor codificado que apunta a la página anterior de resultados.

limit

integer

El número máximo de elementos incluidos en la respuesta.

Crear un Saldo

Recuperar un Saldo

⌘I