This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk/realtime / BalanceUpdate

BalanceUpdate ​

Balance update received on coreTopics.balance(). It only carries what the gateway actually fills in; for the full balance, call wallet.getBalance() (see the "Live balance" flow).

Properties ​

available ​

available: number

Available balance after the change, in minor units (cents).


change ​

change: number

Change applied, in minor units (negative on a debit).


changeType ​

changeType: string

Nature of the change, e.g. 'credit', 'debit', 'reserve', 'release'.


description? ​

optional description?: string

Description of the movement, when the gateway provides one.


updatedAt ​

updatedAt: string

Instant of the update (ISO 8601).