Developer's Guide
Table Of Contents
- Payflow Pro Reporting Developer’s 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
- Daily Activity Report
- Transaction Summary Report
- Settlement Report
- PayPal Settlement Summary Report
- Shipping and Billing Report
- Batch ID Report
- Custom Report
- Fraud Protection Report
- Filter Scorecard Report
- Auto Delayed Capture Report
- Auto Credit Report
- Auto Void Report
- Auto Resettle Report
- Recurring Billing Report
- Recurring Profile Report
- Recurring Profile Failed Report
- Search Parameters
- Transaction ID Search
- Batch ID Search
- AccountNumberSearch
- CommentSearch
- AccountNumberRefSearch
- PurchaseOrderSearch
- RecurringBillingProfileIDSearch
- RecurringBillingProfileNameSearch
- RecurringBillingAccountNumberSearch
- RecurringBillingCommentSearch
- RecurringBillingAmountSearch
- FraudTransactionSearch
- OrderIDSearch
- PayPalTransactionIDSearch
- PayPalEmailSearch
- PayPalNameSearch
- Index
Using the Reporting API
Performing Searches
2
18 Reporting Developer’s Guide
Performing Searches
Using the Reporting API, you can search for transaction data by any of the following search
names.
z TransactionIDSearch
z BatchIDSearch
z AccountNumberSearch
z CommentSearch
z AccountNumberRefSearch
z PurchaseOrderSearch
z RecurringBillingProfileIDSearch
z RecurringBillingProfileNameSearch
z RecurringBillingAccountNumberSearch
z RecurringBillingCommentSearch
z RecurringBillingAmountSearch
Step 1. Run the search request
To run a search request, call runSearchRequest with the following parameters.
runSearchRequest(searchName, reportParam(s), pageSize)
runSearchResponse returns the reportId for this search as well as the statusCode
and statusMsg.
Step 2. Get the metadata
Request to get the search metadata by calling getMetaDataRequest. See “Step 2. Get the
metadata” on page 13.
Step 3. Get the report data
Request to get the search data by calling getDataRequest. See “Step 3. Get the report
data” on page 13.
searchName One of the search names listed above, for example,
TransactionIDSearch.
reportParam(s) paramName and paramValue of one or more input parameters for this
search. See
Appendix C, “Report Parameters,” for the required and
optional parameters.
pageSize Number of rows of data per page. Default is 50.