Settlement Report Specification

DocsCurrentLast updated: October 12th 2021, @ 6:58:00 pm


The Settlement Report is for use by merchants or payment processing partner. This 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 Secure FTP Server Specification.

On this page

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).
  • 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.
  • See T-Codes for a list of transaction event codes.

Creating a secure FTP server user

Account owners must generate their own usernames for the Secure Dropbox at 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 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 Settlement Report for a single account follows this naming convention: STL-yyyymmdd.sequenceNumber.version.format

FieldInformation
STLAn abbreviation for Settlement Report.
yyyymmddThe date on the data in the report. This date stamp represents the latest, or ending date, of the data.
sequenceNumberThe sequence number of this file. Two characters, right-justified and zero-filled. The sequence number begins with 01 and continues until all parts are recorded in files. The sequence number is always present in the report file name even if there is only one file.
versionThe version of the report. Three characters, right-justified and zero-filled.
formatOne 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

FieldInformation
STLAn abbreviation for Settlement Report.
yyyymmddThe date on the data in the report. This date stamp represents the latest, or ending date, of the data.
reportingWindowThe 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
sequenceNumberThe sequence number of this file. Two characters, right-justified and zero-filled. The sequence number begins with 01 and continues until all parts are recorded in files. The sequence number is always present in the report file name even if there is only one file.
totalFilesThe 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.
versionThe version of the report. Three characters, right-justified and zero-filled.
formatOne of the following:
  • CSV: a comma-separated value file
  • TAB: a tab-delimited-field file

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 nonconsecutive 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.

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

  • System update and maintenance
  • New feature releases
  • New version availability

Problems

  • Delays in report delivery
  • Errors in processing
  • System outage

Report format

The user must choose the desired format for the report. The Settlement Report is available in two formats:

  • Comma-separated value (CSV): Opens or saves the report in CSV file format, where the data is separated by the comma character and records/rows are separated by new lines.
  • Tab-delimited (TAB): Opens and saves the report in .TAB format, where data is separated by a tab.

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.

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 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.

CodeDescriptionSection
RHReport headerReport Header Data
FHFile headerFile Header Data
SHSection headerSection Header Data
CHColumn headerSection Body Data
SBRow dataSection Body Data
SFSection footerSection Footer Data
SCSection record countSection Record Count Data
RFReport footerReport Footer Data
RCReport record countReport Record Count Data
FFFile footerFile Footer Data

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 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 1File 2
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)
Section Header (SH)
Column Header (CH)
Row Data (SB)
...
File Footer (FF)
File Header (FH)
Row Data (SB)
...
Row Data (SB)
Section Footer (SF)
Section Record Count (SC)
Report Footer (RF)
Report Record Count (RC)
File Footer (FF)

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.

PositionColumn NameData TypeData Description
1Column TypeType: LiteralRH
2Report Generation DateType: date/timeThe 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 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.
3Reporting WindowType: VarcharThe 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
4Account IDType: VarcharAccount number receiving the report (Payer ID – encrypted hash of PayPal account).
5Report VersionType: VarcharThe version of the report.

Report footer data exists in one row 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.

PositionColumn NameData TypeDescription
1Column TypeLiteralRF
2Currency of balanceThree-character currency code
Max length: 3 characters
See PayPal-Supported Currencies for possible values. Each currency with transactions in the report has a separate row in the report footer. A currency is not reported in the report footer if no transactions in that currency are in the report.
3Total Gross Amount CreditsMoney
Max length: 26 characters
The sum of all gross amount credits in the body data records (SB) of the entire report.
4Total Gross Amount DebitsMoney
Max length: 26 characters
The sum of all gross amount debits in the body data records (SB) of the entire report.
5Total Transaction Fee CreditsMoney
Max length: 26 characters
The sum of all transaction fees credits in the body data records (SB) of the entire report.
6Total Transaction Fee DebitsMoney
Max length: 26 characters
The sum of all transaction fees debits in the body data records (SB) of the entire report.
7Beginning Available Balance Debit or CreditLiteral
Max length: 2 characters
Part of the beginning total balance that was available for withdrawal at the beginning of the period. One of two literal strings:
  • CR: credit
  • DR: debit
