Settlement Report Specification - Version 9.0.5
←
→
Page content transcription
If your browser does not render page correctly, please read the page content below
Settlement Report
Specification
Version 9.0.5
Publication Date:
04/18/19Version 9.0.5 ~ Settlement Report Specification
Document Revision History
Pub. Date Version Description of Changes
April 2019 9.0.5 Updated formatting of this report spec document.
Added Troubleshooting Settlement ReportsAppendix E section.
April 2019 9.0.4 Updated file record limit to 1 million.
June 2016 9.0.3 Updated missing T-Codes and added UTF BOM note
September 2015 9.0.2 Various content edits
June 2015 9.0.1 Updated code T0201 in Transaction Event Codes to reflect it can be a user- or system-initiated
currency conversion.
April 2015 9.0 Added Credit Transactional Fee, Credit Promotional Fee, and Credit Term fields to Table
4.2 Section Body Field Definitions.
Report example updated in Sample Settlement Report.
November 2014 8.0 Added Bank Reference ID row to Table 4.2 Section Body Field Definitions.
Report example updated in Sample Settlement Report.
June 2013 7.0.4 Removed incorrect currency information in footer for “Currency of Balance”.
February 2013 7.0.3 Added note about net and gross amounts when fees are involved.
The gross amount is always shown in the reports for transactions processed in any currency.
In cases where there are no fees is involved, the fees will not be shown in the report and the
net amount is same as gross amount.
November 2012 7.0.2 Added new T-code - T0018 (PayPal Here Payment)
September 2012 7.0.1 Changed file format to
STL-yyyymmdd.sequenceNumber.version.format
August 2012 7.0 • Updated report version to 7.
• Updated sample report to version 7.
• Added the following T-codes:
o T0017: store to store transfers
o T0905: offers as funding source
• Added the following fields:
o Store ID
o Beginning Payable Balance
o Ending Payable Balance
© 1999-2019 PayPal, Inc. All rights reserved.
PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other trademarks and brands a re the
property of their respective owners. The information in this document belongs to PayPal, Inc. It may not be used, reproduced or
disclosed without the written approval of PayPal, Inc. Copyright © PayPal. All rights reserved. PayPal (Europe) S.à r.l. et Cie.,
S.C.A., Société en Commandite par Actions. Registered office: 22-24 Boulevard Royal, L-2449, Luxembourg, R.C.S. Luxembourg B
118 349. Consumer advisory: The PayPal™ payment service is regarded as a stored value facility under Singapore law. As such, it
does not require the approval of the Monetary Authority of Singapore. You are advised to read the terms and conditions carefully.
Notice of non-liability: PayPal, Inc. is providing the information in this document to you “AS-IS” with all faults. PayPal, Inc. makes
no warranties of any kind (whether express, implied or statutory) with respect to the information contained herein. PayPal, Inc.
assumes no liability for damages (whether direct or indirect), caused by errors or omissions, or resulting from the use of this
document or the information contained in this document or resulting from the application or use of the product or s ervice described
herein. PayPal, Inc. reserves the right to make changes to any information herein without further notice. PayPal Inc. does no t
guarantee that the features described in this document will be announced or made available to anyone in the futu re.Version 9.0.5 ~ Settlement Report Specification
August 2012 6.0.6 Updated data descriptions for the following fields:
• Fee Amount
• Fee Credit or Debit
• Fee Currency
• PayPal Reference ID
• Transaction ID
April 2012 6.0.5 Updated the data types and data descriptions for footer fields.
January 2012 6.0.4 • Updated sample report
• Update list of footers
July 2011 6.0.3 Removed link to Settlement System and Reconciliation Guide as that doc has been deprecated.
May 2011 6.0.2 Added following T-codes:
• T2111 - Funds not yet available
• T2112 - Funds available
October 2010 6.0.1 Added following T-codes:
• T0015 - Third Party Payout
• T0016 - Third Party Recoupment
• T2201 - Transfer to and from a credit card funded restricted balance
July 2010 6.0 • Updated STL version to 6.0.
• Added following new columns:
o Beginning Available Balance Debit or Credit
o Beginning Available Balance in this currency
o Ending Available Balance Debit or Credit
o Ending Available Balance in this currency
o Beginning Total Balance Debit or Credit
o Beginning Total Balance in this currency
o Ending Total Balance Debit or Credit
o Ending Total Balance in this currency
• Updated sample report
• Added T1502 T-code
March 2010 4.0.5 Added following new columns:
• Beginning Total Balance Debit or Credit
• Beginning Total Balance in This Currency
• Ending Total Balance Debit or Credit
• Ending Total Balance in This Currency
January 2010 4.0.4 • Corrected information in the description of T2106.
• Removed “https” from https://reports.paypal.com”.
October 2009 4.0.3 Changed character encoding from UTF-16 to UTF-8
September 2009 4.0.2 • Added following T-codes:
o T2103 - Reserve Hold
o T2104 – Reserve Release
o T2105 – Payment Review Hold
o T2016 – Payment Review Release
o T2107 – Payment Hold
o T2108 – Payment Hold Release
o T2109 – Gift Hold Release
o T2110 – Gift Certificate Purchase
• Updated sample report.
• Clarification – For “Beginning Balance in This Currency” and “Ending Balance in This
Currency”, the balance refers to the available balance.
August 2009 4.0.1 Added the following T-codes:
• T1601 – BML Credit
• T1801 – BML Withdrawal
4/18/2019 Page 3 of 38Version 9.0.5 ~ Settlement Report Specification
May 2009 4.0.0 • Updated sample report.
• Added information about account correction transactions.
• Changed versioning convention in this document. Now the document version will reflect
the version of the report.
• Changed character encoding from UTF-16 to UTF-8.
March 2009 3.0.5 • Updated Sample Settlement Report
• Updated T-codes appendix
October 2008 3.0.4 • Updated information about report retention time on the Secure FTP Server.
• Changed the Secure FTP server directory location from ppreports to
ppreports/outgoing.
• Added the following T-codes:
o T0014 – Rebate Payments
o T1117 – Rebate Reversal
o T1114 – MassPay Reversal transaction
o T1115 – MassPay Refund transaction
• Changed character encoding from UTF-8 to UTF-16.
November 2007 3.0.3 Noted that claimant information is not available in the STL or TDR reports
September 2007 3.0.2 • Updated reporting window to remove GMT
• Added Partner Merchant ID field to the section header
• Added Consumer ID field to the section body.
August 2007 3.0.1 • Changed delivery time to 12PM in leading time zone
• Updated descriptions for Gross Transaction Amount and Fee Amount for chargebacks
• Updated Tcodes for chargeback processing
May 2007 2.2.5 • Updated transaction codes for Mass Pay transactions.
March 2007 2.2.4 • All consolidated reports are UTF-8 encoded.
• A file footer is present even if the report is only one file.
• Updated the description for the Reference ID Type field.
February 2007 2.2.3 Specification updated:
• Added document and report version number information
• Updated report file structure information
• Changed delivery time to 9AM in report window timezone.
February 2013 1.2.0 • New T-Code group T20xx for transfer of funds from one PayPal account to another
• Additional transaction currencies
August 2006 1.1.0 Specification updated:
• The character encoding of the Settlement Report is UCS-2.
• The Custom field can include the unique ID of payments made with Mass Payments.
• Report file naming convention now includes the total number of files that represent
the report for this date.
June 2006 1.0.1 Specification updated for minor additional information:
• The latest time each day that a Settlement Report is available from the Secure FTP
Server is 6:00AM PST.
• Additional T-Codes:
o T0011 Mobile Payment
o T0012 Virtual Terminal Payment
o T0904 eBay Loyalty Incentive
o T1302 Void
May 2006 1.0.0 Release of Settlement Report Specification Version 1.0.0
4/18/2019 Page 4 of 38Version 9.0.5 ~ Settlement Report Specification
Table of Contents
Chapter 1. Settlement Report Specification.................................................................................. 6
Report Format ...................................................................................................................... 6
Creating a Secure FTP Server User .......................................................................................... 6
Schedule, Distribution, Archiving, and Versioning ...................................................................... 6
Report Filename ................................................................................................................ 7
Single Account Report ..................................................................................................... 7
Multiple Account Report .................................................................................................. 7
Rerunning of the Report ..................................................................................................... 8
Retention ......................................................................................................................... 8
Versioning ........................................................................................................................ 8
Settlement Withdrawal and Effective Time Zones ...................................................................... 8
Operational Notification and Monitoring ................................................................................... 9
Settlement Report Format ...................................................................................................... 9
Character Encoding: UTF-8 ................................................................................................. 9
Field Characteristics ........................................................................................................... 9
Money Fields ................................................................................................................. 9
Internal Punctuation in Fields ......................................................................................... 10
Spaces or Blanks.......................................................................................................... 10
File Structure .................................................................................................................. 10
Chapter 2. Report Data ........................................................................................................... 12
Report Header Data ............................................................................................................ 12
Report Footer Data ............................................................................................................. 13
Report Record Count Data.................................................................................................... 15
Chapter 3. File Data ............................................................................................................... 16
File Header Data ................................................................................................................. 16
File Footer Data .................................................................................................................. 16
Chapter 4. Section Data .......................................................................................................... 17
Section Header Data ........................................................................................................... 17
Section Body Data .............................................................................................................. 18
Section Footer Data ............................................................................................................ 22
Section Record Count Data................................................................................................... 24
Appendix A. Sample Settlement Report ................................................................................. 25
Appendix B. PayPal Reference IDs ........................................................................................ 26
Appendix C. Transaction Event Codes ................................................................................... 27
Appendix D. PayPal-Supported Currencies ............................................................................. 37
Appendix E. Troubleshooting Settlement Reports.................................................................... 38
4/18/2019 Page 5 of 38Version 9.0.5 ~ Settlement Report Specification
Chapter 1. Settlement Report Specification
The Settlement Report is for use by merchants or payment processing partner.
The Settlement Report gives merchants and processing partners detailed information about
each transaction that affects the settlement of funds to their accounts. The report also
summarizes, for each currency held by the accounts, total debits and credits and the
beginning and ending balance.
The Settlement Report is available through PayPal’s website and the Secure FTP Server,
which is defined and described in the Reporting FTP Server Specification.
Report Format
The user must choose the desired format for the report. The Settlement Report is available
in two formats:
• Comma-separated value – Opens or saves the report in a comma-separated values
(CSV) file format, where the data is separated by the comma character and
records/rows are separated by new lines.
• Tab-delimited – Opens and saves the report in .TAB format, where data is
separated by a tab.
Creating a Secure FTP Server User
An extra account needs to be created for the Secure FTP Server. To ensure data security,
account owners must generate their own usernames for the Secure FTP Server with a page
provided on the main PayPal interactive site (https://www.paypal.com).
Schedule, Distribution, Archiving, and Versioning
The Settlement Report is generated and put on PayPal's website or the Secure FTP Server by
no later than 12:00PM daily in the leading timezone of the reporting window.
The report is available on the Secure FTP Server (reports.paypal.com) in the
/ppreports/outgoing directory.
4/18/2019 Page 6 of 38Version 9.0.5 ~ Settlement Report Specification
Report Filename
The filename naming convention depends on whether or not you are using Multiple Account
Management.
Single Account Report
The filename of the Settlement Report for a single account follows this naming convention:
STL-yyyymmdd.sequenceNumber.version.format
TABLE 1.1 SETTLEMENT REPORT FILE NAMING CONVENTIONS
STL An abbreviation for “Settlement Reprt.”
yyyymmdd The date on the data in the report. This date
stamp represents the latest, or ending date, of
the data.
sequenceNumber The sequence number of this file. Two characters,
right-justified and zero-filled. The sequence
number beings with 01 and continues until all
parts are recorded in files.
The sequence number is always present in the file
name even if there is only one file.
version The version of the report. Three characters, right-
justified and zero-filled.
format One of the following:
CSV: a comma-separated value file
TAB: a tab-delimited field file
Multiple Account Report
When using Multiple Account Management, the filename of the Settlement Report follows this
naming convention:
STL-yyyymmdd.reportingWindow.sequenceNumber.totalFiles.version.format
TABLE 1.2 SETTLEMENT REPORT FILE NAMING CONVENTIONS (MULTIPLE ACCOUNT MANAGEMENT)
STL An abbreviation for “Settlement Report.”
yyyymmdd The date on the data in the report. This date
stamp represents the latest, or ending date, of
the data.
reportingWindow The window of time when 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/18/2019 Page 7 of 38Version 9.0.5 ~ Settlement Report Specification
sequenceNumber The sequence number of this file. Two characters,
right-justified and zero-filled. The sequence
number beings with 01 and continues until all
parts are recorded in files.
The sequence number is always present in the file
name even if there is only one file.
totalFiles The total number of files of the report for this
date. The number of files is always two digits and
zero-padded. For example, for 2 total files,
totalFiles is 02.
version The version of the report. Three characters, right-
justified and zero-filled.
format One of the following:
CSV: a comma-separated value file
TAB: a tab-delimited field file
Rerunning of the Report
Reports that are rerun for any reason, such as by user request, overwrite the previously
generated report for the same date.
Retention
The Settlement Report will be available via Paypal's website and the Secure FTP Server for 45
days after the date of its delivery to the Secure FTP Server.
Versioning
In the future, the Settlement Report will be available in multiple versions. PayPal will
communicate the creation of any new version and any deprecation of older versions. Users
that 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 can also receive non-
consecutive versions of the same report concurrently for the purposes of testing and
integration. Users must contact their account manager to enable different versions and
request any changes in report distribution.
Settlement Withdrawal and Effective Time Zones
The Settlement Report reconciles to the Settlement Withdrawal for any time zone from Pacific
Standard Time (PST, which is GMT minus seven hours or eight hours, depending on daylight
savings time) to nine hours ahead of PST.
4/18/2019 Page 8 of 38Version 9.0.5 ~ Settlement Report Specification
Operational Notification and Monitoring
Around-the-clock every day of the year, PayPal operationally monitors the generation and
delivery of the Settlement Report.
PayPal notifies merchant-specified users of the following:
• Advance notification
o System update and maintenance
o New feature releases
o New version availability
• Problems
o Delays in report delivery
o Errors in processing
o System outage
Settlement 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.
For example, 100,00 Yen and $100.00 are both represented as “10000”.
4/18/2019 Page 9 of 38Version 9.0.5 ~ Settlement Report Specification 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 as two 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 up to 1 million transactions. If the report contains more than 1 million transactions, 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. Each row of the report consists of a two letter row type, followed by the details specific to that row type. The table below lists the valid row types, along with the sections that describe the data for that row type. TABLE 1.3 REPORT ROW TYPES Code Description Section RH Report header Report Header Data FH File header File Header Data SH Section header Section Header Data CH Column header Section Body Data SB Row data Section Body Data SF Section footer Section Footer Data SC Section record count Section Record Count Data RF Report footer Report Footer Data RC Report record count Report Record Count Data FF File footer File Footer Data 4/18/2019 Page 10 of 38
Version 9.0.5 ~ Settlement Report Specification
A report file with less than 100,000 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 FF rows are not available in the Settlement 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:
File 1 File 2
Report Header (RH) File Header (FH)
File Header (FH) Row Data (SB)
Section Header (SH) ...
Column Header (CH) Row Data (SB)
Row Data (SB) Section Footer (SF)
... Section Record Count (SC)
Row Data (SB) Report Footer (RF)
Section Footer (SF) Report Record Count (RC)
Section Record Count (SC) File Footer (FF)
Section Header (SH)
Column Header (CH)
Row Data (SB)
...
File Footer (FF)
4/18/2019 Page 11 of 38Version 9.0.5 ~ Settlement Report Specification
Chapter 2. 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.
TABLE 2.1 REPORT HEADER DATA
Position Column name Data Type Data Description
1 Column Type Literal “RH”
2 Report Generation Date date/time The date and time when the report file was
generated, in the following format:
YYYY/MM/DD HH:MM:SS offset
where:
• YYYY is the four-digit year
• MM is the two-digit month of the year
• DD is the two-digit day of the month
• HH is the hour in 24-hour notation
• MM is minutes
• SS is seconds
• Offset is the five-character signed
offset from GMT. For example, +0800.
3 Reporting Window varchar The window of time when 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 Account ID varchar Account number receiving the report (Payer ID
– encrypted hash of PayPal account)
5 Report Version varchar The version of the report
4/18/2019 Page 12 of 38Version 9.0.5 ~ Settlement Report Specification
Report Footer Data
Report footer data exists in one or more rows with each element being separated by the file
delimiter. The report contains one report footer record for each currency with transactions in
the report. All report fields are non-blank unless otherwise noted.
Note: The gross amount is always shown in the reports for transactions processed in
any currency. In cases where there are no fees is involved, the fees will not be
shown in the report and the net amount is same as gross amount.
TABLE 2.2 REPORT FOOTER DATA
Position Column name Data Type Data Description
1 Column Type Literal “RF”
2 Currency of Balance Three-character See PayPal-Supported Currencies for possible
currency code values.
Each currency with transactions in the report
Max length: 3 has a separate row in the report footer.
characters A currency is not reported in the report footer
if no transactions in that currency are in the
report.
3 Total Gross Amount Money The sum of all gross amount credits in the
Credits body data records (SB) of the entire report.
Max length: 26
characters
4 Total Gross Amount Money The sum of all gross amount debits in the body
Debits data records (SB) of the entire report.
Max length: 26
characters
5 Total Transaction Fee Money The sum of all transaction fees credits in the
Credits body data records (SB) of the entire report.
Max length: 26
characters
6 Total Transaction Fee Money The sum of all transaction fees debits in the
Debits body data records (SB) of the entire report.
Max length: 26
characters
7 Beginning Available Literal Part of the beginning total balance that was
Balance Debit or Credit available for withdrawal at the beginning of the
Max length: 2 period. One of two literal strings:
characters • CR: credit
• DR: debit
8 Beginning Available Money Currency of the beginning available balance
Balance in this currency debit or credit.
Max length: 26
characters
4/18/2019 Page 13 of 38Version 9.0.5 ~ Settlement Report Specification
9 Ending Available Balance Literal Part of the ending total balance that was
Debit or Credit available for withdrawal at the beginning of the
Max length: 2 period. One of two literal strings:
characters • CR: credit
• DR: debit
10 Ending Available Balance Money Currency of the ending available balance debit
in this currency or credit.
Max length: 26
characters
11 Beginning Total Balance Literal The total amount in your PayPal account at the
Debit or Credit beginning of the period. One of two literal
Max length: 2 strings:
characters • CR: credit
• DR: debit
12 Beginning Total Balance Money Currency of total beginning balance debit or
in this currency credit.
Max length: 26
characters
13 Ending Total Balance Literal The total amount in your PayPal account at the
Debit or Credit end of the period. One of two literal strings:
Max length: 2 • CR: credit
characters • DR: debit
14 Ending Total Balance in Money Currency of total ending balance debit or
this currency credit.
Max length: 26
characters
15 Beginning Payable Literal One of two literal strings:
Balance Debit or Credit • CR: credit
Max length: 2 • DR: debit
characters
16 Beginning Payable Money The amount owed by you, but not received into
Balance your account at the beginning of the reporting
Max length: 26 period.
characters
17 Ending Payable Balance Literal One of two literal strings:
Debit or Credit • CR: credit
Max length: 2 • DR: debit
characters
18 Ending Payable Balance Money The amount owed by you, but not received into
your account at the end of the reporting
Max length: 26 period.
characters
19 Report Record Count Number Total number of section body records in the
entire report.
Max length: no
limit
4/18/2019 Page 14 of 38Version 9.0.5 ~ Settlement Report Specification
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.
TABLE 2.3 REPORT RECORD COUNT DATA
Position Column name Data Type Data Description
1 Column Type Literal “RC”
2 Row Count Number The number of body data rows in the report (used for
reconciliation). Note that the report may span multiple
files.
4/18/2019 Page 15 of 38Version 9.0.5 ~ Settlement Report Specification
Chapter 3. File Data
This section details the columns and related data that is delivered in the file header and file
footer 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.
TABLE 3.1 FILE HEADER DATA
Position Column name Data Type Data Description
1 Column Type Literal “FH”
2 File Count Number The sequence number of the file in the report
(used for reconciliation).
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.
TABLE 3.2 FILE FOOTER DATA
Position Column name Data Type Data Description
1 Column Type Literal “FF”
2 Row Count Number The number of body data rows in the file (used
for reconciliation).
4/18/2019 Page 16 of 38Version 9.0.5 ~ Settlement Report Specification
Chapter 4. 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.
TABLE 4.1 SECTION HEADER DATA
Position Column name Data Type Data Description
1 Column Type Literal “SH”
2 Reporting Period Start date/time The date and time that represents the
Date beginning time period of the report, in the
following format:
YYYY/MM/DD HH:MM:SS offset
where:
• YYYY is the four-digit year
• MM is the two-digit month of the year
• DD is the two-digit day of the month
• HH is the hour in 24-hour notation
• MM is minutes
• SS is seconds
• Offset is the five-character signed
offset from GMT. For example, +0800.
3 Reporting Period Ending date/time The date and time that represents the ending
Date time period of the report, in the following
format:
YYYY/MM/DD HH:MM:SS offset
where:
• YYYY is the four-digit year
• MM is the two-digit month of the year
• DD is the two-digit day of the month
• HH is the hour in 24-hour notation
• MM is minutes
• SS is seconds
• Offset is the five-character signed
offset from GMT. For example, +0800.
4 Account ID varchar Encrypted account number generated by
PayPal.
4/18/2019 Page 17 of 38Version 9.0.5 ~ Settlement Report Specification
5 Partner Account ID varchar The partner’s account ID for the merchant. This
is the value passed by the partner in the
Blanks: Yes tag of the
Max length: 127 multiple account management batch input file.
characters See Multiple Account Management for more
information.
Section Body Data
The records in the Section Body are preceded by a single line of literal column headings that
identify the fields in the records that follow. The column heading line is identified by the line
type identifier CH.
The Section Body contains multiple records, one per balance-affecting transaction. The
Section Body fields are on a single row for each transaction. The data elements are
separated by the report recipient’s desired field delimiter.
Notes:
- 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.
- The gross amount is always shown in the reports for transactions processed in any
currency. In cases where there are no fees is involved, the fees will not be shown in
the report and the net amount is same as gross amount.
TABLE 4.2 SECTION BODY FIELD DEFINITIONS
Position Column name Data Type Data Description
1 Column Type Literal “SB”
2 Transaction ID varchar Transaction ID of the money moving event. This
ID is generated by PayPal exclusively and
Unique: Yes cannot be altered by merchant.
Blanks: Yes
Max length: 24
characters
3 Invoice ID Text Invoice ID set by merchant with transaction.
Uniqueness can be enforced by PayPal when
Unique: No the transaction is created.
Blanks: Yes If an invoice ID was sent with the capture
Max length: 127 request, this value is reported here. However, if
characters no invoice ID was sent with the capture
request, the value of the invoice ID (if any)
from the authorizing transaction is reported
here.
4/18/2019 Page 18 of 38Version 9.0.5 ~ Settlement Report Specification
4 PayPal Reference ID varchar A PayPal reference ID is defined as a related,
pre-existing transaction or event. For
Unique: Yes examples, see PayPal Reference IDs.
Blanks: Yes
Max length: 24
characters
5 PayPal Reference ID Type Text One of the following 3-character codes:
ODR: Order ID
Unique: Yes TXN: Transaction ID
Blanks: Yes SUB: Subscription ID
Max length: 3
PAP: Preapproved Payment ID
characters
Refer to the documentation for each of these
types for a description of the length and data
type of the PayPal Reference ID field.
6 Transaction Event Code Alphanumeric Transaction event type or “T-Code.” See
Transaction Event Codes.
Unique: No
Blanks: No
Max length: 5
characters
7 Transaction Initiation date/time Date and time the transaction was initiated, in
Date the following format:
Unique: No YYYY/MM/DD HH:MM:SS offset
Blanks: Yes where:
Max length: 25 • YYYY is the four-digit year
characters • MM is the two-digit month of the year
• DD is the two-digit day of the month
• HH is the hour in 24-hour notation
• MM is minutes
• SS is seconds
• Offset is the five-character signed
offset from GMT. For example, +0800.
8 Transaction Completion date/time Date and time the transaction was completed,
Date in the following format:
Unique: No YYYY/MM/DD HH:MM:SS offset
Blanks: Yes where:
Max length: 25 • YYYY is the four-digit year
characters • MM is the two-digit month of the year
• DD is the two-digit day of the month
• HH is the hour in 24-hour notation
• MM is minutes
• SS is seconds
• Offset is the five-character signed
offset from GMT. For example, +0800.
9 Transaction Debit or Text Direction of money movement of gross
Credit amount, as one of two literal strings:
Unique: No • CR: Credit
Blanks: No • DR: Debit
Max length: 2
characters
4/18/2019 Page 19 of 38Version 9.0.5 ~ Settlement Report Specification
10 Gross Transaction Money The amount of the payment—before fees—
Amount between the two parties.
Unique: No This field contains the gross transaction value
Blanks: No for all transactions.
Max length: 26
characters Note: There are “handling fees” and other “non-
transactional” fees that will be reported as gross
amounts without fees reported in the fee column.
See Transaction Event Codes for more information
about non-transactional fees.
11 Gross Transaction Three-character Currency of transaction. See PayPal-Supported
Currency currency code Currencies for possible values.
Unique: No
Blanks: No
Max length: 3
characters
12 Fee Debit or Credit Char Direction of money-movement for fee, as one
of two literal strings:
Unique: No • CR: Credit
Blanks: Yes • DR: Debit
Max length: 2
characters
13 Fee Amount Number The record of fees associated with the
settlement. All transactional fees are included
Unique: No in this amount. Fees are never amortized
Blanks: Yes across several transactions.
Max length: 26 This field contains the fee amount value for all
characters transactions where a transactional fee has been
processed.
Note: There are “handling fees” and other “non-
transactional” fees that will be reported as gross
amounts without fees reported in the fee column.
See Transaction Event Codes for more information
about non-transactional fees.
14 Fee Currency Char Currency of fee. See PayPal-Supported
Currencies for possible values.
Unique: No
Blanks: Yes
Max length: 3
characters
15 Custom Field varchar Custom text set by the merchant with the
transaction. Reserved exclusively for merchant
Unique: No use. In the Settlement Report, this field can
Blanks: Yes include the unique ID of payments made with
Max length: 256 Mass Payment.
characters
16 Consumer ID varchar The consumer’s account number generated by
PayPal (encrypted hash of the PayPal account
Unique: No number).
Blanks: Yes
Max length: 127
characters
4/18/2019 Page 20 of 38Version 9.0.5 ~ Settlement Report Specification
17 Payment Tracking ID varchar Unique ID specified by partners to obtain
information about a payment or to request a
Unique: No refund.
Blanks: Yes
Max length: 127
characters
18 Store ID varchar ID of the store where the offer was used.
Unique: No
Blanks: Yes
Max length: 50
characters
19 Bank Reference ID varchar For debits only, an alphanumeric value that
appears against the transaction in the bank
Unique: Yes statement of the merchant. This enables the
Blanks: No merchant to reference the transaction against
Max length: 13 the report entry.
characters
20 Credit Transactional Fee Number The credit related transaction fee amount for a
merchant selected credit offering.
Unique: No
Blanks: Yes
Max length: 26
characters
21 Credit Promotional Fee Number The credit related transaction fee amount for a
merchant selected credit offering with a
Unique: No promotional APR.
Blanks: Yes
Max length: 26
characters
22 Credit Term Number The time span covered by the merchant
selected credit offer. The length of the term is
Unique: No captured in months.
Blanks: Yes
Max length: 26
characters
4/18/2019 Page 21 of 38Version 9.0.5 ~ Settlement Report Specification
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.
Note: The gross amount is always shown in the reports for transactions processed in
any currency. In cases where there are no fees is involved, the fees will not be
shown in the report and the net amount is same as gross amount.
TABLE 4.3 SECTION FOOTER DATA
Position Column name Data Type Data Description
1 Column Type Literal “SF”
2 Currency of Balance Three-character See PayPal-Supported Currencies for possible
currency code values.
There is a separate row for each currency that
Max length: 3 has ever held a balance in the account.
characters
3 Total Gross Amount Money The sum of all gross amount credits in the body
Credits data records (SB) of the entire report.
Max length: 26
characters
4 Total Gross Amount Money The sum of all gross amount debits in the body
Debits data records (SB) of the entire report.
Max length: 26
characters
5 Total Transaction Fee Money The sum of all transaction fee credits in the
Credits body data records (SB) of the entire report.
Max length: 26
characters
6 Total Transaction Fee Money The sum of all transaction fee debits in the
Debits body data records (SB) of the entire report.
Max length: 26
characters
7 Beginning Available Literal Part of the beginning total balance that was
Balance Debit or Credit available for withdrawal at the beginning of the
Max length: 2 period. One of two literal strings:
characters • CR: Credit
• DR: Debit
8 Beginning Available Money Currency of the beginning available balance
Balance in this currency debit or credit.
Max length: 26
characters
9 Ending Available Balance Literal Part of the ending total balance that was
Debit or Credit available for withdrawal at the beginning of the
Max length: 2 period. One of two literal strings:
characters • CR: Credit
• DR: Debit
4/18/2019 Page 22 of 38Version 9.0.5 ~ Settlement Report Specification
10 Ending Available Balance Money Currency of the ending available balance debit
in this currency or credit.
Max length: 26
characters
11 Beginning Total Balance Literal The total amount in your PayPal account at the
Debit or Credit beginning of the period. One of two literal
Max length: 2 strings:
characters • CR: Credit
• DR: Debit
12 Beginning Total Balance Money Currency of total beginning balance debit or
in this currency credit.
Max length: 26
characters
13 Ending Total Balance Literal The total amount in your PayPal account at the
Debit or Credit ending of the period. One of two literal strings:
Max length: 2 • CR: Credit
characters • DR: Debit
14 Ending Total Balance in Money Currency of total ending balance debit or credit.
this currency
Max length: 26
characters
15 Beginning Payable Literal One of two literal strings:
Balance Debit or Credit • CR: Credit
Max length: 2 • DR: Debit
characters
16 Beginning Payable Money The amount owed by you, but not received into
Balance your account in this currency at the beginning
Max length: 26 of the reporting period.
characters
17 Ending Payable Balance Literal One of two literal strings:
Debit or Credit • CR: Credit
Max length: 2 • DR: Debit
characters
18 Ending Payable Balance Money The amount owed by you, but not received into
your account in the currency at the end of the
Max length: 26 reporting period.
characters
19 Section Record Count Number Total number of section body records in this
section.
Max length: no
limit
4/18/2019 Page 23 of 38Version 9.0.5 ~ Settlement Report Specification
Section Record Count Data
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.
TABLE 4.4 SECTION RECORD COUNT DATA
Position Column name Data Type Data Description
1 Column Type Literal “SC”
2 Row Count Number The number of body data rows in the section
(used for reconciliation).
4/18/2019 Page 24 of 38Version 9.0.5 ~ Settlement Report Specification
Appendix A. Sample Settlement Report
The following is a sample report for Settlement Report.
"RH",2012/08/13 23:53:12 -0700,"A","HEDH43SEL62QA",007,
"FH",01
"SH",2012/08/08 00:00:00 -0700,2012/08/08 23:59:59 -0700,"HEDH43SEL62QA",""
"CH","Transaction ID","Invoice ID","PayPal Reference ID","PayPal Reference
ID Type","Transaction Event Code","Transaction Initiation
Date","Transaction Completion Date","Transaction Debit or Credit","Gross
Transaction Amount","Gross Transaction Currency","Fee Debit or Credit","Fee
Amount","Fee Currency","Custom Field","Consumer ID","Payment Tracking
ID","Store ID","Bank Reference ID","Credit Transactional Fee","Credit
Promotional Fee","Credit Term"
"SB","84T79597V5700301S","","6W048172DY1452538","TXN","T1110",2012/08/08
01:02:38 -0700,2012/08/08 01:02:38 -
0700,"DR",643,"USD","",,"","","BGM5SAJ6D5DBE","",""
"SB","84T79597V5700301S","","6W048172DY1452538","TXN","T1111",2012/08/08
01:02:38 -0700,2012/08/08 01:57:26 -
0700,"CR",643,"USD","",,"","","BGM5SAJ6D5DBE","",""
"SB","3E503680WL249060K","","","","T0006",2012/08/08 02:03:34 -
0700,2012/08/08 02:03:34 -
0700,"CR",700,"USD","DR",57,"USD","","BGM5SAJ6D5DBE","",""
"SF","USD",3329,2629,0,114,"CR",50002905,"CR",50003491,"CR",50002905,"CR",5
0003491,"CR",0,"CR",0,3
"SC",3
"RF","USD",3329,2629,0,114,"CR",50002905,"CR",50003491,"CR",50002905,"CR",5
0003491,"CR",0,"CR",0,3
"RC",3
"FF",3
4/18/2019 Page 25 of 38Version 9.0.5 ~ Settlement Report Specification
Appendix B. PayPal 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.
TABLE B.1 TRANSACTION TYPES AND THEIR REFERENCE TRANSACTIONS
Transaction Type Reference ID
Settlement on Authorization Original Authorization
Full Refund Originating Settlement
Partial Refund Originating Settlement
Settlement on Reauthorization Original Authorization
Completed Chargeback (Merchant Loss) Disputed Sale or Settlement
Completed Buyer Complaint (Merchant Loss) Disputed Sale or Settlement
Settlement Adjustment Settlement or Sale Transaction
Reimbursement Settlement or Sale Transaction
Reversal Original Settlement
Account Correction Original transaction against which correction was
made.
4/18/2019 Page 26 of 38Version 9.0.5 ~ Settlement Report Specification
Appendix C. Transaction Event Codes
Transaction event codes (or “T-codes”) are five characters long:
• The capital letter “T” followed by a two-digit general accounting event group
• A two-digit specific event type code
The second and third character of the T-code group are sufficient for reconciliation and report
parsing.
The Rev Share column identifies whether events associated with each T-code are used in
the calculation of revenue share, and whether that calculation is a credit (CR) or debit (DR).
T- codes that have neither a CR or DR entry are not used for revenue share calculation.
Note that any event can be either a Credit (CR), or Debit (DR) based on the direction of the
payment relative to the subject of the payment. For example, an Express Checkout event
(T0006) is recorded as a CR in the case where the subject is a seller (receiving funds for a
payment) and as a DR in the case where the subject is a buyer (sending funds for a
payment).
TABLE C.1 TRANSACTION EVENT CODE (T-CODE) DEFINITIONS
T-Code Example Transaction or
Rev Share Specific T-Code Description
Group Comment
T00xx - PayPal Account to PayPal Account Payment
General: received payment of a
CR T0000 type not belonging to the other
T00xx categories
T0001 MassPay Payment
Subscription Payment, either
CR T0002
payment sent or payment received
Preapproved Payment (BillUser
CR T0003
API), either sent or received
CR T0004 eBay Auction Payment
CR T0005 Direct Payment API
CR T0006 Express Checkout APIs
Website Payments Standard
CR T0007
Payment
4/18/2019 Page 27 of 38Version 9.0.5 ~ Settlement Report Specification
T0008 Postage payment to carrier.
Gift Certificate Payment: purchase
CR T0009
of Gift Certificate
CR T0010 3rd Party Auction Payment
Mobile Payment (made via a
CR T0011
mobile phone)
CR T0012 Virtual Terminal Payment
T0013 Donation Payment
T0014 Rebate Payments
T0015 Third Party Payout
T0016 Third Party Recoupment
T0017 Store to Store Transfers
T0018 PayPal Here Payment
Generic Instrument funded
T0019
Payment
T01xx - Non-Payment-Related Fees
General non-payment fee of a type
T0100 not belonging to the other T01xx
categories
Website Payments Pro Account
T0101
Monthly Fee
T0102 Foreign Bank Withdrawal Fee
T0103 WorldLink Check Withdrawal Fee
T0104 Mass Payment Batch Fee
T0105 Check Withdrawal
Chargeback
Processing/Handling Fee
charged against account
T0106 Chargeback Processing Fee
which has received a
chargeback for a previous
transaction
T0107 Payment Fee
4/18/2019 Page 28 of 38Version 9.0.5 ~ Settlement Report Specification
T0108 ATM Withdrawal
T0109 Auto-sweep from account
International Credit Card
T0110
Withdrawal
Warranty Fee for Warranty
T0111
Purchase
T0112 Gift Certificate Expiration Fee
T0113 Partner Fee
T02xx - Currency Conversion
# Transfer of funds from
one currency balance to a
different currency balance
T0200 General Currency Conversion # Withdrawal of funds from
one currency balance that is
covered by funds from a
different currency balance
User- or System-initiated Currency
T0201
Conversion
Currency Conversion required to
T0202 PayPal-system generated
cover negative balance
T03xx - Bank Deposit into PayPal Account
General Funding of PayPal Deposit to PayPal balance
T0300
Account from a bank account
PayPal Balance Manager Funding
T0301 PayPal-system generated
of PayPal Account
ACH Funding for Funds Recovery
T0302
from Account Balance
Electronic Funds Transfer (EFT)
T0303
(German banking)
T04xx - Bank Withdrawal from PayPal Account
General Withdrawal from PayPal Settlement Withdrawal or
T0400
Account user-initiated
T0401 AutoSweep
4/18/2019 Page 29 of 38Version 9.0.5 ~ Settlement Report Specification
T05xx - Debit Card
Requires a PayPal debit
General PayPal Debit Card
T0500 card associated with the
Transaction
PayPal account
Virtual PayPal Debit Card
T0501
Transaction
PayPal Debit Card Withdrawal to
T0502
ATM
Hidden Virtual PayPal Debit Card
T0503
Transaction
T0504 PayPal Debit Card Cash Advance
T0505 PayPal Debit Authorization
T06xx - Credit Card Withdrawal
Reversal of purchase with a
credit card. Seen only in
T0600 General Credit Card Withdrawal
PayPal account of the credit
card owner.
T07xx - Credit Card Deposit
T0700 General Credit Card Deposit Purchase with a credit card
Credit Card Deposit for Negative
T0701
PayPal Account Balance
T08xx - Bonus
General bonus of a type not
T0800 belonging to the other T08xx
categories
Requires a PayPal debit
T0801 Debit Card Cash Back Bonus card associated with the
PayPal account
Must have created a
T0802 Merchant Referral Account Bonus Merchant Referral Bonus
link
T0803 Balance Manager Account Bonus
T0804 PayPal Buyer Warranty Bonus
4/18/2019 Page 30 of 38Version 9.0.5 ~ Settlement Report Specification
PayPal Protection Bonus, Payout
for PayPal Buyer Protection,
T0805
Payout for Full Protection with
PayPal Buyer Credit
T0806 Bonus for First ACH Use
Credit Card Security Charge
T0807
Refund
T0808 Credit Card Cash Back Bonus
T09xx - Incentive
General Incentive/Certificate
T0900
Redemption
T0901 Gift Certificate Redemption
T0902 Points Incentive Redemption
T0903 Coupon Redemption
T0904 eBay Loyalty Incentive
T0905 Offers used as funding source
T10xx - Bill Pay
T1000 BillPay transaction
T11xx - Reversal
General reversal of a type not
DR T1100 belonging to the other T11xx
categories
Reversal of a withdrawal
Reversal of ACH Withdrawal
T1101 from PayPal balance to a
Transaction
bank account
Reversal of a debit card
T1102 Reversal of Debit Card Transaction payment. Requires a PayPal
debit card
T1103 Reversal of Points Usage
T1104 Reversal of ACH Deposit
T1105 Reversal of General Account Hold
4/18/2019 Page 31 of 38Version 9.0.5 ~ Settlement Report Specification
Payment Reversal, initiated by
DR T1106 Completion of a chargeback
PayPal
Payment Refund, initiated by
DR T1107
merchant
T1108 Fee Reversal
T1109 Fee Refund
Hold for Dispute Investigation (cf. To cover possible
T1110
T15xx) chargeback
Cancellation of temporary
Cancellation of Hold for Dispute
T1111 hold to cover possible
Resolution
chargeback
T1112 MAM Reversal
T1113 Non-Reference Credit Payment
T1114 MassPay Reversal Transaction
T1115 MassPay Refund Transaction
Instant Payment Review (IPR)
T1116
Reversal
T1117 Rebate/Cashback Reversal
Generic Instrument/Open wallet
T1118
Reversals (Seller side)
Generic Instrument/Open wallet
T1119
Reversals (Buyer side)
T12xx - Adjustment
DR T1200 General Account Adjustment
DR T1201 Chargeback
T1202 Chargeback Reversal
T1203 Charge-off Adjustment
T1204 Incentive Adjustment
T1205 Reimbursement of Chargeback
Chargeback Representment Adjustment to PayPal
T1207
Rejection Account for Reversal of
payment based on rejection
4/18/2019 Page 32 of 38Version 9.0.5 ~ Settlement Report Specification
of the representment for a
chargeback in the PayPal
system
Adjustment to PayPal
Account for Reversal of
chargeback reversal based
T1208 Chargeback Cancellation
on cancellation of a
chargeback in the PayPal
system
T13xx - Authorization
Note: Appears only in Transaction Detail Report, not Settlement Report.
T1300 General Authorization
T1301 Reauthorization
T1302 Void of Authorization
T14xx - Dividend
T1400 General Dividend
T15xx - Hold for Dispute or Other Investigation
General temporary hold of a type
T1500 not belonging to the other T15xx
categories
Account Hold for Open
T1501
Authorization
T1502 Account Hold for ACH Deposit
Temp Hold - Hold on available
T1503
balance
T16xx - Buyer Credit Deposit
PayPal Buyer Credit Payment Must have signed up for
T1600
Funding Buyer Credit
T1601 BML Credit - Transfer from BML
T1602 Buyer Credit Payment
Buyer Credit Payment Withdrawal
T1603
- Transfer To BML
T17xx - Non-Bank Withdrawal
4/18/2019 Page 33 of 38Version 9.0.5 ~ Settlement Report Specification
General Withdrawal to Non-Bank
T1700
Institution
T1701 WorldLink Withdrawal
T18xx - Buyer Credit Withdrawal
Must have signed up for
T1800 General Buyer Credit Payment
Buyer Credit
BML Withdrawal - Transfer to
T1801
BML
T19xx - Account Correction
General Adjustment without
T1900
business-related event
T20xx - Funds Transfer from PayPal Account to Another
T2000 General intra-account transfer
T2001 Settlement Consolidation
T2002 Transfer of funds from Payable
T2003 Transfer To External GL Entity
T21xx - Reserves and Releases
T2101 General Hold
T2102 General Hold Release
PayPal is holding x% of
funds for y days as a
condition for processing for
T2103 Reserve Hold you. This amount is part of
your total balance, and will
not be available for
withdrawal
A reserve, when released, is
T2104 Reserve Release now available for
withdrawal.
A payment review hold is
used to protect you against
T2105 Payment Review Hold unauthorized fraud loss and
for seller protection. While
a transaction is on payment
review hold, we
4/18/2019 Page 34 of 38Version 9.0.5 ~ Settlement Report Specification
recommend that you do not
ship the item. We are
reviewing this transaction
for up to 24 hours.
A payment review hold,
T2106 Payment Review Release when released, is now
available for withdrawal.
Payment holds are funds
that belong to you that we
set aside, such as security
T2107 Payment Hold deposit. This amount is part
of your total balance, and
will not be available for
withdrawal.
A payment hold, when
T2108 Payment Hold Release released, is now available
for withdrawal.
When a gift certificate is
purchased by your buyer,
T2109 Gift Certificate Purchase
then that amount is placed
on hold.
A gift certificate, when
T2110 Gift Certificate Redemption redeemed, is available for
withdrawal.
While you establish a
successful sales history on
eBay, funds from eBay
sales are usually available
in 21 days or less, based on
how you ship the order.
You may get your funds
faster if you print your
T2111 Funds not yet available
shipping labels on eBay or
PayPal, upload tracking
information, or mark the
item as Shipped on eBay. If
your buyer reports a
problem with the sale, it
may take longer to get your
funds.
T2112 Funds available
4/18/2019 Page 35 of 38You can also read
