Skip to main content
GET
Retrieve card-account balances

Authorizations

x-api-key
string
header
required

Enter your API key

Response

availableCredit
object
required

How much can still be spent on cards right now: your credit limit minus what's owed and any blocked amounts. It's never below zero.

totalCreditLimit
object
required

Your card account's total credit limit. It's never below zero.

outstandingBalance
object
required

The balance currently owed on your card account. A negative value is a credit: you've repaid more than you owed, and that amount will be deducted from your next statement.

pendingAmount
object
required

Repayments you've made that haven't been applied to your card account yet. It can be in a different currency from your other balances, so always check currency.

allocatedCredit
object
required

Credit set aside for specific cards, such as top-up card budgets. The value is signed and can be negative.

unallocatedCredit
object
required

Credit not yet set aside for any card. Check it before creating top-up cards to make sure you can fund them.