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 11
2
Using the Reporting API
This chapter describes how you can use the Reporting API to perform the following tasks.
“Running Reports” on page 12
“Managing Report Templates” on page 14
“Using Report Templates” on page 15
“Performing Searches” on page 18
API Notation in this Chapter
The chapter uses the following short-hand notation for referring to Reporting API requests and
parameter information.
requestName (paramName, paramName, [...])
requestName is the name of the request. The request input parameters, if any, are listed in a
parameter list enclosed in parentheses.
Request Authorization Parameter Data
The Reporting API notation in this chapter does not include the authorization information that
is passed with every request. All Reporting API requests require that you specify these
parameters and values as your user information.
TABLE 2.1 User information
Parameter Description
user If you set up one or more additional users on the account, this value is
the ID of the user authorized to process transactions. If, however, you
have not set up additional users on the account, user has the same value
as vendor.
vendor Your merchant login ID that you created when you registered for the
Payflow Pro account.
partner The ID provided to you by the authorized PayPal Reseller who
registered you for the Payflow Pro service. If you purchased your
account directly from PayPal, use PayPal.
password The 6- to 32-character password that you defined while registering for
the account.