Order Report

DocsCurrent


The Order Report (ORT) gives merchants and processing partners detailed information about outstanding authorized orders that can be captured.

Know before you begin

  • The report is generated and delivered by PayPal on a 24-hour basis.
  • The report is available on the PayPal website and the Secure FTP Server for 45 days after the date of its delivery.
  • The report format is either comma-separated value (CSV) or tab-delimited values.
  • The character encoding of this report is UTF-8 (8-bit UCS/Unicode Transformation Format).

Distribution and access

Access the ORT from the Secure FTP Server, reports.paypal.com, which requires a separate user account for access to the Order Report. A user account that is enabled for the ORT is also enabled to create user accounts for the Secure Drop-Box. To ensure data security, ORT users must generate their own user accounts for the Secure Drop-Box.

The following steps describe how to set up and access the ORT using the Secure FTP Server:

  1. Create a Secure FTP Server user account. Login to PayPal (www.paypal.com) and create a Secure PayPal Reporting FTP Server username and password. Passwords for accessing the Secure FTP Server cannot be reset by PayPal. To obtain a new password, you must create a new Secure FTP Server user account.
  2. Grant access to third-party users. You must explicitly grant access to third-parties by contacting their PayPal Account Manager to provide the following information:

    • Third-parties’ PayPal login username
    • Type of permission: reporting access (read)

      The third-party is then notified by email that access to the business partner’s Secure FTP Server has been granted.

  3. Access the Secure FTP Server programmatically using an FTP client. The hostname of the Secure FTP Server is reports.paypal.com. A user account on the Secure FTP Server has the /ppreports/outgoing directory structure.

Report file name

The file name naming convention depends on whether or not you are using Multiple Account Management (MAM).

Single account report

The filename of the Order report for a single account follows this naming convention: ORT-yyyymmdd.sequenceNumber.version.format

Field Description
ORT An abbreviation for "Downloadable Order Report."
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 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 one file.
version The version of the report. Three characters, right-justified, and zero-filled.
format One of the following:
  • A comma-separated value file (CSV)
  • A tab-delimited-field file (TAB)

Multiple account report

The file name of the Multiple Account Management (MAM) follows this naming convention: ORT-yyyymmdd.reportingWindow.sequenceNumber.totalFiles.version.format

Field Description
ORT An abbreviation for "Downloadable Order 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:

  • X: GMT 00:00 to GMT -0500
  • A: GMT -0500 to GMT-0800
  • H: GMT-0800 to GMT +0800
  • R: GMT +0800 to GMT 00:00
sequenceNumber The 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 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:
  • A comma-separated value file (CSV)
  • A tab-delimited-field file (TAB)

New or revised versions

In the future, PayPal will support multiple versions of the ORT. PayPal will notify you regarding the creation of any new version as well as any deprecation of older versions of the report.

If you want to take advantage of a new version, you can receive two versions of the same report concurrently in order to test and integrate the new version. You can also receive nonconsecutive versions of the same report concurrently in order to test and integrate the new version. Contact your PayPal Account Manager to enable different versions and request any changes in report distribution.

Notifications

PayPal operationally monitors the generation and delivery of the ORT on a 24/7 365 basis. PayPal maintains two different user contact points for report notifications:

  • A business contact point for all notifications related to data integrity, data delivery, and new reporting features
  • A technical contact for all notifications related to data integrity, data delivery, system outages, system updates, and new features.

PayPal notifies you of the following events related to reporting:

  • Delays in report delivery
  • Errors in report generation
  • New version availability
  • System outage
  • System update/maintenance (pre-announcement)
  • New reporting feature releases

Contact your PayPal Account Manager to provide PayPal with the appropriate notification email alias. PayPal strongly recommends that you create a distribution list or email alias that allows multiple parties to receive communication about the ORT.

File structure

The report is 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.

Each row of the report consists of a two letter row type, followed by the details specific to that row type. This table lists the valid row types, along with the sections that describe the data for that row type.

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 footer data
FF File footer File 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)

For report files that are split across 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 across 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)

Section 1: 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 across 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.

Position Column name Data type 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/DDHH:MM:SS offset, where offset is the five-character signed offset from GMT, such as +0800.
3 Reporting Window Varchar The window of time when the report was generated, as follows:
  • X: GMT 00:00 to GMT -0500.
  • A: GMT -0500 to GMT-0800.
  • H: GMT-0800 to GMT +0800.
  • R: GMT +0800 to GMT 00:00.
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.

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.

Position Column name Data type Description
1 Column Type Literal RF
2 Row Count Number The number of body data rows in the report (used for reconciliation). The report might span multiple files.

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.