8Beginning Available Balance in this currencyMoney
Max length: 26 characters
Currency of the beginning available balance debit or credit.
9Ending Available Balance Debit or CreditLiteral
Max length: 2 characters
Part of the ending total balance that was available for withdrawal at the beginning of the period. One of two literal strings:
  • CR: credit
  • DR: debit
10Ending Available Balance in this currencyMoney
Max length: 26 characters
Currency of the ending available balance debit or credit.
11Beginning Total Balance Debit or CreditLiteral
Max length: 2 characters
The total amount in your PayPal account at the beginning of the period. One of two literal strings:
  • CR: credit
  • DR: debit
12Beginning Total Balance in this currencyMoney
Max length: 26 characters
Currency of total beginning balance debit or credit.
13Ending Total Balance Debit or CreditLiteral
Max length: 2 characters
The total amount in your PayPal account at the end of the period. One of two literal strings:
  • CR: credit
  • DR: debit
14Ending Total Balance in this currencyMoney
Max length: 26 characters
Currency of total ending balance debit or credit.
15Beginning Payable Balance Debit or CreditLiteral
Max length: 2 characters
One of two literal strings:
  • CR: credit
  • DR: debit
16Beginning Payable BalanceMoney
Max length: 26 characters
The amount owed by you, but not received into your account at the beginning of the reporting period.
17Ending Payable BalanceDebit or CreditLiteral
Max length: 2 characters
One of two literal strings:
  • CR: credit
  • DR: debit
18Ending Payable BalanceMoney
Max length: 26 characters
The amount owed by you, but not received into your account at the end of the reporting period.
19Report Record CountNumber
Max length: no limit
Total number of section body.

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.

PositionColumn NameData TypeDescription
1Column TypeType: LiteralRC
2Row CountType: NumberThe number of body data rows in the report (used for reconciliation). Note that the report may span multiple files.

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.

PositionColumn NameData TypeDescription
1Column TypeType: LiteralFH
2File CountType: NumberThe sequence number of the file in the report (used for reconciliation).

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.

PositionColumn NameData TypeDescription
1Column TypeType: LiteralFF
2Row CountType: NumberThe number of body data rows in the file (used for reconciliation).

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.

PositionColumn nameData typeDescription
1Column TypeLiteral"SH"
2Reporting period start dateDate/timeThe date and time when the report file was generated, in the following format: YYYY/MM/DDHH: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, `+800`
3Reporting period end dateDate/timeThe date and time when the report file was generated, in the following format: YYYY/MM/DDHH: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, `+800`
4Account IDVarcharAccount number generated by PayPal.
5Partner Account ID
  • Type: Varchar
  • Blanks: Yes
  • Max Length: 127 characters
The partner’s account ID for the merchant. This is the value passed by the partner in the <PartnerMerchantExternalID> tag of the multiple account management batch input file. 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.

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.

PositionField nameData CharacteristicsDescription
1 Column Type Literal "SB"
2 Transaction ID
  • Type: Varchar
  • Unique: Yes
  • Blanks: Yes
  • Max Length: 24 characters
Transaction ID of the money moving event. This ID is generated by PayPal exclusively and cannot be altered by merchant.
3 Invoice ID
  • Type: Text
  • Unique: No
  • Blanks: Yes
  • Max Length: 127 characters
Invoice ID set by merchant with transaction. Uniqueness can be enforced by PayPal when the transaction is created. If an invoice ID was sent with the capture request, this value is reported here. However, if 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 PayPal Reference ID
  • Type: Varchar
  • Unique: Yes
  • Blanks: Yes
  • Max Length: 24 characters
A PayPal reference ID is defined as a related, pre-existing transaction or event. See Reference IDs.
5 PayPal Reference ID Type
  • Type: Text
  • Unique: Yes
  • Blanks: Yes
  • Max Length: 3 characters
One of the following 3-character codes:
  • ODR: Order ID
  • TXN: Transaction ID
  • SUB: Subscription ID
  • PAP: Preapproved Payment ID
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
  • Type: Alphanumeric
  • Unique: No
  • Blanks: No
  • Max Length: 5 characters
