Home

PayPal Payflow Pro - 2010 Developer's Guide

1. 55 Appendix C Report Parameters 57 Daily Activity Report lt lt nn 57 Transaction Summary Report 59 Settlement Report 60 PayPal Settlement Summary Report 62 Shipping and Billing Report 63 Batch ID Report 64 Custom Report 4 4 4 2 4 aa wu a a 4 wm ha ua a 4 a have vd 65 Fraud Protection Report aoaaa 73 Filter Scorecard Report 74 Auto Delayed Capture Report oa oa o a a a 75 Auto Credit Report 76 Auto Void Report ios do Dames un te para Ati tn Peu 77 Auto Resettle Report 78 Recurring Billing Report 79 Recurring Profile Report 80 Recurring Profile Failed Report 82 Appendix D Search Parameters 83 Transaction IDiSeareh 2 2 22 a Yew Lund 2 04 Eau ec ay ed ta dia a b ed 83 Batch ID Search xml au dus a ne 85 AccountNumberSearch 4 4 44444000 a i 86 Reporting Developer s Guide 5 Fest Contents CommentSearch 87 AccountNumberRefSearch 88 Purchas
2. lt columnData gt lt 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 lt data gt V 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt lt columnData gt lt columnDa lt data gt ta gt 01 07 lt data gt lt columnData gt lt columnDa ta gt lt data gt A1000 lt data gt lt columnData gt lt columnDa lt data gt ta gt 0 lt data gt lt columnData gt lt columnDa ta gt lt data gt Approved lt data gt lt columnData gt lt columnDa lt data ta gt gt lt columnData gt lt columnDa lt data ta gt gt lt columnData gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V89A0A000090 lt data gt lt columnData gt 42 Reporting Developer s Guide Reporting Developer s Guide Reporting Samples Getting Data lt columnData gt lt data gt 2 lt columnDa 007 09 07 18 01 31 lt data gt ta gt lt columnData gt lt data gt S lt columnDa lt data gt ta gt lt columnData gt lt data gt 0 lt columnDa lt data
3. getting schedules 52 updating report templates 48 updating schedules 53 M updating templates 48 using report templates 15 managing report templates 14 O on demand 9 P Partner Manager overview 8 Payflow Pro 9 PayPal Settlement Summary Report 62 performing searches 18 Reporting Developer s Guide 103 104 Reporting Developer s Guide
4. Comment2 string Client IP string Authcode string AVS Street Match string AVS Zip Match string Reporting Developer s Guide Report Parameters Transaction Summary Report Transaction Summary Report TABLE C 3 Transaction Summary 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 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 4 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 Reporting Developer s Guide 59 60 Report Parameters Settlement Report Settlement Report TABLE C 5 Settlement 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 report string PayPal N A N on settlement_ Settled or non settled string Settled All N status transactions Unsettled All transaction Transaction types to string Sales All N
5. columnData gt lt reportDataRow gt lt reportDataRow gt lt columnDa lt data gt Data gt lt column lt columnDa lt data lt column lt columnDa lt data lt column lt columnDa lt data gt ata gt lt column lt columnDa lt data gt lt column lt columnDat gt 01 07 lt data gt Data gt lt data lt column lt columnDa gt A1000 lt data gt Data gt lt data lt column lt columnDa lt data gt Data gt lt column lt columnDa gt Approved lt data gt Data gt lt data lt column lt columnDa lt data lt column lt columnDa gt lt data lt column ta gt V8 9A0A000089 lt data gt ta gt 2007 09 07 17 48 20 lt data gt Data gt ta gt S lt data gt ata gt V Ca 0 lt data gt ta gt ta gt 0 lt data gt ta gt ta gt Data gt ta gt Data gt lt reportDataRow gt lt reportDataRow gt lt columnDa lt data gt V89A0A00008A lt data gt ta gt lt columnData gt lt columnDa lt data gt 2007 09 07 17 52 03 lt data gt ta gt lt columnData gt lt columnDa ta gt lt data gt S lt data gt Reporting Developer s Guide Reporting Samples B Getting Data lt columnData gt lt columnData gt lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt
6. 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 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 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 O a V Reporting Developer s Guide 39 40 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 column
7. 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 the database e Retrieve report templates from the database e Update report templates e Delete report templates Reporting Developer s Guide 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 sched
8. 88 Reporting Developer s Guide Search Parameters PurchaseOrderSearch TABLE D 10 AccountNumberRefSearch output parameters Type string Tender Type string Account Number string Expires string Amount currency Response Msg string Commentl string Comment2 string PurchaseOrderSearch TABLE D 11 PurchaseOrderSearch input parameters purchase order num Purchase Order string Y Number to search for start_date Start date to datetime Y search 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 12 PurchaseOrderSearch output parameters Order ID string Only if CyberCash merchant Reporting Developer s Guide 89 90 Search Parameters PurchaseOrderSearch TABLE D 12 PurchaseOrderSearch output parameters Transaction ID string Time string Type string Tender Type string Account Number string Expires string Amount currency Response Msg string Commentl string Comment2 string Reporting Developer s Guide Search Parameters CS RecurringBillingProfilelD Search RecurringBillingProfilelDSearch TABLE D 13 RecurringBillingProfilelDSearch input parameters profile_id Recurring Billing string Y Profile ID to search for timezone Timezone used to string N GMT GMT N interpret times GMT XX
9. 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 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 Reporting Developer s Guide Report Parameters Custom Report TABLE C 13 Custom Report input parameters 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
10. Run report for string N ACH Credit N type ACH or Credit Credit TABLE C 30 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 Reporting Developer s Guide Report Parameters Recurring Profile Report TABLE C 30 Recurring Profile Report output parameters Transaction ID string Result Code number Reporting Developer s Guide 81 82 Report Parameters Recurring Profile Failed Report Recurring Profile Failed Report TABLE C 31 Recurring Profile Failed Report input parameters start_date Start date to run report date Y Y Y Y N A Y for MM DD timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE C 32 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 Reporting Developer s 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
11. 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 Client Version string Expires string Amount currency Reporting Developer s Guide 84 Search Parameters Transaction ID Search TABLE D 2 Transaction ID Search output parameters Commentl 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 Reporting Developer s Guide Search Parameters 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 Y
12. 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 Report Template Request Getting a Report Template Response Deleting a Report Template Deleting a Report Template Request Deleting a Report Template Response Creating a Schedule Creating a Schedule Request Reporting Developer s Guide Contents Creating a Schedule Response 51 Getting a Schedule ss ss 222 2m a nn eau a ee 52 Getting a Schedule Request 52 Getting a Schedule Response 52 Updating a Schedule 53 Updating a Schedule Request 53 Updating a Schedule Response 53 Deleting a Schedule 54 Deleting a Schedule Request 54 Deleting a Schedule Response 54 Running a Transaction ID Search 55 Running a Transaction ID Search Request 55 Running a Transaction ID Search Response
13. 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 number Frequency string Status string Account Number string Expires string Comment string Start Date date Next Payment Date date Last Recurring Billing Date date Reporting Developer s Guide 91 92 Search Parameters RecurringBillingProfileNameSearch TABLE D 14 RecurringBillingProfilelDSearch output parameters Date Established date RecurringBillingProfileNameSearch TABLE D 15 RecurringBillingProfileNameSearch input parameters profile_name Recurring Billing string Profile Name to 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 Expires string Amount currency Frequency string Start Date date Date Established date Reporting Developer s Guide Search Parameters Do RecurringBillingAccountNumberSearch RecurringBillingAccountNumberSearch TABLE D 17 RecurringBillingAccountNumberSearch input parameters account number Account number to string Y search for timezone
14. 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 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 Reporting Developer s Guide Index C R createScheduleRequest 16 response codes 19 create TemplateRequest 14 retrieve report results by reportId 32 creating report templates 47 retrieving metadata 33 creating schedules 51 retrieving report data 36 creating templates 47 retrieving templates 49 running an ad hoc report 31 running reports 13 running reports offline 14 D Daily Activity Report 29 running transaction ID search 55 deleteScheduleRequest 17 runReportRequest 13 15 deleteTemplateRequest 15 runSearchRequest 18 deleting report templates 50 deleting templates 50 53 54 S status codes 20 G getDataRequest 13 17 T getMetaDataRequest 13 14 getResultsRequest 14 Transaction Summary Report 31 getScheduleRequest 16 getting data 36 getting metadata 33 U getting report templates 49 updateScheduleRequest 17 getting results by report ID 32 update TemplateRequest 15
15. 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 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 gt 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 Developer s Guide 37 38 Reporting Samples Getting Data lt columnData gt lt data gt lt columnData gt lt columnData gt lt data gt lt
16. 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 gt 1 lt pageNum gt lt getDataResponse gt lt reportingEngineResponse gt V Reporting Developer s Guide 45 46 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 EE CAC ON C1 A CC ON rom A CO e EN 5 fo emo Ja o rom EE 5 fo armen wor wre ON Pewee EE 5 fo Terme wor am ON Peer A e EE CC ON Peer EN 5 fo e EE o CO we ON C1 arrana 5 fo Jerome ar ans o rom rover 5 fo jerome ar ans o ru EE e fo e Reporting Developer s Guide Reporting Samples EEN Creating a Report Template Creating a Report Template This sample demonstrates how to create a report template from a st
17. 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 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 getResultsRequest gt lt reportId gt 131 lt report Id gt lt getResultsRequest gt lt reportingEngineRequest gt 32 Reporting Developer s Guide Reporting Samples EEN Getting Metadata Getting Results by Report ID Response In the response to getting results by report ID the response code of 100 indicate
18. 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 lt xs complex maxOccurs unbounded gt lt xs complexType gt lt xs sequence gt Reporting Developer s Guide 25 OA 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 complexType 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 reportParam gt m 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 comp
19. returns the following data Parameter Description numberOfRows Total number of rows numberOfPages Total number of pages in the report pageSize Page size numberOfColumns Total number of columns dataName Name of each column dataType Type of column data for example string Step 3 Get the report data To get the actual data in the report call getDataRequest with the following parameters getDataRequest reportId pageNum reportid ID returned for this report returned by runReportRequest pageNum Report page number containing data to be returned Reporting Developer s Guide 13 14 Using the Reporting API Managing Report Templates Data is returned for the report page specified by pageNum To obtain the data in a multi page report you must call getDataRequest for each report page Running Reports Offline When a report takes longer to run than the time allotted it is taken offline and status code 2 Report is currently executing is returned You must check for the results at a later time Step 1 Run the report Request to run a report by calling runReportRequest See Step 1 Run the report on page 13 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 reportId as a parameter getResultsRequest reportId getR
20. 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 show_freight amount Return Freight string true true N Amount false column in result show_duty_amount Return Duty string true true N Amount false column in result TABLE C 14 Custom Report output parameters Reporting Developer s Guide 71 72 Report Parameters Custom Report TABLE C 14 Custom Report output parameters Order ID string Only if Cybercash merchant Transaction ID string Time date Type string Tender Type string Account Number string Expires string ABA Routing Number string Amount currency Result Code number Response Msg string Commentl 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 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 Reporting Developer s Guide TABLE C 14 Custom Report output parameters Report Parameters Fraud Protection Report Shipping First Na
21. type report on Credits All timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE C 6 Settlement Report output parameters Order ID string Only if Cybercash merchant Transaction ID string Time date Type string Tender Type string Account Number string Reporting Developer s Guide Report Parameters Settlement Report TABLE C 6 Settlement Report output parameters Expires string Amount currency Result Code number Response Msg string Commentl string Comment2 string Batch ID number Reporting Developer s Guide 61 Report Parameters PayPal Settlement Summary Report PayPal Settlement Summary Report TABLE C 7 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 8 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 curency Currency Symbol string 62 Reporting Developer s Guide Report Parameters Shipping and Billing Report Shipp
22. Data gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V 89A0A00008C lt data gt lt columnData gt lt columnData gt lt data gt 2 007 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 oO lt data gt lt columnDa lt data gt ta gt lt columnData gt lt data gt 4 lt columnDa 111XXXXXXXX1111 lt data gt ta gt lt columnData gt lt data gt 0 lt columnDa 1 07 lt data gt ta gt lt columnData gt lt columnDa columnData gt data gt 0 lt lt columnDa lt data gt A1000 lt data gt ta gt data gt ta gt lt columnData gt lt columnDa lt data gt A pproved lt data gt ta gt lt columnData gt lt data gt lt columnDa ta gt lt columnData gt lt data gt lt columnDa ta 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 2 007 09 07 17 54 20 lt data gt lt columnData gt Reporting Developer s Guide Reporting Developer s 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 gt lt columnData gt lt columnData gt lt colum
23. In the response to retrieving a report template the response code of 100 indicates that the request completed successfully The response returns the report template name the report type Daily Activity Report upon which it was originally based as well as the parameter names and values defined for this report template lt xml version 1 0 encoding UTF 8 standalone yes gt lt reportingEngineResponse 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 lt reportParam lt paramName gt name3 lt paramName gt lt paramValue gt value3 lt paramValue gt lt reportParam gt lt reportParam 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 Reporting Developer s Guide 49 B Reporting Samples Deleting a Report Template Deleting a Report Template This sample demonstrates how to delete a report template Deleting a Report Template Request The request to delete a report template includes the templateName My Template lt xml version 1 0 encoding UTF 8 gt lt reportin
24. PayPal Payflow Pro Reporting Developer s Guide Payflow Pro Reporting Developer s Guide Document Number 200009 en_US 200912 O 2010 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 describ
25. 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 string Expires string Amount currency Frequency string Start Date date Date Established date Reporting Developer s Guide 93 Search Parameters RecurringBillingCommentSearch RecurringBillingCommentSearch TABLE D 19 RecurringBillingCommentSearch input parameters comment timezone Comment to search for Timezone used to interpret times string string GMT XX XX GMT N TABLE D 20 RecurringBillingCommentSearch output parameters Profile Name string Profile ID string Status string Account Number string Expires string Amount currency Frequency string Start Date date Date Established date 94 Reporting Developer s Guide Search Parameters CS RecurringBillingAmountSearch RecurringBillingAmountSearch TABLE D 21 RecurringBillingAmountSearch input parameters amount Amount to search string Y for timezone Timezone used to string N 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 Expires string Amount currency Frequency st
26. YYY 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 Expires string Amount currency Response Msg string Commentl string Comment2 string Reporting Developer s Guide 85 86 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 YY YY MM DD HH MI SS end_date End date to search datetime for YY Y Y 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 Expires string Amount currency Response Msg string Commentl string Comment2 string Reporting Developer s Guide Search Parameters CommentSearch CommentSearch TABLE D 7 CommentSearch input parameters commentl Comment to string Y One or commentl Comment string search for both of to search comment for and comment2 are required c
27. alue is the ID of the user authorized to process transactions If however you have not set up additional users on the account user has the same value as vendor vendor Your merchant login ID that you created when you registered for the Payflow Pro account partner The ID provided to you by the authorized PayPal Reseller who registered you for the Payflow Pro service If you purchased your account directly from PayPal use PayPal password The 6 to 32 character password that you defined while registering for the account Reporting Developer s Guide 11 Using the Reporting API Where to Go For More Information on the APIs Response Data Responses include the following information e All responses 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 APls 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 Chapter 3 Response Codes and Status Codes Appendix A Appendix B Appendix C Appendix D Contents Lists all response codes status codes and their message strings Contains the XML schema Provides API request and resp
28. andard Daily Activity Report Creating a Report Template Request This request creates a report template from a Daily Activity Report with a report template name of My Template It sets the values of two parameters name1 and name2 The parameter names and values are stored in the database 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 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 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 standa
29. ansactions in report include not buyer auth Include Not string true false N enticated Buyer false Authenticated transactions in 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 n ID on Time Transactio n Time Transactio n Type Tender Type Amount Result Reporting Developer s Guide 67 68 Report Parameters Custom Report TABLE C 13 Custom Report input parameters sort_option Sort by string Ascending Ascendin N ascending or Descendin 8 descending g timezone 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 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 cod
30. art 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 Reporting Developer s Guide Report Parameters Custom Report TABLE C 11 Batch ID Report input parameters timezone Timezone used to string N GMT GMT N interpret times GMT XX XX group by_ Should group string N true false N tender results by tender false TABLE C 12 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 currency 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 Custom Report TABLE C 13 Custom Report input parameters Auto computed Allowed Default by Name Description Type Required values value scheduler start_date Start date to run datetime Y N A Y report for YYYY MM DD HH MI SS Reporting Developer s Guide 65 66 Report Parameters Custom Report TABLE C 13 Custom Report input parameters end_date End date to run datetime N A Y report for YYYY MM DD HH MI SS minimum amo
31. ata 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 response returns the column heading lt xml version 1 0 lt reportingEngineResponse gt lt baseResponse gt lt responseCode gt 100 lt responseCode gt D 131 For each table column the ncoding UTF 8 standalone yes 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 numberOfPages gt 1 lt numberOfPages 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 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 l
32. atus Codes Status Codes Status codes indicate the status of a report not necessarily the status of the Reporting request to be executed A report may fail even if a Reporting request succeeds TABLE 3 2 Status codes and status messages Status Code Status Message 1 Report has been created 2 Report is currently executing 3 Report has completed successfully 4 Report has failed 5 Report has expired 6 Report has expired 20 Reporting Developer s 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 ww 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 elemen name user type xs string gt name vendor type xs string gt name partner type xs string gt name password type xs string gt name executor type xs string minOccurs 0 gt lt xs elemen lt xs elemen lt xs elemen lt xs elemen 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 seq
33. ber of rows of data per page Default is 50 Step 2 Get the metadata Request to get the report s metadata by calling getMetaDataRequest See Step 2 Get the metadata on page 13 Step 3 Get the report data Request to get the report data by calling getDataRequest See Step 3 Get the report data on page 13 Scheduling a Report Template You can schedule a report template to run on a daily weekly or monthly basis The Reporting API includes functionality to create schedules and to get the results of a scheduled report template Step 1 Create a schedule To create a schedule for a report template call createScheduleRequest with the following parameters createScheduleRequest scheduleName templateName schedule scheduleName Name that you give to the schedule templateName Name of the report template to be scheduled schedule One of three values daily weekly select dayOfWeek value Sunday Monday Tuesday Wednesday Thursday Friday or Saturday monthly Specify dayOfMonth value as an integer from 1 to 31 If you specify 30 when the month is 28 days long the value is corrected to 28 The time of the day starts at midnight the previous night The value daily for example means midnight the previous night to midnight tonight Step 2 Get the results To get the results of a scheduled report template that is run call get ScheduleRequest with scheduleName as a parameter getSch
34. cates 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 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 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 52 Reporting Developer s Guide Reporting Samples Bm 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 g
35. 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 Reporting Developer s 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 at payflow support paypal com Revision History Revision history for Reporting Developer 5 Guide TABLE P 1 Revision History Date Description 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 Aug
36. e Return Result string true true N Code column in false result Reporting Developer s Guide Report Parameters Custom Report TABLE C 13 Custom Report input parameters show_response_msg Return string true true N Response Msg false column in result show_commentl Return string true true N Commentl 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 Return 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 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 Reporting Developer s Guide 69 70 Report Parameters Custom Report TABLE C 13 Custom Report input parameters show_csc_match Return CSC string true true N Match column false in result show_billing first name Return Billing string true true N
37. eOrderSearch ooa a 89 RecurringBillingProfilelDSearch 91 RecurringBillingProfileNameSearch 92 RecurringBillingAccountNumberSearch 93 RecurringBillingCommentSearch 94 RecurringBillingAmountSearch 95 FraudTransactionSearch 96 OrderlDSearch 98 PayPalTransactionIDSearch 99 PayPalEmailSearch 101 PayPalNameSearch 2 222 2 2 nn nn nn ee 102 e RE 0 6 Reporting Developer s Guide Preface Payflow Pro Reporting Developer s Guide describes the Reporting XML API 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 You should familiarize yourself with the introductory and Payflow documentation on PayPal Manager s Documentation page Organization This guide is organized as follows e Chapter 1 Reporting Overview provides an overview of Reporting and the types of functionality it offers e Chapter 2 Using the Reporting API describes how to use the Reporting API
38. ed herein PayPal Inc reserves the right to make changes to any information herein without further notice Contents Preface 2 4 2 6684 u a LR eee ee ST AUdIENEE et a ee ee ee des a a ee oe 7 Organization e 4 pad aA we eal ee Sole ed ohn done dn we Pa ee ha 7 Where to Go for More Information 8 How to Contact Customer Service 8 Revision History sa 2 2 2 2 0m nn o e 8 Chapter 1 Reporting Overview 9 Operations You Can Perform Using the Reporting API 9 Managing Report Templates 9 Running Reports by Report Template Name or Report Name 10 Obtaining Information about Reports 10 Managing Report Template Schedules 10 Performing Searches 10 URL for Running Applications oaoa 10 Live Transactions 10 Test Transactions s a a at gun Be en eh 10 Chapter 2 Using the Reporting API 4 11 API Notation in this Chapter 11 Request Authorization Parameter Data 11 Response Data nn 12 Where to Go For More Information on the APIS 12 Running Reports 4 s 4 4 4 lt lt au du du dau du 4 ga 12 Running a Report and Obtaining Repor
39. eduleRequest schedulename Reporting Developer s Guide Using the Reporting API EN 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 getMetaDataRequest passing in the reportld as a parameter to get the information on how that report is formatted See Step 2 Get the metadata on page 13 Step 4 Get the report data Request to get the report data for each report that was run by calling getDataRequest See Step 3 Get the report data on page 13 Managing Report Template Schedules Using the Reporting API you can update and delete report template schedules Update a schedule To update a schedule call the updateScheduleRequest with the following parameters 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 n daily n weekly select dayOfWeek value Sunday Monday Tuesday Wednesday Thursday Friday or Saturday n monthly specify dayOfMonth value as an integer from 1 to 31 Specify dayOfMonth value as an integer from 1 to 31 If you speci
40. 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 lement name runReportRequest gt lt xs lt xs complexType gt lt xs sequence gt lt xs choice gt lement ref reportName gt lt xs lt xs element ref templateName gt lt xs choice gt lt xs element ref reportParam 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 22 Reporting Developer s Guide lt XS Reporting XML Schema KE lement ref reportParam minOccurs 0 maxOccurs unbounded gt lt xs lement ref pageSize minOccurs 0 gt lt xs sequ ence gt lt xs complexType gt lt xs element gt lt xs element nam getResultsRequest gt lt xs complexType gt lt xs seque nce 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
41. er s Guide Reporting XML Schema 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 lt xs element name columnMetaData minOccurs 0 maxOccurs unbounded gt ype 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
42. esultsResponse returns a statusCode and statusMsg Call getResultsResponse in a loop until statusCode 3 Report has completed successfully is returned Step 3 Get the metadata Request to get the report s metadata by calling getMetaDataRequest See Step 2 Get the metadata on page 13 Step 3 Get the report data Request to get the report data by calling getDataRequest See Step 3 Get the report data on page 13 Managing Report Templates Using the Reporting API you can create update and delete report templates Step 1 Create a report template To create a report template call createTemplateRequest with the following parameters createTemplateRequest templateName reportName reportParams Parameter Description templateName Name that you are giving to the report template reportName Standard report from which you are creating the report template Reporting Developer s Guide Using the Reporting API EN 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
43. fy 30 when the month is 28 days the value is corrected to 28 The time of the day starts at midnight the previous night The value daily for example means midnight the previous night to midnight tonight The response to updating a schedule returns a respCode and respMsg Delete a schedule To delete a schedule call deleteScheduleRequest providing the scheduleName as the input parameter deleteTemplateRequest scheduleName The response to deleting a schedule returns a respCode and respMsg Reporting Developer s Guide 17 18 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 paramValue of one or more input parameters for this search See Appendix C Report Parameters for the required and optional pa
44. gEngineRequest 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 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 reportingEngineResponse gt lt baseResponse gt lt responseCode gt 113 lt responseCode gt lt responseMsg gt Unknown template requested lt responseMsg gt lt baseResponse gt lt reportingEngineResponse gt lt reportingEngineRequest gt 50 Reporting Developer s Guide Reporting Samples Boo 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 l
45. gt 4 lt columnDa lt data gt ta gt 111XXXXXXXX1111 lt data gt ta gt lt columnData gt lt data gt 0 lt columnDa 1 05 lt data gt ta gt lt columnData gt lt columnDa lt data gt A1000 lt data gt ta gt lt columnData gt lt data gt 2 lt columnDa 4 lt data gt ta gt lt columnData gt lt columnDa lt data gt Unknown error lt data gt ta gt lt columnData gt lt columnDa lt data gt ta gt lt columnData gt lt columnDa lt data gt ta gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt columnDa lt data gt V89A0A000091 lt data gt ta gt lt columnData gt lt data gt 2 lt columnDa 007 09 07 18 01 44 lt data gt ta gt lt columnData gt lt columnDa lt columnDat lt columnDa lt columnDat lt columnDa lt columnDat lt columnDa lt columnDat lt data gt S lt data gt ta gt a V lt data gt 0 lt data gt ta gt a V lt data gt 4111XXXXXXXX1111 lt data gt ta gt a gt lt data gt 12 05 lt data gt ta gt a gt lt data gt A1000 lt data gt 43 NE 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 g
46. 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 The get TemplateRequest can be used to check the new parameters and values 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 reportingEngineResponse gt 48 Reporting Developer s Guide Reporting Samples EEN Getting a Report Template 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 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 getTemplateRequest gt lt templateName gt My Template lt templateName gt lt getTemplateRequest gt lt reportingEngineRequest gt Getting a Report Template Response
47. 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 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 lt paramName gt end date lt paramName gt lt paramValue gt 2007 09 07 23 59 59 lt paramValue gt lt reportParam gt lt pageSize gt 50 lt pageSize gt lt runReportRequest gt lt reportingEngineRequest gt Reporting Developer s Guide 31 NE 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
48. ing Reporting Developer s Guide Report Parameters Auto Void Report Auto Void Report TABLE C 23 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 YYYY 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 24 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 Reporting Developer s Guide 77 Report Parameters Auto Resettle Report Auto Resettle Report TABLE C 25 Auto Resettle Report input parameters start date Start date to run report datetime YYYY N A Y for MM DD HH MI SS end_date End date to run report datetime Y Y Y Y N A Y for MM DD HH MI SS timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE C 26 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 Comment2 string 78 Re
49. ing and Billing Report TABLE C 9 Shipping and Billing Report input parameters report_date Date to run report date N A for YYYY MM DD sort_by Column to sort string Transaction ID Trans Time data by Transaction Time Transaction Type Tender Type Amount Result sort_option Sort by ascending string Ascending Ascending or descending Descending timezone Timezone used to string GMT GMT interpret times GMT XX XX TABLE C 10 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 Reporting Developer s Guide 63 64 Report Parameters Batch ID Report TABLE C 10 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 Batch ID Report TABLE C 11 Batch ID Report input parameters start date St
50. lexType 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 26 Reporting Developer s Guide Reporting XML Schema 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 xs 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 dayOfMo
51. lone 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 reportingEngineResponse gt Reporting Developer s Guide 47 B Reporting Samples Updating a Report Template Updating a Report Template This sample demonstrates how to update the parameter information in a report template Updating a Report Template Request The request specifies the report template to update by its name My Template and the report type Daily Activity Report upon which it was originally based Updating a report template is not an additive process 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 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 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
52. me 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 Fraud Protection Report TABLE C 15 Fraud Protection Report input parameters start_date Start date to run report datetime N A for YY Y Y MM DD HH MI SS end_date End date to run report datetime N A for YY Y Y MM DD HH MI SS transaction Transaction types to string Review N A type report on Reject Accept Screened By Filters Not Screened By Filters timezone Timezone used to string GMT GMT interpret times GMT XX XX Reporting Developer s Guide 73 74 Report Parameters Filter Scorecard Report TABLE C 16 Fraud Protection Report output parameters Transaction ID string Time date Type string Tender Type string Amount currency Deployment Mode string Fraud Transaction string Filter Scorecard Report TABLE C 17 Filter Scorecard Report input parameters start_date Start date to run datetime Y N A Y report for YY YY 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 18 Filter Scorecard Report output parameters Filter string Times Triggered number Trigger Percentage number Re
53. nData 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 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 columnData gt lt columnData gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData data gt 0 lt data gt lt columnData gt lt columnData gt V ct 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 4111XXXXXXXX1111 lt data gt lt data gt Approved lt data gt lt data gt V8 9A0A00008E lt data gt lt data gt 2007 09 07 17 56 02 lt data gt lt data gt 4111XXXXXXXX1111 lt data gt Reporting Samples Getting Data 41 NE 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
54. ng Num Unprocessed Rules number Unprocessed Rules string Reporting Developer s Guide 97 98 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 Client Version string Expires string Street string Amount currency Zip string Email string Name On Card string Commentl string Reporting Developer s Guide TABLE D 26 OrderlDSearch output parameters Search Parameters CS PayPalTransaction DSearch Comment2 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 PayPalTransactionIDSearch TABLE D 27 PayPalTransactionIDSearch input parameters paypal_transaction PayPal transaction string _id ID to search for timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE D 28 PayPalTransactionIDSearch output parameters U
55. nique transaction ID of the payment returned in a PayPal Transaction ID string DoExpressCheckoutPayment response Transaction ID string Time string Type string Reporting Developer s Guide 99 a Search Parameters PayPalTransactionlDSearch TABLE D 28 PayPalTransactionIDSearch output parameters Tender Type string Email string Amount currency Response Msg string Comment string Comment2 string 100 Reporting Developer s Guide Search Parameters CS 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 Commentl string Comment2 string Reporting Developer s Guide 101 102 Search Parameters PayPalNameSearch PayPalNameSearch TABLE D 31 PayPalNameSearch input parameters last_name Last name to search string Y for first_name First name to search string N for start_date Start date to search datetime
56. nseMsg gt lt baseResponse gt lt reportingEngineResponse gt 54 Reporting Developer s Guide Reporting Samples Running a Transaction ID Search Running a Transaction ID Search This sample demonstrates 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 TransactionIDSearch 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 runSearchRe
57. nth 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 Reporting Developer s Guide 27 OA Reporting XML Schema 28 Reporting Developer s 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 Norte 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 reportingEngineRequest gt lt authRequest gt lt user gt User lt user gt lt vendor gt Vendor lt vend
58. 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 parameter deleteTemplateRequest templateName The response to deleting a report template returns a respCode and respMsg Using Report Templates Report templates are run like any standard report They can also be scheduled to run on a daily weekly or monthly basis Finally report template schedules can be updated or deleted Running a report template and obtaining the report template data Step 1 Run a report template To run a report template call runReportRequest with the following parameters runReportRequest templateName reportParams pageSize templateName Name given to the report template when it was created Reporting Developer s Guide 15 16 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 Num
59. omment2 Comment2 to string Y One or comment2 Comment2 string search for both of to search comment for and comment2 are required start_date Start date to datetime Y start_date Start date datetime search for YY YY MM to search YY YY MM DD for DD HH MI SS HH MI SS end_date End date to search datetime Y end_date End date to datetime for YY YY MM search for YY YY 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 Reporting Developer s Guide 87 a Search Parameters AccountNumberRefSearch TABLE D 8 CommentSearch output parameters Account Number string Expires string Amount currency Response Msg string Comment string Comment2 string 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
60. onse samples for each request and response referred to in this chapter Describes the input and output parameters for all standard predefined reports supported 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 report data 12 Reporting Developer s Guide Using the Reporting API EN 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 reportId The report Id is used to refer to the particular report in future requests 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
61. or 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 Reporting Developer s Guide 29 NE 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 1d 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 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 30 Reporting Developer s Guide Reporting Samples Em Running a Transaction Summary Report Running a Transaction Summary Report This sample demonstrates
62. porting Developer s Guide Report Parameters Auto Delayed Capture Report Auto Delayed Capture Report TABLE C 19 Auto Delayed Capture Report input parameters start_date Start date to run report for datetime Y N A Y YY YY MM DD HH MI SS end_date End date to run report for datetime Y N A Y YY YY MM DD HH MI SS timezone Timezone used to interpret string N GMT GMT N times GMT XX XX TABLE C 20 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 Reporting Developer s Guide 75 76 Report Parameters Auto Credit Report Auto Credit Report TABLE C 21 Auto Credit 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 Y Y Y Y N A Y report for MM DD HH MI SS timezone Timezone used to string GMT GMT N interpret times GMT XX XX TABLE C 22 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 Comment string Comment2 str
63. porting Developer s Guide Report Parameters Recurring Billing Report Recurring Billing Report TABLE C 27 Recurring Billing Report input parameters start date Start date to run 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_ Include string true true approvals approvals in false report include Include declines string true true declines in report false timezone Timezone used string GMT GMT to interpret GMT XX XX times tender_ Run report for string ACH Credit type ACH or Credit Credit TABLE C 28 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 Reporting Developer s Guide 79 80 Report Parameters Recurring Profile Report TABLE C 28 Recurring Billing Report output parameters Result Code number Recurring Profile Report TABLE C 29 Recurring Profile Report input parameters start_date Start date to run datetime Y N A Y report for YY Y Y MM DD HH MI SS end_date End date to run datetime Y N A Y report for YY Y Y MM DD HH MI SS profile_id Profile to report string Y N A N on timezone Timezone used string N GMT GMT N to interpret times GMT XX XX tender_
64. rameters pageSize Number of rows of data per page Default is 50 runSearchResponse returns the report and statusMsg Step 2 Get the metadata a for this search as well as the statusCode Request to get the search metadata by calling getMetaDataRequest See Step 2 Get the metadata on page 13 Step 3 Get the report data Request to get the search data by calling get DataRequest See Step 3 Get the report data on page 13 Reporting Developer s 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 Reporting Developer s Guide 19 Se Response Codes and Status Codes St
65. 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 complex lt xs element gt lt xs element nam Type gt lt xs complexT getMetaDataRequest gt ype gt lt xs sequence gt lt XS lement ref reportId gt lt xs sequence gt lt xs complex lt xs element gt Type gt lt xs element nam lt xs complexT getDataRequest gt ype gt lt xs sequence gt lt XS lt XS lement ref reportId gt lement ref pageNum minOccurs 0 gt lt xs sequ lt xs complex lt xs element gt lt xs choice gt lt xs sequence gt lt xs complexType gt lt xs element gt lt xs element name reporting lt xs complexType gt lt xs sequence gt ence gt Type gt EngineResponse gt lt XS lement name baseResponse gt lt xs complexType gt Reporting Developer s Guide 23 OA 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 g
66. ring Start Date date Date Established date Reporting Developer s Guide 95 96 Search Parameters FraudTransactionSearch FraudTransactionSearch TABLE D 23 FraudTransactionSearch input parameters fraud transaction id Fraud transaction ID string to search for transaction type Transaction 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 AVS Street Match string AVS Zip Match string CSC Match string Internation AVS Indicator string Buyer Authentication string Billing Name string Billing Streetl string Reporting Developer s Guide Search Parameters 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 Streetl 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 stri
67. s that the request completed successfully The status code of 3 indicates that the report with reportId 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 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 getMetaDataRequest gt lt reportId gt 131 lt reportId gt lt getMetaDataRequest gt lt reportingEngineRequest gt Reporting Developer s Guide 33 34 Reporting Samples Getting Metadata Getting Metadata Response In the response to retrieving metad
68. sponse 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 Reporting Developer s Guide 55 Reporting Samples Running a Transaction ID Search 56 Reporting Developer s Guide Report Parameters Daily Activity Report TABLE C 1 Daily Activity Report input parameters report date Date to run report date Y Y Y Y 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 option Sort by ascending string Ascending Ascending or descending Descending timezone Timezone used to string GMT GMT interpret times GMT XX XX Reporting Developer s Guide 58 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 2 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 Expires string Amount currency Result number Response Msg string Commentl string
69. t 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 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 reportingEngineResponse gt Reporting Developer s Guide 53 Be 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 respo
70. t lt data gt lt columnData gt lt data gt lt columnData gt lt reportDataRow gt lt reportDataRow gt lt columnData gt lt data gt V8 9A0A000092 lt data gt lt columnData gt lt columnData gt lt data gt 2007 09 07 18 02 19 lt data gt lt columnData gt lt columnData gt lt data gt S lt data gt lt columnData gt lt columnData lt data gt 0 lt data gt lt columnData gt lt columnData 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 reportDataRow gt lt columnData gt lt data gt V89A0A000093 lt data gt V V 44 Reporting Developer s Guide Reporting Samples B Getting Data 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 lt data gt 0 lt data gt lt columnData gt lt columnData gt lt data gt 4111XXXXXXXX1111 lt data gt
71. t 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 schedul lt xs element ref schedul 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 leName maxOccurs unbounded gt leDefinition 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 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 nam getResultsResponse gt lt xs complexType gt lt xs sequence gt lement name Results minOccurs 0 lt XS maxOccurs unbounded gt lt x 24 s complexType gt lt xs Sequence gt lt xs element ref reportId gt lt xs element ref statusCode gt lt xs element ref statusMsg gt Reporting Develop
72. t Data 13 Running Reports Offline 14 Managing Report Templates 14 Using Report Templates 15 Running a report template and obtaining the report template data 15 Scheduling a Report Template 16 Managing Report Template Schedules 17 Performing Searches nn 18 Reporting Developer s Guide Fest Contents Chapter 3 Response Codes and Status Codes Response Codes Status Codes 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 Report ID Getting Results by Report ID Request Getting Results by Report ID Response Getting Metadata Getting Metadata Request Getting Metadata Response Format Returned Getting Data Getting DataRequest Getting Data Response Data Returned Creating a Report
73. t 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 scheduleDefinition 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 ncoding 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 reportingEngineResponse gt Reporting Developer s Guide 51 NE 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 Getting a Schedule Response In the response to getting a schedule the response code of 100 indi
74. t 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 Reporting Developer s Guide Reporting Samples EEN 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 Transaction Trans Trans Tender Account Expires Amount Result Response Commenti Comment2 ID Time Type Type Number Msg Reporting Developer s Guide 35 ENE 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 retrieve 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
75. 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 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 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 reportID 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 has completed successfully lt responseMsg gt lt baseResponse gt lt getDataResponse gt lt reportDataRow gt lt columnData gt lt data gt V89A0A000087 lt data gt lt columnData gt lt columnData gt lt data gt 2007 09 07 17 45 08 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 36 Reporting Developer s Guide Reporting Samples B Getting Data lt columnData gt lt
76. uence 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 templateDefinition 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 Cr Cr ON u Reporting Developer s Guide 21 lt xs element ref templateName gt OA Reporting XML Schema 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 lement name getScheduleRequest gt lt xs 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
77. ules Performing Searches You can search for payment transaction data based on search names such as TransactionIDSearch BatchIDSearch and AccountNumberSearch URL for Running Applications Use the following URLs for running Reporting applications Live Transactions https payments reports paypal com reportingengine Test Transactions https payments reports paypal com test reportingengine 10 Reporting Developer s Guide Using the Reporting APl This chapter describes how you can use the Reporting API to perform the following tasks e Running Reports on page 12 e Managing Report Templates on page 14 e Using Report Templates on page 15 e Performing Searches on page 18 API Notation in this Chapter The chapter uses the following short hand notation for referring to Reporting API requests and parameter information requestName paramName paramName requestName is the name of the request The request input parameters 1f any are listed in a parameter list enclosed in parentheses Request Authorization Parameter Data The Reporting API notation in this chapter does not include the authorization information that is passed with every request All Reporting API requests require that you specify these parameters and values as your user information TABLE 2 1 User information Parameter Description user If you set up one or more additional users on the account this v
78. unt Minimum number 0 N amount to report on maximum amount Maximum number 10000 N amount to report on results Results to string All All N report on Approvals Only Declines Only Approvals and Declines lt Comma Separated List gt include_amex Include string true true N American false Express cards in report include_diners Include Diners string true true N cards in report false include_discover Include string true true N Discover cards false in report include_enroute Include Enroute string true true N cards in report false include_jcb Include JCB string true true N cards in report false include_mastercard Include string true true N Mastercard false cards in report include_visa Include Visa string true true N cards in report false Reporting Developer s Guide Report Parameters Custom Report TABLE C 13 Custom Report input parameters 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 Voids in string true true N report false include_voiceauthorizati Include Voice string true true N on Authorizations false in report include buyer authentic Include Buyer string true false N ated Authenticated false tr
79. ust 2007 Updated Title page and logo July 2006 Updated document title product names Reformatted in PayPal templates Updated to support new currencies March 2006 Integrated Express Checkout feature 8 Reporting Developer s 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 Everything that Manager can do with reports is available to you through API calls You can for example request a particular report be run within a specified date range The response returns all the data that the report generates The reporting engine encapsulates the information in all the Payflow 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

PayPal Payflow Pro - 2010 Developer's Guide

Contents

Download Pdf Manuals

Related Search

Related Contents