increase-test
GET/accounts/{account_id}/balance

Retrieve an Account balance

Retrieves an Account's current and available balances in minor units of the Account's currency. Provide at_time to query balances at a specific ISO 8601 date-time; when omitted, the response contains the current balances.

2 parameters
account_idstringrequired
The identifier of the Account whose balance to retrieve.
at_timestringoptional
The ISO 8601 date-time at which to query the balance. Defaults to the current balances when omitted.

3 status codes
200Returns a balance lookup with the Account identifier, current balance, available balance, and loan details when applicable. Balances are in minor units of the Account's currency.
account_idstringrequired
The identifier for the account for which the balance was queried.
available_balanceintegerrequired
The Account's available balance, representing the current balance less any open Pending Transactions on the Account.
current_balanceintegerrequired
The Account's current balance, representing the sum of all posted Transactions on the Account.
loanobjectrequired
The loan balances for the Account.
typestringrequired
A constant representing the object's type. For this resource it will always be `balance_lookup`.
Allowed:balance_lookup
4XXReturned when the request encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

The account_id path parameter must identify an existing Account. at_time, if supplied, must be a valid ISO 8601 date-time.