Ledger Balance Update

ledger.balance-updated

This event occurs when a balance is updated in the RocketKOR ledger.

Payload Object

string (UUID)

Event ID.

type

string

Event type. Value is ledger.balance-updated.

createdAt

string (date-time)

Date and time the event occurred.

data

object

Data related to the event.

transactionId

string (UUID)

Transaction ID.

financialAccountId

string (UUID)

Financial Account ID.

description

string

Description of the transaction.

statementDescription

string

Statement description.

currency

string

Transaction currency.

accountBalance

number

Actual balance of the account. This balance includes any pending withdrawals and excludes any pending deposits.

availableBalance

number

Available funds in the account that can be used for transactions. The available balance is calculated as the account balance minus any pending withdrawals.

pendingWithdraw

number

Total value of outbound funds submitted for processing that have not yet settled.

pendingDeposit

number

Total value of inbound funds submitted for processing that have not yet cleared.

accountBalanceDelta

number

Account balance delta.

pendingDepositBalanceDelta

number

Balance delta of pending deposits.

pendingWithdrawalBalanceDelta

number

Balance delta of pending withdrawals.

Sample Payload Object

				
					{
  "id": "25dd692c-0585-4354-8089-8d7ccc737cae",
  "type": "ledger.balance-updated",
  "createdAt": "2025-04-10T21:10:53.857Z",
  "data": {
    "transactionId": "7c382beb-ec37-4814-b9a0-ac0d1af92acc",
    "financialAccountId": "7c382beb-ec37-4814-b9a0-ac0d1af92acc",
    "description": "SEND: transfer",
    "statementDescription": "Funds Transfer: ABC Corporation",
    "currency": "USD",
    "accountBalance": 100000,
    "availableBalance": 90000,
    "pendingWithdraw": 20000,
    "pendingDeposit": 10000,
    "accountBalanceDelta": 1,
    "pendingDepositBalanceDelta": 1,
    "pendingWithdrawalBalanceDelta": 1
  }
}