PayPal Payflow Pro - 2010 Betriebsanweisung Seite 1

Payflow Pro Reporting Developer’s GuideLast updated: June 2010

Reporting OverviewURL for Running Applications110 Reporting Developer’s GuideRunning Reports by Report Template Name or Report NameYou can run reports

Search ParametersPayPalTransactionIDSearchD100 Reporting Developer’s GuideTender Type stringEmail stringAmount currencyResponse Msg stringComment1 str

Reporting Developer’s Guide 101Search ParametersPayPalEmailSearchDPayPalEmailSearchTABLE D.29 PayPalEmailSearch input parametersName Description TypeR

Search ParametersPayPalNameSearchD102 Reporting Developer’s GuidePayPalNameSearchTABLE D.31 PayPalNameSearch input parametersName Description TypeRequ

Reporting Developer’s Guide 103IndexIndexCcreateScheduleRequest 16createTemplateRequest 14creating report templates 47creating schedules 51creating te

Index104 Reporting Developer’s Guide

Reporting Developer’s Guide 112Using the Reporting APIThis chapter describes how you can use the Reporting API to perform the following tasks.z “Runni

Using the Reporting APIWhere to Go For More Information on the APIs212 Reporting Developer’s GuideResponse DataResponses include the following informa

Reporting Developer’s Guide 13Using the Reporting APIRunning Reports2Running a Report and Obtaining Report DataThis procedure describes how to run a r

Using the Reporting APIManaging Report Templates214 Reporting Developer’s GuideData is returned for the report page specified by pageNum. To obtain th

Reporting Developer’s Guide 15Using the Reporting APIUsing Report Templates2The response to creating a report template returns a respCode and respMsg.

Using the Reporting APIUsing Report Templates216 Reporting Developer’s GuideStep 2. Get the metadataRequest to get the report’s metadata by calling ge

Reporting Developer’s Guide 17Using the Reporting APIUsing Report Templates2getScheduleResponse returns all the reportIds and execution dates of the r

Using the Reporting APIPerforming Searches218 Reporting Developer’s GuidePerforming SearchesUsing the Reporting API, you can search for transaction da

Reporting Developer’s Guide 193Response Codes and Status CodesThis chapter provides the following details on reports. It identifies:z Response codes a

Payflow Pro Reporting Developer’s GuideDocument Number: 200009.en_US-200912© 2010 PayPal, Inc. All rights reserved. PayPal is a registered trademark o

Response Codes and Status CodesStatus Codes320 Reporting Developer’s GuideStatus CodesStatus codes indicate the status of a report, not necessarily th

Reporting Developer’s Guide 21AReporting XML SchemaThis appendix contains the XML Reporting 1.0 schema.<?xml version="1.0" encoding="

Reporting XML SchemaA22 Reporting Developer’s Guide<xs:element ref="templateName"/></xs:sequence></xs:complexType></xs:

Reporting Developer’s Guide 23Reporting XML SchemaA<xs:element ref="reportParam" minOccurs="0" maxOccurs="unbounded"/

Reporting XML SchemaA24 Reporting Developer’s Guide<xs:sequence><xs:element name="responseCode" type="xs:int"/><xs:

Reporting Developer’s Guide 25Reporting XML SchemaA<xs:element name="executionTime" type="xs:dateTime" minOccurs="0"/

Reporting XML SchemaA26 Reporting Developer’s Guide<xs:element name="data" type="xs:string" minOccurs="0"/></xs

Reporting Developer’s Guide 27Reporting XML SchemaA<xs:element name="daily"><xs:complexType/></xs:element><xs:element n

Reporting XML SchemaA28 Reporting Developer’s Guide

Reporting Developer’s Guide 29BReporting SamplesThis appendix demonstrates how to use the Reporting API to create, run, and manage reports. For detail

Reporting Developer’s Guide 3ContentsPreface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Reporting SamplesRunning a Daily Activity ReportB30 Reporting Developer’s GuideRunning a Daily Activity Report ResponseIn the response to running the

