Balance Object


A balance is the number of available credits in a pool.

Properties
amountBalanceAmountRead-only

Available credits.


beneficiaryIdentificationDataRead-onlyimmutable

Beneficiary of the associated pool.


createdDatestringRead-onlyformat date-time

Date and time the balance was created.


extendedFieldsExtendedFields

Custom field data for the balance object. Extended fields must be configured in the app dashboard before they can be accessed with API calls.


idstringRead-onlyformat GUIDimmutable

Balance ID. This is the same as the associated pool's ID.


lastTransactionIdstringRead-onlyformat GUID

ID of the transaction associated with the most recent change to the balance.


poolInfoPoolInfoRead-only

Associated pool information.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the balance is updated. To prevent conflicting changes, the current revision must be passed when updating the balance.


updatedDatestringRead-onlyformat date-time

Date and time the balance was updated.

Did this help?