Gateway Reporting
Developer Guide
Last updated: May 2012
Gateway Reporting Developer Guide
Document Number: 200046.en_US-201205
© 2012 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other
trademarks and brands are the property of their respective owners.
The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc.
Copyright © PayPal. All rights reserved. PayPal (Europe) S.à r.l. et Cie., S.C.A., Société en Commandite par Actions. Registered office: 22-24 Boulevard
Royal, L-2449, Luxembourg, R.C.S. Luxembourg B 118 349.
Consumer advisory: The PayPal™ payment service is regarded as a stored value facility under Singapore law. As such, it does not require the approval
of the Monetary Authority of Singapore. You are advised to read the terms and conditions carefully.
Notice of non-liability:
PayPal, Inc. is providing the information in this document to you “AS-IS” with all faults. PayPal, Inc. makes no warranties of any kind (whether express,
implied or statutory) with respect to the information contained herein. PayPal, Inc. assumes no liability for damages (whether direct or indirect), caused
by errors or omissions, or resulting from the use of this document or the information contained in this document or resulting from the application or use
of the product or service described herein. PayPal, Inc. reserves the right to make changes to any information herein without further notice.
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Where to Go for More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
How to Contact Customer Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Chapter 1 Reporting Overview . . . . . . . . . . . . . . . . . . . . . 9
Operations You Can Perform Using the Reporting API . . . . . . . . . . . . . . . . . . . . 9
Managing Report Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Running Reports by Report Template Name or Report Name. . . . . . . . . . . . . . 10
Obtaining Information about Reports . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Managing Report Template Schedules . . . . . . . . . . . . . . . . . . . . . . . . . 10
Performing Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
URL for Running Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Live Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Test Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Chapter 2 Using the Reporting API. . . . . . . . . . . . . . . . . . . 11
API Notation in this Chapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Request Authorization Parameter Data . . . . . . . . . . . . . . . . . . . . . . . . . 11
Response Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Where to Go For More Information on the APIs . . . . . . . . . . . . . . . . . . . . . . . 12
Running Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Running a Report and Obtaining Report Data . . . . . . . . . . . . . . . . . . . . . . 13
Running Reports Offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Managing Report Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Using Report Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Running a report template and obtaining the report template data . . . . . . . . . . . 15
Scheduling a Report Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Managing Report Template Schedules . . . . . . . . . . . . . . . . . . . . . . . . . 17
Performing Searches. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Gateway Reporting Developer Guide 3
Contents
Chapter 3 Response Codes and Status Codes . . . . . . . . . . . . .19
Response Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Status Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Appendix A Reporting XML Schema . . . . . . . . . . . . . . . . . . .21
Appendix B Reporting Samples . . . . . . . . . . . . . . . . . . . . .29
Running a Daily Activity Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Running a Daily Activity Report Request . . . . . . . . . . . . . . . . . . . . . . . . 29
Running a Daily Activity Report Response . . . . . . . . . . . . . . . . . . . . . . . 30
Running a Transaction Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Running a Transaction Summary Report Request . . . . . . . . . . . . . . . . . . . 31
Running a Transaction Summary Report Response . . . . . . . . . . . . . . . . . . 32
Getting Results by Report ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Getting Results by Report ID Request. . . . . . . . . . . . . . . . . . . . . . . . . . 32
Getting Results by Report ID Response . . . . . . . . . . . . . . . . . . . . . . . . . 33
Getting Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Getting Metadata Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Getting Metadata Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Format Returned. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Getting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Getting Data Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Getting Data Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Data Returned . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Creating a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Creating a Report Template Request . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Creating a Report Template Response . . . . . . . . . . . . . . . . . . . . . . . . . 47
Updating a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Updating a Report Template Request . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Updating a Report Template Response . . . . . . . . . . . . . . . . . . . . . . . . . 48
Getting a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Getting a Report Template Request . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Getting a Report Template Response . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Deleting a Report Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Deleting a Report Template Request . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Deleting a Report Template Response . . . . . . . . . . . . . . . . . . . . . . . . . 50
Creating a Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Creating a Schedule Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4 Gateway Reporting Developer Guide
Contents
Creating a Schedule Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Getting a Schedule. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Getting a Schedule Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Getting a Schedule Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Updating a Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Updating a Schedule Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Updating a Schedule Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Deleting a Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Deleting a Schedule Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Deleting a Schedule Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Running a Transaction ID Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Running a Transaction ID Search Request . . . . . . . . . . . . . . . . . . . . . . . 55
Running a Transaction ID Search Response . . . . . . . . . . . . . . . . . . . . . . 55
Running a Profile - Next Payment Date Report . . . . . . . . . . . . . . . . . . . . . . . 56
Running a Profile - Next Payment Request . . . . . . . . . . . . . . . . . . . . . . . 56
Running a Profile - Next Payment Response . . . . . . . . . . . . . . . . . . . . . . 56
Running a Profile - Profile Modified Date Report . . . . . . . . . . . . . . . . . . . . . . 57
Running a Profile - Profile Modified Date Request . . . . . . . . . . . . . . . . . . . 57
Running a Profile - Profile Modified Date Response. . . . . . . . . . . . . . . . . . . 57
Appendix C Report Parameters . . . . . . . . . . . . . . . . . . . . .59
Reports in This Appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
ACH Activity Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
ACH Batch ID Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
ACH Detail Return Activity Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
ACH Notification of Change Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
ACH Return Activity Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
ACH Settlement Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
ACH Transaction Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Auto Credit Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Auto Delayed Capture Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Auto Resettle Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Auto Void Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Batch ID Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Custom Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Daily Activity Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Filter Scorecard Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Gateway Reporting Developer Guide 5
Contents
Fraud Protection Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Payflow Link Orders Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
PayPal Settlement Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Profile Next Payment Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Profile Modified Date Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Recurring Billing Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Recurring Profile Failed Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Recurring Profile Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Settlement Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Shipping and Billing Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Transaction Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Appendix D Search Parameters . . . . . . . . . . . . . . . . . . . . 101
Transaction ID Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
Batch ID Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103
AccountNumberSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
CommentSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
AccountNumberRefSearch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
PurchaseOrderSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108
RecurringBillingProfileIDSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109
RecurringBillingProfileNameSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
RecurringBillingAccountNumberSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
RecurringBillingCommentSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
RecurringBillingAmountSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
FraudTransactionSearch. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
OrderIDSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
PayPalTransactionIDSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118
PayPalEmailSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
PayPalNameSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120
Index. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
6 Gateway Reporting Developer Guide
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
Preface
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.
Gateway Reporting Developer Guide 7
Preface
Where to Go for More Information
Where to Go for More Information
PayPal Manager online help describes the use of PayPal Manager—the web-based
administration tool that you use to process transactions manually, issue credits, and generate
reports.
How to Contact Customer Service
For answers to specific questions about PayPal products, contact Customer Service.
Revision History
Revision history for Gateway Reporting Developer Guide.
TABLE P.1 Revision History
Date Description
May 2012 Updated reportId description - reportId is valid for up to 120 days.
February 2012 Added 4 Settlement report response parameters.
January 2012 Added 7 ACH reports; edits for technical accuracy.
December 2011 Updated for technical accuracy.
August 2011 Added a comment that the last 4 digits of the account number are returned in the Account
Number output field.
June 2011 Added two new reports: Profile - Profile Modified Date and ProfileNext Payment Date.
June 2010 Updated for technical accuracy.
December 2009 Added Fraud Transaction Search table.
November 2008 Updated links to test and live reporting URLs.
June 2008 Minor clarifications and corrections.
August 2007 Updated Title page and logo.
July 2006 Updated document title, product names.
Reformatted in PayPal templates.
Updated to support new currencies.
March 2006 Integrated Express Checkout feature.
8 Gateway Reporting Developer Guide
Reporting Overview
1
The Reporting API is an API that you can use to automate your report queries. It allows you to
programmatically query in XML the Reporting database.
PayPal Manager is also a client of the Reporting API. Everything that Manager can do with
reports is available to you through API calls. You can, for example, request a particular report
be run within a specified date range. The response returns all the data that the report generates.
The reporting engine encapsulates the information in all the Gateway services reports. You can
store this information in your local database and use it as needed.
Operations You Can Perform Using the Reporting API
The Reporting API enables you to perform the following operations:
Managing report templates
Running reports on demand by report or report template name
Obtaining information about reports
Managing report template schedules
Performing searches
The standard (predefined) reports supported are described in Appendix C, “Report
Parameters.”
Managing Report Templates
You may want to create report templates based on the reports that are supported. A report
template lets you create an instance of a report. With this instance, you provide a list of
parameters.
Report templates are handy when you find that you frequently need to look up reports based
on the same criteria. You provide the parameters and values once, and Reporting saves this
information with the report template. When you run the report template, you do not need to
provide the parameters a second time.
Report template management enables you to perform all the following tasks:
Create report templates
Query report templates in the database
Retrieve report templates from the database
Update report templates
Delete report templates
Gateway Reporting Developer Guide 9
Reporting Overview
1
URL for Running Applications
Running Reports by Report Template Name or Report Name
You can run reports and report templates. To run a report or report template, you submit a
runReportRequest, passing in the respective report name or report template name. You
can also pass in additional parameters in with a request.
To submit a request to the Reporting API, you post your XML request via HTTPS to the host
URLs in the body of the request. No SDK is needed since you just perform a standard HTTPS
post using the language of your choice. The Content-Type for the request should be text/plain.
Obtaining Information about Reports
You can obtain the following information about reports:
Report status
Report results
Managing Report Template Schedules
You can create, update, and delete report template schedules.
Performing Searches
You can search for payment transaction data based on search names such as
TransactionIDSearch, BatchIDSearch, and AccountNumberSearch.
URL for Running Applications
Use the following URLs for running Reporting applications.
Live Transactions
https://payments-reports.paypal.com/reportingengine
Test Transactions
https://payments-reports.paypal.com/test-reportingengine
10 Gateway Reporting Developer Guide
Using the Reporting API
2
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.
Gateway Reporting Developer Guide 11
Using the Reporting API
2
Where to Go For More Information on the APIs
Response Data
Responses include the following information:
All responses return a base response consisting of a response code (responseCode) and
a response message (responseMsg).
Most responses return applicable response parameter data.
Some responses return a status code (statusCode) and a status message
(statusMsg).
Where to Go For More Information on the APIs
To understand how the XML API is coded, look at the request notation along with the XML
schema, samples, and report parameters in this guide. See the following sources for details:
Source Contents
Chapter 3,
“Response Codes
and Status Codes”
Appendix A Contains the XML schema.
Appendix B Provides API request and response samples for each request and
Appendix C Describes the input and output parameters for all standard (predefined)
Appendix D Describes the input and output parameters for all report searches
Running Reports
You can run reports and obtain the report data right away. If, however, running a report takes
more than the time allotted, the report is run offline, and you must periodically check for the
report data.
Lists all response codes, status codes, and their message strings.
response referred to in this chapter.
reports supported.
supported.
12 Gateway Reporting Developer Guide
Running a Report and Obtaining Report Data
This procedure describes how to run a report and how to obtain the data in that report.
Step 1. Run the report
To run a report, call runReportRequest, providing the following parameter
information.
runReportRequest(reportName, reportParams, pageSize)
Parameter Description
reportName Name of the report, for example, DailyActivityReport.
reportParam(s) (Optional) paramName and paramValue for each request input param to
be assigned a value.
pageSize Number of rows of data per page. Default is 50.
The runReportResponse returns the reportId. The reportId is used to refer to the
particular report in future requests. The reportId returned is valid for up to 120 days.
Using the Reporting API
Running Reports
2
Step 2. Get the metadata
To get information on how the report is formatted, call getMetaDataRequest, providing
the ReportId returned when the report was run.
getMetaDataRequest(ReportId)
getMetaDataResponse returns the following data.
Parameter Description
numberOfRows Total number of rows.
numberOfPages Total number of pages in the report.
pageSize Page size.
numberOfColumns Total number of columns.
dataName Name of each column.
dataType Type of column data, for example, string.
Step 3. Get the report data
To get the actual data in the report, call getDataRequest with the following parameters.
getDataRequest(reportId, pageNum)
reportId ID for this report returned by runReportRequest; reportId is valid
for up to 120 days.
pageNum Report page number containing data to be returned.
Gateway Reporting Developer Guide 13
Using the Reporting API
2
Managing Report Templates
Data is returned for the report page specified by pageNum. To obtain the data in a multi-page
report, you must call getDataRequest for each report page.
Running Reports Offline
When a report takes longer to run than the time allotted, it is taken offline and status code 2,
“Report is currently executing,” is returned. You must check for the results at a later time.
Step 1. Run the report
Request to run a report by calling runReportRequest. See “Step 1. Run the report” on
page 13.
The report times out. The ReportId and status code 2 are returned.
Step 2. Get the report results later
It is your responsibility to obtain the report results at a later time. Call
getResultsRequest, providing the reportId as a parameter.
getResultsRequest(reportId)
getResultsResponse returns a statusCode and statusMsg. Call
getResultsResponse in a loop until statusCode 3, “Report has completed
successfully,” is returned.
Step 3. Get the metadata
Request to get the report’s metadata by calling getMetaDataRequest. See “Step 2. Get
the metadata” on page 13.
Step 3. Get the report data
Request to get the report data by calling getDataRequest. See “Step 3. Get the report
data” on page 13.
Managing Report Templates
Using the Reporting API, you can create, update, and delete report templates.
Step 1. Create a report template
To create a report template, call createTemplateRequest with the following
parameters.
createTemplateRequest (templateName, reportName,
reportParams)
Parameter Description
templateName Name that you are giving to the report template.
14 Gateway Reporting Developer Guide
Using the Reporting API
Using Report Templates
reportName Standard report from which you are creating the report template.
reportParam(s) paramName and paramValue of each reportParam to be assigned a
value.
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)
templateName Name given to the report template when it was created.
reportParam(s) paramName and paramValue of each reportParam to be assigned a
value.
The response to updating a report template returns a respCode and respMsg.
2
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).
templateName Name given to the report template when it was created.
Gateway Reporting Developer Guide 15
Using the Reporting API
2
Using Report Templates
reportParam(s) (Optional) paramName and paramValue for each reportParam that you
pageSize Number of rows of data per page. Default is 50.
Step 2. Get the metadata
Request to get the report’s metadata by calling getMetaDataRequest. See “Step 2. Get
the metadata” on page 13.
Step 3. Get the report data
Request to get the report data by calling getDataRequest. See “Step 3. Get the report
data” on page 13.
Scheduling a Report Template
want to assign a value to. These parameters can be ones previously
saved in the report template or additional ones. The parameter values
take precedence over the values previously saved for the parameters in
the report template.
You can schedule a report template to run on a daily, weekly, or monthly basis. The Reporting
API includes functionality to create schedules and to get the results of a scheduled report
template.
Step 1. Create a schedule
To create a schedule for a report template, call createScheduleRequest with the
following parameters.
createScheduleRequest(scheduleName, templateName, schedule)
scheduleName Name that you give to the schedule.
templateName Name of the report template to be scheduled.
schedule One of three values:
daily
weekly (select dayOfWeek value: Sunday, Monday, Tuesday,
Wednesday, Thursday, Friday, or Saturday)
monthly (Specify dayOfMonth value as an integer from 1 to 31. If
you specify 30 when the month is 28 days long, the value is
corrected to 28.)
The time of the day starts at midnight the previous night. The value
daily, for example, means midnight the previous night to midnight
tonight.
Step 2. Get the results
To get the results of a scheduled report template that is run, call getScheduleRequest
with scheduleName as a parameter.
getScheduleRequest(schedulename)
16 Gateway Reporting Developer Guide
getScheduleResponse returns all the reportIds and execution dates of the reports that
were run on the schedule.
Step 3. Get the metadata
For each report, call getMetaDataRequest, passing in the reportId as a parameter, to get
the information on how that report is formatted. See “Step 2. Get the metadata” on page 13.
Step 4. Get the report data
Request to get the report data for each report that was run by calling getDataRequest. See
“Step 3. Get the report data” on page 13.
Managing Report Template Schedules
Using the Reporting API, you can update and delete report template schedules.
Update a schedule
To update a schedule, call the updateScheduleRequest with the following parameters.
Using the Reporting API
Using Report Templates
2
updateScheduleRequest(scheduleName, templateName, schedule)
scheduleName Name given to the schedule when it was created.
templateName Name of the report template to update. Use this parameter to specify the
name of a different report template to associate with this schedule
update.
schedule Use this parameter to change the schedule.
schedule is one of three values:
daily
weekly (select dayOfWeek value: Sunday, Monday, Tuesday,
Wednesday, Thursday, Friday, or Saturday)
monthly (specify dayOfMonth value as an integer from 1 to 31.
(Specify dayOfMonth value as an integer from 1 to 31. If you
specify 30 when the month is 28 days, the value is corrected to 28.)
The time of the day starts at midnight the previous night. The value
daily, for example, means midnight the previous night to midnight
tonight.
The response to updating a schedule returns a respCode and respMsg.
Delete a schedule
To delete a schedule, call deleteScheduleRequest, providing the scheduleName as
the input parameter.
deleteTemplateRequest(scheduleName)
The response to deleting a schedule returns a respCode and respMsg.
Gateway Reporting Developer Guide 17
Using the Reporting API
2
Performing Searches
Performing Searches
Using the Reporting API, you can search for transaction data by any of the following search
names.
TransactionIDSearch
BatchIDSearch
AccountNumberSearch
CommentSearch
AccountNumberRefSearch
PurchaseOrderSearch
RecurringBillingProfileIDSearch
RecurringBillingProfileNameSearch
RecurringBillingAccountNumberSearch
RecurringBillingCommentSearch
RecurringBillingAmountSearch
Step 1. Run the search request
To run a search request, call runSearchRequest with the following parameters.
runSearchRequest(searchName, reportParam(s), pageSize)
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.
runSearchResponse returns the reportId for this search as well as the statusCode
and statusMsg. The reportId returned is valid for up to 120 days.
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.
18 Gateway Reporting Developer Guide
Response Codes and Status
3
Codes
This chapter provides the following details on reports. It identifies:
Response codes and response messages
Status codes and the status messages
Response Codes
Response codes indicate the success or failure of a Reporting request. Table 5-2 describes the
supported response codes and messages returned with each.
TABLE 3.1 Response codes and response messages
Response Code Response Message
100 Request has completed successfully
101 Request has failed
102 An internal scheduler error has occurred
103 Unknown report requested
104 Invalid Report ID
105 A system error has occurred
106 A database error has occurred
107 Invalid XML request
108 User authentication failed
109 Invalid report parameters provided
110 Invalid merchant account
111 Invalid page number
112 Template already exists
113 Unknown template requested
Gateway Reporting Developer Guide 19
Response Codes and Status Codes
3
Status Codes
Status Codes
Status codes indicate the status of a report, not necessarily the status of the Reporting request
to be executed. A report may fail even if a Reporting request succeeds.
TABLE 3.2 Status codes and status messages
Status Code Status Message
1 Report has been created
2 Report is currently executing
3 Report has completed successfully
4 Report has failed
5 Report has expired
6 Report has expired
20 Gateway Reporting Developer Guide
Reporting XML Schema
A
This appendix contains the XML Reporting 1.0 schema.
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="reportingEngineRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="authRequest">
<xs:complexType>
<xs:sequence>
<xs:element name="user" type="xs:string"/>
<xs:element name="vendor" type="xs:string"/>
<xs:element name="partner" type="xs:string"/>
<xs:element name="password" type="xs:string"/>
<xs:element name="executor" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:choice>
<xs:element name="createTemplateRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="templateDefinition"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getTemplateRequest">
<xs:complexType>
<xs:choice>
<xs:element ref="reportName"/>
<xs:element ref="templateName"/>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element name="updateTemplateRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="templateDefinition"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="deleteTemplateRequest">
<xs:complexType>
<xs:sequence>
Gateway Reporting Developer Guide 21
Reporting XML Schema
A
maxOccurs="unbounded"/>
<xs:element ref="templateName"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="createScheduleRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="scheduleDefinition"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getScheduleRequest">
<xs:complexType>
<xs:choice>
<xs:element ref="scheduleName"/>
<xs:element ref="templateName"/>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element name="updateScheduleRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="scheduleDefinition"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="deleteScheduleRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="scheduleName"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="runReportRequest">
<xs:complexType>
<xs:sequence>
<xs:choice>
<xs:element ref="reportName"/>
<xs:element ref="templateName"/>
</xs:choice>
<xs:element ref="reportParam" minOccurs="0"
<xs:element ref="notificationRequired" minOccurs="0"/>
<xs:element ref="pageSize" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="runSearchRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="searchName"/>
22 Gateway Reporting Developer Guide
<xs:element ref="reportParam" minOccurs="0"
maxOccurs="unbounded"/>
<xs:element ref="pageSize" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getResultsRequest">
<xs:complexType>
<xs:sequence>
<xs:choice minOccurs="0">
<xs:element ref="scheduleName"/>
<xs:element ref="templateName"/>
<xs:element ref="reportName"/>
<xs:element ref="searchName"/>
<xs:element ref="reportId"/>
</xs:choice>
<xs:choice minOccurs="0">
<xs:complexType>
<xs:sequence>
</xs:sequence>
</xs:complexType>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getMetaDataRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="reportId"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getDataRequest">
<xs:complexType>
<xs:sequence>
<xs:element ref="reportId"/>
<xs:element ref="pageNum" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="reportingEngineResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="baseResponse">
<xs:complexType>
Reporting XML Schema
<xs:element name="startDate"type="xs:date"/>
<xs:element name="endDate" type="xs:date"/>
A
Gateway Reporting Developer Guide 23
Reporting XML Schema
A
maxOccurs="unbounded">
<xs:sequence>
<xs:element name="responseCode" type="xs:int"/>
<xs:element name="responseMsg" type="xs:string"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:choice minOccurs="0">
<xs:element name="getTemplateResponse">
<xs:complexType>
<xs:choice>
<xs:element ref="templateName" maxOccurs="unbounded"/>
<xs:element ref="templateDefinition"/>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element name="getScheduleResponse">
<xs:complexType>
<xs:choice>
<xs:element ref="scheduleName" maxOccurs="unbounded"/>
<xs:element ref="scheduleDefinition"/>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element name="runReportResponse">
<xs:complexType>
<xs:sequence>
<xs:element ref="reportId"/>
<xs:element ref="statusCode"/>
<xs:element ref="statusMsg"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="runSearchResponse">
<xs:complexType>
<xs:sequence>
<xs:element ref="reportId"/>
<xs:element ref="statusCode"/>
<xs:element ref="statusMsg"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getResultsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="Results" minOccurs="0"
<xs:complexType>
<xs:sequence>
<xs:element ref="reportId"/>
<xs:element ref="statusCode"/>
<xs:element ref="statusMsg"/>
24 Gateway Reporting Developer Guide
type="xs:dateTime" minOccurs="0"/>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getMetaDataResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="numberOfRows" type="xs:int"/>
<xs:element name="numberOfPages" type="xs:int"/>
<xs:element ref="pageSize"/>
<xs:element name="numberOfColumns" type="xs:int"/>
<xs:element name="columnMetaData" minOccurs="0"
maxOccurs="unbounded">
<xs:complexType>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="getDataResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="reportDataRow" maxOccurs="unbounded">
<xs:complexType>
maxOccurs="unbounded">
Reporting XML Schema
<xs:element name="executionTime"
<xs:element ref="scheduleName" minOccurs="0"/>
<xs:element ref="reportName" minOccurs="0"/>
<xs:element ref="templateName" minOccurs="0"/>
<xs:element ref="searchName" minOccurs="0"/>
</xs:sequence>
<xs:sequence>
<xs:element name="dataName" type="xs:string"/>
<xs:element name="dataType">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="string"/>
<xs:enumeration value="number"/>
<xs:enumeration value="date"/>
<xs:enumeration value="currency"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
<xs:sequence>
<xs:element name="columnData"
<xs:complexType>
<xs:sequence>
A
Gateway Reporting Developer Guide 25
Reporting XML Schema
A
type="xs:string" minOccurs="0"/>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="reportDefinition">
<xs:complexType>
<xs:sequence/>
</xs:complexType>
</xs:element>
<xs:element name="reportId" type="xs:string"/>
<xs:element name="paramName" type="xs:string"/>
<xs:element name="paramValue" type="xs:string"/>
<xs:element name="templateName" type="xs:string"/>
<xs:element name="reportName" type="xs:string"/>
<xs:element name="reportParam">
<xs:complexType>
<xs:sequence>
<xs:element ref="paramName"/>
<xs:element ref="paramValue"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="templateDefinition">
<xs:complexType>
<xs:sequence>
<xs:element ref="templateName"/>
<xs:element ref="reportName"/>
<xs:element ref="reportParam" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="notificationRequired" type="xs:boolean"/>
<xs:element name="scheduleDefinition">
<xs:complexType>
<xs:sequence>
<xs:element ref="scheduleName"/>
<xs:element ref="templateName"/>
<xs:element ref="notificationRequired"/>
<xs:choice>
<xs:element name="data"
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element ref="pageNum"/>
</xs:sequence>
26 Gateway Reporting Developer Guide
<xs:element name="daily">
<xs:complexType/>
</xs:element>
<xs:element name="weekly">
<xs:complexType>
<xs:sequence>
<xs:element name="dayOfWeek">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Sunday"/>
<xs:enumeration value="Monday"/>
<xs:enumeration value="Tuesday"/>
<xs:enumeration value="Wednesday"/>
<xs:enumeration value="Thursday"/>
<xs:enumeration value="Friday"/>
<xs:enumeration value="Saturday"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="monthly">
<xs:complexType>
<xs:sequence>
<xs:element name="dayOfMonth" type="xs:int"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
<xs:element ref="pageSize" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="scheduleName" type="xs:string"/>
<xs:element name="pageNum" type="xs:int"/>
<xs:element name="searchName" type="xs:string"/>
<xs:element name="pageSize" type="xs:int"/>
<xs:element name="statusCode" type="xs:int"/>
<xs:element name="statusMsg" type="xs:string"/>
</xs:schema>
Reporting XML Schema
A
Gateway Reporting Developer Guide 27
Reporting XML Schema
A
28 Gateway Reporting Developer Guide
Reporting Samples
B
This appendix demonstrates how to use the Reporting API to create, run, and manage reports.
For details on the predefined reports named in this appendix, see the Manager User’s Guide.
N OTE: In this appendix, replace these values shown in boldface with appropriate values:
User, Vendor, Partner, and Password.
Running a Daily Activity Report
This section demonstrates how to run a Daily Activity Report.
Running a Daily Activity Report Request
The request demonstrates how to run a Daily Activity Report with a page size of 50 lines to
obtain results for September 7, 2007.
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<runReportRequest>
<reportName>DailyActivityReport</reportName>
<reportParam>
<paramName>report_date</paramName>
<paramValue>2007-09-07</paramValue>
</reportParam>
<pageSize>50</pageSize>
</runReportRequest>
</reportingEngineRequest>
Gateway Reporting Developer Guide 29
Reporting Samples
B
Running a Daily Activity Report
Running a Daily Activity Report Response
In the response to running the Daily Activity Report, the responseCode of 100 indicates
that the report completed successfully. The reportId 132 returned is used to uniquely
identify this report in future calls to the Reporting API.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runReportResponse>
<reportId>132</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runReportResponse>
</reportingEngineResponse>
30 Gateway Reporting Developer Guide
Running a Transaction Summary Report
Running a Transaction Summary Report
This sample demonstrates how to run a Transaction Summary Report.
Running a Transaction Summary Report Request
The request demonstrates how to run a Transaction Summary Report with a page size of 50
lines starting on September 7, 2007 at 12:00AM and ending on September 7, 2007 at 12:59
and 59 seconds PM.
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<runReportRequest>
<reportName>TransactionSummaryReport</reportName>
<reportParam>
<paramName>start_date</paramName>
<paramValue>2007-09-07 00:00:00</paramValue>
</reportParam>
<reportParam>
<paramName>end_date</paramName>
<paramValue>2007-09-07 23:59:59</paramValue>
</reportParam>
<pageSize>50</pageSize>
</runReportRequest>
</reportingEngineRequest>
Reporting Samples
B
Gateway Reporting Developer Guide 31
Reporting Samples
B
Getting Results by Report ID
Running a Transaction Summary Report Response
In the response to running the Transaction Summary Report, the response code of 100
indicates that the request completed successfully. The status code of 3 indicates that the report
completed successfully and the reportId 131 is returned for future reverence in calls
inquiring about this report.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runReportResponse>
<reportId>133</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runReportResponse>
</reportingEngineResponse>
Getting Results by Report ID
This sample demonstrates how to retrieve the results of a report that was previously run.
Getting Results by Report ID Request
In the request to get the results by report ID, reportId 131 specifies the report for which
results are being requested. The reportId 131 was returned in a previous call to run the
report.
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<getResultsRequest>
<reportId>131</reportId>
</getResultsRequest>
</reportingEngineRequest>
32 Gateway Reporting Developer Guide
Getting Results by Report ID Response
In the response to getting results by report ID, the response code of 100 indicates that the
request completed successfully. The status code of 3 indicates that the report with reportId
131 completed successfully.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getResultsResponse>
<Results>
<reportId>131</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</Results>
</getResultsResponse>
</reportingEngineResponse>
Reporting Samples
Getting Metadata
B
Getting Metadata
This sample demonstrates how to retrieve the format of the data in a previously run report.
Getting Metadata Request
The request demonstrates how to obtain the formatting information for the report with
reportId 131.
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<getMetaDataRequest>
<reportId>131</reportId>
</getMetaDataRequest>
</reportingEngineRequest>
Gateway Reporting Developer Guide 33
Reporting Samples
B
Getting Metadata
Getting Metadata Response
In the response to retrieving metadata, the response code of 100 indicates that the request
completed successfully. The response returns the number columns, rows, pages, and lines per
page are present in the format of the report with reportID 131. For each table column, the
response returns the column heading.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getMetaDataResponse>
<numberOfRows>13</numberOfRows>
<numberOfPages>1</numberOfPages>
<pageSize>50</pageSize>
<numberOfColumns>11</numberOfColumns>
<columnMetaData>
</columnMetaData>
<columnMetaData>
</columnMetaData>
<columnMetaData>
</columnMetaData>
<columnMetaData>
</columnMetaData>
<columnMetaData>
</columnMetaData>
<columnMetaData>
</columnMetaData>
<columnMetaData>
</columnMetaData>
<columnMetaData>
</columnMetaData>
<columnMetaData>
<dataName>Transaction ID</dataName>
<dataType>string</dataType>
<dataName>Trans Time</dataName>
<dataType>date</dataType>
<dataName>Trans Type</dataName>
<dataType>string</dataType>
<dataName>Tender Type</dataName>
<dataType>string</dataType>
<dataName>Account Number</dataName>
<dataType>string</dataType>
<dataName>Expires</dataName>
<dataType>string</dataType>
<dataName>Amount</dataName>
<dataType>string</dataType>
<dataName>Result</dataName>
<dataType>number</dataType>
34 Gateway Reporting Developer Guide
</getMetaDataResponse>
</reportingEngineResponse>
Format Returned
The format returned by this sample is shown below:
N OTE: The last four digits of the Account Number are returned.
<dataName>Reponse Msg</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Comment1</dataName>
<dataType>string</dataType>
</columnMetaData>
<columnMetaData>
<dataName>Comment2</dataName>
<dataType>string</dataType>
</columnMetaData>
Reporting Samples
Getting Metadata
B
Transaction IDTrans
Time
Trans
Typ e
Tender
Type
Account
Number
Expires Amount Result Response
Msg
Comment1 Comment2
Gateway Reporting Developer Guide 35
Reporting Samples
B
Getting Data
Getting Data
This sample demonstrates how to retrieve the data in a previously run report.
Getting Data Request
In the request to retrieve data, reportId 131 specifies the report for which the data is being
requested. The reportId value of 131 was returned in a previous call to run the report. The
pageNum refers to the page number desired in a multi-page report.
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
</reportingEngineRequest>
<getDataRequest>
<reportId>131</reportId>
<pageNum>1</pageNum>
</getDataRequest>
Getting Data Response
In the response to retrieving data, the response code of 100 indicates that the request
completed successfully. The response returns the data in each of the columns and rows of the
report with reportID 131.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getDataResponse>
<reportDataRow>
<columnData>
<data>V89A0A000087</data>
</columnData>
<columnData>
<data>2007-09-07 17:45:08</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
36 Gateway Reporting Developer Guide
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000088</data>
</columnData>
<columnData>
<data>2007-09-07 17:46:09</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
Reporting Samples
Getting Data
B
Gateway Reporting Developer Guide 37
Reporting Samples
B
Getting Data
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000089</data>
</columnData>
<columnData>
<data>2007-09-07 17:48:20</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008A</data>
</columnData>
<columnData>
<data>2007-09-07 17:52:03</data>
</columnData>
<columnData>
<data>S</data>
38 Gateway Reporting Developer Guide
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008B</data>
</columnData>
<columnData>
<data>2007-09-07 17:53:07</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
Reporting Samples
Getting Data
B
Gateway Reporting Developer Guide 39
Reporting Samples
B
Getting Data
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008C</data>
</columnData><columnData>
<data>2007-09-07 17:53:32</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
columnData>
data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008D</data>
</columnData>
<columnData>
<data>2007-09-07 17:54:20</data>
</columnData>
40 Gateway Reporting Developer Guide
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008E</data>
</columnData>
<columnData>
<data>2007-09-07 17:56:02</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
Reporting Samples
Getting Data
B
Gateway Reporting Developer Guide 41
Reporting Samples
B
Getting Data
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A00008F</data>
</columnData>
<columnData>
<data>2007-09-07 17:56:33</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/07</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000090</data>
</columnData>
42 Gateway Reporting Developer Guide
<columnData>
<data>2007-09-07 18:01:31</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>01/05</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>24</data>
</columnData>
<columnData>
<data>Unknown error</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000091</data>
</columnData>
<columnData>
<data>2007-09-07 18:01:44</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>12/05</data>
</columnData>
<columnData>
<data>A1000</data>
Reporting Samples
Getting Data
B
Gateway Reporting Developer Guide 43
Reporting Samples
B
Getting Data
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000092</data>
</columnData>
<columnData>
<data>2007-09-07 18:02:19</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>12/05</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<reportDataRow>
<columnData>
<data>V89A0A000093</data>
44 Gateway Reporting Developer Guide
</columnData>
<columnData>
<data>2007-09-07 18:03:09</data>
</columnData>
<columnData>
<data>S</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>4111XXXXXXXX1111</data>
</columnData>
<columnData>
<data>12/05</data>
</columnData>
<columnData>
<data>A1000</data>
</columnData>
<columnData>
<data>0</data>
</columnData>
<columnData>
<data>Approved</data>
</columnData>
<columnData>
<data/>
</columnData>
<columnData>
<data/>
</columnData>
</reportDataRow>
<pageNum>1</pageNum>
</getDataResponse>
</reportingEngineResponse>
Reporting Samples
Getting Data
B
Gateway Reporting Developer Guide 45
Reporting Samples
B
Getting Data
Data Returned
The data is returned in the following tabular format of 13 rows and 11 columns:
V89A0A000087 2007-09-07 17:45:07 S O 1111 01/07 A1000 O Approved
V89A0A000088 2007-09-07 17:45:09
V89A0A000089 2007-09-07 17:48:20
V89A0A00008A 2007-09-07 17:52:03
V89A0A00008B 2007-09-07 17:53:07
V89A0A00008C 2007-09-07 17:53:32
V89A0A00008D 2007-09-07 17:54:20
V89A0A00008E 2007-09-07 17:56:02
V89A0A00008F 2007-09-07 17:56:33
V89A0A000090 2007-09-07 18:01:31
V89A0A000091 2007-09-07 18:01:44
V89A0A000092 2007-09-07 18:02:19
V89A0A000093 2007-09-07 18:03:09
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
S O 1111 01/07 A1000 O Approved
46 Gateway Reporting Developer Guide
Creating a Report Template
This sample demonstrates how to create a report template from a standard Daily Activity
Report.
Creating a Report Template Request
This request creates a report template from a Daily Activity Report with a report template
name of ‘My Template.’ It sets the values of two parameters (name1 and name2). The
parameter names and values are stored in the database.
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<createTemplateRequest>
<templateDefinition>
<templateName>My Template</templateName>
<reportName>DailyActivityReport</reportName>
<reportParam>
<paramName>name1</paramName>
<paramValue>value1</paramValue>
</reportParam>
<reportParam>
<paramName>name2</paramName>
<paramValue>value2</paramValue>
</reportParam>
</templateDefinition>
</createTemplateRequest>
</reportingEngineRequest>
Reporting Samples
Creating a Report Template
B
Creating a Report Template Response
In the response to creating a report template, the response code of 100 indicates that the
request completed successfully. Thereafter, when ‘My Template’ is run, these parameters are
automatically retrieved from the database and used to generate the Daily Activity Report.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
Gateway Reporting Developer Guide 47
Reporting Samples
B
Updating a Report Template
Updating a Report Template
This sample demonstrates how to update the parameter information in a report template.
Updating a Report Template Request
The request specifies the report template to update by its name ‘My Template’ and the report
type (Daily Activity Report) upon which it was originally based.Updating a report template is
not an additive process. It replaces the parameters and values previously defined for ‘My
Template’ with new parameters and values.
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<updateTemplateRequest>
<templateDefinition>
<templateName>My Template</templateName>
<reportName>DailyActivityReport</reportName>
<reportParam>
<paramName>name3</paramName>
<paramValue>value3</paramValue>
</reportParam>
<reportParam>
<paramName>name4</paramName>
<paramValue>value4</paramValue>
</reportParam>
</templateDefinition>
</updateTemplateRequest>
</reportingEngineRequest>
Updating a Report Template Response
In the response to updating a report template, the response code of 100 indicates that the
request completed successfully. The getTemplateRequest can be used to check the new
parameters and values.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
48 Gateway Reporting Developer Guide
Getting a Report Template
This sample demonstrates how to retrieve a report template.
Getting a Report Template Request
The request specifies the report template name ‘My Template’ to retrieve.
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<getTemplateRequest>
<templateName>My Template</templateName>
</getTemplateRequest>
</reportingEngineRequest>
Reporting Samples
Getting a Report Template
B
Getting a Report Template Response
In the response to retrieving a report template, the response code of 100 indicates that the
request completed successfully. The response returns the report template name, the report type
(Daily Activity Report) upon which it was originally based, as well as the parameter names
and values defined for this report template.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getTemplateResponse>
<templateDefinition>
<templateName>My Template</templateName>
<reportName>DailyActivityReport</reportName>
<reportParam>
<paramName>name3</paramName>
<paramValue>value3</paramValue>
</reportParam>
<reportParam>
<paramName>name4</paramName>
<paramValue>value4</paramValue>
</reportParam>
</templateDefinition>
</getTemplateResponse>
</reportingEngineResponse>
Gateway Reporting Developer Guide 49
Reporting Samples
B
Deleting a Report Template
Deleting a Report Template
This sample demonstrates how to delete a report template.
Deleting a Report Template Request
The request to delete a report template includes the templateName ‘My Template.’
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<deleteTemplateRequest>
<templateName>My Template</templateName>
</deleteTemplateRequest>
</reportingEngineRequest>
Deleting a Report Template Response
In the response to deleting a report template, the response code of 100 indicates that the
request completed successfully. If you were to specify a bogus name for the report template (in
error), responseCode 113, “Unknown template requested.”
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>113</responseCode>
<responseMsg>Unknown template requested</responseMsg>
</baseResponse>
</reportingEngineResponse>
</reportingEngineRequest>
50 Gateway Reporting Developer Guide
Creating a Schedule
This sample demonstrates how to create a schedule for a report template.
Creating a Schedule Request
?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<createScheduleRequest>
<scheduleDefinition>
<scheduleName>My Schedule</scheduleName>
<templateName>My Template</templateName>
<notificationRequired>false</notificationRequired>
<daily></daily>
</scheduleDefinition>
</createScheduleRequest>
</reportingEngineRequest>
Reporting Samples
Creating a Schedule
B
Creating a Schedule Response
In the response to creating a schedule, the response code of 100 indicates that the request
completed successfully.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
Gateway Reporting Developer Guide 51
Reporting Samples
B
Getting a Schedule
Getting a Schedule
Getting a Schedule Request
?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<getScheduleRequest>
<scheduleName>My Schedule</scheduleName>
</getScheduleRequest>
</reportingEngineRequest>
Getting a Schedule Response
In the response to getting a schedule, the response code of 100 indicates that the request
completed successfully. The response returns the name of the schedule, the report template
scheduled, and the schedule (daily).
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<getScheduleResponse>
<scheduleDefinition>
<scheduleName>My Schedule</scheduleName>
<templateName>My Template</templateName>
<notificationRequired>false</notificationRequired>
<daily></daily>
</scheduleDefinition>
</getScheduleResponse>
</reportingEngineResponse>
52 Gateway Reporting Developer Guide
Updating a Schedule
This sample demonstrates how to update a schedule.
Updating a Schedule Request
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<updateScheduleRequest>
<scheduleDefinition>
<scheduleName>My Schedule</scheduleName>
<templateName>My Template</templateName>
<notificationRequired>false</notificationRequired>
<daily/>
</scheduleDefinition>
</updateScheduleRequest>
Reporting Samples
Updating a Schedule
B
Updating a Schedule Response
In the response to updating a schedule, the response code of 100 indicates that the request
completed successfully.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
Gateway Reporting Developer Guide 53
Reporting Samples
B
Deleting a Schedule
Deleting a Schedule
This sample demonstrates how to delete a schedule.
Deleting a Schedule Request
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<deleteScheduleRequest>
<scheduleName>My Schedule</scheduleName>
</deleteScheduleRequest>
</reportingEngineRequest>
Deleting a Schedule Response
In the response to deleting a schedule, the response code of 100 indicates that the request
completed successfully.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
</reportingEngineResponse>
54 Gateway Reporting Developer Guide
Running a Transaction ID Search
This sample demonstrates how to run a search by transaction ID.
Running a Transaction ID Search Request
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>appstest</user>
<vendor>appstest</vendor>
<partner>PayPal</partner>
<password>password5</password>
</authRequest>
<runSearchRequest>
<searchName>TransactionIDSearch</searchName>
<reportParam>
<paramName>transaction_id</paramName>
<paramValue>V89A0A000264</paramValue>
</reportParam>
<pageSize>50</pageSize>
</runSearchRequest>
</reportingEngineRequest>
Reporting Samples
Running a Transaction ID Search
B
Running a Transaction ID Search Response
In the response to running the transaction ID search, the responseCode of 100 indicates
that the report completed successfully. The reportId 132 returned is used to uniquely
identify this report in future calls to the Reporting API.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runSearchResponse>
<reportId>132</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runSearchResponse>
</reportingEngineResponse>
Gateway Reporting Developer Guide 55
Reporting Samples
B
Running a Profile - Next Payment Date Report
Running a Profile - Next Payment Date Report
This sample demonstrates how to run a profile - next payment date report.
Running a Profile - Next Payment Request
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<runReportRequest>
<reportName>RBProfileNPDReport</reportName>
<reportParam>
<paramName>start_date</paramName>
<paramValue>2011-06-22 00:00:00</paramValue>
</reportParam>
<reportParam>
<paramName>end_date</paramName>
<paramValue>2011-08-30 00:00:00</paramValue>
</reportParam>
<pageSize>50</pageSize>
</runReportRequest>
</reportingEngineRequest>
Running a Profile - Next Payment Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runReportResponse>
<reportId>132</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runReportResponse>
</reportingEngineResponse>
56 Gateway Reporting Developer Guide
Reporting Samples
Running a Profile - Profile Modified Date Report
Running a Profile - Profile Modified Date Report
This sample demonstrates how to run a profile - profile modified date report.
Running a Profile - Profile Modified Date Request
<?xml version="1.0" encoding="UTF-8"?>
<reportingEngineRequest>
<authRequest>
<user>User</user>
<vendor>Vendor</vendor>
<partner>Partner</partner>
<password>Password</password>
</authRequest>
<runReportRequest>
<reportName>RBProfilePMDReport</reportName>
<reportParam>
<paramName>start_date</paramName>
<paramValue>2010-06-22 00:00:00</paramValue>
</reportParam>
<reportParam>
<paramName>end_date</paramName>
<paramValue>2010-08-30 00:00:00</paramValue>
</reportParam>
<pageSize>50</pageSize>
</runReportRequest>
</reportingEngineRequest>
B
Running a Profile - Profile Modified Date Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportingEngineResponse>
<baseResponse>
<responseCode>100</responseCode>
<responseMsg>Request has completed successfully</responseMsg>
</baseResponse>
<runReportResponse>
<reportId>132</reportId>
<statusCode>3</statusCode>
<statusMsg>Report has completed successfully</statusMsg>
</runReportResponse>
</reportingEngineResponse>
Gateway Reporting Developer Guide 57
Reporting Samples
B
Running a Profile - Profile Modified Date Report
58 Gateway Reporting Developer Guide
Report Parameters
C
Reports in This Appendix
This appendix describes the input and output parameters for the following reports:
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
PayflowLink 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
Gateway Reporting Developer Guide 59
Report Parameters
C
ACH Activity Summary Report
ACH Activity Summary Report
TABLE C.1 ACH Activity Summary Report input parameters
Name Description Ty p e
Required?Allowed
values
Default
value
Autocomputed
by
scheduler?
report_date Date for which
report needs to be
pulled
sort_by Column to sort data bystring N Transaction
sort_option Sort by ascending or
descending order
timezone Timezone used to
interpret times
include_pen
ding_settlem
ent
include_settl
ed
datetime YYYYMM-DD
HH:MI:SS
string N Descending No
string N GMT
string N true, false TRUE
string N true, false TRUE
YN/AY
ID,
Transaction
Time,
Transaction
Type ,
Tende r
Type ,
Amount,
Result
GMT+/-
XX:
Transacti
on Time
Order
GMT-7
include_faile
d
T
ABLE C.2 ACH Activity Summary Report output parameters
Column name Typ e Comment
Transaction ID string
Time date
Type string
60 Gateway Reporting Developer Guide
string N true, false TRUE
T
ABLE C.2 ACH Activity Summary Report output parameters
Tende r Type s tring
Account Number string
Account ABA string
Amount currency
Status string
Description string
Result Code number
Response Msg string
Result Code Msg string
Customer Ref string
Currency Symbol string
Report Parameters
ACH Activity Summary Report
C
Gateway Reporting Developer Guide 61
Report Parameters
C
ACH Batch ID Report
ACH Batch ID Report
TABLE C.3 ACH Batch ID Report input parameters
Name Description Ty p e
Required?Allowed
values
Default
value
Autocomputed
by
scheduler?
start_date Start date to run
report for
end_date End date to run
report for
timezone Timezone used to
interpret times
host_type number Y 68
batch_id number N
BatchByCar
d
batch_type string N Consumer
T
ABLE C.4 ACH Batch ID Report output parameters
datetime YYYYMM-DD
HH:MI:SS
datetime YYYYMM-DD
HH:MI:SS
string N GMT-7
string N true, false FALSE
YY
Y
Batch,
Merchant
Batch
Merchan
t Batch
Column name Typ e Comment
Host Type number
Batch ID number
Tender Type string If BatchByCard is given as TRUE in input
Settled Date date
Total Sales/Delayed
Captures/Voice
Authorizations
(Amount)
62 Gateway Reporting Developer Guide
currency
T
ABLE C.4 ACH Batch ID Report output parameters
Report Parameters
ACH Batch ID Report
C
Total Sales/Delayed
Captures/Voice
Authorizations
(Count)
Total Credits
(Amount)
Total Credits
(Count)
Total Amount currency
Total Count string
Currency Symbol string
Begin Time date
End Time date
number
currency
number
Gateway Reporting Developer Guide 63
Report Parameters
C
ACH Detail Return Activity Report
ACH Detail Return Activity Report
TABLE C.5 ACH Detail Return Activity Report input parameters
Required?Allowed
Name Description Ty p e
values
Default
value
Autocomputed
by
scheduler?
start_date Start date to run
report for
end_date End date to run
report for
timezone Timezone used to
interpret times
T
ABLE C.6 ACH Detail Return Activity Report output parameters
Column name Typ e Comment
Transaction ID string
Time date
Addenda Return
Code Date
Type string
Tende r Type s tring
date
datetime YYYYMM-DD
HH:MI:SS
datetime YYYYMM-DD
HH:MI:SS
string N GMT-7
YN/A
YN/AY
Account Number string
Account ABA string
Amount currency
Status string
Description string
Result Code number
Response Msg string
Result Code Msg string
Customer Ref string
64 Gateway Reporting Developer Guide
T
ABLE C.6 ACH Detail Return Activity Report output parameters
Batch ID number
Currency Symbol string
ACH Notification of Change Report
ABLE C.7 ACH Notification of Change Report input parameters
T
Required?Allowed
Name Description Ty p e
Report Parameters
ACH Notification of Change Report
Autocomputed
by
scheduler?
values
Default
value
C
start_date Start date to run
report for
end_date End date to run
report for
timezone Timezone used to
interpret times
T
ABLE C.8 ACH Notification of Change Report output parameters
Column name Typ e Comment
Account ABA string
Account Number string
New Name string
Account Type string
Noc Type string
datetime YYYYMM-DD
HH:MI:SS
datetime YYYYMM-DD
HH:MI:SS
string N GMT-7
YN/AY
YN/AY
Deposit Date date
Change
Information
Gateway Reporting Developer Guide 65
string
Report Parameters
C
ACH Return Activity Report
ACH Return Activity Report
TABLE C.9 Auto Return Activity Report input parameters
Name Description Ty p e
Required?Allowed
values
Default
value
Autocomputed
by
scheduler?
start_date Start date to run
report for
end_date End date to run
report for
timezone Timezone used to
interpret times
T
ABLE C.10 ACH Return Activity Report output parameters
Column name Typ e Comment
Status Code string
Description string
Total Amount currency
Total Items number
Currency Symbol string
datetime YYYYMM-DD
HH:MI:SS
datetime YYYYMM-DD
HH:MI:SS
string N GMT-7
YY
YY
66 Gateway Reporting Developer Guide
ACH Settlement Report
TABLE C.11 ACH Settlement Report input parameters
Required?Allowed
Name Description Ty p e
values
Report Parameters
ACH Settlement Report
Auto-
computed
Default
value
by
scheduler?
C
start_date Start date to run
report for
end_date End date to run
report for
timezone Timezone used to
interpret times
T
ABLE C.12 ACH Settlement Report output parameters
Column name Typ e Comment
Transaction ID string
Time date
Type string
Tende r Type s tring
Account Number string
datetime YYYYMM-DD
HH:MI:SS
datetime YYYYMM-DD
HH:MI:SS
string N GMT-7
YY
Y
Account ABA string
Amount currency
Status string
Description string
Result Code number
Response Msg string
Result Code Msg string
Customer Ref string
Batch ID number
Gateway Reporting Developer Guide 67
Report Parameters
C
ACH Transaction Report
T
ABLE C.12 ACH Settlement Report output parameters
Currency Symbol string
Comment1 string
Comment2 string
Fund Status string
ACH Transaction Report
T
ABLE C.13 ACH Transaction Report input parameters
Name Description Ty p e
Required?Allowed
values
Default
value
Auto-
computed
by
scheduler?
report_date Start date for which
report needs to be
pulled
sort_by string N Transaction
sort_option Sort by ascending or
descending
timezone Timezone used to
interpret times
T
ABLE C.14 ACH Transaction Report output parameters
Column name Typ e Comment
datetime YYYYMM-DD
HH:MI:SS
string N Descending No
string N GMT
YN/AY
ID,
Transaction
Time,
Transaction
Type ,
Amount,
Result
GMT+/XX:XX
Transacti
on Time
Order
GMT N
Transaction ID string
Time date
Type string
68 Gateway Reporting Developer Guide
T
ABLE C.14 ACH Transaction Report output parameters
Tende r Type s tring
Account Number string
Account ABA string
Amount currency
Status string
Description string
Result Code number
Response Msg string
Result Code Msg string
Charge Desc string
Customer Ref string
Comment1 string
Report Parameters
Auto Credit Report
C
Comment2 string
Prenote string
Currency Symbol string
Auto Credit Report
T
ABLE C.15 Auto Credit Report input parameters
Name Description Ty p e
start_date Start date to run
report for
end_date End date to run
report for
datetime YYYYMM-DD
HH:MI:SS
datetime YYYYMM-DD
HH:MI:SS
Auto-
computed
Required?Allowed
values
YN/AY
YN/AY
Default
value
by
scheduler?
Gateway Reporting Developer Guide 69
Report Parameters
C
Auto Delayed Capture Report
T
ABLE C.15 Auto Credit Report input parameters
timezone Timezone used to
interpret times
T
ABLE C.16 Auto Credit Report output parameters
Column name Typ e Comment
Order ID string Only if Cybercash merchant
Transaction ID string
Time date
AVS Zip Match string
AVS Street Match string
Type string
Tende r Type s tring
Amount currency
Result Code number
Comment1 string
string N GMT
GMT N
GMT+/XX:XX
Comment2 string
Auto Delayed Capture Report
T
ABLE C.17 Auto Delayed Capture Report input parameters
Name Description Type Required?
start_date Start date to run report for datetime
YYYY-MMDD HH:MI:SS
end_date End date to run report for datetime
YYYY-MMDD HH:MI:SS
YN/AY
YN/AY
Allowed
values
Default
value
Autocomputed
by
scheduler?
70 Gateway Reporting Developer Guide
T
ABLE C.17 Auto Delayed Capture Report input parameters
Report Parameters
Auto Delayed Capture Report
C
timezone Timezone used to interpret
times
ABLE C.18 Auto Delayed Capture Report output parameters
T
Column name Type Comment
Order ID string Only if CyberCash merchant
Transaction ID string
Time date
AVS Zip Match string
AVS Street Match string
Type st ring
Tender Type string
Amount currency
Result Code number
string N GMT
GMT+/XX:XX
GMT N
Comment1 string
Comment2 string
Gateway Reporting Developer Guide 71
Report Parameters
C
Auto Resettle Report
Auto Resettle Report
TABLE C.19 Auto Resettle Report input parameters
Name Description Type Required?
Allowed
values
Default
value
Autocomputed
by scheduler?
start_date Start date to run
report for
end_date End date to run report
for
timezone Timezone used to
interpret times
T
ABLE C.20 Auto Resettle Report output parameters
Column name Type Comment
Order ID string Only if Cybercash merchant
Transaction ID string
Time date
AVS Zip Match string
AVS Street Match string
datetime
YYYY-MMDD HH:MI:SS
datetime
YYYY-MMDD HH:MI:SS
string N GMT
YN/AY
YN/AY
GMT+/XX:XX
GMT N
Type string
Tende r Type string
Amount currency
Result Code number
Comment1 string
Comment2 string
72 Gateway Reporting Developer Guide
Auto Void Report
TABLE C.21 Auto Void Report input parameters
Name Description Ty pe
Required?Allowed
values
Report Parameters
Auto Void Report
Auto-
computed
Default
value
by
scheduler?
C
start_date Start date to run report
for
end_date End date to run report
for
timezone Timezone used to
interpret times
T
ABLE C.22 Auto Void Report output parameters
Column name Type Comment
Order ID string Only if Cybercash merchant
Transaction ID string
Time date
AVS Zip Match string
AVS Street Match string
datetime YYYYMM-DD
HH:MI:SS
datetime YYYYMM-DD
HH:MI:SS
string N GMT
YN/AY
YN/AY
GMT N
GMT+/XX:XX
Type string
Tende r Type str i n g
Amount currency
Result Code number
Comment1 string
Comment2 string
Gateway Reporting Developer Guide 73
Report Parameters
C
Batch ID Report
Batch ID Report
TABLE C.23 Batch ID Report input parameters
Name Description Typ e Required? Allowed values
Default
value
Autocomputed
by
scheduler?
start_date Start date to run
report for
end_date End date to run
report for
processor Processor to
report on
timezone Timezone used to
interpret times
group_by_
tender
ABLE C.24 Batch ID Report output parameters
T
Column name Type Comment
Batch ID number Only if group_by_tender is
Settled Date date
Should group
results by tender?
datetime
YYYY-MM-DD
HH:MI:SS
datetime
YYYY-MM-DD
HH:MI:SS
string Y PayPal N/A N
string N GMT
string N true
YN/AY
YN/AY
GMT N
GMT+/-XX:XX
false N
false
set to true
Total Sales/Delayed Captures/Voice
Authorizations (Amount)
Total Sales/Delayed Captures/Voice
Authorizations (Count)
Total Credits (Amount) currency
Total Credits (Count) number
Total Amount currency
Total Count number
tender_type string Only if group-by-tender is
74 Gateway Reporting Developer Guide
currency
number
set to true
Custom Report
TABLE C.25 Custom Report input parameters
Name Description Type Required?
Allowed
values
Report Parameters
Custom Report
Auto-
computed
Default
value
by
scheduler?
C
start_date Start date to run
report for
end_date End date to run
report for
minimum_amount Minimum
amount to
report on
maximum_amount Maximum
amount to
report on
results Results to
report on
datetime
YYYYMM-DD
HH:MI:SS
datetime
YYYYMM-DD
HH:MI:SS
number N 0 N
number N 10000 N
string N All
YN/AY
YN/AY
All N
Approvals
Only
Declines
Only
Approvals
and
Declines
<Comma
Separated
List>
include_amex Include
American
Express cards
in report
(PayPal only)
include_diners Include Diners
cards in report
(PayPal only)
Gateway Reporting Developer Guide 75
string N true
false
string N true
false
true N
true N
Report Parameters
C
Custom Report
T
ABLE C.25 Custom Report input parameters
include_discover Include
Discover cards
in report
(PayPal only)
include_enroute Include Enroute
cards in report
(PayPal only)
include_jcb Include JCB
cards in report
(PayPal only)
include_mastercard Include
Mastercard
cards in report
include_visa Include Visa
cards in report
include_authorization Include
Authorizations
in report
include_sale Include Sales in
report
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
true N
true N
true N
true N
true N
true N
true N
include_delayedcapture Include
Delayed
Captures in
report
include_credit Include Credits
in report
include_void Include Voids in
report
include_voiceauthorizationInclude Voice
Authorizations
in report
(PayPal only)
include_buyer_authentic
ated
include_not_buyer_auth
enticated
Include Buyer
Authenticated
transactions in
report
Include Not
Buyer
Authenticated
transactions in
report
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
true N
true N
true N
true N
false N
false N
76 Gateway Reporting Developer Guide
T
ABLE C.25 Custom Report input parameters
Report Parameters
Custom Report
C
recurring_only Only include
recurring
transactions in
report
sort_by Column to sort
data by
sort_option Sort by
ascending or
descending
timezone Timezone used
to interpret
times
show_order_id Return Order
ID column in
result?
string N true
false
string N Transactio
n ID
Transactio
n Time
Transactio
n Type
Tender
Type
Amount
Result
string N Ascending
Descendin
g
string N GMT
GMT+/XX:XX
string N true
false
false N
Transacti
on Time
AscendingN
GMT N
true N
N
show_transaction_id Return
Transaction ID
column in
result?
show_time Return Time
column in
result?
show_type Return Type
column in
result?
show_tender_type Return Tender
Type column in
result?
show_account_number Return Account
Number
column in
result?
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
true N
true N
true N
true N
true N
Gateway Reporting Developer Guide 77
Report Parameters
C
Custom Report
T
ABLE C.25 Custom Report input parameters
show_expires Return Expires
column in
result?
show_aba_routing_num
ber
show_amount Return Amount
show_result_code Return Result
show_response_msg Return
show_comment1 Return
Return ABA
Routing
Number
column in
result?
column in
result?
Code column in
result?
Response Msg
column in
result?
Comment1
column in
result?
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
true N
true N
true N
true N
true N
true N
show_comment2 Return
Comment2
column in
result?
show_tax_amount Return Tax
Amount
column in
result?
show_purchase_order Return
Purchase Order
column in
result?
show_original_transactio
n_id
show_avs_street_match Return AVS
Return Original
Transaction ID
column in
result?
Street Match
column in
result?
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
true N
true N
true N
true N
true N
78 Gateway Reporting Developer Guide
T
ABLE C.25 Custom Report input parameters
Report Parameters
Custom Report
C
show_avs_zip_match Return AVS Zip
Match column
in result?
show_invoice_number Return Invoice
Number
column in
result?
show_authcode Return
Authcode
column in
result?
show_batch_id Return Batch
ID column in
result?
show_csc_match Return CSC
Match column
in result?
show_billing_first_name Return Billing
First Name
column in
result?
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
true N
true N
true N
true N
true N
true N
show_billing_last_name Return Billing
Last Name
column in
result?
show_billing_company_
name
show_billing_address Return Billing
show_billing_city Return Billing
show_billing_state Return Billing
show_billing_zip Return Billing
Return Billing
Company
Name column
in result?
Address
column in
result?
City column in
result?
State column in
result?
Zip column in
result?
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
true N
true N
true N
true N
true N
true N
Gateway Reporting Developer Guide 79
Report Parameters
C
Custom Report
T
ABLE C.25 Custom Report input parameters
show_billing_email Return Billing
Email column
in result?
show_billing_country Return Billing
Country
column in
result?
show_shipping_first_nameReturn
Shipping First
Name column
in result?
show_shipping_last_nameReturn
Shipping Last
Name column
in result?
show_shipping_address Return
Shipping
Address
column in
result?
show_shipping_city Return
Shipping City
column in
result?
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
string N true
false
true N
true N
true N
true N
true N
true N
show_shipping_state Return
Shipping State
column in
result?
show_shipping_zip Return
Shipping Zip
column in
result?
show_shipping_country Return
Shipping
Country
column in
result?
show_customer_code Return
Customer Code
column in
result?
80 Gateway Reporting Developer Guide
string N true
false
string N true
false
string N true
false
string N true
false
true N
true N
true N
true N
T
ABLE C.25 Custom Report input parameters
Report Parameters
Custom Report
C
show_freight_amount Return Freight
Amount
column in
result?
show_duty_amount Return Duty
Amount
column in
result?
T
ABLE C.26 Custom Report output parameters
Column name Type Comment
Order ID string Only if Cybercash merchant
Transaction ID string
Time date
Type string
Tende r Type st r ing
Account Number string The last 4 digits are returned
string N true
false
string N true
false
true N
true N
Expires string
ABA Routing Number string
Amount currency
Result Code number
Response Msg string
Comment1 string
Comment2 string
Tax Amount currency
Purchase Order string
Original Transaction ID string
AVS Street Match string
AVS Zip Match string
Invoice Number string
Authcode string
Batch ID number
Gateway Reporting Developer Guide 81
Report Parameters
C
Custom Report
T
ABLE C.26 Custom Report output parameters
CSC Match string
Billing First Name string
Billing Last Name string
Billing Company Name string
Billing Address string
Billing City string
Billing State string
Billing Zip string
Billing Email string
Billing Country string
Shipping First Name string
Shipping Last Name string
Shipping Address string
Shipping City string
Shipping State string
Shipping Zip string
Shipping Country string
Customer Code string
Freight Amount currency
Duty Amount currency
82 Gateway Reporting Developer Guide
Daily Activity Report
TABLE C.27 Daily Activity Report input parameters
Name Description Type Required?
Allowed
values
Report Parameters
Daily Activity Report
Auto-
computed
Default
value
by
scheduler?
C
report_date Date to run report
for
sort_by Column to sort data bystring N Transaction ID
sort_option Sort by ascending
or descending
timezone Timezone used to
interpret times
date YYYYMM-DD
string N Ascending
string N GMT
YN/AY
Transaction
Time
Transaction
Type
Tender Type
Amount
Result
Descending
GMT+/XX:XX
Trans Time N
Ascending N
GMT N
Gateway Reporting Developer Guide 83
Report Parameters
C
Daily Activity Report
Currency values are returned in the three-character currency code specified. The values are:
USD (US dollar) (default value)
EUR (Euro)
GBP (UK pound)
CAD (Canadian dollar)
JPY (Japanese Yen)
AUD (Australian dollar)
TABLE C.28 Daily Activity Report output parameters
Column name Typ e Comment
Order ID string Only if Cybercash merchant
Transaction ID string
Time date
Type string
Tende r Type s tring
Account Number string The last 4 digits are returned
Expires string
Amount currency
Result number
Response Msg string
Comment1 string
Comment2 string
Client IP string
Authcode string
AVS Street Match string
AVS Zip Match string
84 Gateway Reporting Developer Guide
Filter Scorecard Report
TABLE C.29 Filter Scorecard Report input parameters
Name Description Type Required?
Allowed
values
Report Parameters
Filter Scorecard Report
AutoDefault
value
computed
by scheduler?
C
start_date Start date to run
report for
end_date End date to run report
for
timezone Timezone used to
interpret times
T
ABLE C.30 Filter Scorecard Report output parameters
Column name Ty p e
Filter string
Times Triggered number
Trigger Percentage number
datetime
YYYY-MMDD HH:MI:SS
datetime
YYYY-MMDD HH:MI:SS
string N GMT
YN/AY
YN/AY
GMT N
GMT+/XX:XX
Gateway Reporting Developer Guide 85
Report Parameters
C
Fraud Protection Report
Fraud Protection Report
TABLE C.31 Fraud Protection Report input parameters
Name Description Type
Required
?
Allowed values
Default
value
Autocomputed
by
scheduler?
start_date Start date to run report
for
end_date End date to run report
for
transaction_
type
timezone Timezone used to
T
ABLE C.32 Fraud Protection Report output parameters
Column name Ty p e
Transaction ID string
Transaction types to
report on
interpret times
datetime
YYYY-MMDD HH:MI:SS
datetime
YYYY-MMDD HH:MI:SS
string Y Review
string N GMT
YN/AY
YN/AY
N/A N
Reject
Accept
Screened By Filters
Not Screened By
Filters
GMT N
GMT+/-XX:XX
Time date
Type string
Tende r Type str i n g
Amount currency
Deployment Mode string
Fraud Transaction string
86 Gateway Reporting Developer Guide
Payflow Link Orders Report
TABLE C.33 PayflowLink Orders Report input parameters
Required?Allowed
Name Description Type
values
Report Parameters
Payflow Link Orders Report
Auto-
computed
Default
value
by
scheduler?
C
start_date Start date to run report
for
end_date End date to run report
for
timezone Timezone used to
interpret times
T
ABLE C.34 PayflowLink Orders Report output parameters
Column name Type
Time date
Transaction ID string
Billing Name string
Billing Address string
datetime
YYYY-MMDD
HH:MI:SS
datetime
YYYY-MMDD
HH:MI:SS
string N GMT
YN/AY
YN/AY
GMT N
GMT+/XX:XX
Billing City string
Billing State string
Billing Zip string
Billing Country string
Billing Phone string
Billing Fax string
Billing Email string
Shipping Name string
Shipping Address string
Gateway Reporting Developer Guide 87
Report Parameters
C
Payflow Link Orders Report
T
ABLE C.34 PayflowLink Orders Report output parameters
Shipping City string
Shipping State string
Shipping Zip string
Shipping Country string
Shipping Phone string
Shipping Fax string
Shipping Email string
Amount currency
Tax Amount currency
Ship Amount currency
Description string
Type string
Result Code number
88 Gateway Reporting Developer Guide
PayPal Settlement Summary Report
PayPal Settlement Summary Report
TABLE C.35 PayPal Settlement Summary Report input parameters
Name Description Typ e Required?
Allowed
values
Report Parameters
Autocomputed
by
Default
value
scheduler
?
C
start_date Start date to run report
for
end_date End date to run report for datetime
timezone Timezone used to
interpret times
T
ABLE C.36 PayPal Settlement Summary Report output parameters
Column name Ty p e Comment
Date date
Sales and Delay Captures
Number
Sales and Delay Captures
Amount
Credits Number number
number
currency Values are returned in the
datetime
YYYY-MMDD HH:MI:SS
YYYY-MMDD HH:MI:SS
string N GMT
YN/AY
YN/AY
specified, supported currency.
GMT N
GMT+/XX:XX
Credits Amount currency
Fees Amount currency
Net Amount currency
Currency Symbol string
Gateway Reporting Developer Guide 89
Report Parameters
C
Profile Next Payment Report
Profile Next Payment Report
TABLE C.37 Profile Next Payment Report input parameters
Required?Allowed
Name Description Type
values
Default
value
Autocomputed
by
scheduler?
start_date Start date to run
report for
end_date End date to run
report for
T
ABLE C.38 Profile Next Payment Report output parameters
Column name Type
Profile Id number
Profile Name string
Last Name string
Status number
Account Number string - The last 4 digits are
Expires string
Amount currency
datetime YYYY-MM-DD
HH:MI:SS
datetime YYYY-MM-DD
HH:MI:SS
returned
Y Current and
Y Current and
N/A Y
future date/time
values
N/A Y
future date/time
values
Established Date date
Start Date date
Frequency string
Terms number
Next Payment Date date
Deactivation Date date
Profile Modified Date date
90 Gateway Reporting Developer Guide
Profile Modified Date Report
TABLE C.39 Profile Next Payment Report input parameters
Required?Allowed
Name Description Type
values
Report Parameters
Profile Modified Date Report
Auto-
computed
Default
value
by
scheduler?
C
start_date Start date to run
report for
end_date End date to run
report for
T
ABLE C.40 Profile Modified Date Report output parameters
Column name Type
Profile Id number
Profile Name string
Last Name string
Status number
Account Number string - The last 4 digits are
Expires string
datetime YYYY-MM-DD
HH:MI:SS
datetime YYYY-MM-DD
HH:MI:SS
returned
Y Current and
Y Current and
N/A Y
future date/time
values
N/A Y
future date/time
values
Amount currency
Established Date date
Start Date date
Frequency string
Terms number
Next Payment Date date
Deactivation Date date
Profile Modified Date date
Gateway Reporting Developer Guide 91
Report Parameters
C
Recurring Billing Report
Recurring Billing Report
TABLE C.41 Recurring Billing Report input parameters
Name Description Type
Required?Allowed
values
Default
value
Auto-
computed
by
scheduler?
start_date Start date to run
report for
end_date End date to run
report for
include_
approvals
include_
declines
timezone Timezone to
tender_
type
ABLE C.42 Recurring Billing Report output parameters
T
Column name Type
Incl approvals
in report
Include declines
in report
interpret times
Run report for
ACH or Credit
datetime YYYY-MM-DD
HH:MI:SS
datetime YYYY-MM-DD
HH:MI:SS
string N true
string N true
string N GMT
string N ACH
YN/AY
YN/AY
true N
false
true N
false
GMT N
GMT+/-XX:XX
Credit N
Credit
Profile Name string
Profile ID string
Status string
Payment Number number
Retry Number number
Time date
Retry Reason string
Retry Flag number
Transaction ID string
Result Code number
92 Gateway Reporting Developer Guide
Recurring Profile Failed Report
TABLE C.43 Recurring Profile Failed Report input parameters
Name Description Ty pe Required?
Report Parameters
Recurring Profile Failed Report
Allowed
values
Default
value
C
Autocomputed
by scheduler?
start_date Start date to run report
for
timezone Timezone used to
interpret times
T
ABLE C.44 Recurring Profile Failed Report output parameters
Column name Ty pe
Profile Name string
Profile ID string
Status string
Payment Number number
Retry Number number
Time date
Retry Reason string
Retry Flag number
date YYYYMM-DD
string N GMT
YN/AY
GMT N
GMT+/XX:XX
Transaction ID string
Result Code number
Gateway Reporting Developer Guide 93
Report Parameters
C
Recurring Profile Report
Recurring Profile Report
TABLE C.45 Recurring Profile Report input parameters
Name Description Ty pe Required?
Allowed
values
Default
value
Autocomputed
by scheduler?
start_date Start date to run
report for
end_date End date to run
report for
profile_id Profile to report onstring Y N/A N
timezone Timezone used
to interpret times
tender_
type
ABLE C.46 Recurring Profile Report output parameters
T
Column name Ty pe
Profile Name string
Profile ID string
Run report for
ACH or Credit
datetime
YYYY-MMDD HH:MI:SS
datetime
YYYY-MMDD HH:MI:SS
string N GMT
string N ACH
YN/AY
YN/AY
GMT+/XX:XX
Credit
GMT N
Credit N
Status string
Payment Number number
Retry Number number
Time date
Retry Reason string
Retry Flag number
Transaction ID string
Result Code number
94 Gateway Reporting Developer Guide
Settlement Report
TABLE C.47 Settlement Report input parameters
Required?Allowed
Name Description Ty pe
values
Report Parameters
Settlement Report
Auto-
computed
Default
value
by
scheduler?
C
start_date Start date to run
report for
end_date End date to run
report for
processor Processor to report onstring Y Name of the
settlement_
status
transaction_
type
timezone Timezone used to
Settled or non-settled
transactions
Transaction types to
report on
interpret times
datetime
YYYYMM-DD
HH:MI:SS
datetime
YYYYMM-DD
HH:MI:SS
string N Settled
string N Sales
string N GMT
YN/AY
YN/AY
processor for
which the
settlement
report is
requested
Unsettled
All
Credits
All
GMT+/XX:XX
N/A N
All N
All N
GMT N
T
ABLE C.48 Settlement Report output parameters
Column name Type Comment
Order ID string Only if Cybercash merchant
Transaction ID string
Time date
Type string
Gateway Reporting Developer Guide 95
Report Parameters
C
Settlement Report
T
ABLE C.48 Settlement Report output parameters
Tende r Type stri n g
Account Number string The last 4 digits are returned
Expires string
Amount currency
Result Code number
Response Msg string
Comment1 string
Comment2 string
Batch ID number
Currency Symbol string Alphabetic currency symbol, for example
USD
PayPal
Transaction ID
PayPal Fees currency Returned only if merchant has a PayPal
PayPal Email ID string Buyer’s PayPal email address ; returned only
string Returned only if merchant has a PayPal
Internet Merchant Account
Internet Merchant Account
if merchant has a PayPal Internet Merchant
Account
96 Gateway Reporting Developer Guide
Shipping and Billing Report
TABLE C.49 Shipping and Billing Report input parameters
Allowed
Name Description Type Required?
values
Report Parameters
Shipping and Billing Report
Auto-
computed
Default
value
by
scheduler?
C
report_date Date to run report
for
sort_by Column to sort
data by
sort_option Sort by ascending
or descending
timezone Timezone used to
interpret times
T
ABLE C.50 Shipping and Billing Report output parameters
Column name Type Comment
Order ID string Only if Cybercash merchant
date
YYYYMM-DD
string N Transaction ID
string N Ascending
string N GMT
YN/AY
Transaction
Time
Transaction Type
Tender Type
Amount
Result
Descending
GMT+/-XX:XX
Trans Time N
Ascending N
GMT N
Time date
Transaction ID string
Captured string
Type string
Billing First Name string
Billing Last Name string
Billing Company Name string
Billing Address string
Billing City string
Gateway Reporting Developer Guide 97
Report Parameters
C
Shipping and Billing Report
T
ABLE C.50 Shipping and Billing Report output parameters
Billing State string
Billing Zip string
Billing Email string
Billing Country string
Shipping First Name string
Shipping Last Name string
Shipping Address string
Shipping City string
Shipping State string
Shipping Zip string
Shipping Country string
Purchase Order string
Customer Code string
Tax Amount currency
Freight Amount currency
Duty Amount currency
Total Amount currency
98 Gateway Reporting Developer Guide
Transaction Summary Report
TABLE C.51 Transaction Summary Report input parameters
Name Description Type Required?
Transaction Summary Report
Allowed
values
Report Parameters
Auto-
computed
Default
value
by
scheduler?
C
start_date Start date to run report
for
end_date End date to run report
for
settlement_
status
timezone Timezone used to
T
ABLE C.52 Transaction Summary Report output parameters
Column name Typ e
Transaction Type string
Processor string
Settled or non-settled
transactions
interpret times
datetime
YYYY-MMDD HH:MI:SS
datetime
YYYY-MMDD HH:MI:SS
string N Settled
string N GMT
YN/AY
YN/AY
All N
Unsettled
All
GMT N
GMT+/XX:XX
Trans Count number
Result Code number
Tende r Type s tring
Min Amount currency
Max Amount currency
Average currency
Total Amount currency
Gateway Reporting Developer Guide 99
Report Parameters
C
Transaction Summary Report
100 Gateway Reporting Developer Guide
Loading...