Skip to main content
GET
/
deliver
/
balance
/
subledgers
/
{id}
Get subledger account balance
curl --request GET \
  --url https://api-sandbox.orum.io/deliver/balance/subledgers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'
{
  "balance": {
    "subledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pending": 123,
    "available": 123,
    "currency": "USD",
    "updated_at": "2023-11-07T05:31:56Z",
    "subledger_reference_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.orum.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Path Parameters

​
id
string<uuid>
required

Response

The requested subledger account balance

​
balance
SubledgerBalance · object
required