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

​
Attributes

​
Payout Attributes

PropertyTypeDescription
rootfi_idintegerThe RootFi ID of the payout
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 payout
platform_idstringThe Platform’s ID for the Payout
platform_unique_idstringThe platform’s unique identifier for the payout
amountnumberThe amount of the payout
created_atstringThe date the payout was created
descriptionstringThe description of the payout
currency_idstringThe currency of the payout
statusenumThe status of the payout (CREATED, SUCCESS, FAILED)

​
Properties Supported

PropertyTypeDescription
platform_idstringThe Platform’s ID for the Payout
amountnumberThe amount of the payout
created_atstringThe date the payout was created
descriptionstringThe description of the payout
currency_idstringThe currency of the payout
statusenumThe status of the payout. Allowed values are CREATED, SUCCESS, FAILED
{
  "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": "po_123456",
  "created_at": "2024-01-22T05:07:31.000Z",
  "description": "Monthly payout",
  "amount": 5000.00,
  "currency_id": "USD",
  "status": "SUCCESS"
}