ItemizedPayoutsReport
Returns the itemized payouts report, including transaction amounts, payout status, and balance transaction details.
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
- ParametersTimezone
- ParametersReportingCategory
// This first creates the new report and displays it. Report creation may take time before results are displayed.
SELECT * FROM ItemizedPayoutsReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'
SELECT
You can run the following queries to retrieve report data:
SELECT * FROM ItemizedPayoutsReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payouts.itemized.3')
SELECT * FROM ItemizedPayoutsReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM ItemizedPayoutsReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report
Columns
| Name | Type | References | Description |
| Payout_Id | String | The Stripe object to which this transaction is related. | |
| Effective_At_UTC | Datetime | For automatic payouts, this is the date the funds are expected to arrive in your bank account. For manual payouts, this is the date the payout was initiated. In both cases, it is the date the paid-out funds are deducted from your Stripe balance. All dates are in UTC. | |
| Effective_At | Datetime | For automatic payouts, this is the date the funds are expected to arrive in your bank account. For manual payouts, this is the date the payout was initiated. In both cases, it is the date the paid-out funds are deducted from your Stripe balance. All dates are in the requested time zone, or UTC if not provided. | |
| Currency | String | The three-letter ISO code for the currency in which gross, fee, and net are defined. | |
| Gross | Decimal | The gross amount of the transaction, expressed in major units of the currency, such as dollars for USD or yen for JPY. | |
| Fee | Decimal | The fees paid for this transaction, expressed in major units of the currency, such as dollars for USD or yen for JPY. | |
| Net | Decimal | The net amount of the transaction, expressed in major units of the currency, such as dollars for USD or yen for JPY. | |
| Reporting_Category | String | The reporting category, a categorization of balance transactions intended to improve on the current type field. | |
| Balance_Transaction_Id | String | The unique identifier for the balance transaction. | |
| Description | String | An arbitrary string attached to the balance transaction, often useful for displaying to users. | |
| Payout_Expected_Arrival_Date | Datetime | The date the payout is scheduled to arrive in the bank. This factors in delays such as weekends or bank holidays. | |
| Payout_Status | String | The current status of the payout, such as paid, pending, in_transit, canceled, or failed. A payout is pending until it is submitted to the bank, at which point it becomes in_transit. It then changes to paid if the transaction goes through. If it does not go through successfully, its status changes to failed or canceled. | |
| Payout_Reversed_At_UTC | Datetime | This field is typically empty. However, if the payout status is canceled or failed, this field reflects the time at which it entered that status. Times are in UTC. | |
| Payout_Reversed_At | Datetime | This field is typically empty. However, if the payout status is canceled or failed, this field reflects the time at which it entered that status. Times are in the requested time zone, or UTC if not provided. | |
| Payout_Type | String | The destination type for the payout, such as bank_account or card. | |
| Payout_Description | String | An arbitrary string attached to the payout, often useful for displaying to users. | |
| Payout_Destination_Id | String | The Id of the bank account or card the payout was sent to. | |
| Regulatory_Tag | String | An identifier reflecting the classification of this transaction according to local regulations, if applicable. Accounts with automatic payouts enabled receive a separate payout for each regulatory tag. This column is only populated for Brazilian accounts. | |
| 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. | |
| ParametersReportingCategory | String | Category of balance transactions to be included in the report run. | |
| ParametersTimezone | String | The output time zone for all timestamps in the report. Defaults to Etc/UTC. |