Transaction event type or T-Code. See T-Codes.
7 Transaction Initiation Date
  • Type: Date/Time
  • Unique: No
  • Blanks: Yes
  • Max Length: 25 characters
Date and time the transaction was initiated, in the following format: YYYY/MM/DD HH:MM:SS offset. Where:
  • YYYY is the four-digit year.
  • MM is 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
  • Type: Date/Time
  • Unique: No
  • Blanks: Yes
  • Max Length: 25 characters
Date and time the transaction was initiated, in the following format: YYYY/MM/DD HH:MM:SS offset. Where:
  • YYYY is the four-digit year.
  • MM is 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 Credit
  • Type: Date/Time
  • Unique: No
  • Blanks: Yes
  • Max Length: 25 characters
Direction of money movement of gross amount, as one of two literal strings:
  • CR: Credit
  • DR: Debit
10 Gross Transaction Amount
  • Type: Currency/Money
  • Unique: No
  • Blanks: No
  • Max Length: 26 characters
The amount of the payment—before fees—between the two parties. This field contains the gross transaction value for all transactions. There are handling fees and other non-transactional fees that will be reported as gross amounts without fees reported in the fee column. See T-Codes.
11 Gross Transaction Currency
  • Type: Three-character currency code
  • Unique: No
  • Blanks: No
  • Max Length: 3 characters
Currency of transaction. See PayPal Supported Currencies.
12 Fee Debit or Credit
  • Type: Char
  • Unique: Yes
  • Blanks: No
  • Max Length: 2 characters
Direction of money-movement for fee, as one of two literal strings:
  • CR: Credit
  • DR: Debit
.
13 Fee Amount
  • Type: Number
  • Unique: No
  • Blanks: Yes
  • Max Length: 26 characters
The record of fees associated with the settlement. All transactional fees are included in this amount. Fees are never amortized across several transactions. This field contains the fee amount value for all transactions where a transactional fee has been processed. There are handling fees and other non-transactional fees that will bereported as gross amounts without fees reported in the fee column. See T-Codes.
14 Fee Currency
  • Type: Char
  • Unique: No
  • Blanks: Yes
  • Max Length: 3 characters
Currency of fees. See PayPal Supported Currencies.
15 Custom Field
  • Type: varchar
  • Unique: No
  • Blanks: Yes
  • Max Length: 256 characters
Custom text set by the merchant with the transaction. Reserved exclusively for merchant use. In the Settlement Report, this field can include the unique ID of payments made with Mass Payment.
16 Consumer ID
  • Type: varchar
  • Unique: No
  • Blanks: Yes
  • Max Length: 127 characters
TThe consumer’s account number generated by PayPal (encrypted hash of the PayPal account number).
17 Payment Tracking ID
  • Type: varchar
  • Unique: No
  • Blanks: Yes
  • Max Length: 127 characters
Unique ID specified by partners to obtain information about a payment or to request a refund.
18 store ID
  • Type: varchar
  • Unique: No
  • Blanks: Yes
  • Max Length: 50 characters
ID of the store where the offer was used.
19 Bank Reference ID
  • Type: varchar
  • Unique: No
  • Blanks: Yes
  • Max Length: 13 characters
For debits only, an alphanumeric value that appears against the transaction in the bank statement of the merchant. This enables the merchant to reference the transaction against the report entry.
20 Credit Transactional Fee
  • Type: Number
  • Unique: No
  • Blanks: Yes
  • Max Length: 26 characters
The credit related transaction fee amount for a merchant selected credit offering.
21 Credit Promotional Fee
  • Type: Number
  • Unique: No
  • Blanks: Yes
  • Max Length: 26 characters
The credit related transaction fee amount for a merchant selected credit offering with a promotional APR.
22 Credit Term
  • Type: Number
  • Unique: No
  • Blanks: Yes
  • Max Length: 26 characters
The time span covered by the merchant selected credit offer. The length of the term is captured in months.
23 Item Name
  • Type: Alphanumeric
  • Unique: No
  • Blanks: Yes
  • Max Length: 127 characters