Position Column name Data type Description
1 Column Type Literal RC
2 Row Count Number The number of body data rows in the report (used for reconciliation). The report might span multiple files.

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

Position Column name Data type 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 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 FF
2 Row Count Number The number of body data rows in the file (used for reconciliation)

Section 3. 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 one section only.

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.

Position Column name Data type Description
1 Column Type Literal SH
2 Reporting period start date date/time The date time that represents the 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 end date date/time The date time that represents the ending 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 Account number generated by PayPal.

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). For example:

"CH","Order ID","Order Action Type","Order Currency","Order Creation Date", Order Payer PayPal Account ID","Order Payer email address","Order Payer Name", "Order Payer Business Name","Shipping Address Line1","Shipping Address City", "Shipping Address State","Shipping Address Zip","Shipping Address Country", "Order Description","Order Memo","Order Custom Field"

Position Column name Data type Description
1 Column Type Literal SB
2 Order ID
  • Type: varchar
  • Blanks: yes
  • Max length: 24 characters
The authorization identification number of the payment you want to capture. This can be an order number, an order authorization number, or a reauthorization number.
3 Order action type
  • Type: alphanumeric
  • Max length: 5 characters
One of the following values:
  • O0000: Order Created: general
  • O0100: Order Canceled: general
  • O0200: Order Voided: general
4 Order creation date
  • Type: date/time
  • Max length: 25 characters
The date time that represents the ending 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
5 Order currency
  • Type: three-character currency code.
  • Max length: 3 characters
Currency of transaction. See PayPal-supported currencies for possible values.
6 Order Payer PayPal account ID
  • Type: varchar
  • Blanks: yes
  • Max length: 24 characters
Unique PayPal customer account number.
7 Order payer e-mail address
  • Type: varchar
  • Max length: 127 characters
E-mail address of the payer.
8 Order payer name
  • Type: varchar
  • Blanks: yes
  • Max length: 55 characters
Currency of transaction. See PayPal-supported currencies for possible values.
9 Order payer business name
  • Type: varchar
  • Blanks: yes
  • Max length: 127 characters
Payer's business name.
10 Shipping address line 1
  • Type: varchar
  • Blanks: yes
  • Max length: 300 characters
Street address of shipping address as specified by the buyer.
11 Shipping address line 2
  • Type: text
  • Blanks: yes
  • Max length: 300 characters
Street address of shipping address as specified by buyer.
12 Shipping address city
  • Type: text
  • Blanks: yes
  • Max length: 120 characters
City of shipping address as specified by buyer.
13 Shipping address state
  • Type: text
  • Blanks: yes
  • Max length: 120 characters
State, province, or territory of shipping address as specified by payer.
14 Shipping address zip
  • Type: varchar
  • Blanks: yes
  • Max length: 60 characters
Postal code of shipping address as specified by payer.
15 Shipping address country
  • Type: varchar
  • Blanks: yes
  • Max length: 64 characters
Country of shipping address as specified by payer.
16 Order description
  • Type: alphanumeric
  • Blanks: yes
  • Max length: 200 characters
Description of the agreed as specified by the merchant.
17 Order memo
  • Type: varchar
  • Blanks: yes
  • Max length: 4000 characters
Text entered by payer in the memo field during the enrollment.
18 Order custom field
  • Type: varchar
  • Blanks: yes
  • Max length: 256 characters
Custom content specified by originator of the agreement. Reserved for use by merchant.

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.

Position Column name Data type Description
1 Column Type Literal SF
2 Row Count Number The number of body data rows in the file (used for reconciliation)

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.

Position Column name Data type Description
1 Column Type Literal SC
2 Row Count Number The number of body data rows in the file (used for reconciliation)

PayPal-supported currencies

The following currencies are supported by PayPal for use with payments and and as currency balances:

Currency ISO-4217 Code
Australian Dollar AUD
Brazilian Real
This currency is supported as a payment currency and a currency balance for in-country PayPal accounts only.
BRL
Canadian Dollar CAD
Czech Koruna CZK
Danish Krone DKK
Mexican Peso MXN
Hong Kong Dolar HKD
Hungarian Forint HUF
Israeli New Sheqel ILS
Japanese Yen JPY
Malaysian Ringgit
This currency is supported as a payment currency and a currency balance for in-country PayPal accounts only.
MYR
Norwegian Krone NOK
New Zealand Dollar NZD
Philippine Peso PHP
Polish Zloty PLN
Pound Sterling GBP
Russian Ruble RUB
Singapore Dollar SGD
Swedish Krona SEK
Swiss Franc CHF
Taiwan New Dollar TWD
Thai Baht THB
Turkish Lira TRY
U.S. Dollar USD

See also