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 15
Using the Reporting API
Using Report Templates
2
The response to creating a report template returns a respCode and respMsg.
Step 2. Update a report template
To update a report template, call the updateTemplateRequest with the following
parameters.
updateTemplateRequest(templateName, reportParams)
The response to updating a report template returns a respCode and respMsg.
N OTE: Updating a report template is not incremental. It only sets values for the parameters
that are passed to updateTemplateRequest.
Step 3. Delete a report template
To delete a report template, call deleteTemplateRequest, providing the
templateName as the input parameter.
deleteTemplateRequest(templateName)
The response to deleting a report template returns a respCode and respMsg.
Using Report Templates
Report templates are run like any standard report. They can also be scheduled to run on a daily,
weekly, or monthly basis. Finally, report template schedules can be updated or deleted.
Running a report template and obtaining the report template data
Step 1. Run a report template
To run a report template, call runReportRequest with the following parameters.
runReportRequest(templateName, reportParams, pageSize).
reportName Standard report from which you are creating the report template.
reportParam(s) paramName and paramValue of each reportParam to be assigned a
value.
templateName Name given to the report template when it was created.
reportParam(s) paramName and paramValue of each reportParam to be assigned a
value.
templateName Name given to the report template when it was created.