GoCardlessDeveloper Docs
Create a sandbox account

Account Balance Output#

View as Markdown

Account Balance Output#

This section contains key descriptions for balances.

Balance#

KEYTYPEOPTIONALDESCRIPTION
balanceAmountAmountMandatoryan object containing: amount Float currency Max3Text
balanceTypeBalance TypeMandatory
creditLimitIncludedBooleanOptionalA flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable.
lastChangeDateTimeISODateTimeOptionalThis data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked.
lastCommitted TransactionMax35TextOptionalentryReference of the last commited transaction to support the TPP in identifying whether all end users transactions are already known.
referenceDateISODateOptionalindicates the date of the balance

Balance Type#

TYPEDESCRIPTION
closingAvailableClosing balance of amount of money that is at the disposal of the account owner on the date specified.
closingBookedBalance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period. For card-accounts, this is composed of - invoiced, but not yet paid entries
closingClearedClosing balance of amount of money that is cleared on the date specified.
expectedBalance composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted. For card accounts, this is composed of - invoiced, but not yet paid entries, - not yet invoiced but already booked entries and - pending items (not yet booked)
forwardAvailableForward available balance of money that is at the disposal of the account owner on the date specified.
interimAvailableAvailable balance calculated in the course of the account 'servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified. For card-accounts, this is composed of - invoiced, but not yet paid entries, - not yet invoiced but already booked entries
interimClearedCleared balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day.
informationBalance for informational purposes.
interimBookedBalance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
nonInvoicedOnly for card accounts, to be defined yet.
openingBookedBook balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report.
openingAvailableOpening balance of amount of money that is at the disposal of the account owner on the date specified.
openingClearedOpening balance of amount of money that is cleared on the date specified.
previouslyClosedBookedBalance of the account at the previously closed account reporting period. The opening booked balance for the new period has to be equal to this balance. Usage: the previously booked closing balance should equal (inclusive date) the booked closing balance of the date it references and equal the actual booked opening balance of the current date.

What's next?#