Skip to main content
GET
Gets all subledger account balances

Authorizations

Authorization
string
header
required

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

FlowClient Credentials
Token URL
https://api-sandbox.orum.io/oauth/token
Scopes1
read:balances
Read balances

Headers

Orum-Version
enum<string>
required

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

Available options:
v2022-09-21

Query Parameters

index
integer
default:0

Index for paginated results

Required range: x >= 0
size
integer
default:100

Max number of results to return

Required range: 0 <= x <= 500

Response

The requested subledger account balance

balances
SubledgerBalance · object[]
required

List of balance objects.