Skip to main content
GET
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
balances
List Balances
curl --request GET \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/balances \
  --header 'Content-Type: <content-type>'
{
  "items": [
    {
      "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
    }
  ],
  "next_cursor": "string",
  "limit": "10"
}

Headers

​
Authorization
string

The authorization token. This header is required if your environment has the Access Manager enabled.

​
Content-Type
string
required

The type of media of the resource. Must be application/json.

​
X-Request-Id
string

A unique identifier used to trace and track each request.

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

Query Parameters

​
limit
string
required

The maximum number of items to include in the response.

​
start_date
string

The beginning of the period you want to retrieve. You must also include the end_date.

​
end_date
string

The end of the period you want to retrieve. You must also include the start_date.

​
sort_order
enum<enum>

The order used to sort the results.

Available options:
asc,
desc
​
cursor
string

The position in a dataset where the next page of results should start.

Response

Indicates that the request was successful and the response contains the expected data.

​
items
object[]
​
next_cursor
string

The position in a dataset of next page of results.

​
limit
integer

The maximum number of items included in the response.