How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orum Balance API

The Balance API from Orum — 3 operation(s) for balance.

Orum Balance API is one of 17 APIs that Orum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Balances. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version v2022-09-21.

Requests are made against 2 base URLs: https://api-sandbox.orum.io, https://vault.api-sandbox.orum.io.

3 operations 3 paths 9 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2022-09-21
Base URL
https://api.orum.io
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Orum Balance API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Balance 3
GET
/deliver/balance
Get balance
get-balance 1 param → 200401default
GET
/deliver/balance/subledgers/{id}
Get subledger account balance
get-subledger-balance 2 params → 200401default
GET
/deliver/balance/subledgers
Gets all subledger account balances
get-all-subledger-balance 3 params → 200401default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are SubledgerBalance (6 properties), Balance (4 properties), ErrorResponse (3 properties), BalanceResponse (2 properties). Each schema is shown below with its type and property counts.

SubledgerBalanceResponse
object
1 property 1 required
Currency
string
Currency code in ISO 4217 format. Only USD is supported.
Balance
object
4 properties 4 required
BalanceResponse
object
2 properties 2 required
SubledgerBalancesResponse
object
1 property 1 required
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
ErrorResponse
object
3 properties 2 required
UpdatedAt
string
Timestamp when the resource was last updated.
SubledgerBalance
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-balance-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
Orum Book Transfers API
Orum Businesses API
Orum Cards API
Orum Configure webhooks API
Orum Eligibility API
Orum External Accounts API
Orum Persons API
Orum Reports API
Orum Schedules API
Orum Secure webhooks API
Orum Subledgers API
Where this information came from

This is an independent, third-party profile of Orum Balance API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.