PayPal Gateway - 2013 Guide de l'utilisateur

Gateway Reporting Developer GuideLast updated: Nov 2013

PrefaceRevision History10 Gateway Reporting Developer Guide

Report ParametersShipping and Billing ReportC100 Gateway Reporting Developer GuideBilling State stringBilling Zip stringBilling Email stringBilling Co

Gateway Reporting Developer Guide 101Report ParametersTransaction Summary ReportCTransaction Summary ReportTABLE C.51 Transaction Summary Report input

Report ParametersTransaction Summary ReportC102 Gateway Reporting Developer Guide

Gateway Reporting Developer Guide 103DSearch ParametersTransaction ID SearchTABLE D.1 Transaction ID Search input parametersName Description TypeRequi

Search ParametersTransaction ID SearchD104 Gateway Reporting Developer GuideComment1 stringComment2 stringBilling First Name stringBilling Last Name s

Gateway Reporting Developer Guide 105Search ParametersBatch ID SearchDBatch ID SearchTABLE D.3 Batch ID Search input parametersName Description TypeRe

Search ParametersAccountNumberSearchD106 Gateway Reporting Developer GuideAccountNumberSearchTABLE D.5 AccountNumberSearch input parametersName Descri

Gateway Reporting Developer Guide 107Search ParametersCommentSearchDCommentSearchTABLE D.7 CommentSearch input parametersName Description Type Require

Search ParametersCommentSearchD108 Gateway Reporting Developer GuideAccount Number string The last 4 digits are returnedExpires stringAmount currencyR

Gateway Reporting Developer Guide 109Search ParametersAccountNumberRefSearchDAccountNumberRefSearchTABLE D.9 AccountNumberRefSearch input parametersNa

Gateway Reporting Developer Guide 111Reporting OverviewThe Reporting API is an API that you can use to automate your report queries. It allows you to

Search ParametersPurchaseOrderSearchD110 Gateway Reporting Developer GuidePurchaseOrderSearchTABLE D.11 PurchaseOrderSearch input parametersName Descr

Gateway Reporting Developer Guide 111Search ParametersRecurringBillingProfileIDSearchDRecurringBillingProfileIDSearchTABLE D.13 RecurringBillingProfil

Search ParametersRecurringBillingProfileNameSearchD112 Gateway Reporting Developer GuideRecurringBillingProfileNameSearchDate Established dateTABLE D.

Gateway Reporting Developer Guide 113Search ParametersRecurringBillingAccountNumberSearchDRecurringBillingAccountNumberSearchTABLE D.17 RecurringBilli

Search ParametersRecurringBillingCommentSearchD114 Gateway Reporting Developer GuideRecurringBillingCommentSearchTABLE D.19 RecurringBillingCommentSea

Gateway Reporting Developer Guide 115Search ParametersRecurringBillingAmountSearchDRecurringBillingAmountSearchTABLE D.21 RecurringBillingAmountSearch

Search ParametersFraudTransactionSearchD116 Gateway Reporting Developer GuideFraudTransactionSearchTABLE D.23 FraudTransactionSearch input parametersN

Gateway Reporting Developer Guide 117Search ParametersFraudTransactionSearchDBilling Street2 stringBilling City stringBilling State stringBilling Zip

Search ParametersOrderIDSearchD118 Gateway Reporting Developer GuideOrderIDSearchTABLE D.25 OrderIDSearch input parametersName Description TypeRequire

Gateway Reporting Developer Guide 119Search ParametersOrderIDSearchDComment2 stringResult Code numberResponse Msg stringAuthcode stringOriginal Transa

Reporting OverviewURL for Running Applications112 Gateway Reporting Developer GuideRunning Reports by Report Template Name or Report NameYou can run r

Search ParametersPayPalTransactionIDSearchD120 Gateway Reporting Developer GuidePayPalTransactionIDSearchTABLE D.27 PayPalTransactionIDSearch input pa

Gateway Reporting Developer Guide 121Search ParametersPayPalEmailSearchDPayPalEmailSearchTABLE D.29 PayPalEmailSearch input parametersName Description

Search ParametersPayPalNameSearchD122 Gateway Reporting Developer GuidePayPalNameSearchTABLE D.31 PayPalNameSearch input parametersName Description Ty

Gateway Reporting Developer Guide 123IndexIndexAACH 62ACH Activity Summary Report 62ACH Batch ID Report 64ACH Detail Return Activity Report 66ACH

Index124 Gateway Reporting Developer Guiderunning reports offline 16running transaction ID search 57runReportRequest 15, 17runSearchRequest 20SSet

Gateway Reporting Developer Guide 132Using the Reporting APIThis chapter describes how you can use the Reporting API to perform the following tasks.

