Skip to main content
The Balances Data Model simplifies the handling and retrieval of Balances data for your application. The model provides a unified representation of balances data across different platforms, enabling you to easily access and manage balances data from different platforms.
  • Unified Balances properties: The model provides a unified representation of balances properties across different platforms, enabling you to easily access and manage balances data from different platforms.
  • Comprehensive balances information: The model provides a comprehensive representation of balances data, including all the properties and relationships that you can retrieve for a balance.

​
Attributes

​
Balance Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the balance
rootfi_created_atstringThe ISO 8601 timestamp at which the record was created in RootFi
rootfi_updated_atstringThe ISO 8601 timestamp at which the record was last updated in RootFi
rootfi_company_idintegerThe RootFi company ID associated with the balance
platform_idstringThe Platform’s ID for the Balance
platform_unique_idstringThe platform’s unique identifier for the balance
total_balancenumberThe total balance of the account
available_balancenumberThe available balance of the account
pending_balancenumberThe pending balance of the account
currency_idstringThe currency ID of the account

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the Balance
total_balancenumberThe total balance of the account
available_balancenumberThe available balance of the account
pending_balancenumberThe pending balance of the account
currency_idstringThe currency ID of the account
{
  "rootfi_id": 157,
  "rootfi_deleted_at": null,
  "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",
  "total_balance": 10000.00,
  "available_balance": 8500.00,
  "pending_balance": 1500.00,
  "currency_id": "USD"
}