Reporting Developer’s Guide 31Reporting SamplesRunning a Transaction Summary ReportBRunning a Transaction Summary ReportThis sample demonstrates how t

Reporting SamplesGetting Results by Report IDB32 Reporting Developer’s GuideRunning a Transaction Summary Report ResponseIn the response to running th

Reporting Developer’s Guide 33Reporting SamplesGetting MetadataBGetting Results by Report ID ResponseIn the response to getting results by report ID,

Reporting SamplesGetting MetadataB34 Reporting Developer’s GuideGetting Metadata ResponseIn the response to retrieving metadata, the response code of

Reporting Developer’s Guide 35Reporting SamplesGetting MetadataB<dataName>Reponse Msg</dataName><dataType>string</dataType><

Reporting SamplesGetting DataB36 Reporting Developer’s GuideGetting DataThis sample demonstrates how to retrieve the data in a previously run report.G

Reporting Developer’s Guide 37Reporting SamplesGetting DataB</columnData><columnData><data>4111XXXXXXXX1111</data></columnD

Reporting SamplesGetting DataB38 Reporting Developer’s Guide<columnData><data/></columnData><columnData><data/></colu

Reporting Developer’s Guide 39Reporting SamplesGetting DataB</columnData><columnData><data>0</data></columnData><colu

Contents4 Reporting Developer’s GuideChapter 3 Response Codes and Status Codes . . . . . . . . . . . . .19Response Codes. . . . . .

Reporting SamplesGetting DataB40 Reporting Developer’s Guide<columnData><data>Approved</data></columnData><columnData>&l

Reporting Developer’s Guide 41Reporting SamplesGetting DataB<columnData><data>S</data></columnData><columnData><data&

Reporting SamplesGetting DataB42 Reporting Developer’s Guide<data>0</data></columnData><columnData><data>Approved</da

Reporting Developer’s Guide 43Reporting SamplesGetting DataB<columnData><data>2007-09-07 18:01:31</data></columnData><colum

Reporting SamplesGetting DataB44 Reporting Developer’s Guide</columnData><columnData><data>0</data></columnData><colu

Reporting Developer’s Guide 45Reporting SamplesGetting DataB</columnData><columnData><data>2007-09-07 18:03:09</data></colu

Reporting SamplesGetting DataB46 Reporting Developer’s GuideData ReturnedThe data is returned in the following tabular format of 13 rows and 11 column

Reporting Developer’s Guide 47Reporting SamplesCreating a Report TemplateBCreating a Report TemplateThis sample demonstrates how to create a report te

Reporting SamplesUpdating a Report TemplateB48 Reporting Developer’s GuideUpdating a Report TemplateThis sample demonstrates how to update the paramet

Reporting Developer’s Guide 49Reporting SamplesGetting a Report TemplateBGetting a Report TemplateThis sample demonstrates how to retrieve a report te

Reporting Developer’s Guide 5ContentsCreating a Schedule Response . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Reporting SamplesDeleting a Report TemplateB50 Reporting Developer’s GuideDeleting a Report TemplateThis sample demonstrates how to delete a report te

Reporting Developer’s Guide 51Reporting SamplesCreating a ScheduleBCreating a ScheduleThis sample demonstrates how to create a schedule for a report t

Reporting SamplesGetting a ScheduleB52 Reporting Developer’s GuideGetting a ScheduleGetting a Schedule Request?xml version="1.0" encoding=&q

Reporting Developer’s Guide 53Reporting SamplesUpdating a ScheduleBUpdating a ScheduleThis sample demonstrates how to update a schedule.Updating a Sch

Reporting SamplesDeleting a ScheduleB54 Reporting Developer’s GuideDeleting a ScheduleThis sample demonstrates how to delete a schedule.Deleting a Sch

