Developer's Guide
Table Of Contents
- Gateway Reporting Developer Guide
- Preface
- Reporting Overview
- Using the Reporting API
- Response Codes and Status Codes
- Reporting XML Schema
- Reporting Samples
- Running a Daily Activity Report
- Running a Transaction Summary Report
- Getting Results by Report ID
- Getting Metadata
- Getting Data
- Creating a Report Template
- Updating a Report Template
- Getting a Report Template
- Deleting a Report Template
- Creating a Schedule
- Getting a Schedule
- Updating a Schedule
- Deleting a Schedule
- Running a Transaction ID Search
- Running a Profile - Next Payment Date Report
- Running a Profile - Profile Modified Date Report
- Report Parameters
- Reports in This Appendix
- ACH Activity Summary Report
- ACH Batch ID Report
- ACH Detail Return Activity Report
- ACH Notification of Change Report
- ACH Return Activity Report
- ACH Settlement Report
- ACH Transaction Report
- Auto Credit Report
- Auto Delayed Capture Report
- Auto Resettle Report
- Auto Void Report
- Batch ID Report
- Custom Report
- Daily Activity Report
- Filter Scorecard Report
- Fraud Protection Report
- Payflow Link Orders Report
- PayPal Settlement Summary Report
- Profile Next Payment Report
- Profile Modified Date Report
- Recurring Billing Report
- Recurring Profile Failed Report
- Recurring Profile Report
- Settlement Report
- Shipping and Billing Report
- Transaction Summary Report
- Search Parameters
- Transaction ID Search
- Batch ID Search
- AccountNumberSearch
- CommentSearch
- AccountNumberRefSearch
- PurchaseOrderSearch
- RecurringBillingProfileIDSearch
- RecurringBillingProfileNameSearch
- RecurringBillingAccountNumberSearch
- RecurringBillingCommentSearch
- RecurringBillingAmountSearch
- FraudTransactionSearch
- OrderIDSearch
- PayPalTransactionIDSearch
- PayPalEmailSearch
- PayPalNameSearch
- Index
Gateway Reporting Developer Guide 7
Preface
Gateway Reporting Developer Guide describes the Reporting XML API for the following
Gateway payment solutions:PayPal Payments Advanced, PayPal Payments Pro, Payflow Pro,
and Payflow Link. The XML API enables you to develop Web and desktop applications that
create, schedule, and run standard (pre-defined) and custom Payflow services reports.
Audience
This guide assumes that its readers:
Have a good understanding of XML application development
Have a background in payments services
Organization
This guide is organized as follows:
Chapter 1, “Reporting Overview,” provides an overview of Reporting and the types of
functionality it offers.
Chapter 2, “Using the Reporting API,” describes how to use the Reporting API.
Chapter 3, “Response Codes and Status Codes,” identifies all supported standard reports,
along with the valid and required parameters of each. It also presents status codes and
response codes, along with their associated message strings.
Appendix A, “Reporting XML Schema,” provides the XML schema upon which the
Reporting XML API is based.
Appendix B, “Reporting Samples,” presents samples demonstrating how to use the
reporting API.
Appendix C, “Report Parameters,” describes the input and output parameters for each
standard report.
Appendix D, “Search Parameters,” describes the input and output parameters for
performing searches by search name.