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

​
Balance 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_company_idintegerCompany identifier
platform_idstringPlatform-specific balance identifier
platform_unique_idstringAlternative unique identifier from the platform
total_balancenumberTotal balance including pending funds
available_balancenumberFunds available for immediate use or payout
pending_balancenumberFunds not yet available (processing, holds, etc.)
currency_idstringISO 4217 currency code
{
  "rootfi_id": 12001,
  "rootfi_created_at": "2025-01-15T10:00:00Z",
  "rootfi_updated_at": "2025-01-15T10:00:00Z",
  "rootfi_company_id": 999,
  "platform_id": "bal_stripe_001",
  "platform_unique_id": "bal_stripe_001",
  "total_balance": 15000.00,
  "available_balance": 12500.00,
  "pending_balance": 2500.00,
  "currency_id": "USD"
}