ItemizedReconciliationForASinglePayoutReport
Returns the itemized reconciliation report for a single payout, including transaction, charge, and customer 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:
- ParametersPayout
You can also include the following optional columns:
- ParametersColumns
- ParametersTimezone
- ParametersReportingCategory
// This first creates the new report and displays it. Report creation may take time before results are displayed.
SELECT * FROM ItemizedReconciliationForASinglePayoutReport WHERE ParametersPayout = '123456789'
SELECT
You can run the following queries to retrieve report data:
SELECT * FROM ItemizedReconciliationForASinglePayoutReport WHERE Id IN (SELECT Id FROM Reports WHERE report_type = 'payout_reconciliation.by_id.itemized.4')
SELECT * FROM ItemizedReconciliationForASinglePayoutReport WHERE Id IN ('frr_1I54dkATXQzBWNrlnaavpHGe', 'frr_1I3I59ATXQzBWNrl9VcczrDY') // This will show multiple reports
SELECT * FROM ItemizedReconciliationForASinglePayoutReport WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x' // This will show a respective report
Columns
| Name | Type | References | Description |
| Balance_Transaction_Id | String | The unique identifier for the balance transaction. | |
| Created_UTC | Datetime | The time at which the balance transaction was created. Dates are in UTC. | |
| Created | Datetime | The time at which the balance transaction was created. Dates are in the requested time zone, or UTC if not provided. | |
| Available_On_UTC | Datetime | The date the balance transaction net funds become available in the Stripe balance. Dates are in UTC. | |
| Available_On | Datetime | The date the balance transaction net funds become available in the Stripe balance. 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. | |
| Source_Id | String | The Stripe object to which this transaction is related. | |
| Description | String | An arbitrary string attached to the balance transaction, often useful for displaying to users. | |
| Customer_Facing_Amount | Decimal | For transactions associated with charges or refunds, the amount of the original charge or refund. | |
| Customer_Facing_Currency | String | For transactions associated with charges or refunds, the three-letter ISO code for the currency of customer_facing_amount. | |
| Automatic_Payout_Id | String | The Id of the automatically created payout associated with this balance transaction. This is only set if your account is on an automatic payout schedule. | |
| Automatic_Payout_Effective_At_UTC | Datetime | The date this automatic payout is expected to arrive in your bank account, in UTC. This is also when the paid-out funds are deducted from your Stripe balance. | |
| Automatic_Payout_Effective_At | Datetime | The date this automatic payout is expected to arrive in your bank account, in the requested time zone, or UTC if not provided. This is also when the paid-out funds are deducted from your Stripe balance. | |
| Customer_Id | String | The unique Id of the related customer, if any. | |
| Customer_Email | String | The email address of the customer, if any, associated with this balance transaction. | |
| Customer_Name | String | The name of the customer, if any, associated with this balance transaction. | |
| Customer_Description | String | Description provided when creating the customer, often used to store the customer name. | |
| Shipping_Address_Line1 | String | The first line of the shipping address associated with this charge, if any. | |
| Shipping_Address_Line2 | String | The second line of the shipping address associated with this charge, if any. | |
| Shipping_Address_City | String | The city of the shipping address associated with this charge, if any. | |
| Shipping_Address_State | String | The state of the shipping address associated with this charge, if any. | |
| Shipping_Address_Postal_Code | String | The postal code of the shipping address associated with this charge, if any. | |
| Shipping_Address_Country | String | The country of the shipping address associated with this charge, if any. | |
| Charge_Id | String | The unique identifier for the original charge associated with this balance transaction. Available for charges, refunds, and disputes. | |
| Payment_Intent_Id | String | The unique Id of the related Payment Intent, if any. | |
| Charge_Created_UTC | Datetime | Creation time of the original charge associated with this balance transaction. Available for charges, refunds, and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates are in UTC. | |
| Charge_Created | Datetime | Creation time of the original charge associated with this balance transaction. Available for charges, refunds, and disputes. For charges that were separately authorized and captured, this is the authorization time. Dates are in the requested time zone, or UTC if not provided. | |
| Invoice_Id | String | The unique Id for the invoice associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing invoice. | |
| Subscription_Id | String | The unique Id for the subscription associated with this balance transaction. Available for charges, refunds, and disputes made in connection with a Stripe Billing subscription. | |
| Payment_Method_Type | String | The type of payment method used in the related payment. | |
| Card_Brand | String | The card brand, if applicable. | |
| Card_Funding | String | The card funding type, if applicable. | |
| Card_Country | String | The two-letter ISO code representing the country of the card. | |
| Statement_Descriptor | String | The dynamic statement descriptor or suffix specified when the related charge was created. | |
| Dispute_Reason | String | The reason given by the cardholder for the dispute. | |
| Connected_Account_Id | String | For Stripe Connect activity related to a connected account, the unique Id for the account. | |
| Connected_Account_Name | String | For Stripe Connect activity related to a connected account, the name of the account. | |
| Connected_Account_Country | String | For Stripe Connect activity related to a connected account, the two-letter ISO code representing the country of the account. | |
| Id | String |
Reports.Id | The unique identifier for the report run object. |
| ParametersColumns | String | The set of output columns requested for inclusion in the report run. | |
| ParametersPayout | String |
Payouts.Id | The payout Id by which to filter 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. |