Financial summary report

Docs

Last updated: Aug 15th, 7:24am

This report provides a summary of the activity on your financial accounts. You can generate this report for a single financial account or for a set of financial accounts, such as the partner fee account or the recoup account.

Download a sample report

To review what's available in this report, download a sample in CSV format. This sample may vary from your actual report depending on your settings.

Know before you begin

You must be an approved partner to use this report.

This report is generated and placed on the SFTP server on the second day of every month by 12:00 PM daily in the leading time zone of the reporting window.

The amounts in this report are in dollars.

Read the report data by column header name instead of column index to maintain backward compatibility.

If you want to combine data from multiple accounts into a single report, all accounts in the report must be in the same timezone.

Report file name

The file name of the Financial Summary Report for a single account follows this naming convention:

FINANCIAL_SUMMARY.yyyymm.Identifier.ReportingWindow.SequenceNumber.MajorVersion.MinorVersion.Format

Field	Information
`FINANCIAL_SUMMARY`	An abbreviation for Financial Summary Report.
`yyyymm`	The month for the data in the report. It represents the month of the data.
`ReportIdentifier`	As entered by the partner in preference system. If a partner wants several financial reports each consisting of data for a unique set of financial accounts, this identifier can be used to differentiate each report.
`ReportingWindow`	The window of time in which the report was generated.
`SequenceNumber`	The sequence number of the report file. It is two characters, right-justified, and zero-filled. The sequence number begins with `0` and continues until all parts of the report are recorded in files. The sequence number is always present in the report filename even if there is only one file.
`MajorVersion`	The major version of the report.
`MinorVersion`	The minor version of the report.
`Format`	The report format is `CSV` (comma-separated values).

Report format

Each row of the report consists of a two-letter row type, followed by the details specific to that row type. The following table lists the valid row types, along with the sections that describe the data for that row type.

Code	Description
FH	File header
SH	Section header, contains encrypted partner financial PayPal account id. Each section represents unique financial account's data, sections will be repeated in case of multiple financial accounts
CH	Column header
SB	Section body
SF	Section footer
SH	Section header, contains encrypted partner financial PayPal account ID.
CH	Column header
SB	Section body
SF	Section footer
FF	File footer

File header data

Position	Column name	Data type	Description
1	Column Type	`Literal`	The column type (`FH`).
2	Report Generation Date	`Date-time`	The date and time at which the report file was generated, in the following format: `YYYY/MM/DDHH:MM:SS offset`, where `offset` is the five-character signed offset from GMT. For example, `+0800`.
3	Reporting Window	`Varchar`, single character, one of: `A`, `H`, `R`, `X`.	The window of time in which the report was generated, as follows: `A`: America/New York to America/Los Angeles. `H`: America/Los Angeles to Asia/Hong Kong. `R`: Asia/Hong Kong to Europe/London. `X`: Europe/London to America/New York.
4	Report Period Start Date	`Date-time`	The beginning date and time for which to include transactions in the report, in the following format: `YYYY/MM/DDHH:MM:SS offset`, where `offset` is the five-character signed offset from GMT. For example, `+0800`.
5	Report Period End Date	`Date-time`	The final date and time for which to include transactions in the report, in the following format: `YYYY/MM/DDHH:MM:SS offset`, where `offset` is the five-character signed offset from GMT. For example, `+0800`.
6	Financial Account Number	`Varchar`	Partners financial encrypted account number.

Section header data

1	Column Type	`Literal`	`SH`
2	Financial Account Number	String	The partner's financial PayPal encrypted account number. The data summary provided under this section belongs to the given financial account.
3	Financial Account Email ID	String	The primary email ID linked to the partner's financial account.

Section body data

1	Column Type	`Literal`	The column type (`CH`).
2	INTEGRATION_IDENTIFIER	`Varchar`	Button Source code of the partner or Organization name of the partner depending on partner's integration with PayPal.
3	TRANSACTION_TYPE	`Varchar`	The type of transaction. One of: `OPENING_BALANCE`. Indicates the balance of the financial account at the start of the reporting window. `PAYMENT`. Forward money movement between buyer and seller for a given order. `CORRECTION`. Correction type transactions. `CURRENCY_CONVERSION`. Currency conversion type transactions. `DEPOSIT`. Deposit type transactions. `Fees`. Fees type transactions for Partner Fee, Payment Fee or Fee Reversal or Withdrawal fee or Foreign Withdrawal fee `HOLD`. Hold type transactions. `HOLD_RELEASEE`. Hold release type transactions. `OTHERS`. Other type transactions. `RECOUP`. Recoup type transactions done either from Bank or Loss Accounts `REFUND`. Refund type transactions. `REVERSAL`. Reversal type transactions. `WITHDRAWAL`. Withdrawal type transactions. `TRANSFER`. Transfer type transactions. `CLOSING_BALANCE`. Indicates the balance of the financial account at the end of the reporting window. `PAYABLE`. Funds payable are funds provided by PayPal that need to be paid back. `RECEIVABLE`. Funds receivable are funds provided by PayPal that are being paid back. `TRANSFER`. Transfers are funds transferred either from or to a PayPal account and another payable account. `SETTLEMENT_CONSOLIDATION` `ACH_REVERSAL` `BONUS`. Bonus type transactions. `PAYOUT_REFUND`Refund against a past payout transaction. `PAYOUT_REVERSAL`Reversal of a Payout transaction
3	TRANSACTION_SUBTYPE	`Varchar`	The Subtype of Transaction. One of: `FEE`. Fee subtype transactions, applicable for transaction type Chargeback. `REVERSAL`. Reversal subtype transactions, applicable for transaction types Chargeback, Fees and Withdrawal. `PARTNER_FEE`. Partner fee subtype transactions, applicable for transaction type Fees. `PAYMENT_FEE`. Payment fee subtype transactions, applicable for transaction type Fees. `MASSPAY`. Masspay subtype transactions, applicable for transaction type Payment. `Bank`. Bank subtype transactions, applicable for transaction type Withdrawal. `FOREIGN_WITHDRAWAL`. Indicates Foreign withdrawal fees, applicable for transaction type FEES. `LOSS_ACCOUNT`. Loss account subtype transactions, applicable for transaction type Recoup. `DEPOSIT` When the transaction type is `CORRECTION`, the value `DEPOSIT` or `WITHDRAWAL` will be populated for the transaction subtype depending on whether the amount is deposited or withdrawn from the partner's financial account. `WITHDRAWAL` When the transaction type is `CORRECTION`, the value `DEPOSIT` or `WITHDRAWAL` will be populated for the transaction subtype depending on whether the amount is deposited or withdrawn from the partner's financial account. `From`. Currency Conversion from currency. `To`. Currency Conversion to currency. `FOREIGN_WITHDRAWAL`. Indicates foreign withdrawal fees, applicable for transaction type `FEES`. `BONUS`. This subtype applies to bonus transactions.
4	UNITS	`Varchar`	Number of units.
5	VOLUME	`Varchar`	Volume of the transaction.
6	TRANSACTION_CURRENCY	`String`	The Currency representing the record.
7	TARGET_VOLUME	`Varchar`	To Amount in currency conversion records.
8	TARGET_TRANSACTION_CURRENCY	`Varchar`	To currency in currency conversion records.

Section footer data

1 Column Type Literal The column type (SF).

File footer data

1 Column Type Literal The column type (FF).