Skip to main content
​
accountId
string
required

The ID of the account associated with the balance.

​
type
enum<string>
required

The type of balance.

  • "cash" represents the excess balance not used as collateral for the charge card. Not applicable to debit accounts.
  • "credit" represents the balance that can be spent on the charge card. Not applicable to debit accounts.
  • "debit" represents the balance that can be spent or withdrawn. Not applicable to charge card accounts.
Available options:
cash,
credit,
debit
​
available
Money · object
required

The amount of money that is immediately available to use.

  • For "credit" balances, this is the immediately available amount that can be spent on the charge card.
  • For "cash" balances, this value represents the immediately available excess cash that is not being used as collateral for the charge card. You can choose to transfer more than these funds to your bank account, but any amount not coverable by the available balance will be removed from the charge card's collateral balance (the "credit" balance).
  • For "debit" balances, this is the amount of money available that can be spent or withdrawn immediately.
​
posted
Money · object
required

The amount of money that has been posted to the account. This value does not include any pending transactions and instead represents the amount of money that has been posted to the balance.

​
timestamp
string<date-time>
required

The UTC timestamp associated with the balance. Since the balance can change rapidly, the timestamp is included to indicate the time when the balance was computed.