Pricing program summary report
Docs
Last updated: Aug 15th, 7:17am
This report provides a summary view of the interchange and assessment program and their costs.
Know before you begin
- You must be 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.
- 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.
- 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 transaction currency.
- This report is only available to partners who are on gross billing fees or a net settlement revenue share model and have interchange plus pricing.
Section 1: Report file name
The file name of the Pricing Program Summary Report for a single account follows this naming convention:
PRICING_PROGRAM_SUMMARY.yyyymm.ReportIdentifier.ReportingWindow.SequenceNumber.MajorVersion.MinorVersion.Format
| Field | Information |
|---|---|
PRICING_PROGRAM_SUMMARY |
An abbreviation for Pricing Program Summary Report. |
yyyymm |
The month for the data in the report. |
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 when 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) and transaction currency. |
| CH | Column header |
| SB | Section body |
| SF | Section footer |
| SH | Section header. This report contains multiple sections each being a unique combination of partner identifier (button source code or organization name) and transaction currency. |
| 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:
|
| 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 | Transaction currency | Three-character currency code | Currency of transactions reported in the section. |
Section body data
| Position | Column name | Data type | Description |
|---|---|---|---|
| 1 | Column Type | Literal |
The column type (CH). |
| 2 | PROGRAM | Varchar |
Interchange or Assessment program name. |
| 3 | VARIABLE_RATE | Varchar |
Percentage rate of mentioned program. |
| 4 | FIXED_RATE | Money |
Fixed amount component of mentioned program. |
| 5 | UNITS | Varchar |
Number of units for current month. |
| 6 | VOLUME | Money |
Volume of the transaction for current month. |
| 7 | COST | Money |
Total cost for the mentioned program for current month. |
| 8 | REVISION_UNITS | Varchar |
Number of units that received revisions. |
| 9 | REVISION_PRIOR_COST | Money |
Prior Cost for units that received revisions having mentioned Interchange program as the prior program. |
| 10 | REVISION_REVISED_COST | Money |
Revised cost for units that received revisions. |
| 11 | 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:
|
| 12 | PAYMENT_INSTRUMENT_SUBTYPE | Varchar |
One of the following detailed classifications of the financial
instrument used to fund a payment:
For example:
|
| 12 | NETWORK_NAME | varchar |
Pinless debit network name, such as the following:
|
| 13 | PROGRAM_TYPE | varchar |
Indicates the type of Program the cost corresponds to, such as the
following:
|
| 14 | PRICING_FEE_TYPE | varchar |
One of the following fee types, based on transaction and forward or
reverse money movement
|
Section footer data
| Position | Column name | Data type | Description |
|---|---|---|---|
| 1 | Column Type | Literal |
The column type (SF). |
File footer data
| Position | Column name | Data type | Description |
|---|---|---|---|
| 1 | Column Type | Literal |
The column type (FF). |