Using the Reporting APIWhere to Go For More Information on the APIs214 Gateway Reporting Developer GuideResponse DataResponses include the following i

Gateway Reporting Developer Guide 15Using the Reporting APIRunning Reports2Running a Report and Obtaining Report DataThis procedure describes how to r

Using the Reporting APIManaging Report Templates216 Gateway Reporting Developer GuideData is returned for the report page specified by pageNum. To obt

Gateway Reporting Developer Guide 17Using the Reporting APIUsing Report Templates2The response to creating a report template returns a respCode and re

Using the Reporting APIUsing Report Templates218 Gateway Reporting Developer GuideStep 2. Get the metadataRequest to get the report’s metadata by call

Gateway Reporting Developer Guide 19Using the Reporting APIUsing Report Templates2getScheduleResponse returns all the reportIds and execution dates of

Gateway Reporting Developer GuideDocument Number: 200046.en_US-201311© 1999 - 2013 PayPal, Inc. All rights reserved. PayPal is a registered trademark

Using the Reporting APIPerforming Searches220 Gateway Reporting Developer GuidePerforming SearchesUsing the Reporting API, you can search for transact

Gateway Reporting Developer Guide 213Response Codes and Status CodesThis chapter provides the following details on reports. It identifies: Response c

Response Codes and Status CodesStatus Codes322 Gateway Reporting Developer GuideStatus CodesStatus codes indicate the status of a report, not necessar

Gateway Reporting Developer Guide 23AReporting XML SchemaThis appendix contains the XML Reporting 1.0 schema.<?xml version="1.0" encoding

Reporting XML SchemaA24 Gateway Reporting Developer Guide<xs:element ref="templateName"/></xs:sequence></xs:complexType>&l

Gateway Reporting Developer Guide 25Reporting XML SchemaA<xs:element ref="reportParam" minOccurs="0" maxOccurs="unbounded&

Reporting XML SchemaA26 Gateway Reporting Developer Guide<xs:sequence><xs:element name="responseCode" type="xs:int"/>&

Gateway Reporting Developer Guide 27Reporting XML SchemaA<xs:element name="executionTime" type="xs:dateTime" minOccurs="0&

Reporting XML SchemaA28 Gateway Reporting Developer Guide<xs:element name="data" type="xs:string" minOccurs="0"/>&

Gateway Reporting Developer Guide 29Reporting XML SchemaA<xs:element name="daily"><xs:complexType/></xs:element><xs:ele

Gateway Reporting Developer Guide 3ContentsPreface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Reporting XML SchemaA30 Gateway Reporting Developer Guide

Gateway Reporting Developer Guide 31BReporting SamplesThis appendix demonstrates how to use the Reporting API to create, run, and manage reports. For

Reporting SamplesRunning a Daily Activity ReportB32 Gateway Reporting Developer GuideRunning a Daily Activity Report ResponseIn the response to runnin

Gateway Reporting Developer Guide 33Reporting SamplesRunning a Transaction Summary ReportBRunning a Transaction Summary ReportThis sample demonstrates

Reporting SamplesGetting Results by Report IDB34 Gateway Reporting Developer GuideRunning a Transaction Summary Report ResponseIn the response to runn

Gateway Reporting Developer Guide 35Reporting SamplesGetting MetadataBGetting Results by Report ID ResponseIn the response to getting results by repor

Reporting SamplesGetting MetadataB36 Gateway Reporting Developer GuideGetting Metadata ResponseIn the response to retrieving metadata, the response co

Gateway Reporting Developer Guide 37Reporting SamplesGetting MetadataB<dataName>Reponse Msg</dataName><dataType>string</dataType&

Reporting SamplesGetting DataB38 Gateway Reporting Developer GuideGetting DataThis sample demonstrates how to retrieve the data in a previously run re

Gateway Reporting Developer Guide 39Reporting SamplesGetting DataB</columnData><columnData><data>4111XXXXXXXX1111</data></c

Contents4 Gateway Reporting Developer GuideChapter 3 Response Codes and Status Codes . . . . . . . . . . . . .21Response Codes. . . .

Reporting SamplesGetting DataB40 Gateway Reporting Developer Guide<columnData><data/></columnData><columnData><data/><

Gateway Reporting Developer Guide 41Reporting SamplesGetting DataB</columnData><columnData><data>0</data></columnData>&l

Reporting SamplesGetting DataB42 Gateway Reporting Developer Guide<columnData><data>Approved</data></columnData><columnData

Gateway Reporting Developer Guide 43Reporting SamplesGetting DataB<columnData><data>S</data></columnData><columnData><

Reporting SamplesGetting DataB44 Gateway Reporting Developer Guide<data>0</data></columnData><columnData><data>Approved&