Specified by buyer in the website Auction/Item Title field. Specified by seller in any of the following button creation fields (item_name or item_name_x):
  • PayPal Shopping Cart Item Name
  • Buy Now Item Name
  • Donations Item Name
  • Subscriptions Name

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.

Position Column name Data type Description
1 Column Type Literal "SF"
2 Currency of Balance Three-character currency code
Max length: 3 characters
See PayPal-Supported Currencies for possible values. There is a separate row for each currency that has ever held a balance in the account.
3 Total Gross Amount Credits Money
Max length: 26 characters
The sum of all gross amount credits in the body data records (SB) of the entire report.
4 Total Gross Amount Debits Money
Max length: 26 characters
The sum of all gross amount debits in the body data records (SB) of the entire report.
5 Total Transaction Fee Credits Money
Max length: 26 characters
The sum of all transaction fee credits in the body data records (SB) of the entire report.
6 Total Transaction Fee Debits Money
Max length: 26 characters
The sum of all transaction fee debits in the body data records (SB) of the entire report.
7 Beginning Available Balance Debit or Credit Literal
Max length: 2 characters
Part of the beginning total balance that was available for withdrawal at the beginning of the period. One of two literal strings:
  • CR: Credit
  • DR: Debit
8 Beginning Available Balance in this currency Money
Max length: 26 characters
Currency of the beginning available balance debit or credit.
9 Ending Available Balance Debit or Credit Literal
Max length: 2 characters
Part of the ending total balance that was available for withdrawal at the beginning of the period. One of two literal strings:
  • CR: Credit
  • DR: Debit
10 Ending Available Balance in this currency Money
Max length: 26 characters
Currency of the ending available balance debit or credit.
11 Beginning Total Balance Debit or Credit Literal
Max length: 2 characters
The total amount in your PayPal account at the beginning of the period. One of two literal strings:
  • CR: Credit
  • DR: Debit
12 Beginning Total Balance in this currency Money
Max length: 26 characters
Currency of total beginning balance debit or credit.
13 Ending Total Balance Debit or Credit Literal
Max length: 2 characters
The total amount in your PayPal account at the ending of the period. One of two literal strings:
  • CR: Credit
  • DR: Debit
14 Ending Total Balance in this currencyMoney
Max length: 26 characters
Currency of total ending balance debit or credit.
15 Beginning Payable Balance Debit or Credit Literal
Max length: 2 characters
One of two literal strings:
  • CR: Credit
  • DR: Debit
16 Beginning Payable BalanceMoney
Max length: 26 characters
The amount owed by you, but not received into your account in this currency at the beginning of the reporting period.
17 Ending Payable Balance Debit or Credit Literal
Max length: 2 characters
One of two literal strings:
  • CR: Credit
  • DR: Debit
18 Ending Payable Balance Money
Max length: 26 characters
The amount owed by you, but not received into your account in the currency at the end of the reporting period.
19 Section Record Count Number
Max length: no limit
Total number of section body records in this section.

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.

Position Column name Data type Description
1 Column Type Literal "SC"
2 Row count NumberThe number of body data rows in the section (used for reconciliation).

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.
Transaction TypeReference ID
Settlement on AuthorizationOriginal Authorization
Full RefundOriginating Settlement
Partial RefundOriginating Settlement
Settlement on ReauthorizationOriginating Settlement
Completed Chargeback (Merchant Loss)Disputed Sale or Settlement
Completed Buyer Complaint (Merchant Loss)Disputed Sale or Settlement
Settlement AdjustmentSettlement or Sale Transaction
ReimbursementSettlement or Sale Transaction
ReversalOriginal Settlement
Account CorrectionOriginal transaction against which correction was made

Troubleshooting

Important: PayPal updated the settlement functionality to eliminate the occasional mismatch between the balance on your settlement report and the amount settled into your bank account. We are currently onboarding merchants to the updated settlement functionality. This section of the specification is only applicable to those merchants who have been onboarded to the updated settlement functionality. Please contact your account manager for more information.

Refer to the following tips when troubleshooting issues with the settlement report.

IssueResolution
Transaction is missing from the expected settlement report.Settlement for a given transaction might not occur on the day you expect. This most commonly happens when the transaction misses the settlement cut off.

When the settlement does occur, it will display the original transaction date and will appear in the settlement report of the day it is settled.

