Skip to main content
GET
Get a balance

Authorizations

Authorization
string
header
required

Your Jenzy API key: Authorization: Bearer jz_live_…

Headers

HERMES-ORG
string<uuid>

The id of one of your Child orgs. The call then acts on that Child org, not on your organization. If you do not send it, the call acts on your organization. An id that is not one of your Child orgs gives 404.

Example:

"3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10"

Path Parameters

asset
string
required

An asset code as GET /v2/assets lists it — uppercase, never compound (USDC, USD; never USDC-ETHEREUM). Network and rail live on the payment object.

Minimum string length: 1
Example:

"USDC"

Response

The balance.

asset
string
required

An asset code as GET /v2/assets lists it — uppercase, never compound (USDC, USD; never USDC-ETHEREUM). Network and rail live on the payment object.

Minimum string length: 1
Example:

"USDC"

available
string
required

What you can spend in this asset, as an exact decimal string at the asset’s decimals.

Example:

"1250000.00"

held
string
required

Reserved by in-flight payouts in this asset, as an exact decimal string.

Example:

"50000.00"

shortfall
string
required

Still owed on fees already incurred in this asset. Normally zero; the next collection in this asset covers it before adding to available.

Example:

"0.00"