Skip to main content
The Balance Data Model represents the current account balance for a payment gateway account. This is typically a computed view showing available funds across different categories.
  • Real-time balance: Current snapshot of available funds
  • Currency-specific: Balances are tracked per currency
  • Balance categories: Track available, pending, and total balances separately

Attributes

Balances Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier for this balance record
rootfi_created_atstringWhen this record was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringWhen this record was last updated (ISO 8601)
rootfi_integration_typeenum
platform_idstringPlatform-specific balance identifier
total_balancedoubleTotal balance including pending funds
available_balancedoubleFunds available for immediate use or payout
pending_balancedoubleFunds not yet available (processing, holds, etc.)
currency_idenumISO 4217 currency code