Partner fee report
Last updated: Aug 15th, 7:58am
Important: The PayPal Commerce Platform is a limited-release solution at this time. It is available to select partners for approved use cases. For more information, reach out to your PayPal account manager.
Important: The Partner Fee Report is not available for new integrations. PayPal provides this documentation to support existing integrations. For new integrations, use the Financial Detail Report and the Financial Summary Report.
This report provides a detailed view of the transactions affecting the partner fee account and helps with reconciliation and management of revenue through partner fees.
This report is generated and placed on SFTP by 12:00 PM daily in the leading time zone of the reporting window.
The actual amounts in this report are multiplied by 100 to represent the amounts as cents. For instance, a $10 entry appears as 1000 on the report.
Report file name
The file name of the Partner Fee Report for a single account follows this naming convention:
PF.yyyymmdd.BNCode.ReportingWindow.SequenceNumber.MajorVersion.MinorVersion.Format
| Field | Information |
|---|---|
PF |
An abbreviation for Partner Fee report. |
yyyymmdd |
The date for the data in the report. It represents the latest, or ending date, of the data. |
BNCode |
This code is the unique ID for the platform. |
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
01 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. It contains three characters and is right-justified. |
Format |
The report format is CSV (comma-separated values). |
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.
The report groups transactions by the Account Number field.
| Code | Description |
|---|---|
| FH | File header |
| SH | Section header |
| CH | Column header |
| SB | Section body |
| SF | Section footer |
| FF | File footer |
| Position | Column name | Data type | Description |
|---|---|---|---|
| File Header Data | |||
| 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:
|
| 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 | BN Code | Varchar |
Unique ID for the platform. |
| Section Header Data | |||
| 1 | Column Type | Literal |
SH |
| Section Body Data | |||
| 1 | Column Type | Literal |
The column type (CH). |
| 2 | Transaction Type | Varchar |
The type of transaction. One of:
|
| 3 | Account Number | Varchar |
Seller's PayPal encrypted account number. |
| 4 | PayPal Reference ID | String |
Original PayPal transaction ID to which this event is related. |
| 5 | Case Filing Date | Date-time |
Date and time at which the case was filed in the following format is the
five-character signed offset from GMT. For example, +0800.
|
| 6 | Custom Field | Varchar |
A field for custom data. |
| 7 | Transaction Date | Date-time |
Date and time at which the case was filed in the following format is the
five-character signed offset from GMT. For example, +0800.
|
| 8 | Transaction Currency | Three character currency code | The currency of the transaction. |
| 9 | Buyer Amount | Money |
Amount of funds transferred to or from a customer. Funds that are
transfered to the customer have a dash (-) prefix.
|
| 10 | Partner Fee | Money |
Partner fees associated with the transaction. Funds moving
out of the partner fee account have a dash (-)
prefix.
|
| 11 | Bank Transaction Amount | Money |
Funds transferred to the seller's bank account. |
| 12 | Transaction Status | String |
Denotes the status of the transaction. `S`- Success, `P` - Pending |
| Section Footer Data | |||
| 1 | Column Type | Literal |
The column type (SF). |
| File Footer Data | |||
| 1 | Column Type | Literal |
The column type (FF). |