Bank Account

Bank account summary object

Object Parameters

available_balance_close

string

Close available_balance in the currency's smallest unit at the end of effective_on in time_zone.

available_balance_credit

string

Total credit amount in the currency's smallest unit applied to available_balance. Zero or positive.

available_balance_debit

string

Total debit amount in the currency's smallest unit applied to available_balance. Zero or negative.

currency

string

The currency of the balances.

effective_on

string

Effective date of the summary.

holding_balance_close

string

Close holding_balance in the currency's smallest unit at the end of effective_on in time_zone.

holding_balance_credit

string

Total credit amount in the currency's smallest unit applied to holding_balance. Zero or positive.

holding_balance_debit

string

Total debit amount in the currency's smallest unit applied to holding_balance. Zero or negative.

locked_balance_close

string

Close locked_balance in the currency's smallest unit at the end of effective_on in time_zone.

locked_balance_credit

string

Total credit amount in the currency's smallest unit applied to locked_balance. Zero or positive.

locked_balance_debit

string

Total debit amount in the currency's smallest unit applied to locked_balance. Zero or negative.

pending_balance_close

string

Close pending_balance in the currency's smallest unit at the end of effective_on in time_zone.

pending_balance_credit

string

Total credit amount in the currency's smallest unit applied to pending_balance. Zero or positive.

pending_balance_debit

string

Total debit amount in the currency's smallest unit applied to pending_balance. Zero or negative.

time_zone

string

Time zone of effective_on to decide day boundaries. You can set your platform reporting time zone in Platform Settings on Dashboard.

transaction_count

integer

Total number of transactions on the day of effective_on.