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.
Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Where to Go for More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 How to Contact Customer Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Revision History . . . . . . . .
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . .
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 . . . .
Contents Fraud Protection Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Payflow Link Orders Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 PayPal Settlement Summary Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Profile Next Payment Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Profile Modified Date Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Preface Gateway Reporting Developer Guide describes the Reporting XML API for the following Gateway payment solutions:PayPal Payments Advanced, PayPal Payments Pro, Payflow Pro, and Payflow Link. The XML API enables you to develop Web and desktop applications that create, schedule, and run standard (pre-defined) and custom Payflow services reports.
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 Reporting Overview 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.
1 Reporting Overview 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.
2 Using the Reporting API This chapter describes how you can use the Reporting API to perform the following tasks. “Running Reports” on page 12 “Managing Report Templates” on page 14 “Using Report Templates” on page 15 “Performing Searches” on page 18 API Notation in this Chapter The chapter uses the following short-hand notation for referring to Reporting API requests and parameter information. requestName (paramName, paramName, [...]) requestName is the name of the request.
2 Using the Reporting API 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).
Using the Reporting API Running Reports 2 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.
2 Using the Reporting API 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.
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. 2 The response to creating a report template returns a respCode and respMsg. Step 2. Update a report template To update a report template, call the updateTemplateRequest with the following parameters.
2 Using the Reporting API Using Report Templates reportParam(s) (Optional) paramName and paramValue for each reportParam that you 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. pageSize Number of rows of data per page. Default is 50. Step 2.
Using the Reporting API Using Report Templates 2 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.
2 Using the Reporting API 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.
3 Response Codes and Status 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.
3 Response Codes and Status Codes 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.
A Reporting XML Schema This appendix contains the XML Reporting 1.0 schema. PAGE 22A Reporting XML Schema
Reporting XML Schema A
A Reporting XML Schema PAGE 25Reporting XML Schema A
PAGE 26A Reporting XML Schema
Reporting XML Schema A
A 28 Reporting XML Schema Gateway Reporting Developer Guide
B Reporting Samples 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.
B Reporting Samples 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.
Reporting Samples Running a Transaction Summary Report B R u n n i n g a Tr a n s a c t i o n S u m m a r y R e p o r t 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.
B Reporting Samples 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.
Reporting Samples Getting Metadata B 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.
B Reporting Samples 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.
Reporting Samples Getting Metadata B Reponse Msg string Comment1 string Comment2 string Format Returned The format returned by this sample is shown below: N OTE : The Transaction ID Trans Time last four digits of the Account Number are returne
B Reporting Samples Getting Data G e t t i n g D a ta 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.
Reporting Samples Getting Data B 4111XXXXXXXX1111 01/07 A1000 0 Approved V89A0A000088 2007-09-07 17:46:09
B Reporting Samples Getting Data V89A0A000089 2007-09-07 17:48:20 S 0 4111XXXXXXXX1111 01/07 A1000 0
Reporting Samples Getting Data B 0 4111XXXXXXXX1111 01/07 A1000 0 Approved V89A0A00008B 2007-0
B Reporting Samples Getting Data Approved V89A0A00008C 2007-09-07 17:53:32 S 0 4111XXXXXXXX1111 01/07 A1000
Reporting Samples Getting Data B S 0 4111XXXXXXXX1111 01/07 A1000 0 Approved V89A0A00008E
B Reporting Samples Getting Data 0 Approved V89A0A00008F 2007-09-07 17:56:33 S 0 4111XXXXXXXX1111 01/07
Reporting Samples Getting Data B 2007-09-07 18:01:31 S 0 4111XXXXXXXX1111 01/05 A1000 24 Unknown error
B Reporting Samples Getting Data 0 Approved V89A0A000092 2007-09-07 18:02:19 S 0 4111XXXXXXXX1111 12/05
Reporting Samples Getting Data B 2007-09-07 18:03:09 S 0 4111XXXXXXXX1111 12/05 A1000 0 Approved
B Reporting Samples Getting Data Data Returned The data is returned in the following tabular format of 13 rows and 11 columns: 46 V89A0A000087 2007-09-07 17:45:07 S O 1111 01/07 A1000 O Approved V89A0A000088 2007-09-07 17:45:09 S O 1111 01/07 A1000 O Approved V89A0A000089 2007-09-07 17:48:20 S O 1111 01/07 A1000 O Approved V89A0A00008A 2007-09-07 17:52:03 S O 1111 01/07 A1000 O Approved V89A0A00008B 2007-09-07 17:53:07 S O 1111 01/07 A1000 O Approved V89A0A00
Reporting Samples Creating a Report Template B C r e a t i n g a R e p o r t Te m p l a t e 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.
B Reporting Samples 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.
Reporting Samples Getting a Report Template B 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.
B Reporting Samples 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.’
Reporting Samples Creating a Schedule B Creating a Schedule This sample demonstrates how to create a schedule for a report template. Creating a Schedule Request ?xml version="1.
B Reporting Samples Getting a Schedule Getting a Schedule Getting a Schedule Request ?xml version="1.
Reporting Samples Updating a Schedule B U pd a t i n g a S c h e d u l e This sample demonstrates how to update a schedule. Updating a Schedule Request
B Reporting Samples Deleting a Schedule Deleting a Schedule This sample demonstrates how to delete a schedule.
Reporting Samples Running a Transaction ID Search B R u n n i n g a Tr a n s a c t i o n I D S e a r c h This sample demonstrates how to run a search by transaction ID. Running a Transaction ID Search Request
B Reporting Samples 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
Reporting Samples Running a Profile - Profile Modified Date Report B 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
B 58 Reporting Samples Running a Profile - Profile Modified Date Report Gateway Reporting Developer Guide
C Report Parameters 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
C Report Parameters ACH Activity Summary Report ACH Activity Summary Report TABLE C.
Report Parameters ACH Activity Summary Report TABLE C.
C Report Parameters ACH Batch ID Report ACH Batch ID Report TABLE C.3 Required ? Allowed values Default value Name Description Type start_date Start date to run report for datetime YYYYMM-DD HH:MI:SS Y end_date End date to run report for datetime YYYYMM-DD HH:MI:SS Y timezone Timezone used to interpret times string N host_type number Y batch_id number N BatchByCar d string N true, false FALSE batch_type string N Consumer Batch, Merchant Batch Merchan t Batch TABLE C.
Report Parameters ACH Batch ID Report TABLE C.
C Report Parameters ACH Detail Return Activity Report A C H D e ta i l R e t u r n A c t i v i t y R e p o r t TABLE C.5 Required ? Allowed values Default value Name Description Type start_date Start date to run report for datetime YYYYMM-DD HH:MI:SS Y N/A end_date End date to run report for datetime YYYYMM-DD HH:MI:SS Y N/A timezone Timezone used to interpret times string N GMT-7 TABLE C.
Report Parameters ACH Notification of Change Report TABLE C.6 C ACH Detail Return Activity Report output parameters Batch ID number Currency Symbol string ACH Notification of Change Report TABLE C.
C Report Parameters ACH Return Activity Report ACH Return Activity Report TABLE C.9 Auto Return Activity Report input parameters Required ? Allowed values Default value Autocomputed by scheduler? Name Description Type start_date Start date to run report for datetime YYYYMM-DD HH:MI:SS Y Y end_date End date to run report for datetime YYYYMM-DD HH:MI:SS Y Y timezone Timezone used to interpret times string N GMT-7 TABLE C.
Report Parameters ACH Settlement Report C ACH Settlement Report TABLE C.11 ACH Settlement Report input parameters Required ? Name Description Type start_date Start date to run report for datetime YYYYMM-DD HH:MI:SS Y end_date End date to run report for datetime YYYYMM-DD HH:MI:SS Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? Y GMT-7 TABLE C.
C Report Parameters ACH Transaction Report TABLE C.12 ACH Settlement Report output parameters Currency Symbol string Comment1 string Comment2 string Fund Status string ACH Transaction Report TABLE C.
Report Parameters Auto Credit Report C TABLE C.14 ACH Transaction Report output parameters Tender Type string 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 Comment2 string Prenote string Currency Symbol string Auto Credit Report TABLE C.
C Report Parameters Auto Delayed Capture Report TABLE C.15 Auto Credit Report input parameters timezone Timezone used to interpret times string N GMT GMT+/XX:XX GMT N TABLE C.
Report Parameters Auto Delayed Capture Report C TABLE C.17 Auto Delayed Capture Report input parameters timezone Timezone used to interpret times string N GMT GMT+/XX:XX GMT N TABLE C.
C Report Parameters Auto Resettle Report Auto Resettle Report TABLE C.19 Auto Resettle Report input parameters Allowed values Default value Autocomputed by scheduler? Name Description Type Required? start_date Start date to run report for datetime YYYY-MMDD HH:MI:SS Y N/A Y end_date End date to run report for datetime YYYY-MMDD HH:MI:SS Y N/A Y timezone Timezone used to interpret times string N GMT N GMT GMT+/XX:XX TABLE C.
Report Parameters Auto Void Report C Auto Void Report TABLE C.21 Auto Void Report input parameters Default value Autocomputed by scheduler? Y N/A Y datetime YYYYMM-DD HH:MI:SS Y N/A Y string N GMT N Required ? Name Description Type start_date Start date to run report for datetime YYYYMM-DD HH:MI:SS end_date End date to run report for timezone Timezone used to interpret times Allowed values GMT GMT+/XX:XX TABLE C.
C Report Parameters Batch ID Report Batch ID Report TABLE C.
Report Parameters Custom Report C Custom Report TABLE C.
C Report Parameters Custom Report TABLE C.
Report Parameters Custom Report C TABLE C.
C Report Parameters Custom Report TABLE C.
Report Parameters Custom Report C TABLE C.
C Report Parameters Custom Report TABLE C.
Report Parameters Custom Report C TABLE C.25 Custom Report input parameters show_freight_amount Return Freight Amount column in result? string N true false true N show_duty_amount Return Duty Amount column in result? string N true false true N TABLE C.
C Report Parameters Custom Report TABLE C.
Report Parameters Daily Activity Report C Daily Activity Report TABLE C.
C Report Parameters 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.
Report Parameters Filter Scorecard Report C Filter Scorecard Report TABLE C.29 Filter Scorecard Report input parameters Allowed values Default value Autocomputed by scheduler? Name Description Type Required? start_date Start date to run report for datetime YYYY-MMDD HH:MI:SS Y N/A Y end_date End date to run report for datetime YYYY-MMDD HH:MI:SS Y N/A Y timezone Timezone used to interpret times string N GMT N GMT GMT+/XX:XX TABLE C.
C Report Parameters Fraud Protection Report Fraud Protection Report TABLE C.
Report Parameters Payflow Link Orders Report C Payflow Link Orders Report TABLE C.33 PayflowLink Orders Report input parameters Default value Autocomputed by scheduler? Y N/A Y datetime YYYY-MMDD HH:MI:SS Y N/A Y string N GMT N Name Description Type start_date Start date to run report for datetime YYYY-MMDD HH:MI:SS end_date End date to run report for timezone Timezone used to interpret times Required ? Allowed values GMT GMT+/XX:XX TABLE C.
C Report Parameters Payflow Link Orders Report TABLE C.
Report Parameters PayPal Settlement Summary Report C PayPal Settlement Summary Report TABLE C.35 PayPal Settlement Summary Report input parameters Default value Autocomputed by scheduler ? Y N/A Y datetime YYYY-MMDD HH:MI:SS Y N/A Y string N GMT N 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 timezone Timezone used to interpret times Allowed values GMT GMT+/XX:XX TABLE C.
C Report Parameters Profile Next Payment Report Profile Next Payment Report TABLE C.37 Profile Next Payment Report input parameters Required ? Allowed values Default value Autocomputed by scheduler? datetime YYYY-MM-DD HH:MI:SS Y Current and future date/time values N/A Y datetime YYYY-MM-DD HH:MI:SS Y Current and future date/time values N/A Y Name Description Type start_date Start date to run report for end_date End date to run report for TABLE C.
Report Parameters Profile Modified Date Report C Profile Modified Date Report TABLE C.39 Profile Next Payment Report input parameters Required ? Allowed values Default value Autocomputed by scheduler? datetime YYYY-MM-DD HH:MI:SS Y Current and future date/time values N/A Y datetime YYYY-MM-DD HH:MI:SS Y Current and future date/time values N/A Y Name Description Type start_date Start date to run report for end_date End date to run report for TABLE C.
C Report Parameters Recurring Billing Report Recurring Billing Report TABLE C.
Report Parameters Recurring Profile Failed Report C Recurring Profile Failed Report TABLE C.43 Recurring Profile Failed Report input parameters Name Description Type Required? start_date Start date to run report for date YYYYMM-DD Y timezone Timezone used to interpret times string N Allowed values GMT GMT+/XX:XX Default value Autocomputed by scheduler? N/A Y GMT N TABLE C.
C Report Parameters Recurring Profile Report Recurring Profile Report TABLE C.
Report Parameters Settlement Report C Settlement Report TABLE C.
C Report Parameters Settlement Report TABLE C.
Report Parameters Shipping and Billing Report C Shipping and Billing Report TABLE C.
C Report Parameters Shipping and Billing Report TABLE C.
Report Parameters Transaction Summary Report C Tr a n s a c t i o n S u m m a r y R e p o r t TABLE C.
C 100 Report Parameters Transaction Summary Report Gateway Reporting Developer Guide
D Search Parameters Transaction ID Search TABLE D.1 Transaction ID Search input parameters Name Description Type Required ? transaction_id Transaction ID to search for string Y timezone Timezone used to interpret times string N TABLE D.
D Search Parameters Transaction ID Search TABLE D.
Search Parameters Batch ID Search D Batch ID Search TABLE D.3 Batch ID Search input parameters Name Description Type Required ? batch_id Batch ID to search for string Y start_date Start date to search for datetime YYYYMM-DD HH:MI:SS Y end_date End date to search for datetime YYYYMM-DD HH:MI:SS Y timezone Timezone used to interpret times string N TABLE D.
D Search Parameters AccountNumberSearch AccountNumberSearch TABLE D.5 Name Description Type Required ? account_number Account Number to search for string Y start_date Start date to search for datetime YYYY-MMDD HH:MI:SS Y end_date End date to search for datetime YYYY-MMDD HH:MI:SS Y timezone Timezone used to interpret times string N TABLE D.
Search Parameters CommentSearch D CommentSearch TABLE D.
D Search Parameters CommentSearch TABLE D.
Search Parameters AccountNumberRefSearch D AccountNumberRefSearch TABLE D.9 AccountNumberRefSearch input parameters Name Description Type Required ? transaction_id Transaction ID to search for string Y start_date Start date to search for datetime YYYYMM-DD HH:MI:SS Y end_date End date to search for datetime YYYYMM-DD HH:MI:SS Y timezone Timezone used to interpret times string N Allowed values GMT GMT+/XX:XX Defaul t value Autocomputed by scheduler? GMT N TABLE D.
D Search Parameters PurchaseOrderSearch PurchaseOrderSearch TABLE D.11 PurchaseOrderSearch input parameters Name Description Type Required? purchase_order_num Purchase Order Number to search for string Y start_date Start date to search for datetime YYYYMM-DD HH:MI:SS Y end_date End date to search for datetime YYYYMM-DD HH:MI:SS Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
Search Parameters RecurringBillingProfileIDSearch D RecurringBillingProfileIDSearch TABLE D.13 RecurringBillingProfileIDSearch input parameters Name Description Type Required ? profile_id Profile ID to search for string Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
D Search Parameters RecurringBillingProfileNameSearch TABLE D.14 RecurringBillingProfileIDSearch output parameters Date Established date RecurringBillingProfileNameSearch TABLE D.15 RecurringBillingProfileNameSearch input parameters Name Description Type Required ? profile_name Profile Name to search for string Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
Search Parameters RecurringBillingAccountNumberSearch D RecurringBillingAccountNumberSearch TABLE D.17 RecurringBillingAccountNumberSearch input parameters Name Description Type Required? account_number Account number to search for string Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
D Search Parameters RecurringBillingCommentSearch RecurringBillingCommentSearch TABLE D.19 RecurringBillingCommentSearch input parameters Name Description Type Required? comment Comment to search for string Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
Search Parameters RecurringBillingAmountSearch D RecurringBillingAmountSearch TABLE D.21 RecurringBillingAmountSearch input parameters Name Description Type Required? amount Amount to search for string Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
D Search Parameters FraudTransactionSearch F r a u d Tr a n s a c t i o n S e a r c h TABLE D.23 FraudTransactionSearch input parameters Name Description Type Required? fraud_transaction_id transaction ID to search for string Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
Search Parameters FraudTransactionSearch D TABLE D.
D Search Parameters OrderIDSearch OrderIDSearch TABLE D.25 OrderIDSearch input parameters Name Description Type Required ? order_id Order ID to search for string Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
Search Parameters OrderIDSearch D TABLE D.
D Search Parameters PayPalTransactionIDSearch P a y P a l Tr a n s a c t i o n I D S e a r c h TABLE D.27 PayPalTransactionIDSearch input parameters Name Description Type Required ? paypal_transaction _id PayPal transaction ID to search for string Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
Search Parameters PayPalEmailSearch D PayPalEmailSearch TABLE D.29 PayPalEmailSearch input parameters Name Description Type Required ? email Email address to search for string Y start_date Start date to search for datetime YYYYMM-DD HH:MI:SS Y end_date End date to search for datetime YYYYMM-DD HH:MI:SS Y timezone Timezone used to interpret times string N Allowed values Default value Autocomputed by scheduler? GMT GMT+/XX:XX GMT N TABLE D.
D Search Parameters PayPalNameSearch PayPalNameSearch TABLE D.
Index Index A G ACH 60 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 getDataRequest 13, 17 getMetaDataRequest 13, 14 getResultsRequest 14 getScheduleRequest 16 getting data 36 getting metadata 33 getting report templates 49 getting results by repor
Index running reports offline 14 running transaction ID search 55 runReportRequest 13, 15 runSearchRequest 18 S Settlement Report 95 Shipping and Billing Report 97 status codes 20 T Transaction Summary Report 31, 99 U updateScheduleRequest 17 updateTemplateRequest 15 updating report templates 48 updating schedules 53 updating templates 48 using report templates 15 122 Gateway Reporting Developer Guide
