CData Python Connector for Stripe

Build 23.0.8839

ItemizedPayoutsReport

Query the Itemized payouts report in Stripe.

Table Specific Information

It is used to query the Itemized payouts report in Stripe.

Note: It requires a live-mode API key which we can set using the LiveAPIKey connection property. The view is not visible without mentioning the LiveAPIKey.

Creating the Report

To create a report we need to pass some required parameters.

  • ParametersIntervalStart
  • ParametersIntervalEnd

To create a report we can also pass some optional parameters.

  • ParametersColumns
  • ParametersCurrency
  • ParametersTimezone
  • ParametersReportingCategory

//  This first creates the new Report and displays it. Report Creation takes time once it is created will display the report.
SELECT * FROM ItemizedPayoutsReport WHERE ParametersIntervalStart = '2020-12-27' AND ParametersIntervalEnd = '2020-12-28'

Select

To query the report we can try the below queries.

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 we expect funds to arrive in your bank account. For manual payouts, this is the date the payout was initiated. In both cases, its the date the paid-out funds are deducted from your Stripe balance. All dates in UTC.
Effective_At Datetime For automatic payouts, this is the date we expect funds to arrive in your bank account. For manual payouts, this is the date the payout was initiated. In both cases, its the date the paid-out funds are deducted from your Stripe balance. All dates in the requested timezone, or UTC if not provided.
Currency String Three-letter ISO code for the currency in which gross, fee and net are defined.
Gross Decimal Gross amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Fee Decimal Fees paid for this transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Net Decimal Net amount of the transaction. Expressed in major units of the currency (e.g. dollars for USD, yen for JPY).
Reporting_Category String Reporting Category is a new categorization of balance transactions, meant to improve on the current type field.
Balance_Transaction_Id String 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 Date the payout is scheduled to arrive in the bank. This factors in delays like weekends or bank holidays.
Payout_Status String Current status of the payout (paid, pending, in_transit, canceled or failed). A payout will be pending until it is submitted to the bank, at which point it becomes in_transit. It will then change to paid if the transaction goes through. If it does not go through successfully, its status will change to failed or canceled.
Payout_Reversed_At_UTC Datetime Typically this field will be empty. However, if the payouts status is canceled or failed, this field will reflect the time at which it entered that status. Times in UTC.
Payout_Reversed_At Datetime Typically this field will be empty. However, if the payouts status is canceled or failed, this field will reflect the time at which it entered that status. Times in the requested timezone, or UTC if not provided.
Payout_Type String Can be bank_account or card.
Payout_Description String An arbitrary string attached to the payout. Often useful for displaying to users.
Payout_Destination_Id String 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 [KEY] String

Reports.Id

Unique identifier for the reports run object.
ParametersIntervalEnd Datetime Ending timestamp of data to be included in the report run (exclusive).
ParametersIntervalStart Datetime 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 Defaults to Etc/UTC. The output timezone for all timestamps in the report.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839