Skip to main content
GET
Get prepaid credit balance

Authorizations

x-api-key
string
header
required

Response

Current credit balance

balance_cents
integer<int64>
required
Example:

45000

transfer_capacity_cents
integer<int64>
required
Example:

9000000

health
enum<string>

Server-owned balance health. Computed live from the same snapshot as percent_remaining, so the two can never disagree. Clients MUST render this rather than deriving bands themselves; treat an unrecognised value as healthy.

Available options:
healthy,
low,
critical,
empty
Example:

"healthy"

balance_baseline_cents
integer<int64>

Denominator for percent_remaining: the balance at the client's most recent deliberate top-up, ratcheted upward by any incidental credit since. 0 means no baseline and must never be used as a divisor.

Example:

100000

percent_remaining
integer

balance_cents as a whole percentage of balance_baseline_cents, floored. Omitted when balance_baseline_cents is 0.

Example:

45

low_at_transfer_capacity_cents
integer<int64>

Transfer volume at which health becomes low — the capacity of the largest balance that still classifies low. Omitted when balance_baseline_cents is 0.

Example:

8000000

min_next_transfer_fee_cents
integer<int64>

Cheapest total fee any configured rail can charge. Below this, rail transfers are held.

Example:

51

transfer_fee_bps
number<float>

The client's transfer fee rate, so callers stop hardcoding 0.25%.

Example:

25