Skip to content
GitmoapAPIBeta
Schema

NamespaceBalance

An organization's balance: what it has paid in advance, what calls in flight hold, and what can still be reserved.

Shape

  • available_microsinteger · int64What can still be reserved: the balance, less what is reserved, plus any overdraft.
  • balance_microsinteger · int64Top-ups less settled charges, refunds and chargebacks, in micro-dollars.
  • frozenbooleanWhether a disputed payment has frozen the balance.
  • group_idGroupId (string · uuid)
  • low_threshold_microsinteger · int64
  • reserved_microsinteger · int64Held by calls in flight.

Example

Synthesized example
{
"available_micros": 17,
"balance_micros": 49,
"frozen": false,
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"low_threshold_micros": 58,
"reserved_micros": 73
}

Graph

Used inside

No schema contains this one.

Contains

No named schema inside.

Used by

Sent by 0 operations

No operation takes it as a request body.