Balance

Receive updates regarding your balance movement.

EventNameDescription
balance.funds.addedMoney that was added to your balance.
balance.funds.deductedMoney that was deducted from your balance.

Objects Structure Samples

{
  "Id": "b89690a4-10ab-4ba9-87b5-32cb9dbdcd61",
  "Name": "balance.funds.added",
  "AccountId": "a51ad689-bbca-42ac-8442-fe54c55b9a0e",
  "Data": {
    "Id": "d79d2b12-c4a7-45b3-abe6-bfed7e69365b",
    "Currency": "USD",
    "Amount": 150,
    "BalanceAmount": 37762.12,
    "TransactionReference": {
      "Type": "Convert",
      "EntityId": "fc661b73-14a9-4577-b9e9-c2a7b6cd4490"
    }
  },
  "CreateAtUtc": "2025-06-12T09:47:01.0772637Z"
}
{
  "Id": "5accb47d-6ed4-43d9-ac81-18fb67bb8b13",
  "Name": "balance.funds.deducted",
  "AccountId": "a51ad689-bbca-42ac-8442-fe54c55b9a0e",
  "Data": {
    "Id": "9c594dfd-b676-4eee-8e60-3342c4f1dfef",
    "Currency": "CAD",
    "Amount": 109,
    "BalanceAmount": 200016878.25,
    "TransactionReference": {
      "Type": "Payment",
      "EntityId": "1c1c6635-ee61-4463-b99c-e0353218e1db"
    }
  },
  "CreateAtUtc": "2025-06-12T09:48:45.3241356Z"
}


Data Object For Balance

PropertyTypeDescription
IdGuidUnique identifier for the balance update entry.
CurrencystringCurrency code (ISO 4217), e.g., "USD", "EUR".
AmountdecimalAmount involved in this balance change (positive number).
BalanceAmountdecimalThe resulting balance after this update is applied.
TransactionReferenceobjectObject referencing the origin of the transaction that caused the balance update.
TransactionReference.TypestringType of transaction source. Expected to match one of the BalanceUpdateTransactionType enum values: Payment, Convert, or Deposit.
TransactionReference.EntityIdstringID of the associated entity that triggered the balance update.