Overview

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

Property	Type	Description
rootfi_id	integer	The RootFi ID of the payout
rootfi_created_at	string	The ISO 8601 timestamp at which the record was created in RootFi
rootfi_updated_at	string	The ISO 8601 timestamp at which the record was last updated in RootFi
rootfi_company_id	integer	The RootFi company ID associated with the payout
platform_id	string	The Platform’s ID for the Payout
platform_unique_id	string	The platform’s unique identifier for the payout
amount	number	The amount of the payout
created_at	string	The date the payout was created
description	string	The description of the payout
currency_id	string	The currency of the payout
status	enum	The status of the payout (CREATED, SUCCESS, FAILED)

Properties Supported

Property	Type	Description
platform_id	string	The Platform’s ID for the Payout
amount	number	The amount of the payout
created_at	string	The date the payout was created
description	string	The description of the payout
currency_id	string	The currency of the payout
status	enum	The 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"
}

General

Server Side SDKs

Core API

Unified API

Attributes

Payout Attributes

Properties Supported

​Attributes

​Payout Attributes

​Properties Supported

Attributes

Payout Attributes

Properties Supported