Preapproved Payments Agreement Report Specification

The Preapproved Payments Agreement Report is for use by merchants or payment processing partners, who have integrated the Preapproved Payments Product. The Preapproved Payments Agreement Report gives merchants and processing partners detailed information about outstanding Preapproved Payments billing agreements.

Know before you begin

• You must have a PayPal secure file transfer protocol (SFTP) account to access reports.
• 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. This report is generated and distributed by 9:00 AM daily in the leading timezone of the reporting window.
• The character encoding of this report is UTF-16 (16-bit UCS/Unicode Transformation Format).
• This report is available via the Secure FTP Server for 45 days after the date of its delivery.

Notifications

In the future, PayPal will support multiple versions of this report. PayPal will notify you regarding the creation of any new version as well as any deprecation of older versions of the report. If you wish 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.

PayPal operationally monitors the generation and delivery of this report 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 will notify 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 this report.

Report file name

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

Single account report

The filename of the Dispute Detail Custom report for a single account follows this naming convention:

PPA-yyyymmdd.sequenceNumber.version.format

Multiple account report

When using Multiple Account Management, the filename of the report follows this naming convention:

PPA-yyyymmdd.reportingWindow.sequenceNumber.totalFiles.version.format

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

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

Report row types

This table lists the valid row types, along with the sections that describe the data for that row type.

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

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

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 footer and a report record count. A report with two sections split over two files might be organized as follows:

Report data

This section details the columns and related data that is delivered in the report header, report footer, and report record count records. If the report is split over multiple files, only the last file contains the report footer and report record count records.

Report header data

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

Report footer data

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

Report record count data

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

File data

This section details the columns and related data that is delivered in the file header and file footer records. Each file in the report has a file header and a file footer, even if the number of files in the report is one.

File header data

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

File footer data

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

Section data

This section details the columns and related data that is delivered in the section header, section footer, and section record count records. If you are not using Multiple Account Management, the report contains only one section.

Section header data

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

Section body data

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

Before any rows of body data in the report, a column header row lists the name of each of the fields in each body data row. The column header column starts with CH, followed by the column name for each body data field (except for the column type field). For example:

"CH","Agreement Id","Agreement Action Type","Agreement Payment Type",
"Agreement Max Amount","Total Bill to Date","Agreement Currency",
"Agreement Modification Date","Agreement Description","Agreement Payer PayPal Account ID",
"Agreement Payer Email Address","Agreement Payer Name","Agreement Payer Business Name","Agreement Custom Field"

Section body field definitions

Section footer data

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

Section record count 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.

Version history

See also

• T-codes