Skip to main content
Retrieve a Balance
curl --request GET \
  --url http://127.0.0.1:3001/v1/organizations/{organization_id}/ledgers/{ledger_id}/balances/{balance_id} \
  --header 'Content-Type: <content-type>'
{
  "id": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "alias": "<string>",
  "assetCode": "<string>",
  "available": 123,
  "onHold": 123,
  "scale": 123,
  "version": 123,
  "accountType": "<string>",
  "allowSending": true,
  "allowReceiving": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

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 <code>application/json</code>.

​
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.

​
balance_id
string
required

The unique identifier of the balance that you want to retrieve.

Response

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

​
id
string

The unique identifier of the Balance.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

The unique identifier of the Ledger.

​
accountId
string<uuid>

The unique identifier of the Account.

​
alias
string

The alias for the account used in the operation.

​
assetCode
string

The name of the asset used in the operation.

​
available
integer

Previous available balance.

​
onHold
integer

Amount on hold/reserved.

​
scale
integer

The number of decimal points used to display the balance.

​
version
integer

Balance version, which is updated with each transaction.

​
accountType
string

The type of account.

​
allowSending
boolean

If true, indicates that sending transactions is permitted.

​
allowReceiving
boolean

If true, indicates that receiving transactions is permitted.

​
createdAt
string<date-time>

Timestamp of creation (UTC).

​
updatedAt
string<date-time>

Timestamp of last update (UTC).

​
deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).