PayoutsSummaryReport
Returns the payouts summary report, including transaction counts and gross, fee, and net totals by reporting category.
View-Specific Information
Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.
Creating the Report
To create a report, the following columns are required:
- ParametersIntervalStart
- ParametersIntervalEnd
You can also include the following optional columns:
- ParametersColumns
- ParametersCurrency
// This first creates the new report and displays it. Report creation may take time before results are displayed.
SELECT * FROM PayoutsSummaryReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'
SELECT
You can run the following queries to retrieve report data:
SELECT * FROM PayoutsSummaryReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payouts.summary.1')
SELECT * FROM PayoutsSummaryReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM PayoutsSummaryReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report
Columns
| Name | Type | References | Description |
| Reporting_Category | String | The reporting category, a categorization of balance transactions intended to improve on the current type field. | |
| Currency | String | The three-letter ISO code for the currency in which gross, fee, and net are defined. | |
| Count | Int | The number of transactions associated with the reporting category. | |
| Gross | Decimal | The sum of the gross amounts of the transactions associated with the reporting category, expressed in major units of the currency, such as dollars for USD or yen for JPY. | |
| Fee | Decimal | The sum of the fees paid for the transactions associated with the reporting category, expressed in major units of the currency, such as dollars for USD or yen for JPY. | |
| Net | Decimal | The sum of the net amounts for the transactions associated with the reporting category, expressed in major units of the currency, such as dollars for USD or yen for JPY. | |
| Id | String |
Reports.Id | The unique identifier for the report run object. |
| ParametersIntervalEnd | Datetime | The ending timestamp of data to be included in the report run (exclusive). | |
| ParametersIntervalStart | Datetime | The starting timestamp of data to be included in the report run. | |
| ParametersColumns | String | The set of output columns requested for inclusion in the report run. | |
| ParametersCurrency | String | Currency of objects to be included in the report run. |