Transaction Detail Report Specification

The Transaction Detail Report is for use by any merchant or payment processing partner. The Transaction Detail Report gives merchants and processing partners detailed information about each transaction occurring in the account, whether they affect the balance or not.

The report also summarizes total debits and credits for each currency held by the accounts.

The report provides details on individual payments made for any single day within the past 45 days. The Transaction Detail Report is available through PayPal’s website or the Secure Dropbox, which is defined and described in the Secure FTP Server Specification.

Know before you begin

• You must be an approved merchant to use this report. Contact your PayPal account manager to request access to this report.
• This report is generated and placed on SFTP on a 24-hour basis. The report format is CSV (comma-separated value).
• This report includes alternative payment methods (APMs). See the list of supported APMs.
• Money amount fields are unsigned, with no currency symbol, decimal separator, or other punctuation. Amounts should be interpreted by the debit or credit column to ensure that the right direction of the amount is recorded. For instance, 100,00 yen and $100.00 USD are both represented as 10000.
• The character encoding of this report is UTF-8 (8-bit UCS/Unicode Transformation Format).
• Regardless of the field delimiter of the report, all fields of type varchar are surrounded with double quotation marks. Double quotation marks inside the field are represented as two double quotation marks in succession.
• Some fields can contain spaces. In the descriptions of fields, this is indicated with the words: Blanks: Yes.
• See PayPal Supported Currencies for a list of all ISO-4217 currency codes that PayPal supports for use with payments and balances.

Creating a secure Dropbox user

Account owners must generate their own usernames for the Secure Dropbox at paypal.com.

Schedule, distribution, archiving, and versioning

The Transaction Detail Report is generated and put on PayPal's website and the Secure Dropbox by no later than 12:00PM daily in the leading timezone of the reporting window. The report is available on the Secure FTP Server in the /ppreports/outgoingdirectory. See Access SFTP reports for instructions.

Report file name

The filename naming convention depends on whether or not you are using Multiple Account Management.

Single account report

The filename of the Transaction Detail Report for a single account follows this naming convention: TRR-yyyymmdd.sequenceNumber.version.format

Multiple account report

When using Multiple Account Management, the filename of the Transaction Detail Report follows this naming convention: TRR-yyyymmdd.reportingWindow.sequenceNumber.totalFiles.version.format

Retention

The Transaction Detail Report will be available in the Secure Dropbox for 45 days after its delivery.

Versioning

The Transaction Detail Report will support multiple versions in the future. PayPal will communicate the creation of any new version as well as any deprecation of older versions. Users who wish to take advantage of new versions will be able to receive two versions of the same report concurrently for the purposes of testing and integration. Users will also be able to receive nonconsecutive versions of the same report concurrently for the purposes of testing and integration. Users will need to contact their account manager to enable different versions and request any changes in report distribution.

Report format

Character encoding: UTF-8

The report’s character encoding is UTF-8 (8-bit UCS/Unicode Transformation Format). Note: Any report encoded with UTF-8 files will have the BOM (Byte Order Mark) character in the beginning of the report.

Field characteristics

Fields in lines and records can be separated by one of two delimiters, as specified by the report recipient when signing up for the report:

• Comma
• Tab

Money fields

Money amount fields are unsigned, with no currency symbol, decimal separator, or other punctuation. Amounts should be interpreted by the debit or credit column to ensure that the right direction of the amount is recorded. Moreover, the amounts provided for shipping amount, tax amount and insurance amount should always be considered to be the direction of the gross transaction amount.

Internal punctuation in fields

Regardless of the field delimiter of the report, all fields of type varchar are surrounded with double quotation marks. Double quotation marks inside the field are represented astwo double quotation marks in succession.

Spaces or blanks

Some fields can contain spaces. In the descriptions of fields, this is indicated with the words: Blanks: Yes

File structure

The report can be delivered as either a comma-separated values or tab-delimited file. This section describes the structure of the data file. A report file can contain a maximum of 1 million records. If the report contains more than 1 million records, the report is split across multiple files. The report is also organized by section, where each section represents a single PayPal account. If you are not using PayPal Multiple Account Management, the report contains only a single section.

Report row types

Each row of the report consists of a two letter row type, followed by the details specific to that row type.

A report file with fewer than 1 million records (a single file) with only one section is organized as follows:

Report Header (RH)
File Header (FH)
Section Header (SH)
Column Header (CH)
Row Data (SB)
...
Row Data (SB)
Section Footer (SF)
Section Record Count (SC)
Report Footer (RF)
Report Record Count (RC)
File Footer (FF)

Note: The FH, SC, RC, and RF rows are not available in the Transaction Detail Report, version 001.

For report files that are split over multiple files, only the first file has a report header record and only the last file has a report footer and a report record count record. A report with two sections split over two files might be organized as follows:

Report data

This section details the columns and related data that is delivered in the report header, report footer, and report record count records.

Note: If the report is split over multiple files, only the last file contains the report footer and report record count records.

Report header data

Report header data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Report footer data

Report footer data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Report record count data

Report record count data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

File data

This section details the columns and related data that is delivered in the file header, file footer, and file record count records.

Note: Each file in the report has a file header and a file footer, even if the number of files in the report is one.

File header data

File header data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

File footer data

File footer data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Section data

This section details the columns and related data that is delivered in the section header, section footer, and section record count records.

Note: If you are not using Multiple Account Management, the report contains only one section.

Section header data

All section header data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Section body data

Body data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted. Before any rows of body data in the report, a column header row lists the name of each of the fields in each body data row. The column header column starts with CH, followed by the Column Name for each body data field (except for the column type field).

Note: For transactions with disputes associated with them, claimant information is displayed only in the dispute report. It is not included in the settlement report or the transaction detail report.

Additional Fields

These are additional fields user can get as part of report customisations & can work with Customer Service agent to get these if needed.

Section footer data

Section footer data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Section record count

Section record count data exists in one row with each element being separated by the file delimiter. All report fields are non-blank unless otherwise noted.

Reference IDs

Certain transaction types have a pre-existing or originating transaction or event from which they derive or to which they are related. These PayPal reference transactions or events have a unique PayPal reference ID.

• 1:n relationship: A reference transaction or event always has a one-to-one relationship to a single referred transaction or event. Although one reference transaction can have multiple referred transactions, a referred transaction has only reference transaction.
• Event: Reference transactions are only transactions that move money or are related to a future money movement, such as an order, an authorization, a subscription, or a preapproved payment

Version history

See also

• T-codes