Pricing summary report
Last updated: Oct 30th, 11:49am
This report provides a summary view of the pricing or costs incurred for transactions.
Know before you begin
- Ensure you are an approved partner to use this report.
- Reports for partners on IC++ are generated and placed on PayPal's secure file transfer protocol (SFTP) server by the seventh day of every month by 9:00 AM in the leading time zone of the reporting window.
- Reports for all other partners are generated and placed on PayPal's secure file transfer protocol (SFTP) server by the second day of every month by 9:00 AM in the leading time zone of the reporting window.
- This report includes alternative payment methods (APMs). See the list of supported APMs.
- To maintain backward compatibility, read the report data by column header name instead of column index.
- This report can be generated for a single account or for a set of accounts. To include data from multiple accounts into a single report, all accounts must belong to the same timezone.
- Each of the multiple sections in this report is a unique combination of partner identifier (the button source code or organization name) and pricing model value.
- This report is only available to partners who are on gross billing fees or a net settlement revenue share model.
Section 1: Report file name
The file name of the Pricing Summary Report for a single account follows this naming convention:
PRICING_SUMMARY.yyyymm.ReportIdentifier.ReportingWindow.SequenceNumber.MajorVersion.MinorVersion.Format
Field | Information |
---|---|
PRICING_SUMMARY |
An abbreviation for Pricing 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 partner wants several reports each consisting of data for unique set of accounts, this 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. 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). |
Section 2: 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 and the sections that describe the data for that row type.
Code | Description |
---|---|
FH | File header |
SH | Section header. This report contains multiple sections each being a unique combination of partner identifier (button source code or organization name), payout/invoice account email, and pricing model. |
CH | Column header |
SB | Section body |
SF | Section footer |
TH | Total header. This report can have multiple total sections depending on different aggregate parameters supported. |
CH | Column header |
TB | Total body |
TF | Total 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:
|
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 .
|
Section header data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
SH |
2 | Partner Identifier | Literal |
Button source code or organization name of partner |
3 | Payout Account Email or Invoice Account Email | Literal |
Email of the account to receive revenue share payout if pricing model is REVSHARE or email of the account which to receive invoice if pricing model is GROSS_BILLING |
7 | PRICING_MODEL | Varchar |
Denotes if there is a revenue share on the transaction or if the fees
are gross billed through invoices.
|
Section body data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
The column type (CH ). |
2 | PRICING_FEE_TYPE | Varchar |
One of the following fee types, based on transaction and forward or
reverse money movement
|
3 | PAYMENT_INSTRUMENT_TYPE | Varchar |
A high-level classification of the type of financial instrument that was
used to fund a payment, such as the following:
|
4 | PAYMENT_INSTRUMENT_SUBTYPE | Varchar |
One of the following detailed classifications of the financial
instrument used to fund a payment:
For example:
|
5 | TRANSACTION_CURRENCY | Three-character currency code | The currency of the transaction. |
6 | UNITS | Varchar |
Number of units for current month's transactions. |
7 | VOLUME | Money |
Volume for current month's transactions, rounded to two decimal places. |
8 | PP_FEES | Money |
PP Fees charged to sellers for current month's transactions, rounded to two decimal places. |
9 | PROCESSING_COST | Money |
Total PayPal markup for current month's transactions, rounded to two. decimal places. |
10 | INTERCHANGE_COST | Money |
Total interchange cost for current month's transactions, rounded to five decimal places. |
11 | ASSESSMENT_COST | Money |
Total assessment cost for current month's transactions, rounded to five decimal places. |
12 | REVISION_UNITS | Money |
Total units that received revised costs, applicable only when partner is on interchange plus pricing. |
13 | REVISION_PRIOR_INTERCHANGE_COST | Money |
Prior interchange cost for units that received revisions, rounded to five decimal places. |
14 | REVISION_REVISED_INTERCHANGE_COST | Money |
Revised interchange cost for units that received revisions, rounded to five decimal places. |
15 | REVISION_REVISED_ASSESSMENT_COST | Money |
Assessment costs received in the current month for transactions belonging to a prior month, rounded to five decimal places. |
16 | PAYOUT_AMT_IN_ TRANSACTION_CURRENCY |
Money |
This will reflect the calculated revenue share payout amount in
transaction currency, rounded to 5 decimal places. If the payout
account's primary currency is different, it will further get converted
to payout account currency. Please see PAYOUT_AMT_IN_ PAYOUT_CURRENCY column. |
17 | PAYOUT_AMT_IN_ PAYOUT_CURRENCY |
Money |
This reflects the converted amount in payout account's currency, rounded to 5 decimal places. Sum up this amount across different rows and sections for each payout account to reconcile with what you receive as revenue share payout. |
18 | PAYOUT_CURRENCY | Three character currency code | The currency of payout account in which revenue share amount is payed out. |
19 | INVOICE_AMT_IN_ TRANSACTION_CURRENCY |
Money |
This will reflect the calculated invoice amount in transaction currency, rounded to 5 decimal places. If the invoice account's primary currency is different, it will further get converted to invoice account currency. Please see INVOICE_AMT_IN_INVOICE_CURRENCY column. |
20 | INVOICE_AMT_IN_ INVOICE_CURRENCY |
Money |
This reflects the converted amount in invoice account's primary currency, rounded to 5 decimal places. Sum up this amount across different rows and sections for each invoice account to reconcile with what you get in invoice. |
21 | INVOICE_CURRENCY | Three character currency code | The currency of invoice account in which invoice is raised on. |
22 | PP_FX_MARKUP_AMOUNT | Money |
The PayPal markup amount for FX Optimizer enabled currency conversion transactions. |
23 | PARTNER_FX_MARKUP_ AMOUNT |
Money |
The partner's markup amount for FX Optimizer enabled currency conversion transactions. |
Section footer data
Position | Field | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
The column type (SF ). |
2 | Total | Literal |
Total row for the section (TOTAL ). |
17 | Total payout amount | Money |
Total Payout amount for this section in payout account's currency, rounded to 2 decimal places. |
18 | Payout currency | Three character currency code | The currency of payout account. |
20 | Total invoice amount | Money |
Total invoice amount for this section in invoice accounts, rounded to 2 decimal places. |
21 | INVOICE_CURRENCY | Three character currency code | The currency of invoice account in which invoice is raised on. |
22 | PP_FX_MARKUP_AMOUNT | Money |
PayPal markup amount for FX Optimizer enabled currency conversion transaction. |
23 | PARTNER_FX_MARKUP _AMOUNT |
Money |
Partner's markup amount for FX Optimizer currency conversion transaction. |
Total body data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
TB |
2 | CURRENCY | Three character currency code | The currency for the amount represented in the amount column |
3 | AMOUNT | Money |
Total aggregated amount |
4 | ACCOUNT_ID | Varchar |
PayPal encrypted account number for account |
5 | Varchar |
PayPal email ID for account |
Total footer data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
The column type (TF ). |
File footer data
Position | Column name | Data type | Description |
---|---|---|---|
1 | Column Type | Literal |
The column type (FF ). |
Section 3: Reconciliation
You can use this report to reconcile across the Pricing Transaction Report (PRICING_TXN), the Pricing Transaction Revision Report (PRICING_TXN_REVISION), and the Pricing Summary Report (PRICING_SUMMARY). The following sections describe which data points to reconcile with each report.
Reconciliation with PRICING_TXN Report
- Sum of PP_FEES in PRICING_TXN matches with sum of PP_FEES in PRICING_SUMMARY report for each partner identifier.
- Sum of PROCESSING_COST in PRICING_TXN matches with sum of PROCESSING_COST in PRICING_SUMMARY report for each partner identifier.
- Total number of records in PRICING_TXN matches with total number of UNITS column in PRICING_SUMMARY report for each partner identifier.
- Sum of INTERCHANGE_COST in PRICING_TXN matches with sum of INTERCHANGE_COST in PRICING_SUMMARY report for each partner identifier.
- Sum of TRANSACTION_AMOUNT (with 'CR' TRANSACTION_DEBIT_CREDIT_CODE) - Sum of TRANSACTION_AMOUNT (with 'DR' TRANSACTION_DEBIT_CREDIT_CODE) in PRICING_TXN matches with total VOLUME in PRICING_SUMMARY report for each partner identifier.
Reconciliation with PRICING_TXN_REVISION Report
- Sum of INTERCHANGE_COST in PRICING_TXN_REVSION matches with sum of REVISION_REVISED_ASSESSMENT_COST in PRICING_SUMMARY report for each partner identifier.
- Total number of records in PRICING_TXN_REVSION matches with total of REVISION_UNITS in PRICING_SUMMARY report for each partner identifier.
Reconciliation with PRICING_PROGRAM_SUMMARY Report
- Sum of COST in PRICING_PROGRAM_SUMMARY matches with sum of INTERCHANGE_COST and ASSESSMENT_COST in PRICING_SUMMARY report for each partner identifier.
- Sum of REVISION_REVISED_COST in PRICING_PROGRAM_SUMMARY matches with sum of REVISION_REVISED_INTERCHANGE_COST and REVISION_REVISED_ASSESSMENT_COST in PRICING_SUMMARY report for each partner identifier.
- Sum of REVISION_PRIOR_COST in PRICING_PROGRAM_SUMMARY matches with sum of REVISION_PRIOR_INTERCHANGE_COST in PRICING_SUMMARY report for each partner identifier.