The Balance endpoint gives access to balance information

Field

Description

accessible

The balance that you can use. However The accessible balance can easily change when the pending_debits settle. That's why total available is the balance that is "safe to spend".

pending_debits

Total balance of debit transactions that have not yet settled

pending_credits

Total balance of credit transactions that have not yet settled

scheduled_debits

Total balance of scheduled debit transactions

settled

Total balance of settled transactions

lockbox

Total balance in the lockbox

total_available

Total balance that is safe to spend. total_available = accessible - pending_debits - scheduled_debits

Language
Authentication
Header
Click Try It! to start a request and see the response here!