Reporting Developer’s Guide 55Reporting SamplesRunning a Transaction ID SearchBRunning a Transaction ID SearchThis sample demonstrates how to run a se

Reporting SamplesRunning a Transaction ID SearchB56 Reporting Developer’s Guide

Reporting Developer’s Guide 57CReport ParametersDaily Activity ReportTABLE C.1 Daily Activity Report input parameters Name Description Type Required?A

Report ParametersDaily Activity ReportC58 Reporting Developer’s GuideCurrency values are returned in the three-character currency code specified. The

Reporting Developer’s Guide 59Report ParametersTransaction Summary ReportCTransaction Summary ReportTABLE C.3 Transaction Summary Report input paramet

Contents6 Reporting Developer’s GuideCommentSearch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Report ParametersSettlement ReportC60 Reporting Developer’s GuideSettlement ReportTABLE C.5 Settlement Report input parameters Name Description TypeRe

Reporting Developer’s Guide 61Report ParametersSettlement ReportCExpires stringAmount currencyResult Code numberResponse Msg stringComment1 stringComm

Report ParametersPayPal Settlement Summary ReportC62 Reporting Developer’s GuidePayPal Settlement Summary ReportTABLE C.7 PayPal Settlement Summary Re

Reporting Developer’s Guide 63Report ParametersShipping and Billing ReportCShipping and Billing ReportTABLE C.9 Shipping and Billing Report input para

Report ParametersBatch ID ReportC64 Reporting Developer’s GuideBatch ID ReportBilling State stringBilling Zip stringBilling Email stringBilling Countr

Reporting Developer’s Guide 65Report ParametersCustom ReportCCustom Reporttimezone Timezone used to interpret timesstring N GMTGMT+/-XX:XXGMT Ngroup_b

Report ParametersCustom ReportC66 Reporting Developer’s Guideend_date End date to run report fordatetime YYYY-MM-DD HH:MI:SSYN/AYminimum_amount Minimu

Reporting Developer’s Guide 67Report ParametersCustom ReportCinclude_authorization Include Authorizations in reportstring N truefalsetrue Ninclude_sal

Report ParametersCustom ReportC68 Reporting Developer’s Guidesort_option Sort by ascending or descendingstring N AscendingDescendingAscendingNtimezone

Reporting Developer’s Guide 69Report ParametersCustom ReportCshow_response_msg Return Response Msg column in result?string N truefalsetrue Nshow_comme

Reporting Developer’s Guide 7PrefacePayflow Pro Reporting Developer’s Guide describes the Reporting XML API. The XML API enables you to develop Web an

Report ParametersCustom ReportC70 Reporting Developer’s Guideshow_csc_match Return CSC Match column in result?string N truefalsetrue Nshow_billing_fir

Reporting Developer’s Guide 71Report ParametersCustom ReportCshow_shipping_last_nameReturn Shipping Last Name column in result?string N truefalsetrue

Report ParametersCustom ReportC72 Reporting Developer’s GuideOrder ID string Only if Cybercash merchantTransaction ID stringTime dateType stringTender

Reporting Developer’s Guide 73Report ParametersFraud Protection ReportCFraud Protection ReportShipping First Name stringShipping Last Name stringShipp

Report ParametersFilter Scorecard ReportC74 Reporting Developer’s GuideFilter Scorecard ReportTABLE C.16 Fraud Protection Report output parametersColu

Reporting Developer’s Guide 75Report ParametersAuto Delayed Capture ReportCAuto Delayed Capture ReportTABLE C.19 Auto Delayed Capture Report input par

Report ParametersAuto Credit ReportC76 Reporting Developer’s GuideAuto Credit ReportTABLE C.21 Auto Credit Report input parameters Name Description Ty

Reporting Developer’s Guide 77Report ParametersAuto Void ReportCAuto Void ReportTABLE C.23 Auto Void Report input parameters Name Description TypeRequ

