Home

PayPal Gateway - 2013 Developer's Guide

Contents

1. 0 60 Retrieving a List of All Scheduled Reports Response 60 Appendix C Report Parameters 2 858 2682 61 Reports in This Appendix o 61 ACH Activity Summary Report 22 2 22m nn nn 62 ACH Batch ID Report 22 2 2 2 nn nn 64 ACH Detail Return Activity Report 2 22 nn nn nn 66 ACH Notification of Change Report 2 2 2 nn nn nn 67 ACH Return Activity Report 2 2 a 68 ACH Settlement Report e 69 ACH Transaction Report a 70 Auto Credit Report a 71 Auto Delayed Capture Report 0 72 Auto Resettle Report 2 2 eo 74 Auto Void Rep s sc a a a ka Se me a ee ee eae el ee ee a 75 Batch ID R polt sars 24 du wa be dh eee td ake blew AA ha A ie ed 76 Gateway Reporting Developer Guide 5 De Contents Custom Repaso 77 Daily Activity Report LL 85 Filter Scorecard Report aoaaa 87 Fraud Protection Report 22 22 m nn nn nn 88 Payflow Link Orders Report 22 n on nn nn 89 PayPal Settlement Summary Report 22 2 2 nn nn nn 91 Profile Next Payment Report aoaaa aa a 92 Profile Modified Date Report 2 2 2m m nn nn nn 93 Recurring Billing Report sacas sasaa rra ek taa 94 Recurring Profile Failed Report 0 95 Recurring Profile Report 0 96 Settlement Report nn 97 Shipping and Billing Report LL 99 Transaction Summary Report 22 2 2 2m nn nn 101 Appendix D Search Parameters
2. 2 2 ee eee 103 Transaction ID Search 103 Batch ID Search io a 200 20a daa ei 105 AccountNumberSearch 106 CommentSearch gt lt a 2 m nn 107 AccountNumberRefSearch 109 PurchaseOrderSearch LL 110 RecurringBillingProfilelIDSearch oaoa e e o 111 RecurringBillingProfileNameSearch Cum nn nn 112 RecurringBillingAccountNumberSearch 22 22 2 nun 113 RecurringBillingCommentSearch aaao a 114 RecurringBillingAmountSearch 2 222222 u nn nn nn 115 FraudTransactionSearch aooo a 116 OrderlDSeafch e 4 dre del a en e tr ra 118 PayPalTransactionlDSearch LL 120 PayPalEmailSearch LL 121 PayPalNameSearch LL 122 INOX ino a we ee er GE 28 6 Gateway Reporting Developer Guide 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 Audience This guide assumes that its readers e Have a good understanding of XML application development e Have a background in payments services Organization This guide is organized as follows e Chapter 1 Reporting Overview provides an overview of Reporting and the types of functionality it offers
3. TABLE C 44 Recurring Profile Failed Report output parameters 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 Gateway Reporting Developer Guide 95 96 Report Parameters Recurring Profile Report Recurring Profile Report TABLE C 45 Recurring Profile Report input parameters start_date Start datetorun datetime N A Y report for YYYY MM DD HH MI SS end_date End date to run datetime N A Y report for YYYY MM DD HH MI SS profile_id Profile to report string N A N on timezone Timezone used string GMT GMT N to interpret times GMT XX XX tender _ Run report for string ACH Credit N type ACH or Credit Credit TABLE C 46 Recurring Profile Report output parameters 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 Gateway Reporting Developer Guide Report Parameters Settlement Report Settlement Report TABLE C 47 Settlement Report input parameters start_date Start date to run datetime Y N A Y report for YYYY MM DD HH MI SS end_date End date to run datetime Y N A Y report for YYYY MM DD HH MI SS processor Processor to report stri
4. e Chapter 2 Using the Reporting API describes how to use the Reporting API e 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 e Appendix A Reporting XML Schema provides the XML schema upon which the Reporting XML API is based e Appendix B Reporting Samples presents samples demonstrating how to use the reporting API e Appendix C Report Parameters describes the input and output parameters for each standard report e Appendix D Search Parameters describes the input and output parameters for performing searches by search name Gateway Reporting Developer Guide 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 November 2013 Added a note on how to retrive all report templates in Getting a Report Template Request Added a note on how to retriev
5. lt columnMetaData gt lt columnMetaData gt lt dataName gt Trans Type lt dataName gt lt dataType gt string lt dataType gt lt columnMetaData gt lt columnMetaData gt lt dataName gt Tender Type lt dataName gt lt dataType gt string lt dataType gt lt columnMetaData gt lt columnMetaData gt lt dataName gt Account Number lt dataName gt lt dataType gt string lt dataType gt lt columnMetaData gt lt columnMetaData gt lt dataName gt Expires lt dataName gt lt dataType gt string lt dataType gt lt columnMetaData gt lt columnMetaData gt lt dataName gt Amount lt dataName gt lt dataType gt string lt dataType gt lt columnMetaData gt lt columnMetaData gt lt dataName gt Result lt dataName gt lt dataType gt number lt dataType gt lt columnMetaData gt lt columnMetaData gt Gateway Reporting Developer Guide Reporting Samples Getting Metadata lt dataName gt Reponse Msg lt dataName gt lt dataType gt string lt dataType gt lt columnMetaData gt lt columnMetaData gt lt dataName gt Comment1 lt dataName gt lt dataType gt string lt dataType gt lt columnMetaData gt lt columnMetaData gt lt dataName gt Comment2 lt dataName gt lt dataType gt string lt dataType gt lt columnMetaData gt lt getMetaDataResponse gt lt reportingEngineResponse gt Format Returned The format returned by this sample is shown below Note The last four digits of the Account
6. Gateway Reporting Developer Guide Report Parameters ACH Notification of Change Report TABLE C 6 ACH Detail Return Activity Report output parameters Batch ID number Currency Symbol string ACH Notification of Change Report TABLE C 7 ACH Notification of Change Report input parameters start_date Start date to run datetime Y Y Y Y N A Y report for MM DD HH MI SS end_date End date to run datetime YYYY N A Y report for MM DD HH MI SS timezone Timezone used to string GMT 7 interpret times TABLE C 8 ACH Notification of Change Report output parameters Account ABA string Account Number string New Name string Account Type string Noc Type string Deposit Date date Change string Information Gateway Reporting Developer Guide 67 68 Report Parameters ACH Return Activity Report ACH Return Activity Report TABLE C 9 Auto Return Activity Report input parameters start_date Start date to run datetime Y Y Y Y report for MM DD HH MI SS end_date End date to run datetime Y Y Y Y report for MM DD HH MI SS timezone Timezone used to string GMT 7 interpret times TABLE C 10 ACH Return Activity Report output parameters Status Code string Description string Total Amount currency Total Items number Currency Symbol string Gateway Reporting Developer Guide Report Parameters ACH Settlement
7. The 6 to 32 character password that you defined while registering for the account Gateway Reporting Developer Guide 13 Using the Reporting API Where to Go For More Information on the APIs Response Data Responses include the following information e Allresponses return a base response consisting of a response code responseCode and a response message responseMsg e Most responses return applicable response parameter data e 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 Lists all response codes status codes and their message strings Response Codes and Status Codes Appendix A Contains the XML schema Appendix B Provides API request and response samples for each request and response referred to in this chapter Appendix C Describes the input and output parameters for all standard predefined reports supported Appendix D Describes the input and output parameters for all report searches supported 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
8. lt templateName gt My Template lt templateName gt lt deleteTemplateRequest gt lt reportingEngineRequest gt 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 lt xml version 1 0 encoding UTF 8 standalone yes gt lt report ingEngineResponse gt lt baseResponse gt lt responseCode gt 113 lt responseCode gt lt responseMsg gt Unknown template requested lt responseMsg gt lt baseResponse gt lt report ingEngineResponse gt lt reportingEngineRequest gt 52 Gateway Reporting Developer Guide Reporting Samples Creating a Schedule 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 gt lt reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt createScheduleRequest gt lt scheduleDefinition gt lt scheduleName gt My Schedule lt scheduleName gt lt templateName gt My Template lt templateName gt lt notificationRequired gt false lt notificationRequired gt lt daily gt lt daily gt lt scheduleDe
9. lt pageSize gt 50 lt pageSize gt lt runReportRequest gt lt reportingEngineRequest gt Gateway Reporting Developer Guide 33 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 report Id 131 is returned for future reverence in calls inquiring about this report lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt runReportResponse gt lt reportId gt 133 lt reportId gt lt statusCode gt 3 lt statusCode gt lt statusMsg gt Report has completed successfully lt statusMsg gt lt runReportResponse gt lt reportingEngineResponse gt 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 report Id 131 specifies the report for which results are being requested The report Id 131 was returned in a previous call to run the report lt xml version 1 0 encoding UTF 8 gt lt reportingEngineRequest gt lt au
10. lt xs element name columnMetaData minOccurs 0 maxOccurs unbounded gt lt xs complexType gt lt XS Sequence gt lt xs element name dataName type xs string gt lt xs element name dataType gt lt xs simpleType gt lt xs restriction base xs string gt lt xs enumeration value string gt lt xs enumeration value number gt lt xs enumeration value date gt lt xs enumeration value currency gt lt xs restriction gt lt xs simpleType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs Sequence gt lt xs complexType gt lt xs element gt lt xs element name getDataResponse gt lt xs complexType gt lt XS Sequence gt lt xs element name reportDataRow maxOccurs unbounded gt lt xs complexType gt lt XS Sequence gt lt xs element name columnData maxOccurs unbounded gt lt xs complexType gt lt XS Sequence gt Gateway Reporting Developer Guide 27 A Reporting XML Schema type xs string minOccurs 0 gt lt xs element name data lt xs sequence gt lt xs complexType gt lt xs element gt lt xS Sequence gt lt xs complexType gt lt xs element gt lt xs element ref pageNum gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs choice gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name reportDefinition gt lt xs complexT
11. 91 92 Report Parameters Profile Next Payment Report Profile Next Payment Report TABLE C 37 Profile Next Payment Report input parameters start_date Start datetorun datetime Y Current and N A Y report for YYYY MM DD future date time HH MI SS values end_date End date to run datetime Y Current and N A Y report for YYYY MM DD future date time HH MI SS values TABLE C 38 Profile Next Payment Report output parameters Profile Id number Profile Name string Last Name string Status number Account Number string The last 4 digits are returned Expires string 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 Report Parameters Profile Modified Date Report Profile Modified Date Report TABLE C 39 Profile Next Payment Report input parameters start_date Start datetorun datetime Y Current and N A Y report for YYYY MM DD future date time HH MI SS values end_date End datetorun datetime Y Current and N A Y report for YYYY MM DD future date time HH MI SS values TABLE C 40 Profile Modified Date Report output parameters Profile Id number Profile Name string Last Name string Status number Account Number string The last 4 digits are
12. 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 89 90 Report Parameters Payflow Link Orders Report TABLE 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 Gateway Reporting Developer Guide Report Parameters PayPal Settlement Summary Report PayPal Settlement Summary Report TABLE C 35 PayPal Settlement Summary Report input parameters start_date Start date to run report datetime N A Y for YYYY MM DD HH MI SS end_date End date to run report for datetime N A Y YYYY MM DD HH MI SS timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE C 36 PayPal Settlement Summary Report output parameters Date date Sales and Delay Captures number Number Sales and Delay Captures currency Values are returned in the Amount specified supported currency Credits Number number Credits Amount currency Fees Amount currency Net Amount currency Currency Symbol string Gateway Reporting Developer Guide
13. Developer Guide 57 E 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 lt xml version 1 0 encoding UTF 8 gt lt reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt runReportRequest gt lt reportName gt RBProfileNPDReport lt reportName gt lt reportParam gt lt paramName gt start_date lt paramName gt lt param Value gt 2011 06 22 00 00 00 lt param Value gt lt reportParam gt lt reportParam gt lt paramName gt end_date lt paramName gt lt param Value gt 2011 08 30 00 00 00 lt param Value gt lt reportParam gt lt pageSize gt 50 lt pageSize gt lt runReportRequest gt lt reportingEngineRequest gt Running a Profile Next Payment Response lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt runReportResponse gt lt reportld gt 132 lt reportld gt lt statusCode gt 3 lt statusCode gt lt statusMsg gt Report has completed successfully lt statusM
14. Report ACH Settlement Report TABLE C 11 ACH Settlement Report input parameters start_date Start date to run datetime Y Y Y Y report for MM DD HH MI SS end_date End date to run datetime Y Y Y Y report for MM DD HH MI SS timezone Timezone used to string GMT 7 interpret times TABLE C 12 ACH Settlement Report output parameters Transaction ID string Time date Type string 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 Customer Ref string Batch ID number Gateway Reporting Developer Guide 69 Report Parameters ACH Transaction Report TABLE C 12 ACH Settlement Report output parameters Currency Symbol string Comment string Comment2 string Fund Status string ACH Transaction Report TABLE C 13 ACH Transaction Report input parameters report_date Start date for which datetime YYYY Y N A Y report needs to be MM DD pulled HH MI SS sort_by string N Transaction Transacti ID on Time Transaction Time Transaction Type Amount Result sort_option Sort by ascending or string N Descending No descending Order timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE C 14 ACH Transaction Report output parameters Transaction
15. Report output parameters 64 Host Type number Batch ID number Tender Type string If BatchByCard is given as TRUE in input Settled Date date Total Sales Delayed currency Captures Voice Authorizations Amount Gateway Reporting Developer Guide TABLE C 4 ACH Batch ID Report output parameters Report Parameters ACH Batch ID Report Total Sales Delayed number Captures Voice Authorizations Count Total Credits currency Amount Total Credits number Count Total Amount currency Total Count string Currency Symbol string Begin Time date End Time date Gateway Reporting Developer Guide 65 66 Report Parameters ACH Detail Return Activity Report ACH Detail Return Activity Report TABLE C 5 ACH Detail Return Activity Report input parameters start_date Start date to run datetime Y Y Y Y N A report for MM DD HH MI SS end_date End date to run datetime Y Y Y Y N A Y report for MM DD HH MI SS timezone Timezone used to string GMT 7 interpret times TABLE C 6 ACH Detail Return Activity Report output parameters Transaction ID string Time date Addenda Return date Code Date Type string 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 Customer Ref string
16. Reporting API This chapter describes how you can use the Reporting API to perform the following tasks e Running Reports on page 14 e Managing Report Templates on page 16 e Using Report Templates on page 17 e Performing Searches on page 20 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 user vendor partner password Description 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 Your merchant login ID that you created when you registered for the Payflow Pro account 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
17. S lt data gt lt data gt 2007 09 07 17 48 20 lt data gt lt data gt 2007 09 07 17 52 03 lt data gt Gateway Reporting Developer Guide lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 01 07 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt Gateway Reporting Developer Guide lt columnData gt lt data gt V89A0A00008B lt data gt lt columnData gt lt columnData gt lt data gt 2007 09 07 17 53 07 lt data gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 01 07 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt Reporting Samples Ge
18. The getTemplateRequest can be used to check the new parameters and values lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt 50 Gateway Reporting Developer Guide Reporting Samples Boo Getting a Report Template lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt reportingEngineResponse gt 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 lt xml version 1 0 encoding UTF 8 gt lt report ingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt getTemplateRequest gt lt templateName gt My Template lt templateName gt lt getTemplateRequest gt lt reportingEngineRequest gt Norte To retrieve all of your report templates pass lt getTemplateRequest gt without specifying any child elements 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
19. has completed successfully lt responseMsg gt lt baseResponse gt lt getDataResponse gt lt reportDataRow gt lt columnData gt lt dat a gt V89A0A000087 lt data gt lt columnData gt lt columnData gt lt dat a gt 2007 09 07 17 45 08 lt data gt lt columnData gt lt columnData gt lt dat a gt S lt data gt lt columnData gt lt columnData gt lt dat 38 a gt 0 lt data gt Gateway Reporting Developer Guide lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 01 07 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt Gateway Reporting Developer Guide lt columnData gt lt data gt V89A0A000088 lt data gt lt columnData gt lt columnData gt lt data gt 2007 09 07 17 46 09 lt data gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData g
20. has failed 5 Report has expired 6 Report has expired 22 Gateway Reporting Developer Guide Reporting XML Schema This appendix contains the XML Reporting 1 0 schema lt xml version 1 0 encoding UTF 8 gt lt xs schema elementFormDefault qualified attributeFormDefault unqualified xmlns xs http www w3 org 2001 XMLSchema gt lt xs element name reportingEngineRequest gt lt xs complexType gt lt XS sequence gt lt xs element name authRequest gt lt xs complexType gt lt xs Sequence gt lt xs element name user type xs string gt lt xs element name vendor type xs string gt lt xs element name partner type xs string gt lt xs element name password type xs string gt lt xs element name executor type xs string minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs choice gt lt xs element name createTemplateRequest gt lt xs complexType gt lt XS Sequence gt lt xs element ref templateDefinition gt lt xs Sequence gt lt xs complexType gt lt xs element gt lt xs element name getTemplateRequest gt lt xs complexType gt lt xs choice gt lt xs element ref reportName gt lt xs element ref templateName gt lt xs choice gt lt xs complexType gt lt xs element gt lt xs element name updateTemplateRequest gt lt xs complexType gt lt XS Sequence gt lt xs element ref tem
21. lt columnData gt lt data gt 24 lt data gt lt columnData gt lt columnData gt lt data gt Unknown error lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V89A0A000091 lt data gt lt columnData gt lt columnData gt lt data gt 2007 09 07 18 01 44 lt data gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 12 05 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt Gateway Reporting Developer Guide 45 46 Reporting Samples Getting Data lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V89A0A000092 lt data gt lt columnData gt lt columnData gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt
22. lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt createTemplateRequest gt lt templateDefinition gt lt templateName gt My Template lt templateName gt lt reportName gt DailyActivityReport lt reportName gt lt reportParam gt lt paramName gt namel lt paramName gt lt paramValue gt valuel lt paramValue gt lt reportParam gt lt reportParam gt lt paramName gt name2 lt paramName gt lt paramValue gt value2 lt paramValue gt lt reportParam gt lt templateDefinition gt lt createTemplateRequest gt lt reportingEngineRequest gt Norte To retrieve all of your report templates pass lt getTemplateRequest gt without specifying any child elements 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 lt xml version 1 0 encoding UTF 8 standalone yes gt lt report ingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt Gateway Reporting Developer Guide 49 E Reporting Samples Updating a Report Template lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse
23. name getDataRequest gt lt xs complexType gt lt xs Sequence gt lt xs element ref reportId gt lt xs element ref pageNum minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs choice gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name reportingEngineResponse gt lt xs complexType gt lt XS Sequence gt lt xs element name baseResponse gt lt xs complexType gt Gateway Reporting Developer Guide 25 A Reporting XML Schema lt xS sequence gt lt xs element name responseCode type xs int gt lt xs element name responseMsg type xs string gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs choice minOccurs 0 gt lt xs element name getTemplateResponse gt lt xs complexType gt lt xs choice gt lt xs element ref templateName maxOccurs unbounded gt lt xs element ref templateDefinition gt lt xs choice gt lt xs complexType gt lt xs element gt lt xs element name getScheduleResponse gt lt xs complexType gt lt xs choice gt lt xs element ref scheduleName maxOccurs unbounded gt lt xs element ref scheduleDefinition gt lt xs choice gt lt xs complexType gt lt xs element gt lt xs element name runReportResponse gt lt xs complexType gt lt XS Sequence gt lt xs element ref reportId gt lt xs element ref statusCode gt lt xs ele
24. number Frequency string Status string Account Number string The last 4 digits are returned Expires string Comment string Start Date date Next Payment Date date Last Date date Gateway Reporting Developer Guide 111 112 Search Parameters RecurringBillingProfileNameSearch TABLE D 14 RecurringBillingProfilelDSearch output parameters Date Established date RecurringBillingProfileNameSearch TABLE D 15 RecurringBillingProfileNameSearch input parameters profile_name Profile Name to string search for timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE D 16 RecurringBillingProfileNameSearch output parameters Profile Name string Profile ID string Status string Account Number string The last 4 digits are returned Expires string Amount currency Frequency string Start Date date Date Established date Gateway Reporting Developer Guide Search Parameters Ca RecurringBillingAccountNumberSearch RecurringBillingAccountNumberSearch TABLE D 17 RecurringBillingAccountNumberSearch input parameters account number Account number to string Y search for timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE D 18 RecurringBillingAccountNumberSearch output parameters Profile Name string Profile ID string Status string Account Number stri
25. originally based as well as the parameter names and values defined for this report template lt xml version 1 0 encoding UTF 8 standalone yes gt lt report ingEngineResponse gt lt baseResponse gt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt getTemplateResponse gt lt templateDefinition gt lt templateName gt My Template lt templateName gt lt reportName gt DailyActivityReport lt reportName gt Gateway Reporting Developer Guide 51 B Reporting Samples Deleting a Report Template lt reportParam gt lt paramName gt name3 lt paramName gt lt paramValue gt value3 lt paramValue gt lt reportParam gt lt reportParam gt lt paramName gt name4 lt paramName gt lt paramValue gt value4 lt paramValue gt lt reportParam gt lt templateDefinition gt lt getTemplateResponse gt lt reportingEngineResponse gt 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 lt xml version 1 0 encoding UTF 8 gt lt reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt deleteTemplateRequest gt
26. report_date Date to run report date Y N A Y for YYYY MM DD sort_by Column to sort string N Transaction ID Trans Time N data by Transaction Time Transaction Type Tender Type Amount Result sort_option Sort by ascending string N Ascending Ascending N or descending Descending timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE C 50 Shipping and Billing Report output parameters Order ID string Only if Cybercash merchant 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 99 100 Report Parameters Shipping and Billing Report TABLE 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 Gateway Reporting Developer Guide Report Parameters Transaction Summary Report Transaction Summary Report TABLE C 51 Transaction Sum
27. returned Expires string 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 93 Report Parameters Recurring Billing Report Recurring Billing Report TABLE C 41 Recurring Billing Report input parameters start_date Start datetorun datetime N A report for YYYY MM DD HH MI SS end_date End date to run datetime N A report for YYYY MM DD HH MI SS include_ Incl approvals string true true approvals in report false include_ Include declines string true true declines in report false timezone Timezone to string GMT GMT interpret times GMT XX XX tender_ Run report for string ACH Credit type ACH or Credit Credit TABLE C 42 Recurring Billing Report output parameters 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 94 Gateway Reporting Developer Guide Report Parameters Recurring Profile Failed Report Recurring Profile Failed Report TABLE C 43 Recurring Profile Failed Report input parameters start_date Start date to run report date YYYY Y N A Y for MM DD timezone Timezone used to string N GMT GMT N interpret times GMT XX XX
28. scheduleName The response to deleting a schedule returns a respCode and respMsg Gateway Reporting Developer Guide 19 Ze 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 e TransactionIDSearch e BatchIDSearch e AccountNumberSearch e CommentSearch e AccountNumberRefSearch e PurchaseOrderSearch e RecurringBillingProfileIDSearch e RecurringBillingProfileNameSearch e RecurringBillingAccountNumberSearch e RecurringBillingCommentSearch e 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 param Value 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 report Id for this search as well as the statusCode and statusMsg The report Id 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 15 Step 3 Get the report data Request to get the search data by calling g
29. 2 Get the metadata on page 15 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 15 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 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 e daily e weekly select dayOfWeek value Sunday Monday Tuesday Wednesday Thursday Friday or Saturday e 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
30. 2 string Gateway Reporting Developer Guide Report Parameters Auto Void Report Auto Void Report TABLE C 21 Auto Void Report input parameters start date Start date to run report datetime YYYY Y N A Y for MM DD HH MI SS end_date End date to run report datetime Y Y Y Y Y N A Y for MM DD HH MI SS timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE C 22 Auto Void Report output parameters Order ID string Only if Cybercash merchant Transaction ID string Time date AVS Zip Match string AVS Street Match string Type string Tender Type string Amount currency Result Code number Comment string Comment2 string Gateway Reporting Developer Guide 75 76 Report Parameters Batch ID Report Batch ID Report TABLE C 23 Batch ID Report input parameters start_date Start date to run datetime N A Y report for YYYY MM DD HH MI SS end_date End date to run datetime N A Y report for YYYY MM DD HH MI SS processor Processor to string PayPal N A N report on timezone Timezone used to string GMT GMT N interpret times GMT XX XX group_by_ Should group string true false N tender results by tender false TABLE C 24 Batch ID Report output parameters Batch ID number Only if group_by_tender is set to true Settled Date date Total Sales Delayed Captures Voice cu
31. ID string Time date Type string 70 Gateway Reporting Developer Guide Report Parameters Auto Credit Report 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 Comment string Comment2 string Prenote string Currency Symbol string Auto Credit Report TABLE C 15 Auto Credit Report input parameters start_date Start date to run datetime YYYY Y N A Y report for MM DD HH MI SS end_date End date to run datetime YYYY Y N A Y report for MM DD HH MI SS Gateway Reporting Developer Guide 71 72 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 16 Auto Credit Report output parameters Order ID string Only if Cybercash merchant Transaction ID string Time date AVS Zip Match string AVS Street Match string Type string Tender Type string Amount currency Result Code number Commentl string Comment2 string Auto Delayed Capture Report TABLE C 17 Auto Delayed Capture Report input parameters start_date Start d
32. Number are returned Transaction Trans Trans Tender Account Expires Amount Result Response Commenti Comment2 ID Time Type Type Number Msg Gateway Reporting Developer Guide 37 B Reporting Samples Getting Data Getting Data This sample demonstrates how to retrieve the data in a previously run report Getting Data Request In the request to retriev e data report Id 131 specifies the report for which the data is being requested The report Id 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 lt xml version 1 0 encoding UTF 8 gt lt report ingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt getDataRequest gt lt reportId gt 131 lt reportId gt lt pageNum gt 1 lt pageNum gt lt getDataRequest gt lt reportingEngineRequest gt 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 report ID 131 lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request
33. 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 lt xml version 1 0 encoding UTF 8 gt lt report ingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt runReportRequest gt lt reportName gt DailyActivityReport lt reportName gt lt reportParam gt lt paramName gt report date lt paramName gt lt paramValue gt 2007 09 07 lt paramValue gt lt reportParam gt lt pageSize gt 50 lt pageSize gt lt runReportRequest gt lt reportingEngineRequest gt Gateway Reporting Developer Guide E 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 report Id 132 returned is used to uniquely identify this report in future calls to the Reporting API lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt
34. PayPal Gateway Reporting Developer Guide Gateway Reporting Developer Guide Document Number 200046 en_US 201311 1999 2013 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 here
35. Report TABLE C 25 Custom Report input parameters show_billing_email Return Billing string true true N Email column false in result show_billing_country Return Billing string true true N Country false column in result show_shipping_first_na Return string true true N me Shipping First false Name column in result show_shipping_last na Return string true true N me Shipping Last false Name column in result show_shipping_address Return string true true N Shipping false Address column in result show_shipping_city Return string true true N Shipping City false column in result show_shipping_state Return string true true N Shipping State false column in result show_shipping_zip Return string true true N Shipping Zip false column in result show_shipping_country Return string true true N Shipping false Country column in result show_customer_code Return string true true N Customer Code false column in result Gateway Reporting Developer Guide Report Parameters Custom Report TABLE C 25 Custom Report input parameters show_freight_amount Return Freight string N true true N Amount false column in result show_duty_amount Return Duty string N true true N Amount false column in result TABLE C 26 Custom Report output parameters Order ID string Only if Cybercash merchan
36. See Step 3 Get the report data on page 15 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 report Params Parameter Description templateName Name that you are giving to the report template reportName Standard report from which you are creating the report template Gateway Reporting Developer Guide Using the Reporting API Pas Using Report Templates 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 NOTE 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 paramete
37. Timezone used to string GMT GMT interpret times GMT XX XX TABLE D 32 PayPalNameSearch output parameters PayPal Transaction ID string Unique transaction ID of the payment returned in a DoExpressCheckoutPayment response Transaction ID string Time string Type string Tender Type string Email string Amount currency Response Msg string Comment string Comment2 string Gateway Reporting Developer Guide Index A ACH 62 ACH Activity Summary Report 62 ACH Batch ID Report 64 ACH Detail Return Activity Report 66 ACH Notification of Change Report 67 ACH Return Activity Report 68 ACH Settlement Report 69 ACH Transaction Report 70 Auto Credit Report 71 Auto Delayed Capture Report 72 Auto Resettle Report 74 Auto Void Report 75 Batch ID Report 76 C createScheduleRequest 18 createTemplateRequest 16 creating report templates 49 creating schedules 53 creating templates 49 Custom Report 77 D Daily Activity Report 31 85 deleteScheduleRequest 19 deleteTemplateRequest 17 deleting report templates 52 deleting templates 52 55 56 F Filter Scorecard Report 87 Fraud Protection Report 88 Gateway Reporting Developer Guide G getDataRequest 15 19 getMetaDataRequest 15 16 getResultsRequest 16 getScheduleRequest 18 getting data 38 getting metadata 35 getting report templates 51 getting results by report ID 34 getting schedules 54 managin
38. _date End date to search datetime Y end_date End date to datetime for YYYY MM search for YYYY MM DD DD HH MI SS HH MI SS timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE D 8 CommentSearch output parameters Order ID string Only if CyberCash merchant Transaction ID string Time string Type string Tender Type string Gateway Reporting Developer Guide 107 es Search Parameters CommentSearch TABLE D 8 CommentSearch output parameters Account Number string The last 4 digits are returned Expires string Amount currency Response Msg string Comment string Comment2 string 108 Gateway Reporting Developer Guide Search Parameters Ca AccountNumberRefSearch AccountNumberRefSearch TABLE D 9 AccountNumberRefSearch input parameters transaction_id Transaction ID to string Y search for start_date Start date to search datetime Y for YYYY MM DD HH MI SS end_date End date to search datetime Y for YYYY MM DD HH MI SS timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE D 10 AccountNumberRefSearch output parameters Order ID string Only if CyberCash merchant Transaction ID string Time string Type string Tender Type string Account Number string The last 4 digits are returned Expires string Amount currency Response Msg string C
39. ate to run report for datetime YY Y Y MM DD HH MI SS N A Y end_date End date to run report for datetime YY YY MM DD HH MI SS N A Y Gateway Reporting Developer Guide Report Parameters Auto Delayed Capture Report TABLE C 17 Auto Delayed Capture Report input parameters timezone Timezone used to interpret times string N GMT GMT N GMT XX XX TABLE C 18 Auto Delayed Capture Report output parameters Order ID string Only if CyberCash merchant Transaction ID string Time date AVS Zip Match string AVS Street Match string Type string Tender Type string Amount currency Result Code number Commentl string Comment2 string Gateway Reporting Developer Guide 73 74 Report Parameters Auto Resettle Report Auto Resettle Report TABLE C 19 Auto Resettle Report input parameters start_date Start date to run datetime N A Y report for YYYY MM DD HH MI SS end_date End date to run report datetime N A Y for YYYY MM DD HH MI SS timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE C 20 Auto Resettle Report output parameters Order ID string Only if Cybercash merchant Transaction ID string Time date AVS Zip Match string AVS Street Match string Type string Tender Type string Amount currency Result Code number Comment string Comment
40. ber Trigger Percentage number Gateway Reporting Developer Guide 87 Report Parameters Fraud Protection Report Fraud Protection Report TABLE C 31 Fraud Protection Report input parameters start_date Start datetorunreport datetime Y N A Y for YYYY MM DD HH MI SS end_date End date torun report datetime Y N A Y for YYYY MM DD HH MI SS transaction_ Transaction types to string Y Review N A N type report on Reject Accept Screened By Filters Not Screened By Filters timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE C 32 Fraud Protection Report output parameters Transaction ID string Time date Type string Tender Type string Amount currency Deployment Mode string Fraud Transaction string 88 Gateway Reporting Developer Guide Report Parameters Payflow Link Orders Report Payflow Link Orders Report TABLE C 33 PayflowLink Orders Report input parameters start_date Start date to run report datetime Y N A Y for YYYY MM DD HH MI SS end_date End date to run report datetime Y N A Y for YYYY MM DD HH MI SS timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE C 34 PayflowLink Orders Report output parameters Time date Transaction ID string Billing Name string Billing Address string Billing City string Billing State string
41. d successfully lt xml version 1 0 encoding UTF 8 standalone yes gt lt report ingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt report ingEngineResponse gt Gateway Reporting Developer Guide 55 E Reporting Samples Deleting a Schedule Deleting a Schedule This sample demonstrates how to delete a schedule Deleting a Schedule Request lt reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt deleteScheduleRequest gt lt scheduleName gt My Schedule lt scheduleName gt lt deleteScheduleRequest gt lt reportingEngineRequest gt Deleting a Schedule Response In the response to deleting a schedule the response code of 100 indicates that the request completed successfully lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt report ingEngineResponse gt 56 Gateway Reporting Developer Guide Reporting Samples Running a Transaction ID Search Running a Transaction ID Search This sample demonst
42. e Transaction Type Tender Type Amount Result sort_option Sort by ascending or string Descending No descending order Order timezone Timezone used to string GMT GMT 7 interpret times GMT XX include_pen string true false TRUE ding_settlem ent include_settl string true false TRUE ed include_faile string true false TRUE d TABLE C 2 ACH Activity Summary Report output parameters Transaction ID string Time date Type string Gateway Reporting Developer Guide Report Parameters ACH Activity Summary Report TABLE C 2 ACH Activity Summary 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 Customer Ref string Currency Symbol string Gateway Reporting Developer Guide 63 Report Parameters ACH Batch ID Report ACH Batch ID Report TABLE C 3 ACH Batch ID Report input parameters start_date Start date to run datetime YYYY Y Y report for MM DD HH MI SS end_date End date to run datetime YYYY Y report for MM DD HH MI SS timezone Timezone used to string N GMT 7 interpret times host_type number Y 68 batch_id number N BatchByCar string N true false FALSE d batch_type string N Consumer Merchan Batch t Batch Merchant Batch TABLE C 4 ACH Batch ID
43. e Timezone used string GMT GMT N to interpret GMT times XX XX show_order_id Return Order string true true N ID column in false result show_transaction_id Return string true true N Transaction ID false column in result show_time Return Time string true true N column in false result show_type Return Type string true true N column in false result show_tender_type Return Tender string true true N Type column in false result show_account_number Return Account string true true N Number false column in result Gateway Reporting Developer Guide 79 80 Report Parameters Custom Report TABLE C 25 Custom Report input parameters show_expires Return Expires string true true N column in false result show_aba_routing_num Return ABA string true true N ber Routing false Number column in result show_amount Return Amount string true true N column in false result show_result_code Return Result string true true N Code column in false result show_response_msg Return string true true N Response Msg false column in result show_commentl Return string true true N Comment false column in result show_comment2 Return string true true N Comment2 false column in result show_tax_amount Return Tax string true true N Amount false column in result show_purchase_order Return string true true N Purchase Order false column in result show_original_transactio R
44. e all schedules in Getting a Schedule Request Added the sample report Retrieving a List of All Scheduled Reports that were Run May 2012 Updated reportld description reportld 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 Gateway Reporting Developer Guide Preface Revision History TABLE P 1 Revision History Date Description March 2006 Integrated Express Checkout feature Gateway Reporting Developer Guide 9 Preface Revision History 10 Gateway Reporting Developer Guide 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 Every
45. eport Template Request Getting a Report Template Response Deleting a Report Template Deleting a Report Template Request Deleting a Report Template Response CreatingaSchedule 0 4 Creating a Schedule Request Gateway Reporting Developer Guide Contents Ei Creating a Schedule Response 2 2 22 mn 2 e 53 Getting a Schedule 54 Getting a Schedule Request LL 54 Getting a Schedule Response 2 22 2 Hmm nn nn 54 Updating a Schedule 2 2 2 2 Can nn 55 Updating a Schedule Request eo 55 Updating a Schedule Response LL 55 Deleting a Schedule nn 56 Deleting a Schedule Request 56 Deleting a Schedule Response LL 56 Running a Transaction ID Search oaoa a 57 Running a Transaction ID Search Request LL 57 Running a Transaction ID Search Response 57 Running a Profile Next Payment Date Report 58 Running a Profile Next Payment Request 2 2 nun nn 58 Running a Profile Next Payment Response LL 58 Running a Profile Profile Modified Date Report 0 o 59 Running a Profile Profile Modified Date Request 4 59 Running a Profile Profile Modified Date Response 59 Retrieving a List of All Scheduled Reports that were RUN 60 Retrieving a List of All Scheduled Reports Request
46. eportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt getMetaDataRequest gt lt reportId gt 131 lt reportId gt lt getMetaDataRequest gt lt reportingEngineRequest gt Gateway Reporting Developer Guide 35 36 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 report ID 131 For each table column the response returns the column heading lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt getMetaDataResponse gt lt numberOfRows gt 13 lt numberOfRows gt lt numberOf Pages gt 1 lt numberOf Pages gt lt pageSize gt 50 lt pageSize gt lt numberOfColumns gt 11 lt numberOfColumns gt lt columnMetaData gt lt dataName gt Transaction ID lt dataName gt lt dataType gt string lt dataType gt lt columnMetaData gt lt columnMetaData gt lt dataName gt Trans Time lt dataName gt lt dataType gt date lt dataType gt
47. eportld gt lt statusCode gt 3 lt statusCode gt lt statusMsg gt Report has completed successfully lt statusMsg gt lt runReportResponse gt lt reportingEngineResponse gt Gateway Reporting Developer Guide Report Parameters Reports in This Appendix This appendix describes the input and output parameters for the following reports e ACH Activity Summary Report e ACH Batch ID Report e ACH Detail Return Activity Report e ACH Notification of Change Report e ACH Return Activity Report e ACH Settlement Report e ACH Transaction Report e Auto Credit Report e Auto Delayed Capture Report e Auto Resettle Report e Auto Void Report e Batch ID Report e Custom Report e Daily Activity Report e Filter Scorecard Report e Fraud Protection Report e PayflowLink Orders Report e PayPal Settlement Summary Report e Profile Next Payment Report e Profile Modified Date Report e Recurring Billing Report e Recurring Profile Failed Report e Recurring Profile Report e Settlement Report e Shipping and Billing Report e Transaction Summary Report Gateway Reporting Developer Guide 62 Report Parameters ACH Activity Summary Report ACH Activity Summary Report TABLE C 1 ACH Activity Summary Report input parameters report_date Date for which datetime Y Y Y Y N A report needs to be MM DD pulled HH MI SS sort_by Column to sort data string Transaction Transacti by ID on Time Transaction Tim
48. er Guide 117 118 Search Parameters OrderlDSearch OrderlDSearch TABLE D 25 OrderlDSearch input parameters order_id timezone Order ID to search for Timezone used to interpret times string string GMT GMT XX XX GMT N TABLE D 26 OrderlDSearch output parameters Order ID string Transaction ID string Merchant string Time string Type string Duration number Tender Type string Client IP Address string Account Number string The last 4 digits are returned Client Version string Expires string Street string Amount currency Zip string Email string Name On Card string Commentl string Gateway Reporting Developer Guide TABLE D 26 OrderlDSearch output parameters Search Parameters OrderlDSearch Comment string Result Code number Response Msg string Authcode string Original Transaction ID string AVS Street Match string Original Amount currency AVS Zip Match string Batch ID number AVS Result Code string Gateway Reporting Developer Guide 119 120 Search Parameters PayPalTransactionIDSearch PayPalTransactionIDSearch TABLE D 27 PayPalTransactionIDSearch input parameters paypal_transaction _id timezone PayPal transaction ID to search for Timezone used to interpret times string string GMT GMT N GMT XX XX TABLE D 28 PayPa
49. etDataRequest See Step 3 Get the report data on page 15 20 Gateway Reporting Developer Guide Response Codes and Status Codes This chapter provides the following details on reports It identifies e Response codes and response messages e 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 21 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 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
50. eters FraudTransactionSearch FraudTransactionSearch TABLE D 23 FraudTransactionSearch input parameters fraud_transaction_id transaction ID to string search for timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE D 24 FraudTransactionSearch output parameters Transaction ID string Time string Return Code Message string Customer Name string Email Address string Phone Number string Amount currency Total Items number SKU string Account Number string The last 4 digits are returned AVS Street Match string AVS Zip Match string CSC Match string International AVS Indicator string Buyer Authentication string Billing Name string Billing Street string Gateway Reporting Developer Guide Search Parameters Ca FraudTransactionSearch TABLE D 24 FraudTransactionSearch output parameters Billing Street2 string Billing City string Billing State string Billing Zip string Billing Country string Shipping Name string Shipping Street string Shipping Street2 string Shipping City string Shipping State string Shipping Zip string Shipping Country string Client IP Address string Num Custom Rules number Custom Rules string Num Triggered Rules number Triggered Rules string Num Unprocessed Rules number Unprocessed Rules string Gateway Reporting Develop
51. eturn Original string true true N n_id Transaction ID false column in result show_avs_street_match Return AVS string true true N Street Match false column in result Gateway Reporting Developer Guide TABLE C 25 Custom Report input parameters Report Parameters Custom Report show_avs_zip_match Return AVS Zip string true true N Match column false in result show_invoice_number Return Invoice string true true N Number false column in result show_authcode Return string true true N Authcode false column in result show_batch_id Return Batch string true true N ID column in false result show_csc_match Return CSC string true true N Match column false in result show_billing_first_name Return Billing string true true N First Name false column in result show_billing_last_name Return Billing string true true N Last Name false column in result show_billing_company_ Return Billing string true true N name Company false Name column in result show_billing_address Return Billing string true true N Address false column in result show_billing_city Return Billing string true true N City column in false result show_billing_state Return Billing string true true N State column in false result show_billing_zip Return Billing string true true N Zip column in false result Gateway Reporting Developer Guide 81 82 Report Parameters Custom
52. eturned Expires string Amount currency Response Msg string Comment string Comment2 string Gateway Reporting Developer Guide 105 106 Search Parameters AccountNumberSearch AccountNumberSearch TABLE D 5 AccountNumberSearch input parameters account_number Account Number to string search for start_date Start date to search datetime for YYYY MM DD HH MI SS end_date End date to search datetime for YYYY MM DD HH MI SS timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE D 6 AccountNumberSearch output parameters Order ID string Only if CyberCash merchant Transaction ID string Time string Type string Tender Type string Account Number string The last 4 digits are returned Expires string Amount currency Response Msg string Comment string Comment2 string Gateway Reporting Developer Guide Search Parameters CommentSearch CommentSearch TABLE D 7 CommentSearch input parameters commentl Comment to string Y One or commentl Commentl string search for both of to search commentl for and comment are required comment Comment to string Y One or comment2 Comment string search for both of to search commentl for and comment are required start_date Start date to datetime Y start_date Start date datetime search for YYYY MM to search YYYY MM DD for DD HH MI SS HH MI SS end
53. finition gt lt createScheduleRequest gt lt reportingEngineRequest gt Creating a Schedule Response In the response to creating a schedule the response code of 100 indicates that the request completed successfully lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt report ingEngineResponse gt Gateway Reporting Developer Guide 53 B Reporting Samples Getting a Schedule Getting a Schedule Getting a Schedule Request xml version 1 0 encoding UTF 8 gt lt reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt getScheduleRequest gt lt scheduleName gt My Schedule lt scheduleName gt lt getScheduleRequest gt lt reportingEngineRequest gt NoTe To retrieve all of your scheduled reports pass lt getScheduleRequest gt without specifying any child elements 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 lt xml version 1 0 encodin
54. g UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt getScheduleResponse gt lt scheduleDefinition gt lt scheduleName gt My Schedule lt scheduleName gt lt templateName gt My Template lt templateName gt lt notificationRequired gt false lt notificationRequired gt lt daily gt lt daily gt lt scheduleDefinition gt lt getScheduleResponse gt lt reportingEngineResponse gt 54 Gateway Reporting Developer Guide Reporting Samples Updating a Schedule Updating a Schedule This sample demonstrates how to update a schedule Updating a Schedule Request lt xml version 1 0 encoding UTF 8 gt lt reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt updateScheduleRequest gt lt scheduleDefinition gt lt scheduleName gt My Schedule lt scheduleName gt lt templateName gt My Template lt templateName gt lt notificationRequired gt false lt notificationRequired gt lt daily gt lt scheduleDefinition gt lt updateScheduleRequest gt Updating a Schedule Response In the response to updating a schedule the response code of 100 indicates that the request complete
55. g report templates 16 O on demand 11 P Partner Manager overview 8 Payflow Link Orders Report 89 Payflow Pro 11 PayPal Settlement Summary Report 91 performing searches 20 Profile Modified Date Report 93 Profile Next Payment Report 92 R Recurring Billing Report 94 Recurring Profile Failed Report 95 Recurring Profile Report 96 response codes 21 retrieve report results by reportId 34 retrieving metadata 35 retrieving report data 38 retrieving templates 51 running an ad hoc report 33 running reports 15 123 124 running reports offline 16 running transaction ID search 57 runReportRequest 15 17 runSearchRequest 20 S Settlement Report 97 Shipping and Billing Report 99 status codes 22 Transaction Summary Report 33 101 U updateScheduleRequest 19 updateTemplateRequest 17 updating report templates 50 updating schedules 55 updating templates 50 using report templates 17 Gateway Reporting Developer Guide
56. gt lt reportingEngineResponse gt 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 lt xml version 1 0 encoding UTF 8 gt lt report ingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt updateTemplateRequest gt lt templateDefinition gt lt templateName gt My Template lt templateName gt lt reportName gt DailyActivityReport lt reportName gt lt reportParam gt lt paramName gt name3 lt paramName gt lt paramValue gt value3 lt paramValue gt lt reportParam gt lt reportParam gt lt paramName gt name4 lt paramName gt lt paramValue gt value4 lt paramValue gt lt reportParam gt lt templateDefinition gt lt updateTemplateRequest gt lt reportingEngineRequest gt Updating a Report Template Response In the response to updating a report template the response code of 100 indicates that the request completed successfully
57. gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 01 07 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt Gateway Reporting Developer Guide lt columnData gt lt data gt V89A0A00008E lt data gt lt columnData gt lt columnData gt lt data gt 2007 09 07 17 56 02 lt data gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 01 07 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt lt columnData gt Reporting Samples Getting Data 43 B Reporting Samples Getting Data lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt
58. gt 1 lt pageNum gt lt getDataResponse gt lt reportingEngineResponse gt Gateway Reporting Developer Guide Reporting Samples Getting Data 47 48 Reporting Samples Getting Data Data Returned The data is returned in the following tabular format of 13 rows and 11 columns V89A0A000087 V89A0A000088 V89A0A000089 V89A0A00008A V89A0A00008B V89A0A00008C V89A0A00008D V89A0A00008E V89A0A00008F V89A0A000090 V89A0A000091 V89A0A000092 V89A0A000093 Erra Ts Ts on ow ree e rons rm 5 o on Tan ree To Jue overran 5 o on 99 ree To Jue ren rss 5 om ove row fo net _ rr an o om over row o Je rn 3 o om over ree 9 ret _ erre 5 o 009 ree 9 ret _ E ofen Tome ren I on fo fr over Row fo Pe E A EZ E A ren fo rom aerar fo ofen Tome rom I I rano ansa 5 gt KEG ED eo rom Gateway Reporting Developer Guide Reporting Samples Boo Creating a Report Template 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 namel and name2 The parameter names and values are stored in the database lt xml version 1 0 encoding UTF 8 gt lt report ingEngineRequest gt lt authRequest gt
59. he database e Retrieve report templates from the database e Update report templates e Delete report templates Gateway Reporting Developer Guide 11 BE 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 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 e Report status e 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 12 Gateway Reporting Developer Guide Using the
60. in PayPal Inc reserves the right to make changes to any information herein without further notice Contents Preface ij Lal sl ww oe na a De eT AUDIENCE ee fee oe OK a a ee ee a a A 7 Organization cee Sop Pee ad hh eRe ee eae Hee be A 7 Where to Go for More Information LL 8 How to Contact Customer Service 8 Revision HIStoryi zu ie EER ee ee ee le a A e O ae a 8 Chapter 1 Reporting Overview 2 ee ee TT Operations You Can Perform Using the Reporting API 11 Managing Report Templates 2 2 2 En nn nn 11 Running Reports by Report Template Name or Report Name 12 Obtaining Information about Reports 002002 eee eee 12 Managing Report Template Schedules 12 Performing Searches 12 URL for Running Applications 2 22 Cu nn nn 12 Live Transactions LL 12 Test Transactions 4 irradia RAE 12 Chapter 2 Using the Reporting API 18 API Notation in this Chapter 2 2 2 2m nn nn nn 13 Request Authorization Parameter Data 13 Response Data ye e rra smp ee EN asa RD a a a a 14 Where to Go For More Information on the APIS 0 e 14 Running Reports 14 Running a Report and Obtaining Report Data 0 15 Running Reports Offline 16 Managing Report Templates 0 0 16 Using Report Templates 2 22 LE nn nn nn 17 Running a report tem
61. lTransactionIDSearch output parameters Unique transaction ID of the payment returned in a PayPal Transaction ID string DoExpressCheckoutPayment response Transaction ID string Time string Type string Tender Type string Email string Amount currency Response Msg string Comment string Comment2 string Gateway Reporting Developer Guide Search Parameters CIS PayPalEmailSearch PayPalEmailSearch TABLE D 29 PayPalEmailSearch input parameters email Email address to string Y search for start_date Start date to search datetime Y for YYYY MM DD HH MI SS end_date End date to search datetime Y for YYYY MM DD HH MI SS timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE D 30 PayPalEmailSearch output parameters PayPal Transaction ID string Transaction ID string Time string Type string Tender Type string Email string Amount currency Response Msg string Comment string Comment2 string Gateway Reporting Developer Guide 121 122 Search Parameters PayPalNameSearch PayPalNameSearch TABLE D 31 PayPalNameSearch input parameters last_name Last name to search string for first_name First name to search string for start_date Start date to search datetime for YYYY MM DD HH MI SS end_date End date to search datetime for YYYY MM DD HH MI SS timezone
62. lt columnData gt lt columnData gt lt columnData gt lt columnData gt lt data gt 12 05 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V89A0A000093 lt data gt lt data gt 2007 09 07 18 02 19 lt data gt lt data gt 4111XXXXXXXX1111 lt data gt Gateway Reporting Developer Guide lt columnData gt lt columnData gt lt data gt 2007 09 07 18 03 09 lt data gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 12 05 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt pageNum
63. lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt runReportResponse gt lt reportId gt 132 lt reportId gt lt statusCode gt 3 lt statusCode gt lt statusMsg gt Report has completed successfully lt statusMsg gt lt runReportResponse gt lt reportingEngineResponse gt 32 Gateway Reporting Developer Guide Reporting Samples 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 lt xml version 1 0 encoding UTF 8 gt lt reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt runReportRequest gt lt reportName gt TransactionSummaryReport lt reportName gt lt reportParam gt lt paramName gt start date lt paramName gt lt paramValue gt 2007 09 07 00 00 00 lt paramValue gt lt reportParam gt lt reportParam gt lt paramName gt end date lt paramName gt lt paramValue gt 2007 09 07 23 59 59 lt paramValue gt lt reportParam gt
64. mary Report input parameters start_date Start datetorun report datetime Y N A Y for YYYY MM DD HH MI SS end_date End date to run report datetime Y N A Y for YYYY MM DD HH MI SS settlement_ Settled or non settled string N Settled All N status transactions Unsettled All timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE C 52 Transaction Summary Report output parameters Transaction Type string Processor string Trans Count number Result Code number Tender Type string Min Amount currency Max Amount currency Average currency Total Amount currency Gateway Reporting Developer Guide 101 Report Parameters Transaction Summary Report 102 Gateway Reporting Developer Guide Search Parameters Transaction ID Search TABLE D 1 Transaction ID Search input parameters transaction_id Transaction ID to string Y search for timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE D 2 Transaction ID Search output parameters Order ID string Transaction ID string Merchant string User Name string Time string Type string Duration number Tender Type string Client IP Address string Account Number string The last 4 digits are returned Client Version string Expires string Amount currency Gateway Reporting Developer Guide 104 Search Parame
65. ment ref statusMsg gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name runSearchResponse gt lt xs complexType gt lt XS Sequence gt lt xs element ref reportId gt lt xs element ref statusCode gt lt xs element ref statusMsg gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name getResultsResponse gt lt xs complexType gt lt XS Sequence gt lt xs element name Results minOccurs 0 maxOccurs unbounded gt lt xs complexType gt lt XS Sequence gt lt xs element ref reportId gt lt xs element ref statusCode gt lt xs element ref statusMsg gt 26 Gateway Reporting Developer Guide Reporting XML Schema A lt xs element name executionTime type xs dateTime minOccurs 0 gt lt xs element ref scheduleName minOccurs 0 gt lt xs element ref reportName minOccurs 0 gt lt xs element ref templateName minOccurs 0 gt lt xs element ref searchName minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name getMetaDataResponse gt lt xs complexType gt lt XS Sequence gt lt xs element name numberOfRows type xs int gt lt xs element name numberOfPages type xs int gt lt xs element ref pageSize gt lt xs element name numberOfColumns type xs int gt
66. ng The last 4 digits are returned Expires string Amount currency Frequency string Start Date date Date Established date Gateway Reporting Developer Guide 113 es Search Parameters RecurringBillingCommentSearch RecurringBillingCommentSearch TABLE D 19 RecurringBillingCommentSearch input parameters comment timezone Comment to search for Timezone used to interpret times string string GMT GMT XX XX GMT N TABLE D 20 RecurringBillingCommentSearch output parameters Profile Name string Profile ID string Status string Account Number string The last 4 digits are returned Expires string Amount currency Frequency string Start Date date Date Established date 114 Gateway Reporting Developer Guide Search Parameters CIS RecurringBillingAmountSearch RecurringBillingAmountSearch TABLE D 21 RecurringBillingAmountSearch input parameters amount Amount to search string for timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE D 22 RecurringBillingAmountSearch output parameters Profile Name string Profile ID string Status string Account Number string The last 4 digits are returned Expires string Amount currency Frequency string Start Date date Date Established date Gateway Reporting Developer Guide 115 116 Search Param
67. ng Y Name of the N A N on processor for which the settlement report is requested settlement_ Settledornon settled string N Settled AII N status transactions Unsettled AII transaction_ Transaction types to string N Sales AII N type report on Credits AII timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE C 48 Settlement Report output parameters Order ID string Only if Cybercash merchant Transaction ID string Time date Type string Gateway Reporting Developer Guide 97 98 Report Parameters Settlement Report TABLE C 48 Settlement Report output parameters Tender Type string Account Number string The last 4 digits are returned Expires string Amount currency Result Code number Response Msg string Comment string Comment2 string Batch ID number Currency Symbol string Alphabetic currency symbol for example USD PayPal string Returned only if merchant has a PayPal Transaction ID Internet Merchant Account PayPal Fees currency Returned only if merchant has a PayPal Internet Merchant Account PayPal Email ID string Buyer s PayPal email address returned only if merchant has a PayPal Internet Merchant Account Gateway Reporting Developer Guide Report Parameters Shipping and Billing Report Shipping and Billing Report TABLE C 49 Shipping and Billing Report input parameters
68. o 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 e daily e weekly select dayOfWeek value Sunday Monday Tuesday Wednesday Thursday Friday or Saturday e 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 yetScheduleRequest with scheduleName as a parameter get ScheduleRequest schedulename Gateway Reporting Developer Guide Using the Reporting API Using Report Templates getScheduleResponse returns all the report Ids and execution dates of the reports that were run on the schedule Step 3 Get the metadata For each report call yetMetaDataRequest passing in the reportId as a parameter to get the information on how that report is formatted See Step
69. omment string Comment2 string Gateway Reporting Developer Guide 109 110 Search Parameters PurchaseOrderSearch PurchaseOrderSearch TABLE D 11 PurchaseOrderSearch input parameters purchase_order_num Purchase Order string Number to search for start_date Start date to datetime search for YYYY MM DD HH MI SS end_date End date to search datetime for YYYY MM DD HH MI SS timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE D 12 PurchaseOrderSearch output parameters Order ID string Only if CyberCash merchant Transaction ID string Time string Type string Tender Type string Account Number string The last 4 digits are returned Expires string Amount currency Response Msg string Comment string Comment2 string Gateway Reporting Developer Guide Search Parameters CIS RecurringBillingProfilelDSearch RecurringBillingProfilelDSearch TABLE D 13 RecurringBillingProfilelDSearch input parameters profile_id Profile ID to search string Y for timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE D 14 RecurringBillingProfilelDSearch output parameters Profile ID string Profile Name string Name string Address string Phone Number string EMail string Recurring Amount currency Original Start Date date Term
70. on Sort by ascending string Ascending Ascending or descending Descending timezone Timezone used to string GMT GMT interpret times GMT XX XX Gateway Reporting Developer Guide 85 Report Parameters Daily Activity Report Currency values are returned in the three character currency code specified The values are e USD US dollar default value e EUR Euro e GBP UK pound e CAD Canadian dollar e JPY Japanese Yen e AUD Australian dollar TABLE C 28 Daily Activity Report output parameters Order ID string Only if Cybercash merchant Transaction ID string Time date Type string Tender Type string Account Number string The last 4 digits are returned Expires string Amount currency Result number Response Msg string Comment string Comment2 string Client IP string Authcode string AVS Street Match string AVS Zip Match string 86 Gateway Reporting Developer Guide Report Parameters Filter Scorecard Report Filter Scorecard Report TABLE C 29 Filter Scorecard Report input parameters start_date Start date to run datetime Y N A Y report for YYYY MM DD HH MI SS end_date End date to run report datetime Y N A Y for YYYY MM DD HH MI SS timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE C 30 Filter Scorecard Report output parameters Filter string Times Triggered num
71. plate and obtaining the report template data 17 Scheduling a Report Template 2 2 22H nn nn 18 Managing Report Template Schedules 19 Performing Searches 2 aa 20 Gateway Reporting Developer Guide De Contents Chapter 3 Response Codes and Status Codes Response Codes Status Codes LL Appendix A_ Reporting XML Schema Appendix B Reporting Samples Running a Daily Activity Report Running a Daily Activity Report Request Running a Daily Activity Report Response Running a Transaction Summary Report Running a Transaction Summary Report Request Running a Transaction Summary Report Response Getting Results by ReportID Getting Results by Report ID Request Getting Results by Report ID Response Getting Metadata Getting Metadata Request Getting Metadata Response Format Returned Getting Data LL Getting DataRequest Getting DataResponse Data Returned Creating a Report Template Creating a Report Template Request Creating a Report Template Response Updating a Report Template Updating a Report Template Request Updating a Report Template Response Getting a Report Template Getting a R
72. plateDefinition gt lt xs Sequence gt lt xs complexType gt lt xs element gt lt xs element name deleteTemplateRequest gt lt xs complexType gt lt xs Sequence gt Gateway Reporting Developer Guide 23 24 Reporting XML Schema lt xs element ref templateName gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name createScheduleRequest gt lt xs complexType gt lt xs Sequence gt lt xs element ref scheduleDefinition gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name getScheduleRequest gt lt xs complexType gt lt xs choice gt lt xs element ref scheduleName gt lt xs element ref templateName gt lt xs choice gt lt xs complexType gt lt xs element gt lt xs element name updateScheduleRequest gt lt xs complexType gt lt XS Sequence gt lt xs element ref scheduleDefinition gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name deleteScheduleRequest gt lt xs complexType gt lt xs Sequence gt lt xs element ref scheduleName gt lt xs Sequence gt lt xs complexType gt lt xs element gt lt xs element name runReportRequest gt lt xs complexType gt lt xs Sequence gt lt xs choice gt lt xs element ref reportName gt lt xs element ref templateName gt lt xs choice gt lt xs element ref reportPa
73. r 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 17 18 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 Get the metadata Request to get the report s metadata by calling getMetaDataRequest See Step 2 Get the metadata on page 15 Step 3 Get the report data Request to get the report data by calling getDataRequest See Step 3 Get the report data on page 15 Scheduling a Report Template You can schedule a report template t
74. ram minOccurs 0 maxOccurs unbounded gt lt xs element ref notificationRequired minOccurs 0 gt lt xs element ref pageSize minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name runSearchRequest gt lt xs complexType gt lt xs Sequence gt lt xs element ref searchName gt Gateway Reporting Developer Guide Reporting XML Schema lt xs element ref reportParam minOccurs 0 maxOccurs unbounded gt lt xs element ref pageSize minOccurs 0 gt lt xs Sequence gt lt xs complexType gt lt xs element gt lt xs element name getResultsRequest gt lt xs complexType gt lt xs Sequence gt lt xs choice minOccurs 0 gt lt xs element ref scheduleName gt lt xs element ref templateName gt lt xs element ref reportName gt lt xs element ref searchName gt lt xs element ref reportId gt lt xs choice gt lt xs choice minOccurs 0 gt lt xs complexType gt lt xs Sequence gt lt xs element name startDate type xs date gt lt xs element name endDate type xs date gt lt xs Sequence gt lt xs complexType gt lt xs choice gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name getMetaDataRequest gt lt xs complexType gt lt XS Sequence gt lt xs element ref reportId gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element
75. rates how to run a search by transaction ID Running a Transaction ID Search Request lt xml version 1 0 encoding UTF 8 gt lt reportingEngineRequest gt lt authRequest gt lt user gt appstest lt user gt lt vendor gt appstest lt vendor gt lt partner gt PayPal lt partner gt lt password gt password5 lt password gt lt authRequest gt lt runSearchRequest gt lt searchName gt Transact ionIDSearch lt searchName gt lt reportParam gt lt paramName gt transaction id lt paramName gt lt paramValue gt V89A0A000264 lt paramValue gt lt reportParam gt lt pageSize gt 50 lt pageSize gt lt runSearchRequest gt lt reportingEngineRequest gt 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 report Id 132 returned is used to uniquely identify this report in future calls to the Reporting API lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt runSearchResponse gt lt reportId gt 132 lt reportId gt lt statusCode gt 3 lt statusCode gt lt statusMsg gt Report has completed successfully lt statusMsg gt lt runSearchResponse gt lt reportingEngineResponse gt Gateway Reporting
76. report data 14 Gateway Reporting Developer Guide Using the Reporting API Posi Running Reports 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 report Id The report Id is used to refer to the particular report in future requests The report Id returned is valid for up to 120 days Step 2 Get the metadata To get information on how the report is formatted call getMetaDataRequest providing the Report Id 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 getDa
77. reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V89A0A00008F lt data gt lt columnData gt lt columnData gt lt data gt 2007 09 07 17 56 33 lt data gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 01 07 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt 44 lt columnData gt lt data gt V89A0A000090 lt data gt lt columnData gt Gateway Reporting Developer Guide Reporting Samples Getting Data lt columnData gt lt data gt 2007 09 07 18 01 31 lt data gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 01 05 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt
78. rrency Authorizations Amount Total Sales Delayed Captures Voice number 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 set to true Gateway Reporting Developer Guide Report Parameters Custom Report Custom Report TABLE C 25 Custom Report input parameters Auto computed Allowed Default by Name Description Type Required values value scheduler start_date Start date torun datetime Y N A Y report for YYYY MM DD HH MI SS end_date End date torun datetime Y N A Y report for YYYY MM DD HH MI SS minimum amount Minimum number N 0 N amount to report on maximum_amount Maximum number N 10000 N amount to report on results Results to string N All All N report on Approvals Only Declines Only Approvals and Declines lt Comma Separated List gt include _amex Include string N true true N American false Express cards in report PayPal only include_diners Include Diners string N true true N cards in report false PayPal only Gateway Reporting Developer Guide 77 78 Report Parameters Custom Report TABLE C 25 Custom Report input parameters include_discover Include string true true N Discover cards false in report PayPal only include_enroute Include Enroute string true
79. s simpleType gt lt xs restriction base xs string gt lt xs enumeration value Sunday gt lt xs enumeration value Monday gt lt xs enumeration value Tuesday gt lt xs enumeration value Wednesday gt lt xs enumeration value Thursday gt lt xs enumeration value Friday gt lt xs enumeration value Saturday gt lt xs restriction gt lt xs simpleType gt lt xs element gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name monthly gt lt xs complexType gt lt XS Sequence gt lt xs element name dayOfMonth type xs int gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs choice gt lt xs element ref pageSize minOccurs 0 gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name scheduleName type xs string gt lt xs element name pageNum type xs int gt lt xs element name searchName type xs string gt lt xs element name pageSize type xs int gt lt xs element name statusCode type xs int gt lt xs element name statusMsg type xs string gt lt xs schema gt Gateway Reporting Developer Guide 29 A Reporting XML Schema 30 Gateway Reporting Developer Guide 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
80. sg gt lt runReportResponse gt lt reportingEngineResponse gt 58 Gateway Reporting Developer Guide Reporting Samples Boo 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 lt xml version 1 0 encoding UTF 8 gt lt reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt runReportRequest gt lt reportName gt RBProfilePMDReport lt reportName gt lt reportParam gt lt paramName gt start_date lt paramName gt lt param Value gt 2010 06 22 00 00 00 lt param Value gt lt reportParam gt lt reportParam gt lt paramName gt end_date lt paramName gt lt param Value gt 2010 08 30 00 00 00 lt param Value gt lt reportParam gt lt pageSize gt 50 lt pageSize gt lt runReportRequest gt lt reportingEngineRequest gt Running a Profile Profile Modified Date Response lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt runReportResponse gt lt reportld gt 132 lt repor
81. t lt data gt 01 07 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt Reporting Samples Getting Data 39 40 Reporting Samples Getting Data lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V89A0A000089 lt data gt lt columnData gt lt columnData gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 01 07 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V89A0A00008A lt data gt lt columnData gt lt columnData gt lt columnData gt lt columnData gt lt data gt
82. t Transaction ID string Time date Type string Tender Type string Account Number string The last 4 digits are returned Expires string ABA Routing Number string Amount currency Result Code number Response Msg string Comment 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 83 84 Report Parameters Custom Report TABLE 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 Gateway Reporting Developer Guide Report Parameters Daily Activity Report Daily Activity Report TABLE C 27 Daily Activity Report input parameters report_date Date to run report date YYYY N A for MM DD sort_by Column to sort data string Transaction ID Trans Time by Transaction Time Transaction Type Tender Type Amount Result sort_opti
83. taRequest 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 15 16 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 areport by calling runReportRequest See Step 1 Run the report on page 15 The report times out The Report Id 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 report Id as a parameter getResultsRequest report Id getResultsResponse returns a statusCode and statusMsg Call getResultsResponse ina 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 15 Step 3 Get the report data Request to get the report data by calling getDataRequest
84. ters Transaction ID Search TABLE D 2 Transaction ID Search output parameters Comment string Comment2 string Billing First Name string Billing Last Name string Billing Address string Billing City string Billing State string Billing Zip string Billing Country string Billing Email string Shipping First Name string Shipping Last Name string Shipping Address string Shipping City string Shipping State string Shipping Zip string Shipping Country string Recurring string Result Code number Response Msg string Authcode string Original Transaction ID string AVS Street Match string Original Amount currency AVS Zip Match string International AVS Indicator string CSC Match string Batch ID number Gateway Reporting Developer Guide Search Parameters Ca Batch ID Search Batch ID Search TABLE D 3 Batch ID Search input parameters batch_id Batch ID to search string Y for start_date Start date to search datetime Y for YYYY MM DD HH MI SS end_date End date to search datetime Y for YYYY MM DD HH MI SS timezone Timezone used to string N GMT GMT N interpret times GMT XX XX TABLE D 4 Batch ID Search output parameters Order ID string Only if CyberCash merchant Transaction ID string Time string Type string Tender Type string Account Number string The last 4 digits are r
85. thRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt getResultsRequest gt lt reportId gt 131 lt reportId gt lt getResultsRequest gt lt reportingEngineRequest gt 34 Gateway Reporting Developer Guide Reporting Samples Getting Metadata 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 report Id 131 completed successfully lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt getResultsResponse gt lt Results gt lt reportId gt 131 lt reportId gt lt statusCode gt 3 lt statusCode gt lt statusMsg gt Report has completed successfully lt statusMsg gt lt Results gt lt getResultsResponse gt lt reportingEngineResponse gt 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 reportld 131 lt xml version 1 0 encoding UTF 8 gt lt r
86. thing 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 e Managing report templates e Running reports on demand by report or report template name e Obtaining information about reports e Managing report template schedules e 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 e Create report templates e Query report templates in t
87. tld gt lt statusCode gt 3 lt statusCode gt lt statusMsg gt Report has completed successfully lt statusMsg gt lt runReportResponse gt lt reportingEngineResponse gt Gateway Reporting Developer Guide 59 60 Reporting Samples Retrieving a List of All Scheduled Reports that were Run Retrieving a List of All Scheduled Reports that were Run This sample demonstrates how to retrieve a list of report IDs for all of the scheduled reports that were run The report ID returned can then be used for Getting Metadata on page 35 and Getting Results by Report ID on page 34 Retrieving a List of All Scheduled Reports Request lt xml version 1 0 encoding UTF 8 gt lt reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vendor gt lt partner gt Partner lt partner gt lt password gt Password lt password gt lt authRequest gt lt runReportRequest gt lt reportName gt RetrieveReports lt reportName gt lt pageSize gt 1000 lt pageSize gt lt runReportRequest gt lt reportingEngineRequest gt Retrieving a List of All Scheduled Reports Response lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt lt responseMsg gt Request has completed successfully lt responseMsg gt lt baseResponse gt lt runReportResponse gt lt reportld gt RE1234567890 lt r
88. true N cards in report false PayPal only include_jcb Include JCB string true true N cards in report false PayPal only include_mastercard Include string true true N Mastercard false cards in report include_visa Include Visa string true true N cards in report false include_authorization Include string true true N Authorizations false in report include_sale Include Sales in string true true N report false include_delayedcapture Include string true true N Delayed false Captures in report include_credit Include Credits string true true N in report false include_void Include Voidsin string true true N report false include_voiceauthorizati Include Voice string true true N on Authorizations false in report PayPal only include_buyer_authentic Include Buyer string true false N ated Authenticated false transactions in report include_not_buyer_auth Include Not string true false N enticated Buyer false Authenticated transactions in report Gateway Reporting Developer Guide TABLE C 25 Custom Report input parameters Report Parameters Custom Report recurring_only Only include string true false N recurring false transactions in report sort_by Column to sort string Transactio Transacti N data by nID on Time Transactio n Time Transactio n Type Tender Type Amount Result sort_option Sort by string Ascending Ascendin N ascending or Descendin amp descending g timezon
89. tting Data 41 42 Reporting Samples Getting Data lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V89A0A00008C lt data gt lt columnData gt lt columnData gt lt data gt 2007 09 07 17 53 32 lt data gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnData gt lt data gt 01 07 lt data gt lt columnData gt lt columnData gt lt data gt A1000 lt data gt lt columnData gt columnData gt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt Approved lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V89A0A00008D lt data gt lt columnData gt lt columnData gt lt data gt 2007 09 07 17 54 20 lt data gt lt columnData gt Gateway Reporting Developer Guide lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData
90. ype gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name reportId type xs string gt lt xs element name paramName type xs string gt lt xs element name paramValue type xs string gt lt xs element name templateName type xs string gt lt xs element name reportName type xs string gt lt xs element name report Param gt lt xs complexType gt lt xs Sequence gt lt xs element ref paramName gt lt xs element ref paramValue gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name templateDefinition gt lt xs complexType gt lt XS Sequence gt lt xs element ref templateName gt lt xs element ref reportName gt lt xs element ref reportParam minOccurs 0 maxOccurs unbounded gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name notificationRequired type xs boolean gt lt xs element name scheduleDefinition gt lt xs complexType gt lt xs Sequence gt lt xs element ref scheduleName gt lt xs element ref templateName gt lt xs element ref notificationRequired gt lt xs choice gt 28 Gateway Reporting Developer Guide Reporting XML Schema A lt xs element name daily gt lt xs complexType gt lt xs element gt lt xs element name weekly gt lt xs complexType gt lt XS Sequence gt lt xs element name dayOfWeek gt lt x

Download Pdf Manuals

Related Search

Related Contents

l`entretien, qui doit faire quoi  USER MANUAL  Horizon Fitness T40-03 Sell Sheet  User Manual - Thegobo.com  9630 Instructions  Lenmar Enterprises SPK300K/W User's Manual  

Copyright © All rights reserved. Failed to retrieve file