Version history

Publication dateVersionChanges
October 202012Convertd this report specification from PDF to HTML.
December 201911.1.1Added new T-Code designation – T0020: Tax Collected by Partner
April 201911.1Updated file record limit from 150,000 to 1 million.
July 201811.0GST Amount was converted to Sales Tax Amount.
Called out deprecation of Gift Card ID field.
June 201610.0.5Updated missing T-Codes and added UTF BOM note.
September 201510.0.4Various content edits
November 201210.0.3Added new T-code - T0018 (PayPal Here Payment)
October 201210.0.2Added new column - 3PL Reference ID
Updated sample report
September 201210.0.1Changed file format to -TRR-yyyymmdd.sequenceNumber.version.format
August 201210.0Added following T-codes:
  • T0017: store to store transfers
  • T0905: Offers as funding source

Added the following fields:
  • Checkout Type
  • Coupons
  • Loyalty Card Number
  • Secondary Shipping Address City
  • Secondary Shipping Address Country
  • Secondary Shipping Address Line 1
  • Secondary Shipping Address Line 2
  • Secondary Shipping Address State
  • Secondary Shipping Address Zip
  • Special Offers
  • Store ID
  • Terminal ID

Updated definition of T-code T0008.
Updated doc version number to 10.
Updated sample report to version 10.
August 20128.0Updated field definitions for the following:
  • Auction Buyer ID
  • Auction Site
  • Billing Address Line1
  • Billing Address Line2
  • Billing Address Country
  • Billing Address Zip
  • Fee Amount
  • Fee Currency
  • Fee Debit or Credit
  • Payer's Account Id
  • Payer's Address Status
  • Payment Source
  • PayPal Reference ID
  • Protection Eligibility
  • Shipping Address Line1
  • Shipping Address Line2
  • Shipping Address Country
  • Shipping Address Zip
  • Shipping Method
  • Transaction ID
  • Transaction Note
April 20128.0Updated maximum length of the following columns:
  • Shipping/Billing Address Line 1 - Max length 300 characters
  • Shipping/Billing Address Line 2 - Max length 300 characters
  • Shipping/Billing Address City - Max length 120 characters
  • Shipping/Billing Address State - Max length 120 characters
  • Shipping/Billing Address Zip - Max length 60 characters
  • Shipping/Billing Address Country - Max length 64 characters
May 20118.0Added following T-codes:
  • T2111 - Funds not yet available
  • T2112 - Funds available
November 20108.0Updated document version to 8.0.
Changed character encoding form UTF -16 to UTF - 8.
October 20107.0.6Added following T-codes:
  • T0015 - Third Party Payout
  • T0016 - Third Party Recoupment
  • T2201 - Transfer to and from a credit card funded restricted balance
July 20107.0.5Added T1503 T-code.
May 20107.0.4Added following T-codes:
  • T9701- Funds Payable
  • T9702- Funds Receivable
January 20107.0.3Corrected information in the description of T2106
Removed https from https://reports.paypal.com.
September 20097.0.2Added following T-codes:
  • T2103 - Reserve Hold
  • T2104 - Reserve Release
  • T2105 - Payment Review Hold
  • T2106 - Payment Review Release
  • T2107 - Payment Hold
  • T2108 - Payment Hold Release
  • T2109 - Gift Hold Release
  • T2110 - Gift Certificate Purchase
August 20097.0.1Added following T-codes:
  • T1601- BML Credit
  • T1801- BML Withdrawal
September 20087.0Added the following fields:
  • Authorization Review Status
  • Protection Eligibility

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.
May 20086.0Added following columns:
  • Card Type
  • Payment Source
  • Shipping Name
February 20085.0Added following columns:
  • Consumer ID
  • First Name
  • Last Name
  • Consumer Business Name
September 20074.0Added column for Shipping Method.
July 20073.0Added following columns:
  • Billing Address Line 1
  • Billing Address Line 2
  • Billing Address City
  • Billing Address State
  • Billing Address Zip
  • Billing Address Country
January 20072.0Added Column for PayPal Reference ID Type.
August 20061.0Release of Settlement Report

See also

T-codes