Skip to main content
GET
Get a balance

Authorizations

Authorization
string
header
required

Your Jenzy API key: Authorization: Bearer jz_live_…

Path Parameters

asset
string
required

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

Minimum string length: 1
Example:

"KES"

Response

The balance.

asset
string
required

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

Minimum string length: 1
Example:

"KES"

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"