Skip to main content
The Balances Data Model provides access to account balance information from e-commerce platforms.
  • Available Balance: Funds immediately available for use, withdrawal, or transfer
  • Pending Balance: Funds awaiting processing or clearance

​
Attributes

FieldTypeDescriptionRequired
rootfi_idintegerUnique identifier assigned by CommendaYes
rootfi_created_atdatetimeWhen this record was created in Commenda’s systemYes
rootfi_updated_atdatetimeWhen this record was last updatedYes
rootfi_company_idintegerCompany identifierYes
platform_idstringPlatform-specific identifierYes
available_balancedecimalFunds immediately availableNo
pending_balancedecimalFunds awaiting clearanceNo
currency_idstringISO 4217 currency codeNo
{
  "rootfi_id": 157,
  "rootfi_created_at": "2024-01-22T05:07:31.465Z",
  "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
  "rootfi_company_id": 1089,
  "platform_id": "bal_123456",
  "available_balance": 15000.00,
  "pending_balance": 2500.00,
  "currency_id": "USD"
}