Skip to main content
GET
Retrieve card-account balances

Authorizations

x-api-key
string
header
required

Enter your API key

Response

availableCredit
object
required

Credit currently available for card spending, floored at zero.

totalCreditLimit
object
required

Total credit limit assigned to the card account, floored at zero.

outstandingBalance
object
required

Balance currently outstanding on the card account.

pendingAmount
object
required

Repayments currently pending for the card account. Uses the repayment-summary currency when present, which may differ from the budget currency; otherwise uses the budget currency.

allocatedCredit
object
required

Credit allocated to cards and sub-budgets.

unallocatedCredit
object
required

Credit not allocated to cards or sub-budgets.