Report ParametersAuto Resettle ReportC78 Reporting Developer’s GuideAuto Resettle ReportTABLE C.25 Auto Resettle Report input parameters Name Descript

Reporting Developer’s Guide 79Report ParametersRecurring Billing ReportCRecurring Billing ReportTABLE C.27 Recurring Billing Report input parameters N

PrefaceWhere to Go for More Information8 Reporting Developer’s GuideWhere to Go for More InformationPayPal Manager online help describes the use of Pa

Report ParametersRecurring Profile ReportC80 Reporting Developer’s GuideRecurring Profile ReportResult Code numberTABLE C.29 Recurring Profile Report

Reporting Developer’s Guide 81Report ParametersRecurring Profile ReportCTransaction ID stringResult Code numberTABLE C.30 Recurring Profile Report out

Report ParametersRecurring Profile Failed ReportC82 Reporting Developer’s GuideRecurring Profile Failed ReportTABLE C.31 Recurring Profile Failed Repo

Reporting Developer’s Guide 83DSearch ParametersTransaction ID SearchTABLE D.1 Transaction ID Search input parametersName Description TypeRequired?All

Search ParametersTransaction ID SearchD84 Reporting Developer’s GuideComment1 stringComment2 stringBilling First Name stringBilling Last Name stringBi

Reporting Developer’s Guide 85Search ParametersBatch ID SearchDBatch ID SearchTABLE D.3 Batch ID Search input parametersName Description TypeRequired?

Search ParametersAccountNumberSearchD86 Reporting Developer’s GuideAccountNumberSearchTABLE D.5 AccountNumberSearch input parametersName Description T

Reporting Developer’s Guide 87Search ParametersCommentSearchDCommentSearchTABLE D.7 CommentSearch input parametersName Description Type Required?Allow

Search ParametersAccountNumberRefSearchD88 Reporting Developer’s GuideAccountNumberRefSearchAccount Number stringExpires stringAmount currencyResponse

Reporting Developer’s Guide 89Search ParametersPurchaseOrderSearchDPurchaseOrderSearchType stringTender Type stringAccount Number stringExpires string

Reporting Developer’s Guide 91Reporting OverviewThe Reporting API is an API that you can use to automate your report queries. It allows you to program

Search ParametersPurchaseOrderSearchD90 Reporting Developer’s GuideTransaction ID stringTime stringType stringTender Type stringAccount Number stringE

Reporting Developer’s Guide 91Search ParametersRecurringBillingProfileIDSearchDRecurringBillingProfileIDSearchTABLE D.13 RecurringBillingProfileIDSear

Search ParametersRecurringBillingProfileNameSearchD92 Reporting Developer’s GuideRecurringBillingProfileNameSearchDate Established dateTABLE D.15 Recu

Reporting Developer’s Guide 93Search ParametersRecurringBillingAccountNumberSearchDRecurringBillingAccountNumberSearchTABLE D.17 RecurringBillingAccou

Search ParametersRecurringBillingCommentSearchD94 Reporting Developer’s GuideRecurringBillingCommentSearchTABLE D.19 RecurringBillingCommentSearch inp

Reporting Developer’s Guide 95Search ParametersRecurringBillingAmountSearchDRecurringBillingAmountSearchTABLE D.21 RecurringBillingAmountSearch input

Search ParametersFraudTransactionSearchD96 Reporting Developer’s GuideFraudTransactionSearchTABLE D.23 FraudTransactionSearch input parametersName Des

Reporting Developer’s Guide 97Search ParametersFraudTransactionSearchDBilling Street2 stringBilling City stringBilling State stringBilling Zip stringB

Search ParametersOrderIDSearchD98 Reporting Developer’s GuideOrderIDSearchTABLE D.25 OrderIDSearch input parametersName Description TypeRequired?Allow

Reporting Developer’s Guide 99Search ParametersPayPalTransactionIDSearchDPayPalTransactionIDSearchComment2 stringResult Code numberResponse Msg string