Gateway Reporting Developer Guide 45Reporting SamplesGetting DataB<columnData><data>2007-09-07 18:01:31</data></columnData><

Reporting SamplesGetting DataB46 Gateway Reporting Developer Guide</columnData><columnData><data>0</data></columnData>&l

Gateway Reporting Developer Guide 47Reporting SamplesGetting DataB</columnData><columnData><data>2007-09-07 18:03:09</data><

Reporting SamplesGetting DataB48 Gateway Reporting Developer GuideData ReturnedThe data is returned in the following tabular format of 13 rows and 11

Gateway Reporting Developer Guide 49Reporting SamplesCreating a Report TemplateBCreating a Report TemplateThis sample demonstrates how to create a rep

Gateway Reporting Developer Guide 5ContentsCreating a Schedule Response . . . . . . . . . . . . . . . . . . . . . . . . . .

Reporting SamplesUpdating a Report TemplateB50 Gateway Reporting Developer Guide<responseMsg>Request has completed successfully</responseMsg&

Gateway Reporting Developer Guide 51Reporting SamplesGetting a Report TemplateB<baseResponse><responseCode>100</responseCode><res

Reporting SamplesDeleting a Report TemplateB52 Gateway Reporting Developer Guide<reportParam><paramName>name3</paramName><paramVa

Gateway Reporting Developer Guide 53Reporting SamplesCreating a ScheduleBCreating a ScheduleThis sample demonstrates how to create a schedule for a re

Reporting SamplesGetting a ScheduleB54 Gateway Reporting Developer GuideGetting a ScheduleGetting a Schedule Request?xml version="1.0" encod

Gateway Reporting Developer Guide 55Reporting SamplesUpdating a ScheduleBUpdating a ScheduleThis sample demonstrates how to update a schedule.Updating

Reporting SamplesDeleting a ScheduleB56 Gateway Reporting Developer GuideDeleting a ScheduleThis sample demonstrates how to delete a schedule.Deleting

Gateway Reporting Developer Guide 57Reporting SamplesRunning a Transaction ID SearchBRunning a Transaction ID SearchThis sample demonstrates how to ru

Reporting SamplesRunning a Profile - Next Payment Date ReportB58 Gateway Reporting Developer GuideRunning a Profile - Next Payment Date ReportThis sam

Gateway Reporting Developer Guide 59Reporting SamplesRunning a Profile - Profile Modified Date ReportBRunning a Profile - Profile Modified Date Report

Contents6 Gateway Reporting Developer GuideCustom Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Reporting SamplesRetrieving a List of All Scheduled Reports that were RunB60 Gateway Reporting Developer GuideRetrieving a List of All Scheduled Repor

Gateway Reporting Developer Guide 61CReport ParametersReports in This AppendixThis appendix describes the input and output parameters for the followin

Report ParametersACH Activity Summary ReportC62 Gateway Reporting Developer GuideACH Activity Summary ReportTABLE C.1 ACH Activity Summary Report inpu

Gateway Reporting Developer Guide 63Report ParametersACH Activity Summary ReportCTender Type stringAccount Number stringAccount ABA stringAmount curre

Report ParametersACH Batch ID ReportC64 Gateway Reporting Developer GuideACH Batch ID ReportTABLE C.3 ACH Batch ID Report input parameters Name Descri

Gateway Reporting Developer Guide 65Report ParametersACH Batch ID ReportCTotal Sales/Delayed Captures/Voice Authorizations (Count)numberTotal Credits

Report ParametersACH Detail Return Activity ReportC66 Gateway Reporting Developer GuideACH Detail Return Activity ReportTABLE C.5 ACH Detail Return Ac

Gateway Reporting Developer Guide 67Report ParametersACH Notification of Change ReportCACH Notification of Change ReportBatch ID numberCurrency Symbol

Report ParametersACH Return Activity ReportC68 Gateway Reporting Developer GuideACH Return Activity ReportTABLE C.9 Auto Return Activity Report input

Gateway Reporting Developer Guide 69Report ParametersACH Settlement ReportCACH Settlement ReportTABLE C.11 ACH Settlement Report input parameters Name

Gateway Reporting Developer Guide 7PrefaceGateway Reporting Developer Guide describes the Reporting XML API for the following Gateway payment solution

Report ParametersACH Transaction ReportC70 Gateway Reporting Developer GuideACH Transaction ReportCurrency Symbol stringComment1 stringComment2 string

Gateway Reporting Developer Guide 71Report ParametersAuto Credit ReportCAuto Credit ReportTender Type stringAccount Number stringAccount ABA stringAmo

Report ParametersAuto Delayed Capture ReportC72 Gateway Reporting Developer GuideAuto Delayed Capture Reporttimezone Timezone used to interpret timess

