Get Balances using Alias

Returns the current balance state. When that state cannot be read, the request answers 503 (0542) and may be retried.

GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances

Get Balances using Alias

cURL

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/alias/{alias}/balances \
  --header 'Authorization: Bearer <token>'

200

{
  "items": "<unknown>",
  "limit": 10,
  "next_cursor": "eyJpZCI6IjAxOTI...",
  "page": 1,
  "prev_cursor": "eyJpZCI6IjAxOTE..."
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

organization_id · string · required

Organization ID (UUID)

ledger_id · string · required

Ledger ID (UUID)

alias · string · required

Alias (e.g. @person1)

Response

200

application/json

OK

items · any · required

limit · integer<int64> · required

Example:

10

next_cursor · string

Example:

"eyJpZCI6IjAxOTI..."

page · integer<int64>

Example:

1

prev_cursor · string

Example:

"eyJpZCI6IjAxOTE..."