Gateway Reporting Developer Guide 73Report ParametersAuto Delayed Capture ReportCtimezone Timezone used to interpret timesstring N GMTGMT+/-XX:XXGMT N

Report ParametersAuto Resettle ReportC74 Gateway Reporting Developer GuideAuto Resettle ReportTABLE C.19 Auto Resettle Report input parameters Name De

Gateway Reporting Developer Guide 75Report ParametersAuto Void ReportCAuto Void ReportTABLE C.21 Auto Void Report input parameters Name Description Ty

Report ParametersBatch ID ReportC76 Gateway Reporting Developer GuideBatch ID ReportTABLE C.23 Batch ID Report input parameters Name Description Type

Gateway Reporting Developer Guide 77Report ParametersCustom ReportCCustom ReportTABLE C.25 Custom Report input parameters Name Description Type Requir

Report ParametersCustom ReportC78 Gateway Reporting Developer Guideinclude_discover Include Discover cards in report (PayPal only)string N truefalsetr

Gateway Reporting Developer Guide 79Report ParametersCustom ReportCrecurring_only Only include recurring transactions in reportstring N truefalsefalse

PrefaceWhere to Go for More Information8 Gateway Reporting Developer GuideWhere to Go for More InformationPayPal Manager online help describes the use

Report ParametersCustom ReportC80 Gateway Reporting Developer Guideshow_expires Return Expires column in result?string N truefalsetrue Nshow_aba_rout

Gateway Reporting Developer Guide 81Report ParametersCustom ReportCshow_avs_zip_match Return AVS Zip Match column in result?string N truefalsetrue Ns

Report ParametersCustom ReportC82 Gateway Reporting Developer Guideshow_billing_email Return Billing Email column in result?string N truefalsetrue Ns

Gateway Reporting Developer Guide 83Report ParametersCustom ReportCshow_freight_amount Return Freight Amount column in result?string N truefalsetrue

Report ParametersCustom ReportC84 Gateway Reporting Developer GuideCSC Match stringBilling First Name stringBilling Last Name stringBilling Company Na

Gateway Reporting Developer Guide 85Report ParametersDaily Activity ReportCDaily Activity ReportTABLE C.27 Daily Activity Report input parameters Name

Report ParametersDaily Activity ReportC86 Gateway Reporting Developer GuideCurrency values are returned in the three-character currency code specified

Gateway Reporting Developer Guide 87Report ParametersFilter Scorecard ReportCFilter Scorecard ReportTABLE C.29 Filter Scorecard Report input parameter

Report ParametersFraud Protection ReportC88 Gateway Reporting Developer GuideFraud Protection ReportTABLE C.31 Fraud Protection Report input parameter

Gateway Reporting Developer Guide 89Report ParametersPayflow Link Orders ReportCPayflow Link Orders ReportTABLE C.33 PayflowLink Orders Report input p

Gateway Reporting Developer Guide 9PrefaceRevision HistoryMarch 2006 Integrated Express Checkout feature.TABLE P.1 Revision HistoryDate Description

Report ParametersPayflow Link Orders ReportC90 Gateway Reporting Developer GuideShipping City stringShipping State stringShipping Zip stringShipping C

Gateway Reporting Developer Guide 91Report ParametersPayPal Settlement Summary ReportCPayPal Settlement Summary ReportTABLE C.35 PayPal Settlement Sum

Report ParametersProfile Next Payment ReportC92 Gateway Reporting Developer GuideProfile Next Payment ReportTABLE C.37 Profile Next Payment Report inp

Gateway Reporting Developer Guide 93Report ParametersProfile Modified Date ReportCProfile Modified Date ReportTABLE C.39 Profile Next Payment Report i

Report ParametersRecurring Billing ReportC94 Gateway Reporting Developer GuideRecurring Billing ReportTABLE C.41 Recurring Billing Report input parame

Gateway Reporting Developer Guide 95Report ParametersRecurring Profile Failed ReportCRecurring Profile Failed ReportTABLE C.43 Recurring Profile Faile

Report ParametersRecurring Profile ReportC96 Gateway Reporting Developer GuideRecurring Profile ReportTABLE C.45 Recurring Profile Report input parame

Gateway Reporting Developer Guide 97Report ParametersSettlement ReportCSettlement ReportTABLE C.47 Settlement Report input parameters Name Description

Report ParametersSettlement ReportC98 Gateway Reporting Developer GuideTender Type stringAccount Number string The last 4 digits are returnedExpires s

Gateway Reporting Developer Guide 99Report ParametersShipping and Billing ReportCShipping and Billing ReportTABLE C.49 Shipping and Billing Report inp