Home

PayPal XMLPay - 2009 Developer's Guide

1. 15 Transaction zs iei Re PES Bw x RU RON RE 16 R QUESTAUINE e uui UN ER Gina are CU RUN VECTOR PR 21 The XMLPayRequest Document Recurring Profiles 22 RecurringProfile 22 PayDatar Last sas 1 et Ede 4e 25 PayDataAuth 226 seeks be hehe Rx xo yok 49 3 verset a 25 n a 25 HMS uuum RR Oe Dae EA ee e pn e ea we 28 MerchatitlnfO s 42 zu dte Se OR Ko RO ua tb ROT dates 30 XMLPay Developer s Guide Contents RPData 4 22 Rowe Bk ou ExtData 2 23 64 See Soe RUE SSR ERD Ses The XMLPayResponse Document Transactions TransactionResult The XMLPayResponse Document Recurring Profiles BuyerAuthResult RecurringProfileResult Chapter 3 Elements General Transaction Parameters Credit Card Transaction Parameters Retail Credit Card Transaction Parameters Level 3 Commercial Credit Card Transaction Parameters Buyer Authentication Transaction Parameters Credit Card Transaction Response Parameters ACH Transaction Parameters Norwest PayPal Express Checkout Request Transaction Parameters PayPal Express Checkout Response Transaction
2. lt ELEMENT RPData Name TotalAmt Start Term PayPeriod MaxFailPayments RetryNumDays EMail CompanyName Comment OptionalTrans OptionalTransAmt BillTo ShipTo OrigProfileID PaymentNum ExtData gt lt ELEMENT Add RPData Tender gt lt ELEMENT ProfileID PCDATA gt lt ELEMENT Modify ProfileID RPData Tender gt lt ELEMENT Cancel ProfileID lt ELEMENT Reactivate ProfileID RPData Tender gt lt ELEMENT Payment ProfileID RPData Tender gt lt ELEMENT PaymentHistory PCDATA gt lt ELEMENT Inquiry ProfileID PaymentHistory gt lt ELEMENT RecurringProfile Add Modify Cancel Reactivate lt ATTLIST RecurringProfile Id CDATA IMPLIED gt lt ELEMENT RecurringProfiles RecurringProfile gt lt ELEMENT AccountUpdateRequest Action PNRef Tender ExtData lt ELEMENT AccountUpdateRequests AccountUpdateRequest gt lt ELEMENT IntegrationType PCDATA gt lt ELEMENT IntegrationVersion PCDATA gt lt ELEMENT WrapperType PCDATA gt lt ELEMENT WrapperVersion PCDATA gt lt ELEMENT OSName PCDATA gt lt ELEMENT OSArchitecture PCDATA gt 140 Payment Inquiry gt XML
3. lt ELEMEN ransState PCDATA gt lt ELEMENT RPPaymentResult PaymentNum PNRef TransTime Result Tender Amt TransState ExtData gt lt ATTLIST RPPaymentResult Id CDATA IMPLIED gt lt ELEMENT RecurringProfileResult Result Message ProfileID RPRef Status Name Start Term End PayPeriod MaxFailPayments RetryNumDays EMail CompanyName Amt PaymentsLeft NextPayment AggregateAmt AggregateOptionalTransAmt NumFailedPayments Tender BillTo ShipTo TransactionResult RPPaymentResult ExtData lt ATTLIST RecurringProfileResult Id CDATA IMPLIED gt lt ELEMENT RecurringProfileResults RecurringProfileResultt gt lt ELEMENT AUResponseCode PCDATA gt lt ELEMENT AUResponseText PCDATA gt lt ELEMENT AUSubmitDate PCDATA gt lt ELEMENT AccountUpdateResult Result Message PNRef AUResponseCode AUResponseText AUSubmitDate Tender ExtData gt lt ELEMENT AccountUpdateResults AccountUpdateResult gt Developer s Guide 143 B XMLPay DTD 144 lt ELEMENT lt ELEMENT lt ELEMENT Recur lt ELEMENT ReceiptData ri HTTPCommitResul HTTPCommitResul ngProfil ResponseData
4. 80 Card Void Request 81 Card Void Response 81 Check Sale Request 82 Check Sale 83 Customer P uus ud uem w e 83 Express Checkout Authorization Transaction 84 Set Express Checkout Request 84 Set Express Checkout Response 85 Get Express Checkout Request 85 Get Express Checkout Response 86 Do Express Checkout Request 87 Do Express Checkout Response 88 IAVS Result 88 Level SINVOICE 24 es vos o ook Roe om Q ha Vas Dog X 89 Line Item Sale Request 90 Line Item Sale Response 92 Merchant Description and Merchant Service Number 92 Processor Result 93 Recurring Billing Profile 94 ACH Recurring Billing Profile 94 Credit Card Recurring Billing Profile oo aa a 95 Shipping Carrier and Shipping Method 96 Trans
5. CustCode PONum TaxExempt gt lt ELEMENT ShipCarrier PCDATA gt lt ELEMENT ShipMethod PCDATA gt lt ELEMENT ShipFromEU PCDATA gt lt ELEMENT ShipFrom Name Address EMail Phone Fax ShipFromEU gt lt ELEMENT ShipToEU PCDATA gt lt ELEMENT ShipTo Name Address 11 Phone Phone2 Fax ShipToEU gt lt ELEMENT Des lt ELEMENT SKU lt ELEMENT UPC cription PCDATA gt PCDATA gt PCDATA gt lt ELEMENT Quantity PCDATA gt 132 XMLPay Developer s Guide UnitOfMeasurement PCDATA gt lt ELEMEN UnitPrice PCDATA gt lt ATTLIS UnitPrice Currency CDATA IMPLIED gt lt ELEMEN lt ATTLIST lt ELEMENT ExtAmt PCDATA gt ExtAmt Currency CDATA IMPLIED gt DiscountAmt PCDATA gt lt ATTLIS DiscountAmt Currency CDATA IMPLIED gt lt ELEMEN axAmt PCDATA gt lt ATTLIS axAmt Currency CDATA IMPLIED gt lt ELEMEN axRate PCDATA gt otalAmt PCDATA gt lt ATTLIS lt ELEMEN lt ATTLIST lt ATTLIS otalAmt Currency CDATA IMPLIED gt ExtData PCDATA gt ExtData Name CDATA IMPLIED gt ExtData Va
6. AN AAAAAA AAA A Developer s Guide 91 XMLPay Examples Merchant Description and Merchant Service Number lt Tender gt lt PayData gt lt Sale gt lt Transaction gt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Line Item Sale Response lt xml version 1 0 encoding UTF 8 XMLPayResponse xmlns http www paypal com XMLPay lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Match lt StreetMatch gt lt ZipMat ch gt Match lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRe gt VTHA55395881 lt PNRef gt lt AuthCode gt 624PNI lt AuthCode gt lt HostCode gt 00 lt HostCode gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Merchant Description and Merchant Service Number lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendo
7. Token ReturnURL CancelURL NotifyURL ReqConfirmShippiing NoShipping AddressOverride LocaleCode PageStyle HeaderImage HeaderBorderColor HeaderBackColor PayflowColor ButtonSource ExtData lt PayPal gt Attribute Description EMail Email address of customer as entered during checkout PayPal uses this value to pre fill the PayPal membership signup portion of the PayPal login page Payerld Unique encrypted PayPal customer account identification number Token A string value returned by Set Express Checkout response XMLPay Developer s Guide XMLPay Syntax Core Structures Attribute ReturnURL NotifyURL ReqConfirmShipping NoShipping AddressOverride LocaleCode PageStyle HeaderImage HeaderBorderColor HeaderBackColor PayflowColor ButtonSource ExtData Description URL to which the customer s browser is returned after approving use of PayPal Set RETURNURL to your order review page or the page on which the customer clicked the Edit Shipping button or hyperlink Your URL for receiving Instant Payment Notification IPN about this transaction Is 1 or 0 The value 1 indicates that you require that the customer s shipping address on file with PayPal be a confirmed address Setting this element overrides the setting you have specified in your Merchant Account Profile Is 1 o
8. lt ELEMENT PayPalResult EMail PayerID Token PPRef FeeAmount PayerStatus PaymentType PendingReason Custom InvNum Phone Name ShipTo CorrelationID gt lt ELEMENT TransactionResult Result BuyerAuthResult ProcessorResult FraudPreprocessResult FraudPostprocessResult CardSecure IAVSResult AVSResult CVResult Message PNRef AuthCode HostCode HostURL OrigResult TrStatus ReceiptURL ACHStatus OrigPNRef OrigMessage PayPalResult ExtData gt lt ATTLIST TransactionResult Id CDATA IMPLIED gt 142 XMLPay Developer s Guide XMLPay DTD m lt ATTLIS ransactionResult CustRef CDATA IMPLIED gt lt ATTLIS ransactionResult Duplicate CDATA IMPLIED gt lt ELEMEN ransactionResults TransactionResult gt lt ELEMENT RPRef PCDATA gt lt ELEMENT End PCDATA gt lt ELEMENT Amt PCDATA gt lt ATTLIST Amt Currency CDATA IMPLIED gt lt ELEMENT PaymentsLeft PCDATA gt lt ELEMENT NextPayment PCDATA gt lt ELEMENT AggregateAmt PCDATA gt lt ATTLIST AggregateAmt Currency CDATA IMPLIED gt lt ELEMENT AggregateOptionalTransAmt PCDATA gt lt ATTLIST AggregateOptionalTransAmt Currency CDATA IMPLIED gt lt ELEMENT NumFailedPayments PCDATA gt lt ELEMEN ransTime PCDATA gt
9. lt ShipFrom gt Name Address EMail Phone Fax ShipFromEU ShipFrom lt ShipTo gt Name Address EMail Phone Phone2 Fax ShipToEU lt ShipTo gt Description DiscountAmt ShippingAmt Dut yAmt TaxAmt NationalTaxIncl TotalAmt FreightAmt HandlingAmt ItemAmt evel 3Invoice Memo OrderDesc MerchantInfo AdditionalAmounts SKU CustomerHostName CustomerBrowser lt Invoice gt XMLPay Developer s Guide XMLPay Syntax Core Structures Attribute CustIP MerchantDescripton MechantServiceNum Recurring InvNum OrigInvNum Date OrderDateTime BillFrom Name Address EMail Phone Fax and URL BillTo Customerld Name Address EMail Phone Phone2 PhoneType and Fax BillTo PONum BillTo TaxExempt ShipCarrier ShipMethod ShipFrom and ShipTo Description Items Description Customer IP address filter transactions Merchant descriptor For example ABCCMPY FALLCATALOG Merchant telephone number For example 603 555 1212 Identifies the transaction as recurring This value does not activate the Recurring Billing Service If the RECURRING parameter was set to Y for the original transaction then the setting is ignored when forming Credit Void and Force transactions If you subscribe t
10. lt simpleType name CorrelationIDType base string gt lt maxLength value 31 gt lt simpleType gt lt simpleType name ECTokenType base string lt maxLength value 20 gt lt simpleType gt lt simpleType name PayerIDType base string gt lt maxLength value 127 gt lt simpleType gt lt simpleType name Base64BinaryData base binary gt lt encoding value base64 gt lt simpleType gt lt element name ExtData gt lt complexType base string content elementOnly gt lt attribute name Name type string gt lt attribute name Value type string gt lt complexType gt lt element gt Developer s Guide 129 130 XMLPay Schemas XMLPay Types Schema lt simpleType name URI base string gt lt maxLength value 256 gt lt simpleType gt lt simpleType name SicType base string gt lt maxLength value 4 gt lt simpleType gt lt simpleType name StatusType base string gt lt enumeration value New gt lt enumeration value Update gt lt enumeration value Replace gt lt simpleType gt lt simpleType name ReferenceIdType base string gt lt maxLength value 12 gt lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType n
11. 0 maxOccurs 1 gt lt element ref Address minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name CardStart type string minOccurs 0 maxOccurs 1 gt lt element name CardIssue type string minOccurs 0 maxOccurs 1 gt lt element name CountyTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt Developer s Guide 117 XMLPay Schemas XMLPay Types Schema lt complexType gt lt element gt lt element name CountySalesTax type Level3TaxType minOccurs 0 maxOccurs 1 lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name CityTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs MANS lt element nam
12. 1 gt lt element name BillTo minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element ref Address minOccurs 0 maxOccurs 1 gt lt element name Phone type PhoneNumberType minOccurs 0 maxOccurs 1 gt lt element name Fax type PhoneNumberType minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name ShipTo minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element ref Address gt lt element name Phone type PhoneNumberType minOccurs 0 maxOccurs WL gt lt element name Fax type PhoneNumberType minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element ref TransactionResult minOccurs 0 maxOccurs 1 gt lt element ref RPPaymentResult minOccurs 0 maxOccurs unbounded gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt lt attribute name Id type ID gt lt complexType gt lt element gt lt simpleType name ProfileIDType base string gt lt maxLength value 12 gt lt simpleType gt lt simpleType name RPNameType base string gt lt maxLength value 128 gt lt simpleType gt
13. lt Transaction gt lt Sale gt lt PayData gt lt Invoice gt lt BillTo gt lt Name gt billtoname lt Name gt lt Address gt lt Street gt street lt Street gt lt City gt city lt City gt lt State gt NY lt State gt lt Zip gt 67890 lt Zip gt lt Count ry gt US lt Country gt lt Address gt lt EMail gt email lt EMail gt lt Phone gt 1234567890 lt Phone gt lt Fax gt 9876543210 lt Fax gt lt CustCode gt custcode lt CustCode gt lt PONum gt 123456 lt PONum gt lt TaxExempt gt false lt TaxExempt gt lt 111 gt lt Items gt lt Item Number 1 gt lt SKU gt 1111 lt SKU gt UPC gt 9999 lt UPC gt Description gt Widget lt Description gt Quantity gt 2 lt Quantity gt nitOfMeasurement INQ UnitOfMeasurement UnitPrice gt 49 99 lt UnitPrice gt DiscountAmt gt 9 98 lt DiscountAmt gt FreightAmt gt 3 00 lt FreightAmt gt HandlingAmt gt 8 00 lt HandlingAmt gt TotalAmt gt 101 00 lt TotalAmt gt PickUp gt lt Address gt lt Street gt 500 Main St lt Street gt lt City gt Anytown lt City gt lt State gt NY lt State gt lt Zip gt 67890 lt Zip gt lt Count ry gt US lt Country gt lt Address gt lt Time gt 15 30 lt Time gt AA A A A 90 Developer s Guide XMLPay Examples Line Item Sale Request lt Date gt 20030630 lt Date gt lt RecordNumber gt 24680 lt RecordNumber gt lt PickUp gt lt TrackingNumber gt ABC0123 lt
14. BillTo ShipTo ExtData Description Amount collected through sending optional transactions Number of payments that failed Specifies payment type Information about the buyer Information about the shipping addresses if different from BillTo Optional element that may carry extended data outside the syntax of the XMLPay schema XMLPay Developer s Guide 45 XMLPay Syntax The XMLPayResponse Document Recurring Profiles 46 XMLPay Developer s Guide XMLPay Elements The following tables define the existing Payflow SDK parameters name value pairs and their XMLPay equivalent Some parameters cannot be processed by specific processors For details on what your processor can process see Payflow Pro Developer s Guide If you are developing applications that use the Recurring Billing Service see Recurring Billing Service User s Guide That document provides detailed information about Payflow SDK parameters specific to Recurring Billing Note ExtData is an optional XMLPay element for including parameter data not supported by the schema you are using Place the data at the appropriate element level in the XML Pay hierarchy If you can t find or are unsure of the appropriate location place the data in the Invoice element See the examples in Express Checkout Authorization Transaction on page 84 General Transaction Parameters The following are general parameters accepted in Payflow SDK transactions
15. Fax type PhoneNumberType minOccurs 0 maxOccurs 1 gt lt element name ShipToEU type ShipEUType minOccurs 0 maxOccurs jm lt complexType gt lt element gt lt element name Description type DescType minOccurs 0 maxOccurs unbounded gt lt element name Items minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element ref Item minOccurs 0 maxOccurs unbounded gt lt complexType gt lt element gt lt element name DiscountAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ShippingAmt type CurrencyAmount minOccurs 0 maxOccurs 1 Je lt element name DutyAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name TaxAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name NationalTaxIncl type boolean minOccurs 0 maxOccurs 1 gt lt element name TotalAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name FreightAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name HandlingAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ItemAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name Comment type CommentType minOccurs 0 maxOccurs 1 gt lt element ref Level3Invoice minOccurs 0 maxOccurs
16. XMLPay Developer s Guide 77 XMLPay Examples Card Sale Request lt Invoice gt lt NationalTaxIncl gt false lt NationalTaxIncl gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt visa lt CardType gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200911 lt ExpDate gt lt NameOnCard gt lt Card gt lt Tender gt lt PayData gt lt Sale gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Card Sale Response lt xml version 1 0 encoding UTF 8 lt XMLPayResponse gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Service Not Available lt StreetMatch gt lt ZipMatch gt Service Not Available lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt V64A09909896 lt PNRef gt lt AuthCode gt 968PNI lt AuthCode gt lt HostCode gt 00 lt HostCode gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayR
17. gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt XMLPay Developer s Guide 105 XMLPay Schemas XMLPay Schema lt element name VerifyEnrollment gt lt complexType content elementOnly gt lt sequence gt lt element ref PayData gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name ValidateAuthentication gt lt complexType content elementOnly gt lt sequence gt lt element name PARes type BuyerAuthMesgType gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt lt complexType gt lt element gt lt element name AccountUpdateRequest gt lt complexType content elementOnly gt lt sequence gt lt element name Action type AUActionEnum gt lt choice gt lt element name PNRef type PNRefType gt lt element ref Tender gt lt choice gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt simpleType name TransactionUpdateActionEnum base string gt lt enumeration value Approve gt lt enumeration value Review gt lt enumeration value ServiceDecline gt lt enumeration value MerchantDecline gt lt simpleType gt lt element name Transactio
18. Buying Group first address line XMLPay Element Level3Invoice AlITax Level3Invoice AlITax Level3Invoice AlITax Level3Invoice AlternateTax Amount Level3Invoice Alternate TaxID Level3Invoice gt BuyingGroup Level3Invoice BuyingGroup XMLPay Developer s Guide XMLPay Elements Credit Card Transaction Parameters TABLE 3 3 Level 3 commercial credit card transaction parameters Payflow SDK Parameter Description XMLPay Element BGSECONDADDR Buying Group second address Level3Invoice gt line BuyingGroup BGCITY Buying Group city Level3Invoice gt BuyingGroup BGSTATE Buying Group state Level3Invoice gt BuyingGroup BGZIP Buying Group zip code Level3 Invoice BuyingGroup BGCOUNTRY Buying Group country Level3Invoice BuyingGroup CARDSTART Starting date printed on card Level3Invoice gt Switch Solo only CardStart CARDISSUE Issue number printed on card Level3Invoice gt Switch Solo only CardIssue COUNTYTAXAMT County tax amount Level3Invoice CountyTax COUNTYTAXEXEMPTCODE County tax exempt code Level3Invoice CountyTax COUNTYTAXPERCENT County tax rate Level3Invoice CountyTax COUNTYSALESTAXAMT County sales tax amount Level3Invoice CountySalesTax COUNTYSALESTAXEXEMPTCODE County sales tax exempt code Level3Invoice gt CountySalesTax COUNTYSALESTAXPERCENT County sales tax amount Level3Invoice gt CountySalesTax CITYTAXAMT City tax amount Level3Invoice CityTax CITYTAXEXEMPTCODE City tax exempt code L
19. Check attribute 33 CheckType Check attribute 33 City Address attribute 31 Comment Invoice attribute 28 RPData attribute 37 commercial credit card transaction parameters 52 to 58 communications results 150 CompanyName RecurringProfileResult attribute 44 RPData attribute 37 core structures 25 Corporate Purchase Card 32 CorrelationID PayPalResult attribute 41 CostCenterNumber Item attribute 30 Country Address attribute 31 credit card recurring billing profile example 95 credit card transaction parameters 48 to 58 credit card transaction response parameters 58 to 59 Credit transaction 65 credit transaction attributes 18 CustIP Invoice attribute 27 Custom Invoice attribute 28 PayPalResult attribute 41 customer IP example 83 CustomerBrowser Invoice attribute 28 CustomerHostName Invoice attribute 28 CustRef TransactionResult element 40 CVNum Card attribute 33 CVResult TransactionResult attribute 39 D Date Invoice attribute 27 Item attribute 30 deactivating a recurring profile see cancelling a recurring profile Delivery Date Item attribute 30 Delivery Time Item attribute 30 Description Invoice attribute 27 XMLPay Developer s Guide Item attribute 29 DiscountAmt 30 Invoice attribute 28 Item attribute 29 DL Check attribute 34 DOB Check attribute 34 DTD see document type definition Duplicate TransactionResult element 40 DutyAmt Invoice attribute 28 E ECI BuyerAuthResult attribute 42 E
20. E ts Result Message ExtData gt HTTPCommitResult gt Vendor Partner TransactionResults leResults AccountUpdateResults HTTPCommitResults gt Vendor Partner Transaction TransactionResult gt ReceiptData Signature gt ResponseData Signature TransactionReceipts gt LPayResponse request_id CDATA IMPLIED gt lt ELEMENT XMLPayReceipt lt ELEMENT TransactionReceipts XMLPayReceiptt gt lt ELEMENT XMLPayRespons lt ATTLIST XMLPayResponse xmlns CDATA IMPLIED gt lt ATTLIST XMLPayResponse version CDATA IMPLIED gt lt ATTLIST XM lt ATTLIST XMLPayRespons response_id CDATA IMPLIED gt XMLPay Developer s Guide Transaction Results The transaction result status response RESULT is the first value returned from the Payflow SDK server This value indicates the overall status of the transaction attempt The response message RESPMSG provides a brief description for decline or error results e A value of 0 zero indicates that no errors occurred and the transaction was approved e A value greater than zero indicates a decline or error See Table C 1 e A value less than zero indicates that a communication error occurred In this case no transaction is attempted See Table C 1 TABLE C 1 Payflow transaction RESULT values and RESPMSG text RESULT RESPMSG and Explanation 0 Approved 1 User authentication failed Error is
21. Merchant is not enrolled for Buyer Authentication Service 3 D Secure Buyer Authentication Service 3 D Secure error response received Instead of receiving a PARes response to a Validate Authentication transaction an error response was received Buyer Authentication Service 3 D Secure error response is invalid An error response is received and the response is not well formed for a Validate Authentication transaction Buyer Authentication Service Invalid card type Buyer Authentication Service Invalid or missing currency code Buyer Authentication Service merchant status for 3D secure is invalid Buyer Authentication Service Validate Authentication failed missing or invalid PARES Buyer Authentication Service Validate Authentication failed PARES format is invalid XMLPay Developer s Guide 149 150 Transaction Results AVS Result Codes TABLE C 1 Payflow transaction RESULT values and RESPMSG text Continued RESULT RESPMSG and Explanation 1043 Buyer Authentication Service Validate Authentication failed Cannot find successful Verify Enrollment 1044 Buyer Authentication Service Validate Authentication failed Signature validation failed for PARES 1045 Buyer Authentication Service Validate Authentication failed Mismatched or invalid amount in PARES 1046 Buyer Authentication Service Validate Authentication failed Mismatched or invalid acquirer in PARES 1047 Buyer Authe
22. TABLE 3 1 Retail credit card transaction parameters Payflow SDK Parameter Description XMLPay Element COMMCARD Type of commercial card account number sent Card CommercialCard COUNTRYCODE Destination country code See the appendix ShipTo Address Country entitled ISO Country Codes in the Payflow Pro Developer s Guide COMPANYNAME Billing country code BillTo Address gt Company CUSTIP IP address of customer Invoice CustIP ECI Values returned from Buyer Auth transaction Card BuyerAuthResult ECI MERCHDESCR Description of product Invoice MerchantDescription MERCHSVC Merchant telephone number including area Invoice MerchantServiceNum code XXX XXX XXXX ORDERDATE Date of invoice Invoice Date RECURRING Recurring transaction Invoice Recurring UPDATEACTION Update action to take TransactionUpdate Action VERBOSITY Verbosity level of response desired Transaction Verbosity XMLPay Developer s Guide 47 48 XMLPay Elements Credit Card Transaction Parameters Credit Card Transaction Parameters The following parameters are accepted in Payflow SDK credit card transactions Retail Credit Card Transaction Parameters Table 3 2 lists retail credit card transaction parameters TABLE 3 2 Retail credit card transaction parameters Payflow SDK Parameter ABA ACCT ACCTTYPE AMT AUTHCODE AUTHTYPE CHKNUM CHKTYPE CITY COMMCARD COMMENTI COMMENT2 COUNTRY CUSTCODE CUSTREF CVV2
23. Visa MasterCard Amex JCB Discover DinersClub The server does not use this value but rather uses the card number to determine the card type CardNum Account number ExpDate Card expiration date YY YYMM or ISO 8601 CVNum Card verification number typically printed on the back of the card but not embossed on the front MagData Data located on the magnetic strip of a credit card NameOnCard Card holder s name as printed on the card ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema Check Check tender detail lt Check gt CheckType CheckNum MICR DL SS DOB ExtData lt Check gt Attribute Description CheckType Indicates the type of the check corporate personal or government CheckNum Account holder s next unused check number XMLPay Developer s Guide 33 34 XMLPay Syntax Core Structures Attribute Description MICR Magnetic Ink Check Reader MICR is the entire line of numbers at the bottom of the check It includes the transit number account number and check number DL Account holder s driver s license number XxNnnnnnnn format where Xx is the state code Nnnnnnnn is the number SS Account holder s social security number DOB Account holder s date of birth YY YYMMDD ISO 8601 ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema PayPal PayPal tender detail lt PayPal gt EMail
24. XML can easily produce large documents such as transaction logs and reports Benefits of XML The main benefits of XML are that it e Allows text annotation e Presents text data and content to applications as a structured document e Facilitates integration of diverse applications e In addition to these benefits XML is easy to e Read all text e Parse and validate e Search for content e Produce Well formed XML Document A well formed XML document conforms to XML syntax and must have e An XML processing instruction at the beginning prolog e Asingle root element e Matching case sensitive start and end tags for all elements e All XML elements properly nested e Attribute values in quotes XMLPay Developer s Guide XMLPay Overview Using XMLPay Example 1 lt xml version 1 0 lt Card gt lt CardType gt MasterCard lt CardType gt lt CardNumber gt 495576040004 lt CardNumber gt lt ExpDate gt 200011 lt ExpDate gt CVNum gt 828 lt CVNum gt lt Card gt Example 2 lt xml version 1 0 Items ID IDTI123 lt Item Number 1 lt Description gt Electric Toothbrush lt Description gt lt Quantity gt 1 lt Quantity gt lt UnitPrice gt 100 lt UnitPrice gt lt TotalAmt gt 100 lt TotalAmt gt lt Item gt lt Item Number 2 lt Description gt ToothPaste lt Description gt lt Quantity gt 20 lt Quantity gt lt UnitPrice gt 2 lt UnitPrice gt lt TotalAmt gt 40 l
25. gt lt simpleType gt lt element name lt complexType content lt sequence gt lt element ref lt element ref lt element ref lt sequence gt lt complexType gt lt element gt lt element name Capture lt complexType content lt sequence gt lt choice gt lt element name lt element name lt choice gt lt element ref lt element ref lt sequence gt lt complexType gt lt element gt lt element name Sale gt lt complexType content lt sequence gt lt element ref lt element ref lt element ref lt sequence gt lt complexType gt 104 Authorization gt elementOnly gt PayData PayDataAuth minOccurs 0 maxOccurs 1 gt ExtData minOccurs 0 maxOccurs unbounded gt elementOnly gt PNRefType gt PPRefType gt PNRef type PPRef type Invoice minOccurs 0 maxOccurs 1 ExtData minOccurs 0 maxOccurs unbounded gt elementOnly gt PayData gt PayDataAuth minOccurs 0 maxOccurs 1 gt ExtData minOccurs 0 maxOccurs unbounded gt XMLPay Developer s Guide XMLPay Schemas XMLPay Schema lt element gt lt element name Credit gt lt complexType content elementOnly gt lt sequence gt lt choice gt lt element name PNRef type PNRefType gt lt element name PPRef type PPRefType gt lt element ref Tender gt lt choice gt lt element ref
26. lt ELEMENT SettleDate PCDATA gt lt ELEMENT STAN PCDATA gt lt ELEMENT RRN PCDATA gt lt ELEMENT HostCode PCDATA gt lt ELEMENT HostResponse PCDATA gt Developer s Guide 141 XMLPay DTD lt ELEMENT ProcessorResult AVSResult CVResult CardSecure ResponseText AdditionalMessages SettleDate STAN RRN HostCode HostResponse ExtData gt lt ELEMENT Message PCDATA gt lt ELEMENT XMLData PCDATA gt lt ELEMENT FraudPreprocessResult Message XMLData gt lt ELEMENT FraudPostprocessResult Message XMLData gt lt ELEMENT IAVSResult PCDATA gt lt ELEMENT StreetMatch PCDATA gt lt ELEMENT ZipMatch PCDATA gt lt ELEMENT HostURL PCDATA gt lt ELEMENT OrigResult PCDATA gt lt ELEMENT TrStatus PCDATA gt lt ELEMENT ReceiptURL PCDATA gt lt ELEMENT ACHStatus PCDATA gt lt ELEMENT OrigPNRef PCDATA gt lt ELEMENT OrigMessage PCDATA gt lt ELEMENT FeeAmount PCDATA gt lt ELEMENT PayerStatus PCDATA gt lt ELEMENT PaymentType PCDATA gt lt ELEMENT PendingReason PCDATA gt lt ELEMENT CorrelationID PCDATA gt
27. lt element gt lt element name Transaction gt lt complexType content elementOnly gt lt sequence gt lt choice gt lt element ref Authorization gt lt element ref Capture gt lt element ref Sale gt lt element ref Credit gt lt element ref Void gt XMLPay Developer s Guide 103 XMLPay Schemas XMLPay Schema lt element ref ForceCapture gt lt element ref RepeatSale gt lt element ref GetStatus gt lt element ref VerifyEnrollment gt lt element ref ValidateAuthentication gt lt element ref lt element ref lt element ref lt element ref lt choice gt lt sequence gt Transact ionUpdate gt SetExpressCheckout gt GetExpressCheckout gt DoExpressCheckout attribute name Id type ID gt lt attribute name CustRef type ReferenceIdType lt element name Verbosity type VerbosityEnum minOccurs 0 maxOccurs 1 gt lt element name BrowserUserAgent type string minOccurs 0 maxOccurs 1 gt lt element name BrowserTime type string minOccurs 0 maxOccurs 1 gt lt element name BrowserCountryCode type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt simpleType name VerbosityEnum base string gt lt enumeration value Off gt lt enumeration value Low gt lt enumeration value Medium gt lt enumeration value High
28. type AuthCodeType minOccurs 0 maxOccurs 1 gt lt element name HostCode type HostCodeType minOccurs 0 maxOccurs 1 gt lt element name HostURL type uriReference minOccurs 0 maxOccurs 1 gt lt element name OrigResult type byte minOccurs 0 maxOccurs 1 gt lt element name TrStatus type StatusType minOccurs 0 maxOccurs 1 gt lt element name ReceiptURL type uriReference minOccurs 0 maxOccurs 1 gt lt element name ACHStatus type string minOccurs 0 maxOccurs 1 gt lt element name OrigPNRef type PNRefType minOccurs 0 maxOccurs 1 gt lt element name OrigMessage type string minOccurs 0 maxOccurs 1 gt lt element ref PayPalResult minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt lt attribute name Id type ID gt lt attribute name CustRef type ReferenceIdType lt attribute name Duplicate type boolean gt lt complexType gt lt element gt lt element name PayPalResult gt lt complexType content elementOnly gt lt sequence gt lt element name EMail type EMailType minOccurs 0 maxOccurs 1 gt lt element name PayerID type PayerIDType minOccurs 0 maxOccurs 1 gt lt element name Token type ECTokenType minOccurs 0 maxOccurs 1 gt lt element name P
29. type CVType minOccurs 0 maxOccurs 1 gt lt element name MagData type MagDataType minOccurs 0 maxOccurs 1 gt lt element name NameOnCard type NameType minOccurs 0 maxOccurs 1 gt lt element name CommercialCard type CommCardType minOccurs 0 maxOccurs 1 gt lt element ref BuyerAuthResult minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt lt complexType gt lt element gt lt simpleType name CardTypeEnum base string gt lt enumeration value Visa gt lt enumeration value MasterCard gt lt enumeration value Amex gt lt enumeration value JCB gt lt enumeration value Discover gt XMLPay Developer s Guide lt enumeration value XMLPay Schemas XMLPay Types Schema DinersClub gt lt enumeration value Switch gt lt enumeration value Solo gt lt simpleType gt lt simpleType name CardNumType base string gt lt maxLength value 19 gt lt simpleType gt lt simpleType name ExpDateType base string gt lt maxLength value 6 gt lt simpleType gt lt simpleType name CVType base string lt maxLength value 4 gt lt simpleType gt lt simpleType name CommCardType base string gt lt maxLength value 1 gt lt simpleType gt lt element name Debit gt lt complexType content e
30. 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Card Authorization Request lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Authorization gt lt PayData gt lt Invoice gt lt BillTo gt lt Address gt lt Street gt 123 4th street lt Street gt lt City gt San Jose lt City gt lt State gt CA lt State gt lt Zip gt 95032 lt Zip gt lt Count ry gt USA lt Country gt lt Address gt XMLPay Developer s Guide 71 XMLPay Examples Card Authorization Request lt BillTo gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt visa lt CardType gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200911 lt ExpDate gt lt NameOnCard gt lt Card gt lt Tender gt lt PayData gt lt Authorization gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Card Authorization Response lt xml version 1 0 encoding UTF 8 XMLPayRespon
31. 1 gt lt element name Memo type string minOccurs 0 maxOccurs 1 gt lt element name Custom type string minOccurs 0 maxOccurs 1 gt lt element name OrderDesc type string minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt element ref MerchantInfo minOccurs 0 maxOccurs 1 gt XMLPay Developer s Guide XMLPay Schemas XMLPay Types Schema lt element ref AdditionalAmounts minOccurs 0 maxOccurs 1 gt lt element name SKU type SKUType minOccurs 0 maxOccurs 1 gt lt element name CustomerHostName type string minOccurs 0 maxOccurs 1 gt lt element name CustomerBrowser type String minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name AdditionalAmounts gt lt complexType content elementOnly gt lt element name Amount1 type AdditionalAmount minOccurs 0 maxOccurs 1 gt lt element name Amount2 type AdditionalAmount minOccurs 0 maxOccurs 1 gt lt element name Amount3 type AdditionalAmount minOccurs 0 maxOccurs 1 lt element name Amount4 type AdditionalAmount minOccurs 0 maxOccurs 1 gt lt element name Amount5 type AdditionalAmount minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name MerchantInfo gt l
32. 71 e Card Capture Request on page 73 e Card Credit Request on page 74 e Card Credit Reference Credit Request on page 75 e Card Force Capture Request on page 76 e Card Sale Request on page 77 e Card Secure Request on page 79 e Card Status Request on page 80 e Card Void Request on page 81 e Check Sale Request on page 82 e Customer IP on page 83 e Express Checkout Authorization Transaction on page 84 5 Result Request on page 88 e Level 3 Invoice on page 89 e Line Item Sale Request on page 90 e Merchant Description and Merchant Service Number on page 92 e Processor Result on page 93 e Recurring Billing Profile on page 94 e Shipping Carrier and Shipping Method on page 96 e Transaction Update on page 97 XMLPay Developer s Guide 69 XMLPay Examples ACH Sale Request e ValidateAuthentication Request on page 98 e ValidateAuthentication Response on page 98 e VerifyEnrollment Request on page 99 e VerifyEnrollment Response on page 99 ACH Sale Request lt xml version 1 0 encoding UTF 8 XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Sale gt lt PayData gt lt Invoice gt
33. DLState lt ELEMENT CardType PCDATA gt lt ELEMENT CardNum PCDATA gt lt ELEMENT ExpDate PCDATA gt lt ELEMENT CVNum PCDATA gt lt ELEMENT MagData PCDATA gt lt ELEMENT NameOnCard PCDATA gt lt ELEMENT CommercialCard PCDATA gt lt ELEMENT Status PCDATA gt lt ELEMENT AuthenticationId PCDATA gt BankName SellerMsg BusName ACH AcctType AcctNum Prenote AuthType CheckNum TermCity ExtData gt XMLPay Developer s Guide XMLPay DTD m lt ELEMENT PAReq PCDATA gt lt ELEMENT ACSUrl PCDATA gt lt ELEMENT PCDATA gt lt ELEMENT PCDATA gt lt ELEMENT XID PCDATA gt lt ELEMENT BuyerAuthResult Status AuthenticationId PAReq ACSUr1 CAVV lt ELEMENT Card CardType CardNum ExpDate CVNum MagData NameOnCard CommercialCard BuyerAuthResult ExtData gt lt ELEMENT CheckType PCDATA gt lt ELEMENT AllianceNum PCDATA gt lt ELEMENT MICR PCDATA gt lt ELEMENT CustomerType PCDATA gt lt ELEMENT BankState PCDATA gt lt ELEMENT BankAcctType PCDATA gt lt ELEMENT Check CheckType AllianceNum CheckNum MICR DL SS DOB DLState AuthType CustomerType BankName BankState BankAcctT
34. Guide 57 XMLPay Elements Buyer Authentication Transaction Parameters TABLE 3 3 Level 3 commercial credit card transaction parameters Payflow SDK Parameter Description XMLPay Element L_VATAXAMT Value added tax amount line item Level3Item Value AddedTax L_VATAXEXEMPTCODE Value added tax exemption code Level31Item line item ValueAddedTax L VATAXPERCENT Value added tax rate line item Level3Item ValueAddedTax Buyer Authentication Transaction Parameters Table 3 4 lists the buyer authentication transaction parameters TABLE 3 4 Transaction response parameters Payflow SDK Parameter Description XMLPay Element AUTHENTICATION_ID Values returned from Buyer Auth BuyerAuthResult transaction AuthenticationId AUTHENTICATION STATUS Values returned from Buyer Auth BuyerAuthResult Status transaction CAVV Values returned from Buyer Auth BuyerAuthResult transaction UCAF Values returned from Buyer Auth BuyerAuthResult gt CAVV transaction XID Values returned from Buyer Auth BuyerAuthResult 5 XID transaction Credit Card Transaction Response Parameters Table 3 5 lists the parameters returned for a credit card transaction TABLE 3 5 Transaction response parameters Payflow SDK Parameter Description XMLPay Element ADDLMSGS Additional messages ProcessorResult AdditionalMessages AMEXID Unique identifier to track ProcessorResult American Express transactions AMEXID 58 XMLPay Developer
35. Invoice minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name Void gt lt complexType content elementOnly gt lt sequence gt lt choice gt lt element name PNRef type PNRefType gt lt element name PPRef type PPRefType gt lt choice gt lt element name Note type string minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt lt complexType gt lt element gt lt element name ForceCapture gt lt complexType content elementOnly gt lt sequence gt lt element ref PayData gt lt element ref PayDataAuth minOccurs 0 maxOccurs 1 gt lt element name AuthCode type AuthCodeType gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name RepeatSale gt lt complexType content elementOnly gt lt sequence gt lt element name PNRef type PNRefType gt lt element ref Invoice minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name GetStatus gt lt complexType content elementOnly gt lt sequence gt lt element name PNRef type PNRefType
36. NameOnCard gt lt Card gt lt Tender gt lt PayData gt lt Authorization gt lt Transaction gt lt Transactions gt 96 Developer s Guide XMLPay Examples Transaction Update lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Transaction Update lt xml version 1 0 encoding UTF 8 XMLPayRequest Timeout 40 xmlns http www paypal com XMLPay gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt TransactionUpdate gt lt PNRef gt V53A12345678 lt PNRef gt lt Action gt Approve lt Action gt lt TransactionUpdate gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt lt xml version 1 0 encoding UTF 8 lt XMLPayResponse gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt Message gt Approved lt Message gt lt PNRef gt V63A09910356 lt PNRef gt lt AuthCode gt 747PNI lt AuthCode gt lt HostCode gt 00 lt Hos
37. OrigProfileID type ProfileIDType minOccurs 0 maxOccurs 1 gt lt element name PaymentNum type int minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt lt complexType gt lt element gt lt element name RPPaymentResult lt complexType content elementOnly gt lt sequence gt lt element name PaymentNum type int gt lt element name PNRef type PNRefType minOccurs 0 maxOccurs 1 gt lt element name TransTime type dateTime minOccurs 0 maxOccurs 1 gt lt element name Result type int gt lt element name Tender type TenderTypeEnum minOccurs 0 maxOccurs 1 gt lt element name Amt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name TransState type string minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt attribute name Id type ID gt lt complexType gt lt element gt lt element name RecurringProfileResult gt lt complexType content elementOnly gt lt sequence gt lt element name Result type int gt lt element name Message type string minOccurs 0 maxOccurs 1 gt lt element name ProfileID type ProfileIDType minOccurs 0 maxOccurs 1 gt 112 XMLPay Developer s Guide XMLPay Schemas XMLPay Schema lt element nam
38. ShipTo Address Street2 ShipTo Address Zip Item TaxAmt PayPal Token 62 XMLPay Developer s Guide PayPal Express Checkout Response Transaction Parameters XMLPay Elements PayPal Express Checkout Response Transaction Parameters Table 3 7 lists the PayPal Express Checkout response transaction parameters TABLE 3 8 Mapping Express Checkout parameters to XMLPay parameters Express Checkout Parameter CUSTOM EMAIL FEEAMT INVNUM PAYERID PAYERSTATUS PHONENUM PPREF SHIPTOBUSINESS SHIPTOCITY SHIPTOCOUNTRY SHIPTOCOUNTRYCODE SHIPTOSTATE SHIPTOZIP TOKEN Description Free form field for your own use such as a tracking number or other value you want PayPal to return in the Get Express Checkout Details response Customer s email address PayPal fee amount charged for the transaction Your own unique invoice or tracking number Unique encrypted PayPal customer account identification number Status of customer Account holder s telephone number Unique transaction ID of the payment Customer s business name Name of ship to city Ship to country code See the appendix entitled ISO Country Codes in the Payflow Pro Developer s Guide Customer s country of residence in the form of ISO standard 3166 two character country codes Name of ship to state or province U S ship to ZIP code or other country specific postal code Value returned in Set Express Checkout resp
39. TrackingNumber gt lt Delivery gt lt Date gt 20030714 lt Date gt lt Time gt 12 00 lt Time gt lt Delivery gt lt UNSPSCCode gt 54 10 15 05 lt UNSPSCCode gt lt Item gt lt Item Number 2 gt lt SKU gt 2222 lt SKU gt UPC gt 8888 lt UPC gt Description gt Gizmo lt Description gt Quantity gt 5 lt Quantity gt UnitOfMeasurement INQ UnitOfMeasurement UnitPrice gt 9 99 lt UnitPrice gt DiscountAmt gt 2 50 lt DiscountAmt gt FreightAmt gt 3 00 lt FreightAmt gt HandlingAmt gt 2 50 lt HandlingAmt gt TotalAmt gt 52 95 lt TotalAmt gt PickUp gt lt Address gt lt Street gt 500 Main St lt Street gt lt City gt Anytown lt City gt lt State gt NY lt State gt lt Zip gt 67890 lt Zip gt lt Country gt US lt Country gt lt Address gt lt Time gt 09 00 lt Time gt lt Date gt 20030628 lt Date gt lt RecordNumber gt 13579 lt RecordNumber gt lt PickUp gt lt TrackingNumber gt XYZ7890 lt TrackingNumber gt lt Delivery gt Date gt 20030711 lt Date gt lt Time gt 09 00 lt Time gt lt Delivery gt lt UNSPSCCode gt 54 10 16 05 lt UNSPSCCode gt lt Item gt lt Items gt lt TaxAmt gt 13 47 lt TaxAmt gt lt NationalTaxIncl gt false lt NationalTaxIncl gt lt TotalAmt gt 167 42 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt mastercard lt CardType gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200912 lt ExpDate gt lt Card gt
40. Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Service Not Available lt StreetMatch gt lt ZipMatch gt Service Not Available lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt V53A09206640 lt PNRef gt lt AuthCode gt 747PNI lt AuthCode gt lt HostCode gt 00 lt HostCode gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Developer s Guide 73 XMLPay Examples Card Credit Request Card Credit Request lt xml version 1 0 encoding utf 8 gt lt XMLPayRequest Timeout 30 version 2 0 xmins http www paypal com XMLPay gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt VeriSign lt Partner gt lt Transactions gt lt Transaction gt lt Credit gt lt PayData gt Invoice lt TotalAmt gt 10 00 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt MasterCard lt CardType gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200911 lt ExpDate gt lt Card gt lt Tender gt lt PayData gt lt Credit gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt
41. Void gt lt enumeration value ForceCapture gt lt enumeration value RepeatSale gt lt enumeration value GetStatus gt lt simpleType gt lt element name ACH gt lt complexType content elementOnly gt lt sequence gt lt element name AcctType type AcctTypeEnum minOccurs 0 maxOccurs 1 gt lt element name AcctNum type AcctNumType minOccurs 0 maxOccurs 1 gt lt element name ABA type ABAType minOccurs 0 maxOccurs 1 gt lt element name Prenote type boolean minOccurs 0 maxOccurs 1 gt lt element name AuthType type AuthType minOccurs 0 maxOccurs 1 gt lt element name CheckNum type CheckNumType minOccurs 0 maxOccurs 1 gt lt element name TermCity type string minOccurs 0 maxOccurs 1 gt lt element name TermState type string minOccurs 0 maxOccurs 1 gt lt element name DL type DLType minOccurs 0 maxOccurs 1 gt lt element name SS type SSType minOccurs 0 maxOccurs 1 gt lt element name DOB type date minOccurs 0 maxOccurs 1 gt lt element name DLState type DLStateType minOccurs 0 maxOccurs 1 gt lt element name BankName type BankNameType minOccurs 0 maxOccurs 1 gt lt element name SellerMsg type SellerMsgType minOccurs 0 maxOccurs 1 gt XMLPay Developer s Guide 125 126 X
42. a delegated processing model the merchant of record may be different from the submitting party Partner Identifies the submitting party RecurringProfile Defined on page 22 RequestAuth Defined on page 21 Timeout The value of this attribute is ignored RecurringProfile lt Profile Id CustRef gt Add Reactivate Payment Inquiry lt Profile gt Attribute Description Id Optional attribute that tracks the transaction through the payment processing network The submitting merchant generates this transaction identifier which should be unique among all transactions submitted by that merchant Id need not be globally unique across merchants since the payment processing network interprets it within the context of the merchant associated with the transaction If an Id attribute is provided in a transaction it will be included in the matching TransactionResult in the resultant XMLPayResult Similarly CustRef is a merchant generated ID identifying a specific customer of this merchant and associating it with this transaction 22 Developer s Guide XMLPay Syntax XMLPayRequest Document Recurring Profiles Add Recurring Profile Add a new recurring profile either by sending all data required to define the profile or by converting an existing transaction into a profile lt Add gt RPData Tender lt Add gt Attribute Description RPData Describes r
43. attribute 44 RPData attribute 36 NameOnCard Card attribute 33 NationalTaxIncl Invoice attribute 28 NextPayment RecurringProfileResult attribute 44 Norwest transaction parameters 60 NoShipping PayPal attribute 35 NotifyURL PayPal attribute 35 Number Item attribute 29 NumFailedPayments XMLPay Developer s Guide RecurringProfileResult attribute 45 NVP tags passing unsupported 95 O OptionalTrans RPData attribute 37 OptionalTransAmt RPData attribute 37 OrderDesc Invoice attribute 28 OrigInvNum Invoice attribute 27 OrigMessage TransactionResult attribute 39 OrigPNRef TransactionResult attribute 39 OrigProfileID RPData attribute 37 OrigResult TransactionResult attribute 39 PageStyle PayPal attribute 35 PAReq BuyerAuthResult attribute 42 PARes ValidateAuthentication transaction attribute 21 Partner RecurringProfile transaction attribute 22 XMLPayRequest attribute 16 XMLPayResponse attribute 42 XMLPayResponse transaction attribute 38 passing values as extended data 95 Password UserPass attribute 21 PayData authorization transaction attribute 17 ForceCapture transaction attribute 20 sale transaction attribute 17 VerifyEnrollment transaction attribute 20 PayData attributes 25 PayDataAuth element 25 PayerID PayPalResult attribute 41 157 158 Payerld PayPal attribute 34 PayerStatus PayPalResult attribute 41 Payflow Pro ACH transaction parameters 60 buyer authentication transaction parameter
44. elementOnly gt lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element ref Address minOccurs 0 maxOccurs 1 gt lt element name EMail type EMailType minOccurs 0 maxOccurs 1 gt lt element name Phone type PhoneNumberType minOccurs 0 maxOccurs nine lt element name Fax type PhoneNumberType minOccurs 0 maxOccurs lt element name URL type uriReference minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name BillTo minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name CustomerId type UserIdType minOccurs 0 maxOccurs ns lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element ref Address minOccurs 0 maxOccurs 1 gt lt element name EMail type EMailType minOccurs 0 maxOccurs 1 lt element name Phone type PhoneNumberType minOccurs 0 maxOccurs ms lt element name Phone2 type PhoneNumberType minOccurs 0 maxOccurs TINS lt element name Fax type PhoneNumberType minOccurs 0 maxOccurs m lt element name CustCode type CustCodeType minOccurs 0 maxOccurs WS lt element name PONum type PONumType minOccurs 0 maxOccurs 1 gt lt element name TaxExempt type boolean minOccurs 0 maxOccurs 1 gt lt element n
45. gt lt EMail gt a com lt EMail gt lt OptionalTrans gt Sale lt OptionalTrans gt lt OptionalTransAmt gt 12 lt OptionalTransAmt gt lt BillTo gt lt Address gt XMLPay Developer s Guide 95 XMLPay Examples Shipping Carrier and Shipping Method lt Street gt 123 4th street lt Street gt lt City gt San Jose lt City gt lt State gt CA lt State gt lt Zip gt 95032 lt Zip gt lt Address gt lt BillTo gt lt RPData gt lt Add gt lt RecurringProfile gt lt RecurringProfiles gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Shipping Carrier and Shipping Method lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Authorization gt lt PayData gt lt Invoice gt lt ShipCarrier gt UPS lt ShipCarrier gt lt ShipMethod gt Next Day lt ShipMethod gt lt NationalTaxIncl gt false lt NationalTaxIncl gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt visa lt CardType gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200911 lt ExpDate gt lt
46. gt lt element name Quantity type float minOccurs 0 maxOccurs 1 gt lt element name UnitOfMeasurement type UnitOfMeasurementType minOccurs 0 maxOccurs 1 gt lt element name UnitPrice CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExtAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name DiscountAmt type CurrencyAmount minOccurs 0 maxOccurs gt lt element name TaxAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name TaxRate type TaxRateType minOccurs 0 maxOccurs 1 gt lt element name TotalAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt element ref Delivery minOccurs 0 maxOccurs 1 gt lt element ref PickUp minOccurs 0 maxOccurs 1 gt lt element name CostCenterNumber type CostCenterType minOccurs 0 maxOccurs 1 gt lt element name TrackingNumber type TrackingType minOccurs 0 maxOccurs 1 gt lt element name FreightAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name HandlingAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ShipmentNumber type ShipmentType minOccurs 0 maxOccurs 1 gt lt element name UNSPSCCode type UNSPSCType minOccurs 0 maxOcc
47. lt Authorization gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Express Checkout Authorization Transaction Set Express Checkout Request lt xml version 1 0 encoding UTF 8 XMLPayRequest Timeout 30 version 2 1 gt lt RequestData gt lt Vendor gt Vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt SetExpressCheckout gt lt Authorization gt lt PayData gt lt Invoice gt lt ShipTo gt lt Address gt lt Street gt 123 4th street lt Street gt lt City gt San Jose lt City gt lt State gt CA lt State gt lt Zip gt 95032 lt Zip gt lt Count ry gt USA lt Country gt lt Address gt lt ShipTo gt lt TotalAmt gt 10 23 lt TotalAmt gt lt ExtData Name VERBOSITY Value HIGH gt lt Invoice gt lt Tender gt lt PayPal gt 84 Developer s Guide XMLPay Examples Express Checkout Authorization Transaction lt EMail gt emailname paypal com lt EMail gt lt ReturnURL gt http www ebay com lt ReturnURL gt lt CancelURL gt http www yahoo com lt CancelURL gt lt PayPal gt lt Tender gt lt PayData gt lt Authorization gt lt SetExpressCheckout gt lt Transaction gt lt Transactions gt lt RequestData
48. lt InvNum gt 1 lt InvNum gt lt Date gt 20020208 lt Date gt lt BillTo gt lt Name gt billtoname lt Name gt lt TaxExempt gt t rue lt TaxExempt gt lt 111 gt lt NationalTaxIncl gt true lt NationalTaxIncl gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Invoice gt lt Tender gt lt ACH gt lt AcctType gt C lt AcctType gt lt AcctNum gt 6355059797 lt AcctNum gt lt ABA gt 091000019 lt ABA gt lt Prenote gt false lt Prenote gt lt ACH gt lt Tender gt lt PayData gt lt Sale gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt 70 Developer s Guide XMLPay Examples Card Authorization Request lt XMLPayRequest gt ACH Sale Response lt xml version 1 0 encoding UTF 8 XMLPayResponse xmlns http www paypal com XMLPay gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Service Not Requested lt StreetMatch gt lt ZipMatch gt Service Not Requested lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt VTHD55395864 lt PNRef gt lt OrigResult gt
49. lt complexType content elementOnly gt lt element ref TransactionResult minOccurs 1 maxOccurs unbounded gt lt complexType gt lt element gt lt element name RecurringProfileResults gt lt complexType content elementOnly gt lt element ref RecurringProfileResult minOccurs 1 maxOccurs unbounded gt lt complexType gt lt element gt lt element name AccountUpdateResults gt lt complexType content elementOnly gt lt element ref AccountUpdateResult minOccurs 1 maxOccurs unbounded gt lt complexType gt lt element gt lt element name HTTPCommitResults gt lt complexType content elementOnly gt lt element ref HTTPCommitResult minOccurs 1 maxOccurs unbounded gt lt complexType gt lt element gt lt choice gt lt sequence gt lt complexType gt lt element gt lt element name XMLPayReceipt lt complexType content elementOnly gt lt sequence gt lt element ref ReceiptData gt lt element ref Signature minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name ReceiptData lt complexType content elementOnly gt lt sequence gt lt element name Vendor type UserIdType lt element name Partner type UserIdType gt lt element ref Transaction gt lt element ref TransactionResult gt lt sequence gt lt complexType gt
50. name AddressOverride type boolean minOccurs 0 maxOccurs 1 gt lt element name LocaleCode type string minOccurs 0 maxOccurs 1 gt lt element name PageStyle type string minOccurs 0 maxOccurs 1 gt lt element name HeaderImage type string minOccurs 0 maxOccurs 1 gt lt element name HeaderBorderColor type string minOccurs 0 maxOccurs 1 gt lt element name HeaderBackColor type string minOccurs 0 maxOccurs 1 gt lt element name PayflowColor type string minOccurs 0 maxOccurs 1 gt lt element name ButtonSource type string minOccurs 0 maxOccurs 1 gt lt element name MerchantSessionID type string minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt lt complexType gt lt element gt lt simpleType name CheckTypeEnum base string gt lt enumeration value Personal gt lt enumeration value Corporate gt lt enumeration value Government gt lt simpleType gt lt simpleType name CheckNumType base string gt lt maxLength value 8 gt lt simpleType gt lt simpleType name MICRType base string gt lt maxLength value 35 gt lt simpleType gt lt simpleType name DLType base string gt lt maxLength value 35 gt lt simpleType gt lt simpleType name DLStateType base string gt lt maxLength value
51. s Guide Credit Card Transaction Response Parameters TABLE 3 5 Transaction response parameters XMLPay Elements Payflow SDK Parameter AUTHCODE AVSADDR AVSZIP BALAMT CARDSECURE CVV2MATCH HOSTCODE IAVS PNREF RESPMSG PROCAVS PROCCVV2 PROCCARDSECURE RRN RESPTEXT RESULT SETTLE_DATE STAN Description Returned for Sale Authorization AVS address verification response AVS ZIP code verification response Balance on a pre paid stored value card for American Express CAPN transactions Raw card secure value Result of the card security code CVV2 check Raw response from processor IAVS result code Reference ID a unique number that identifies the transaction The response message returned with the transaction result Raw processor AVS result code Raw processor CVV2 result code Raw card secure value from processor Retrieval reference number typically not passed to merchant Text response returned from processor for example Approval The outcome of the attempted transaction Date transaction will settle Unique PayPal generated transaction ID for processor typically not passed to merchant XMLPay Element AuthCode AVSResult AVSResult ProcessorResult BalanceAmount TransactionResult CardSecure CVResult ProcessorResult HostCode TransactionResult gt IAVSResult PNRef Message ProcessorResult AV SResult ProcessorResult CV Result Pro
52. simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleType gt UNSPSCType base string gt value 30 gt CatalogType base string gt value 20 gt RecordType base string gt value 30 gt CostCenterType base value 30 string gt TrackingType base value 30 gt string gt ShipmentType base value 30 gt string gt InvNumType base value 127 gt string gt PONumType base value 25 gt string gt DescType base value 160 gt string gt CommentType base string gt value 255 gt XMLPay Developer s Guide XMLPay Schemas XMLPay Types Schema lt element name Item gt lt complexType content elementOnly gt lt sequence gt lt element name SKU type SKUType minOccurs 0 maxOccurs 1 gt lt element name UPC type UPCType minOccurs 0 maxOccurs 1 gt lt element name Description type CommentType minOccurs 0 maxOccurs 1
53. the Set Express Checkout request PPRef Unique transaction ID of the payment If the request ACTION was A Authorization you should store the value of PPREF if you need to research a specific transaction with PayPal FeeAmount PayPal fee amount charged for the transaction PayerStatus Status of payer PaymentType Indicates whether the payment is instant or delayed PendingReason The reason the payment is pending Values are none echeck intl multi currency verify other and completed Custom Free form field for your own use InvNum Merchant invoice number The merchant invoice number is used for authorizations and settlements and depending on your merchant bank will appear on your customer s credit card statement and your bank reconciliation report If you do not provide an invoice number the transaction ID PNREF will be submitted Phone Account holder s telephone number ShipTo Name Address Information about the shipping addresses if different from BillTo EMail Phone Phone2 Fax and ShipToEU CorrelationID Value used for tracking this Direct Payment transaction The XMLPayResponse Document Recurring Profiles lt XMLPayResponse gt lt ResponseData gt Vendor Partner lt RecurringProfileResults gt RecurringProfileResult lt RecurringProfileResults gt lt ResponseData gt Signature TransactionReceipts XMLPay Developer s Guide 41 ESSE XMLPay Syntax The XMLPayResponse Docume
54. uses XMLPay to communicate business focused purchasing information such as level 3 corporate purchase card data to a payment gateway B Tradin Il uyers Exchang Sellers XMLPay Payment Gateway Financial networks lt i pement In this way the Trading Exchange links payment execution to other XML based communications between Buyers and Sellers such as Advance Shipping Notice delivery Purchase Order communication or other B2B communication functions XMLPay Messaging The highest level XMLPay structures represent payment transaction requests and responses 12 XMLPay Developer s Guide XMLPay Overview um XMLPay Messaging XMLPayRequest Payment transactions are submitted one or more at a time as XMLPayRequest documents The high level structure of a request looks like this XMLPayRequest lt RequestData gt lt MerchantId gt lt Transactions gt Pi lt RequestAuth gt Merchant ID identifies the merchant of record for the transaction within the target payment processing network The merchant of record may be different from the submitting party in a delegated processing model Transactions is the list of payment transactions to be processed XMLPay supports up to 32 transactions per XMLPay document submission RequestAuth is an optional structure used to authenticate the submitting party in the absence of transport level authentication See
55. 2 gt lt simpleType gt lt simpleType name CustomerType base string gt lt maxLength value 10 gt lt simpleType gt lt simpleType name BankNameType base string gt lt maxLength value 50 gt lt simpleType gt lt simpleType name BankStateType base string gt lt maxLength value 2 gt lt simpleType gt 128 Developer s Guide XMLPay Schemas XMLPay Types Schema lt simpleType name BankAcctType base string gt lt maxLength value 10 gt lt simpleType gt lt simpleType name SSType base string gt lt maxLength value 35 gt lt simpleType gt lt complexType name AuthInfoType content elementOnly gt lt sequence gt lt element name UserId type UserIdType lt element name Password type PasswordType minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt simpleType name UserldType base string gt lt maxLength value 12 gt lt simpleType gt lt simpleType name CustCodeType base string gt lt maxLength value 17 gt lt simpleType gt lt simpleType name PasswordType base string gt lt maxLength value 12 gt lt simpleType gt lt simpleType name PNRefType base string gt lt maxLength value 12 gt lt simpleType gt lt simpleType name PPRefType base string gt lt maxLength value 31 gt lt simpleType gt
56. 2 see Business to Business B2C 11 BillFrom Name Invoice attribute 27 BillTo RecurringProfileResult attribute 45 RPData attribute 37 41 BillTo Name Invoice attribute 27 RPData attribute 37 BillTo PONum Invoice attribute 27 BillTo TaxExempt Invoice attribute 27 business to business 12 Business to Consumer see B2C business to consumer 11 ButtonSource PayPal attribute 35 buyer authentication transaction parameters 58 buyer authentication transactions profile 65 BuyerAuthResult 153 154 TransactionResult attribute 39 BuyerAuthResult attributes 42 C cancel recurring profile attributes 23 cancelling a recurring profile 23 capture transaction attributes 17 19 Card attributes 33 card authorization request example 71 card capture request example 73 card capture response example 73 card credit request example 75 card credit response example 75 card force capture request example 76 card force capture response example 77 card sale request example 77 card sale response example 78 card secure request example 79 card status request example 80 card status response example 80 card void request example 81 card void response example 81 CardNum Card attribute 33 CardSecure TransactionResult attribute 39 CardType Card attribute 33 CatalogNumber Item attribute 30 CAVV BuyerAuthResult attribute 42 Check attributes 33 34 check sale request example 82 check sale response example 83 check transactions 67 CheckNum
57. 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Void gt lt PNRef gt V54A09206691 lt PNRef gt lt Void gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Card Void Response lt xml version 1 0 encoding UTF 8 lt XMLPayResponse gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Service Not Requested lt StreetMatch gt lt ZipMatch gt Service Not Requested lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt V54A09206748 lt PNRef gt lt HostCode gt 00 lt HostCode gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt XMLPay Developer s Guide 81 Examples Check Sale Request Check Sale Request lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns
58. 7Signature PCDATA gt lt ELEMENT PayDataAuth PKCS7Signature Signature gt lt ELEMENT Vendor PCDATA gt lt ELEMENT Partner PCDATA gt lt ELEMENT Authorization PayData PayDataAuth ExtData gt lt ELEMENT PNRef PCDATA gt lt ELEMENT PPRef PCDATA gt lt ELEMENT Capture PNRef PPRef Invoice ExtData gt lt ELEMENT Sale PayData PayDataAuth ExtData gt lt ELEMENT Credit PNRef PPRef Tender Invoice ExtData gt lt ELEMENT Note PCDATA gt lt ELEMENT Void PNRef PPRef Note ExtData gt lt ELEMENT AuthCode PCDATA gt lt ELEMENT ForceCapture PayData PayDataAuth AuthCode ExtData 138 XMLPay Developer s Guide XMLPay DTD m lt ELEMENT RepeatSale PNRef Invoice ExtData lt ELEMENT GetStatus PNRef ExtData gt lt ELEMENT VerifyEnrollment PayData ExtData gt lt ELEMENT PARes PCDATA gt lt ELEMENT ValidateAuthentication PARes ExtData gt lt ELEMENT Action PCDATA gt lt ELEMENT RMSID PCDATA gt lt ELEMENT TransactionUpdate PNRef Action RMSID ExtData gt lt ELEMENT SetExpressCheckout Authorization Sale ExtData gt lt ELEMENT GetEx
59. ARes The authentication data returned by Issuer s ACS ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema RequestAuth The RequestAuth element provides authentication of the requestor through either a username and password using UserPass or a digital signature using Signature lt RequestAuth gt UserPass Signature lt RequestAuth gt In the case of a digital signature the W3C XML Signature syntax is used and the signature is executed over the RequestData UserPass lt UserPass gt User UserDomain Password lt UserPass gt Attribute Description User String identifier assigned to a user UserDomain Names a partner or a vendor under whose auspice a transaction is being submitted Password User s password string XMLPay Developer s Guide 21 ESSE XMLPay Syntax The XMLPayRequest Document Recurring Profiles The XMLPayRequest Document Recurring Profiles A RecurringProfile transaction defines a scheduled payment that enables you to automatically bill your customers at regular intervals XMLPayRequest Timeout 30 version 2 0 gt lt RequestData gt Vendor Partner lt RecurringProfiles gt RecurringProfile lt RecurringProfiles gt lt RequestData gt RequestAuth lt XMLPayRequest gt Attribute Description Vendor Identifies the merchant of record for the transaction within the target payment processing network In
60. BankNameType minOccurs 0 maxOccurs 1 gt lt element name BankState type BankStateType minOccurs 0 maxOccurs 1 gt lt element name BankAcctType type BankAcctType minOccurs 0 maxOccurs 1 gt lt element name AcctNum type AcctNumType minOccurs 0 maxOccurs 1 gt lt element name ABA type ABAType minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt element ref Address minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name PayPal gt XMLPay Developer s Guide 127 XMLPay Schemas XMLPay Types Schema lt complexType content elementOnly gt lt sequence gt lt element name EMail type EMailType minOccurs 0 maxOccurs 1 gt lt element name PayerID type PayerIDType minOccurs 0 maxOccurs 1 gt lt element name Token type ECTokenType minOccurs 0 maxOccurs 1 gt lt element name ReturnURL type uriReference minOccurs 0 maxOccurs 1 gt lt element name CancelURL type uriReference minOccurs 0 maxOccurs 1 gt lt element name NotifyURL type uriReference minOccurs 0 maxOccurs 1 gt lt element name ReqConfirmShipping type boolean minOccurs 0 maxOccurs 1 gt lt element name NoShipping type boolean minOccurs 0 maxOccurs 1 gt lt element
61. Chapter 2 XMLPay Syntax for a detailed description of request documents XMLPayResponse Each XMLPayRequest submission produces a corresponding XMLPayResponse document containing results for each submitted transaction request The high level structure of a response looks like this Developer s Guide 13 XMLPay Overview XMLPay Messaging NOTE Signature and TransactionReceipts are not supported on the Payment server lt XMLPayResponse gt lt ResponseData gt lt MerchantId gt lt TransactionResults gt i Signature I 1 1 1 gt TransactionReceipts See Chapter 2 XMLPay Syntax for a detailed description of response documents 14 XMLPay Developer s Guide XMLPay Syntax This chapter presents the syntax for transaction requests and responses using a simplified notation e Appendix A XMLPay Schemas provides the complete syntax expressed W3C XML schema notation e Appendix B XMLPay DTD provides a document type definition DTD representation of the schema Syntax Notation The following example presents the notation used to describe XMLPay document lt Example gt element optionalElement alternativeElement1 alternativeElement2 element element lt Example gt element Indicates the occurrence of a possibly complex XML element for example lt element gt lt elem
62. DESC Description Bank routing number The credit card or purchase card number Type of the bank account Amount in US dollars The approval code obtained over the phone from the processing network Used only when processing Voice Authorization transactions Method of authorization Check number Type of the bank account Cardholder s city Type of commercial card account number sent Merchant defined value for reporting and auditing purposes Merchant defined value for reporting and auditing purposes Destination country code See the appendix entitled ISO Country Codes in the Payflow Pro Developer s Guide Customer code or customer reference ID Merchant defined identifier for reporting and auditing purposes The 3 or 4 digit Card Security Code CSC found on the back of a credit card General description of the transaction XMLPay Element ABA AcctNum or CardNum AcctType or CheckType Invoice TotalAmt AuthCode AuthType CheckNum AcctType City Card CommercialCard Comment ExtData Country CustCode CustRef CVNum Item Description XMLPay Developer s Guide Credit Card Transaction Parameters TABLE 3 2 Retail credit card transaction parameters XMLPay Elements Payflow SDK Parameter DESC1 4 DISCOUNT DL DOB DSGUID DUTYAMT EMAIL ENDTIME EXECUTOR EXPDATE FIRSTNAME FREIGHTAMT HANDLINGAMT INVNUM INVOICEDATE L_AMT L_CARRIERSHIPMENTNUM L_CATA
63. EXEMPTCODE State goods tax exempt code Level3Invoice gt StateGoodsTax STATEGOODSTAXPERCENT State goods tax rate Level3Invoice gt StateGoodsTax STATETAXAMT State tax amount Level3Invoice State Tax STATETAXEXEMPTCODE State tax exempt code Level3Invoice gt StateTax STATETAXPERCENT State tax rate Level3Invoice State Tax STATESERVICESTAXAMT State services tax amount Level3Invoice StateServicesTax STATESERVICESTAXEXEMPTCODE State services tax exempt code Level3Invoice gt StateServicesTax XMLPay Developer s Guide 55 56 XMLPay Elements Credit Card Transaction Parameters TABLE 3 3 Level 3 commercial credit card transaction parameters Payflow SDK Parameter STATESERVICESTA XPERCENT VATAXAMT VATAXEXEMPTCODE VATAXPERCENT VATREGNUM Description State services tax rate Value added tax amount Value added tax exempt code Value added tax rate Value added tax registration number XMLPay Element Level3Invoice gt StateServicesTax Level3Invoice ValueAddedTax Level3Invoice ValueAddedTax Level3Invoice ValueAddedTax Level3Invoice Value AddedTaxRegNum Line item Transactions Identifies one item in a transaction with multiple items The number of the item is appended to the parameter L_ALLTAXAMT L_ALLTAXEXEMPTCODE L_ALLTAXPERCENT L_CITYTAXAMT L_CITYTAXEXEMPTCODE L_CITYTAXPERCENT L_COUNTYSALESTAXAMT L_COUNTYSALESTAXEXEMPTCODE L_COUNTYSALESTAXPERCENT L_COUNTY
64. LOGNUM L_COSTCENTERNUM L_COST L_DELIVERYDATE L_DELIVERYTIME L_DESC L_DISCOUNT L_FREIGHTAMT Description Up to 4 additional lines describing the transaction Discount amount on total sale Cardholder s driver s license number Cardholder s date of birth Transaction ID Duty or import tax Email address Specifies the end of the time period during which the transaction specified by the CUSTREF occurred Optional for Inquiry transactions when using CUSTREF to specify the transaction Names a partner or a vendor under whose auspice a transaction is being submitted Expiration date of the credit card The cardholder s name Freight amount Handling amount Merchant invoice number Invoice date Total line item amount including tax and discount Shipment number Merchant s product code Purchaser s department number to which the item will be billed Cost per item excluding tax Delivery date Delivery time Item description Discount per line item Line item freight amount XMLPay Element Item Description DiscountAmt DL DOB Id DutyAmt Email ExtData UserDomain ExpDate Name or NameOnCard FreightAmt or ShippingAmt Item HandlingAmt Invoice InvNum Date Invoice TotalAmt ShipmentNumber CatalogNumber CostCenterNumber UnitPrice Date Time Item Description DiscountAmt FreightAmt XMLPay Developer s Guide 49 50 XMLPay Elements Cre
65. MENT Date PCDATA gt lt ELEMENT OrderDateTime PCDATA gt lt ELEMENT Name PCDATA gt lt ELEMENT Company PCDATA gt lt ELEMENT Street PCDATA gt lt ELEMENT Street2 PCDATA gt lt ELEMENT City PCDATA gt lt ELEMENT State PCDATA gt lt ELEMENT Zip PCDATA gt lt ELEMENT Country PCDATA gt lt ELEMENT AddressLinel PCDATA gt lt ELEMENT AddressLine2 PCDATA gt lt ELEMENT AddressLine3 PCDATA gt XML Pay Developer s Guide 131 lt ELEMENT Add XMLPay DTD ressLine4 PCDATA gt lt ELEMENT CountryName PCDATA gt lt ELEMENT Add AddressLinel lt ELEMENT EMa ress Company Street Street2 City State Zip Country AddressLine2 AddressLine3 AddressLine4 CountryName gt 11 PCDATA gt lt ELEMENT Phone PCDATA gt lt ELEMENT Fax lt ELEMENT URL lt ELEMENT Bil PCDATA gt PCDATA gt lFrom Name Address EMail Phone Fax URL gt lt ELEMENT CustomerId PCDATA gt lt ELEMENT 2 PCDATA gt lt ELEMENT CustCode PCDATA gt lt ELEMENT PONum PCDATA gt lt ELEMENT Tax Exempt PCDATA gt lt ELEMENT Bil 1 CustomerId Name Address 11 Phone Phone2 Fax
66. MLPay Examples VerifyEnrollment Request lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt VerifyEnrollment Request lt xml version 1 0 gt lt XMLPayRequest gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt VerifyEnrollment gt lt PayData gt lt Invoice gt lt TotalAmt Currency 840 gt 12 16 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardNum gt 4000000000000002 lt CardNum gt lt ExpDate gt 200411 lt ExpDate gt lt Card gt lt Tender gt lt PayData gt lt VerifyEnrollment gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt assword lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt VerifyEnrollment Response lt xml version 1 0 gt lt XMLPayResponse gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt XMLPay Developer s Guide 99 XMLPay Examples VerifyEnrollment Response lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt Message gt OK lt Message gt lt BuyerAuthResult gt lt Status gt E lt Status gt lt AuthenticationId gt CTEremezUA7PkaDwP0Qk lt AuthenticationId gt PAReq pareq bloc lt PAReq gt lt ACSUr1 gt https ba
67. MLPay Schemas XMLPay Types Schema lt element name BusName type BusNameType minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt lt complexType gt lt element gt lt simpleType name AcctTypeEnum base string gt lt enumeration value lt enumeration value lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name Saving gt Checking gt AcctNumType base string gt value 19 gt MagDataType base string gt value 80 gt ABAType base String gt value 9 gt AuthType base string gt lt maxLength value 10 gt lt simpleType gt lt simpleType name SellerMsgType base string gt lt maxLength value 31 gt lt simpleType gt lt simpleType name BusNameType base string gt lt maxLength value 50 gt lt simpleType gt lt element name Card gt lt complexType content elementOnly gt lt sequence gt lt element name CardType type CardTypeEnum minOccurs 0 maxOccurs 1 gt lt element name CardNum type CardNumType minOccurs 0 maxOccurs 1 gt lt element name ExpDate type ExpDateType minOccurs 0 maxOccurs 1 gt lt element name CVNum
68. Match gt lt AVSResult gt lt Message gt Approved lt Message gt lt PNRef gt EEEPB48 9DB3B lt PNRef gt lt PayPalResult gt lt PayerID gt 2BUBWABP28LFL lt PayerID gt lt Token gt EC 1R668591NV5623643 lt Token gt lt PPRef gt 9HG32848HD669470X lt PPRef gt lt FeeAmount gt 0 lt FeeAmount gt lt Payment Type gt instant lt Payment Type gt lt PendingReason gt authorization lt PendingReason gt lt PayPalResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt IAVS Result Request lt xml version 1 0 encoding UTF 8 XMLPayResponse lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt IAVSResult gt Y lt IAVSResult gt lt AVSResult gt lt StreetMatch gt Service Not Available lt StreetMatch gt lt ZipMatch gt Service Not Available lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt V63A09910356 lt PNRef gt lt AuthCode gt 747PNI lt AuthCode gt lt Host Code gt 00 lt HostCode gt lt OrigResult gt 0 lt OrigResult gt 88 Developer s Guide XMLPay Examples Level 3 Invoice lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Lev
69. PRef type PPRefType minOccurs 0 maxOccurs 1 gt lt element name FeeAmount type int lt element name PayerStatus type string minOccurs 0 maxOccurs 1 gt lt element name PaymentType type string minOccurs 0 maxOccurs 1 gt lt element name PendingReason type string minOccurs 0 maxOccurs 1 gt lt element name Custom type string minOccurs 0 maxOccurs 1 gt lt element name InvNum type InvNumType minOccurs 0 maxOccurs 1 gt lt element name Phone type PhoneNumberType minOccurs 0 maxOccurs 1 gt lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element name ShipTo minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element ref Address gt 108 XMLPay Developer s Guide XMLPay Schemas XMLPay Schema lt complexType gt lt element gt lt element name CorrelationID type CorrelationIDType minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name AccountUpdateResult lt complexType content elementOnly gt lt sequence gt lt element name Result type int gt lt element name Message type string gt lt element name PNRef type PNRefType gt lt element name AUResponseCode type AUResponseCode gt lt element name AUResponseText ty
70. Parameters Chapter 4 XMLPay Transaction Profiles ACH Transactions Buyer Authentication Transactions Card Transactions Purchase Card Levell Purchase Card Level ll Purchase Card Level I Check Transactions PayPal Chapter 5 XMLPay Examples ACH Sale Request ACH Sale Response Card Authorization Request Card Authorization Response XMLPay Developer s Guide Contents E Card Capture 73 Card Capture Response 73 Card Credit 74 Card Credit Response 75 Card Credit Reference Credit Request 75 Card Credit Reference Credit Response 75 Card Force Capture Request 76 Card Force Capture Response 77 Card Sale 77 Card Sale Response 78 Card Secure Request 79 Card Status Request 80 Card Status Response
71. Pay Developer s Guide XMLPay DTD lt ELEMENT OSVersion PCDATA gt lt ELEMENT JavaVersion PCDATA gt lt ELEMENT Proxy PCDATA gt lt ELEMENT VersionIntegrationTracking IntegrationType IntegrationVersion WrapperType WrapperVersion OSName OSArchitecture OSVersion JavaVersion Proxy ExtData gt lt ELEMENT RequestData Vendor Partner Transactions RecurringProfiles AccountUpdateRequests VersionIntegrationTracking gt lt ELEMENT User PCDATA gt lt ELEMENT UserDomain PCDATA gt lt ELEMENT Password PCDATA gt lt ELEMENT UserPass User UserDomain Password gt lt ELEMENT RequestAuth UserPass Signature gt lt ELEMENT XMLPayRequest RequestData RequestAuth gt lt ATTLIST XMLPayRequest version CDATA IMPLIED gt lt ATTLIST XMLPayRequest request_id CDATA IMPLIED gt lt ATTLIST XMLPayRequest response_id CDATA IMPLIED gt lt ATTLIST XMLPayRequest Timeout CDATA IMPLIED gt lt ELEMENT Result PCDATA gt lt ELEMENT AVSResult PCDATA gt lt ELEMENT CVResult PCDATA gt lt ELEMENT CardSecure PCDATA gt lt ELEMENT ResponseText PCDATA gt lt ELEMENT AdditionalMessages PCDATA gt
72. PayPal XMLPay Developer s Guide Payflow Pro XMLPay Developer s Guide Document Number 200013 en_US 200912 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 described herein PayPa
73. R NationalTaxIncl ExtData PNRef Partner Phone BillTo PhoneType XMLPay Developer s Guide Credit Card Transaction Parameters TABLE 3 2 Retail credit card transaction parameters XMLPay Elements Payflow SDK Parameter PONUM PRENOTE PWD RECURRING SHIPFROMZIP SHIPTOCITY SHIPTOFIRSTNAME SHIPTOSTATE SHIPTOSTREET SHIPTOZIP SS STARTTIME STATE STREET SWIPE TAXAMT TAXEXEMPT TENDER Description Specified by the cardholder to identify the order Usually used as a Purchase Order number Identifies the transaction as an authorization for future transactions The 6 to 32 character password that you defined while registering for the account This value is case sensitive Identifies the transaction as recurring Ship from postal code Ship to city Ship to name Ship to state Ship to street Ship to postal code Cardholder s Social Security Number Specifies the beginning of the time period during which the transaction specified by the CUSTREF occurred Optional for Inquiry transactions when using CUSTREF to specify the transaction Cardholder s state The cardholder s street address number and street name Used to pass the Track 1 or Track 2 data the card s magnetic stripe information for card present transactions Tax amount Tax exempt status The method of payment XMLPay Element BillTo PONum Prenote Password ExtData Zip ShipTo A
74. Renamed the existing credit request example Card Refereence Credit Request Updated the RESULT values and RESPMSG table February 2008 Minor updates for technical accuracy December 2007 Updated host addresses in RESULT values and RESPMSG table August 2007 Updated RESPMSD text Updated PayPal logo May 2007 Represents a merge of content from two separate XMLPay developer guides Corrections for technical accuracy February 2007 Updated transaction RESULT values and RESPMSG text August 2006 Updated URLs to PayPal test and live servers May 2006 Reformatted in PayPal templates Integrated Direct Payment feature March 2006 Integrated Express Checkout feature XMLPay Developer s Guide XMLPay Overview About XML XML eXtensible Markup Language is derived from Standardized General Markup Language SGML and HyperText Markup Language HTML In a sense XML is SGML lite but XML manages to maintain SGML s strength as well as HTML s simplicity What s more XML can be converted to HTML The main advantage of XML is that text can be meaningfully annotated In XML markers identify and tag the text But the markers themselves have no defined meaning it is the applications that define the markers XML allows complex transactions to be structured Client integration is simplified through the exchange of XML documents Since XML provides support for digital signatures documents from unknown sources can be trusted In addition
75. T2 SHIPTOZIP TAXAMT TOKEN Description Sets the Custom Payment Page Style for payment pages associated with this button link PageStyle corresponds to the HTML variable page_style for customizing payment pages Unique encrypted PayPal customer account identification number Sets the background color for the payment page Is 1 or 0 The value 1 indicates that you require that the customer s shipping address on file with PayPal be a confirmed address URL to which the customer s browser is returned after approving use of PayPal You must set the currencyID attribute to USD Must not exceed 10 000 USD No currency symbol Decimal separator must be a period Shipping city Destination Country Code See the appendix entitled ISO Country Codes in the Payflow Pro Developer s Guide Shipping state US 2 letter state code Outside US use full name Shipping street address Extended shipping address Example Bldg 6 Mail Stop 3 Shipping postal code called ZIP code in the USA Sum of tax for all items in this order Value returned in Set Express Checkout response to identify this request as part of the same checkout session XMLPay Element PayPal PageStyle PayPal Payerld PayPal PayflowColor PayPal ReqConfirmShipping PayPal ReturnURL PayPal ExtData ShipTo gt Address City ShipTo Address Country ShipTo Address State ShipTo Address Street
76. TAXAMT L_COUNTYTAXEXEMPTCODE L_COUNTYTAXPERCENT L_EVTAXAMT L_EVTAXEXEMPTCODE All tax amount line item All tax exemption code line item All tax rate line item City tax amount line item City tax exemption code line item City tax rate line item County sales tax amount line item County sales tax exemption code line item County sales tax rate line item County tax amount line item County tax exemption code line item County tax rate line item Environmental tax amount line item Environmental tax exemption code line item Level3Item AllTax Level3Item AllTax Level3Item AllTax Level3ltem CityTax Level3ltem CityTax Level3Item CityTax Level3Item CountySalesTax Level3Item CountySalesTax Level3Item CountySalesTax Level3Item CountyTax Level3Item CountyTax Level3Item CountyTax Level3Item EnvironmentalTax Level3Item EnvironmentalTax XMLPay Developer s Guide Credit Card Transaction Parameters TABLE 3 3 Level 3 commercial credit card transaction parameters XMLPay Elements Payflow SDK Parameter L_EVTAXPERCENT L_LOCALTAXAMT L_LOCALTAXEXEMPTCODE L_LOCALTAXPERCENT L_STATEANDLOCALTAXAMT L_STATEANDLOCALTAXEXEMPTCODE L_STATEANDLOCALTAXPERCENT L_STATETAXAMT L_STATETAXEXEMPTCODE L_STATETAXPERCENT L_STATEGOODSTAXAMT L_STATEGOODSTAXEXEMPTCODE L STATEGOODSTAXPERCENT L STATESALESTAXAMT L STATESALESTAXEXEMPTCODE L STATESALESTA
77. Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Get Express Checkout Response XMLPayResponse xmlns http www paypal com XMLPay gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transaction Results gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Match lt StreetMatch gt lt ZipMatch gt lt ZipMatch gt lt AVSResult gt lt Message gt Approved lt Message gt lt PayPalResult gt lt EMail gt echeung b1 paypal com lt EMail gt lt PayerID gt 2BUBWABP28LFL lt PayerID gt lt Token gt EC 1R668591NV5623643 lt Token gt lt FeeAmount gt 0 lt FeeAmount gt lt PayerStatus gt verified lt PayerStatus gt lt Name gt Joshua lt Name gt lt ShipTo gt lt Address gt lt Company gt AA Logos lt Company gt lt Street gt 90252 Laurel Crest Drive lt Street gt lt City gt San Jose lt City gt 86 Developer s Guide XMLPay Examples s Express Checkout Authorization Transaction lt State gt CA lt State gt lt Zip gt 95148 lt Zip gt lt Count ry gt US lt Count ry gt lt Address gt lt ShipTo gt lt PayPalResult gt lt ExtData Name LASTNAMI lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayRespon
78. UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt GetStatus gt lt PNRef gt V54A09206691 lt PNRef gt lt GetStatus gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Card Status Response lt xml version 1 0 encoding UTF 8 lt XMLPayResponse gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Service Not Requested lt StreetMatch gt lt ZipMatch gt Service Not Requested lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt V54A09206691 lt PNRef gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt 80 Developer s Guide XMLPay Examples s Card Void Request Card Void Request lt xml version 1 0 encoding UTF 8 gt lt XMLPayRequest Timeout 30 version
79. XMLPayResponse gt XMLPay Developer s Guide 75 76 XMLPay Examples Card Force Capture Request lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 105 lt Result gt lt AVSResult gt lt StreetMatch gt Service Not Requested lt StreetMatch gt lt ZipMatch gt Service Not Requested lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Credit error lt Message gt lt PNRef gt V54A09206685 lt PNRef gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Card Force Capture Request lt xml version 1 0 encoding UTF 8 XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt ForceCapture gt lt PayData gt lt Invoice gt lt NationalTaxIncl gt false lt NationalTaxIncl gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt visa lt CardType gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200911 lt ExpDate gt lt NameOnCard gt lt Card gt lt Tender gt lt PayData gt lt AuthCode gt AUTHCODE lt AuthCode gt
80. XPERCENT L STATESERVICESTAXAMT L_STATESERVICESTA XEXEMPTCODE L_STATESERVICESTAXPERCENT L_TAXTYPE Description Environmental tax rate line item Local tax amount line item Local tax exemption code line item Local tax rate line item State and local tax amount line item State and local tax exemption code line item State and local tax rate line item State tax amount line item State tax exemption code line item State tax rate line item State goods tax amount line item State goods tax exemption code line item State goods tax rate line item State sales tax amount line item State sales tax exemption code line item State sales tax rate line item State service tax amount line item State service tax exemption code line item State service tax rate line item Tax type line item XMLPay Element Level3Item EnvironmentalTax Level3Item LocalTax Level3Item LocalTax Level3Item LocalTax Level31Item StateAndLocalTax Level3Item State AndLocalTax Level31Item StateAndLocalTax Level3Item StateTax Level3Item StateTax Level3Item StateTax Level3lItem StateGoodsTax Level31Item StateGoodsTax Level3Item StateGoodsTax Level31Item StateSalesTax Level3Item StateSalesTax Level3Item StateSalesTax Level31Item StateServicesTax Level31Item StateServicesTax Level31Item StateServicesTax Level3Item TaxType XMLPay Developer s
81. action Update 97 ValidateAuthentication Request 98 ValidateAuthentication Response 98 XMLPay Developer s Guide 5 Contents VerifyEnrollment Request VerifyEnrollment Response Appendix A XMLPay Schemas XMLPay Schema XMLPay Types Schema Appendix B XMLPay DTD Appendix C Transaction Results AVS Result Codes Index XMLPay Developer s Guide Preface This document defines an XML syntax for payment transaction requests responses and receipts in a payment processing network Intended Audience The typical user of XMLPay is an Internet merchant or merchant aggregator who wants to dispatch credit card corporate purchase card Automated Clearing House ACH or other payment requests to a financial processing network Organization of This Document This document is organized as follows e Chapter 1 XMLPay Overview describes XML and XMLPay presenting processing models networking messaging and related specifications e Chapter 2 XML Pay Syntax presents the syntax for transaction requests responses and receipts using a simplified notation e Chapter 3 XMLPay Elements provides tables defining the existing Payflow SDK parameters name value pairs and their XMLPay equivalents e Chapter 4 XML P
82. ame IpCodeType base string gt value 24 gt BuyerAuthMesgType base string Base64ShalStringType base string gt value 28 gt ECIType base string gt lt maxLength value 2 gt lt simpleType gt lt simpleType name AUResponseCode base string lt maxLength value 1 gt lt simpleType gt lt simpleType name AUResponseText base string lt simpleType gt lt simpleType name AUActionEnum base string gt lt enumeration value Submit gt lt enumeration value Query gt lt simpleType gt lt complexType name AdditionalAmount base Decimal9 2 lt attribute name Type type string gt lt complexType gt lt schema gt XMLPay Developer s Guide XMLPay DTD A document type definition DTD defines the structure of an XML document With a DTD you can define the set and order of tags as well as the attributes for each A well formed XML document is considered valid when it conforms to its corresponding DTD The following is a document type definition DTD representation of the XMLPay schema lt ELEMENT Signature PCDATA gt lt ELEMENT CustIP PCDATA gt lt ELEMENT MerchantDescription PCDATA gt lt ELEMENT MerchantServiceNum PCDATA gt lt ELEMENT Recurring PCDATA gt lt ELEMENT InvNum PCDATA gt lt ELEMENT OrigInvNum PCDATA gt lt ELE
83. ame PhoneType type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt XMLPay Developer s Guide 115 116 XMLPay Schemas XMLPay Types Schema lt element name ShipCarrier type string minOccurs 0 maxOccurs 1 gt lt element name ShipMethod type string minOccurs 0 maxOccurs 1 gt lt element name ShipFrom minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element ref Address gt lt element name EMail type EMailType minOccurs 0 maxOccurs 1 gt lt element name Phone type PhoneNumberType minOccurs 0 maxOccurs 1 gt lt element name Fax type PhoneNumberType minOccurs 0 maxOccurs qu lt element name ShipFromEU type ShipEUType minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name ShipTo minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element ref Address gt lt element name EMail type EMailType minOccurs 0 maxOccurs 1 gt lt element name Phone type PhoneNumberType minOccurs 0 maxOccurs n lt element name Phone2 type PhoneNumberType minOccurs 0 maxOccurs n lt element name
84. any gt lt complexType gt lt element gt lt element name PayData gt lt complexType content elementOnly gt lt sequence gt lt element ref Invoice gt lt element ref Tender gt lt sequence gt lt complexType gt XMLPay Developer s Guide XMLPay Schemas XMLPay Types Schema lt element gt lt element name PayDataAuth gt lt complexType content elementOnly gt lt choice gt lt element name PKCS7Signature type Base64BinaryData gt lt element ref Signature gt lt choice gt lt complexType gt lt element gt lt element name Invoice gt lt complexType content elementOnly gt lt sequence gt lt element name CustIP type string minOccurs 0 maxOccurs 1 gt lt element name MerchantDescription type String minOccurs 0 maxOccurs nu lt element name MerchantServiceNum type string minOccurs 0 maxOccurs 1 gt lt element name Recurring type boolean minOccurs 0 maxOccurs 1 gt lt element name InvNum type InvNumType minOccurs 0 maxOccurs 1 gt lt element name OrigInvNum type InvNumType minOccurs 0 maxOccurs 1 gt lt element name Date type date minOccurs 0 maxOccurs 1 gt lt element name OrderDateTime type string minOccurs 0 maxOccurs 1 gt lt element name BillFrom minOccurs 0 maxOccurs 1 gt lt complexType context
85. ata attribute 25 Payment recurring profile attribute 24 reactivate recurring profile attribute 24 RecurringProfileResult attribute 45 Tender element 32 Term RecurringProfileResult attribute 44 RPData attribute 36 test and live URLs 8 Time Item attribute 30 Timeout RecurringProfile transaction attribute 22 XMLPayRequest attribute 16 Token PayPal attribute 34 PayPalResult attribute 41 TotalAmt Invoice attribute 28 Item attribute 30 RPData attribute 36 TrackingNumber Item attribute 30 Transaction XMLPayRequest attribute 16 transaction 13 transaction requests 12 transaction responses 12 transaction result status response 145 transaction update example 97 TransactionReceipts 14 XMLPayResponse attribute 42 XMLPayResponse transaction attribute 38 TransactionResult RecurringProfileResult attribute 43 XMLPayResponse transaction attribute 38 TransactionResult attributes 40 TransactionResult elements 39 transactions 160 ACH 65 buyer authentication 65 check 67 Credit 65 level I purchase card 66 level II purchase card 66 level purchase card transactions 66 retail credit card 66 retail debit card 66 Sale 65 67 ValidateAuthentication 65 VerifyEnrollment 65 Void 65 U UnitOfMeasurement 29 UnitPrice Item attribute 29 UNSPSCCode Item attribute 30 unsupported NVP tags passing values for 95 UPC Item attribute 29 URL Invoice attribute 27 URLs test and live 8 User UserPass attribute 21 UserDomain UserPass attr
86. axOccurs 1 gt lt element name RetryNumDays type int minOccurs 0 maxOccurs 1 gt lt element name EMail type EMailType minOccurs 0 maxOccurs 1 gt lt element name CompanyName type CompanyNameType minOccurs 0 maxOccurs 1 gt lt element name Comment type CommentType minOccurs 0 maxOccurs 1 gt lt element name OptionalTrans type OptionalTransType minOccurs 0 maxOccurs 1 gt lt element name OptionalTransAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name BillTo minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element ref Address minOccurs 0 maxOccurs 1 gt lt element name Phone type PhoneNumberType minOccurs 0 maxOccurs lt element name Fax type PhoneNumberType minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name ShipTo minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element ref Address gt lt element name Phone type PhoneNumberType minOccurs 0 maxOccurs 1 gt lt element name Fax type PhoneNumberType minOccurs 0 maxOccurs 17 gt lt complexType gt lt element gt lt element name
87. ay Developer s Guide 65 66 XMLPay Transaction Profiles Card Transactions Card Transactions Retail credit and debit cards and corporate purchase cards support the following transactions Sale Authorization Delay Capture Credit and Void The following data are used to process card transactions Invoice TotalAmt Card CardNum Card ExpDate Card NameOnCard Defaults to BillTo Name BillTo Street ZIP Required for AVS CardInfo CV Num Purchase Card Level I Level I purchase cards use the following additional data BillTo PONum Invoice TaxAmt Purchase Card Level Il Level II purchase cards use the following additional data BillTo TaxExempt ShipTo ZIP Purchase Card Level Ill Level III purchase cards use the following additional data Invoice Date BillTo CustCode ShipTo Country ShipFrom ZIP Invoice ShippingAmt Invoice DiscountAmt Item SKU UPC Description Quantity UnitOfMeasurement UnitPrice ExtAmt DiscountAmt TaxAmt TotalAmt DutyAmt NationalTaxIncl XMLPay Developer s Guide XMLPay Transaction Profiles am Check Transactions Note Minimum requirements for describing an item are Description Quantity and UnitPrice ExtAmt Quantity UnitPrice TotalAmt TaxAmt DiscountAmt Check Transactions Checks support the following transaction Sale The following data are used to process check transactions required elements are in bold text e Invoice TotalAmt e Check CheckType e Che
88. ay Transaction Profiles lists the transactions supported for each tender type ACH Card Check along with the data elements used for each of those transactions e Chapter 5 X MLPay Examples gives several XMLPay document samples e Appendix A XMLPay Schemas provides standard W3C schemas for XMLPay and XMLPay Types e Appendix B XMLPay DTD presents the Document Type Definition XMLPay schema e Appendix C Transaction Results lists transaction result codes and response messages as well as Address Verification Service AVS result codes Where to Go For More Information This guide is not the complete source of all the information you need to develop Payflow applications Use the Payflow Pro Developer s Guide along with this guide It provides XMLPay Developer s Guide How to Contact Customer Service detailed descriptions of all the Payflow name value pair parameters In addition it contains testing data the test and live URLs and error codes How to Contact Customer Service For problems with transaction processing or connections contact Customer Service by opening a ticket on the Contact Support tab at http www paypal com mts Revision History Revision history for Website Payments Pro Payflow Edition XMLPay Developer s Guide Date Description December 2009 Added an example of using ExtData to pass values for unsupported NVP tags October 2008 Added a card credit request example
89. caused by one or more of the following e Login information is incorrect Verify that USER VENDOR PARTNER and PASSWORD have been entered correctly VENDOR is your merchant ID and USER is the same as VENDOR unless you created a Payflow Pro user All fields are case sensitive e Invalid Processor information entered Contact merchant bank to verify e Allowed IP Address security feature implemented The transaction is coming from an unknown IP address See PayPal Manager online help for details on how to use Manager to update the allowed IP addresses e You are using a test not active account to submit a transaction to the live PayPal servers Change the host address from the test server URL to the live server URL 2 Invalid tender type Your merchant bank account does not support the following credit card type that was submitted 3 Invalid transaction type Transaction type is not appropriate for this transaction For example you cannot credit an authorization only transaction 4 Invalid amount format Use the format Do not include currency symbols or commas 5 Invalid merchant information Processor does not recognize your merchant account information Contact your bank account acquirer to resolve this problem Invalid or unsupported currency code Field format error Invalid information entered See RESPMSG Not a transaction server NN Too many parameters or invalid stream De
90. ccurs 1 gt lt complexType gt lt element gt lt element name StateGoodsTax type Level3TaxType minOccurs 0 maxOccurs lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name StateSalesTax type Level3TaxType minOccurs 0 maxOccurs MINS lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name StateServicesTax type Level3TaxType minOccurs 0 maxOccurs TIS lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs m s lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name ValueAddedTax type Level3TaxType minOccurs 0 maxOccurs 11 gt lt complexType content e
91. cesTax ValueAddedTax ValueAddedTaxRegNum ExtData gt lt ELEMENT Memo PCDATA gt lt ELEMENT Custom PCDATA gt lt ELEMENT OrderDesc PCDATA gt lt ELEMENT Invoice CustIP MerchantDescription MerchantServiceNum Recurring InvNum OrigInvNum Date OrderDateTime BillFrom BillTo ShipCarrier ShipMethod ShipFrom ShipTo Description Items DiscountAmt ShippingAmt DutyAmt TaxAmt NationalTaxIncl TotalAmt FreightAmt HandlingAmt ItemAmt Comment Level3Invoice Memo Custom OrderDesc ExtData XMLPay Developer s Guide 135 136 XMLPay DTD lt ELEMENT AcctType PCDATA gt lt ELEMENT AcctNum PCDATA gt lt ELEMENT ABA PCDATA gt lt ELEMENT Prenote PCDATA gt lt ELEMENT AuthType PCDATA gt lt ELEMENT CheckNum PCDATA gt lt ELEMEN ermCity PCDATA gt lt ELEMEN ermState PCDATA gt lt ELEMENT DL PCDATA gt lt ELEMENT SS PCDATA gt lt ELEMENT DOB PCDATA gt lt ELEMENT DLState PCDATA gt lt ELEMENT BankName PCDATA gt lt ELEMENT SellerMsg PCDATA gt lt ELEMENT BusName PCDATA gt lt ELEMEN TermState DL SS DOB
92. cessorResult gt CardSecure ProcessorResult gt RRN ProcessorResult gt ResponseText Result ProcessorResult SettleDate ProcessorResult gt STAN XMLPay Developer s Guide 59 60 XMLPay Elements ACH Transaction Parameters Norwest ACH Transaction Parameters Norwest Table 3 6 lists the ACH transaction parameters These parameters are specific to Norwest TABLE 3 6 Transaction response parameters Payflow SDK Parameter Description XMLPay Element TERMCITY City of terminal that captured the transaction ACH gt TermCity TERMSTATE State of terminal that captured the transaction ACH Termstate PayPal Express Checkout Request Transaction Parameters Table 3 7 lists the PayPal Express Checkout request transaction parameters TABLE 3 7 Express Checkout request parameters Express Checkout Parameter Description XMLPay Element ADDROVERRIDE PayPal pages display the shipping address set PayPal gt AddressOverride in the shipping address parameters in the Set Express Checkout request not the shipping address on file with PayPal for this customer AMT Amount US Dollars U S based currency Invoice TotalAmt If shipping cost and tax charges are known include them in AMT If not AMT should be the current subtotal of the order BUTTONSOURCE Identification code for use by third party PayPal ButtonSource applications to identify transactions CANCELURL URL to which the customer is returned if t
93. ck CheckNum e Check MICR e BillTo Name BillTo Address e BillTo EMail e BillTo Phone e BillTo DL DL is optional if SS is provided e BillTo SS SS is optional if DL is provided e BillTo DOB e Invoice InvNum XMLPay Developer s Guide 67 68 XMLPay Transaction Profiles PayPal Transactions PayPal Transactions PayPal Express Checkout supports the following transactions Sale Authorization Delayed Capture Void and Credit The following data are used to process PayPal Express Checkout transactions PayPal CancelURL PayPal ReturnURL PayPal Token PayPal Payerld Invoice TotalAmt ShipTo Address Street ShipTo Address City ShipTo Address State ShipTo Address Zip ShipTo Address Country XMLPay Developer s Guide XMLPay Examples This chapter provides several examples of XMLPay documents For specific examples of how to submit XML documents using the Payflow SDK client service see the Payflow SDK SDKdownload package To receive namespaces in the XML response document you must set the XMLPayRequest version attribute to 2 0 or 1 1 Leaving this attribute out or setting it to any value less than 1 1 leaves the namespace out of the XML response document which may cause errors with some XML parsers Set the version attribute to 2 0 to enable all the functionality described in this document In this Chapter e ACH Sale Request on page 70 e Card Authorization Request on page
94. cription RPData Describes recurring profile details Defined on page 36 Tender Specifies type of payment ProfileID Profile ID of the profile you want to retrying payment for Inquiry Recurring Profile Inquire about the status of a profile Inquiry ProfileID lt Inquiry gt Attribute Description ProfileID Profile ID of the profile you want to review 24 Developer s Guide XMLPay Syntax PERI Core Structures Core Structures PayData lt PayData gt Invoice Tender lt PayData gt Attribute Description Invoice Describes the details of a purchase Defined on page 25 Tender Describes the payment instrument Defined on page 32 PayDataAuth The PayDataAuth element provides authentication of the payer for an associated PayData using either a PKCS 7 format or a W3C XML Signature format digital signature PayDataAuth PKCS7Signature Signature PayDataAuth Invoice Invoice CustIP MerchantDescription Merchant ServiceNum Recurring InvNum OrigInvNum OrderDateTime BillFrom EMail Phone URL BillFrom lt BillTo gt Customerld Name Address Developer s Guide 25 26 XMLPay Syntax Core Structures EMail Phone 2 CustCode PONum TaxExempt PhoneType lt BillTo gt lt ShipCarrier gt lt ShipMethod gt
95. d type PasswordType gt lt sequence gt lt complexType gt lt element gt lt element name RecurringProfile gt lt complexType content elementOnly gt lt sequence gt lt choice gt lt element ref Add gt lt element ref Modify gt lt element ref Cancel gt lt element ref Reactivate gt lt element ref Payment gt lt element ref Inquiry gt lt choice gt lt sequence gt lt attribute name Id type ID gt lt complexType gt lt element gt lt element name Add gt lt complexType content elementOnly gt 110 UserIdType minOccurs 0 maxOccurs 1 gt XMLPay Developer s Guide XMLPay Schemas XMLPay Schema lt sequence gt lt element ref RPData gt lt element ref Tender gt lt sequence gt lt complexType gt lt element gt lt element name Modify gt lt complexType content elementOnly gt lt sequence gt lt element name ProfileID type ProfileIDType lt element ref RPData minOccurs 0 maxOccurs 1 gt lt element ref Tender minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name Cancel gt lt complexType content elementOnly gt lt element name ProfileID type ProfileIDType lt complexType gt lt element gt lt element name Reactivate gt lt complexType content elementOnly gt lt sequence gt lt eleme
96. d by a previous authorization transaction identified by PNRef into the merchant s account lt Capture gt PNRef Invoice ExtData lt Capture gt Attribute Description Invoice An updated Invoice may optionally be provided specifying any changes in the purchase details from the original invoice in the reference authorization ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema Sale Transaction A sale transaction verifies the availability of funds and captures funds in one step lt Sale gt lt PayData gt Invoice Tender lt PayData gt ExtData lt Sale gt Attribute Description PayData Specifies the details of the purchase within Invoice as well as the payment Tender to use XMLPay Developer s Guide 17 XMLPay Syntax The XMLPayRequest Document Transactions Attribute Description ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema Credit Transaction A credit transaction reverses a previous sale or capture transaction lt Credit gt PNRef Tender Invoice ExtData lt Credit gt Attribute Description PNReflTender The transaction to be credited is identified by PNRef Acredit may be run without a PNRef by providing the Tender for the account to be credited and Invoice for the amount Invoice In the case of a partial credit you must provide Invoic
97. ddress City Name ShipTo Address State ShipTo Address Street ShipTo Address Zip SS ExtData State Street MagData Item TaxAmt TaxExempt Tender XMLPay Developer s Guide 51 52 XMLPay Elements Credit Card Transaction Parameters TABLE 3 2 Retail credit card transaction parameters Payflow SDK Parameter TRXTYPE USER VENDOR ZIP Description The type of transaction For XMLPay e Authorization Capture Sale Credit Void ForceCapture RepeatSale GetStatus If you set up one or more additional users on the account this value is the ID of the user authorized to process transactions If however you have not set up additional users on the account USER has the same value as VENDOR This value is case sensitive Your merchant login ID that you created when you registered for the account This value is case sensitive The cardholder s postal code XMLPay Element XMLPay transaction type UserName Vendor Zip Level 3 Commercial Credit Card Transaction Parameters Table 3 3 lists level 3 commercial credit card transaction parameters TABLE 3 3 Level 3 commercial credit card transaction parameters Payflow SDK Parameter ALLTAXEXEMPTCODE ALLTAXPERCENT ALTTAXAMT ALTERNATETAXAMT ALTERNATETAXID BGNAME BGFIRSTADDR Description Tax exempt code Tax rate Tax amount Alternate tax amount Alternate tax ID number Buying Group name
98. dit Card Transaction Parameters TABLE 3 2 Retail credit card transaction parameters Payflow SDK Parameter L_HANDLINGAMT L_PICKUPCITY L_PICKUPCOUNTRY L_PICKUPDATE L_PICKUPRECORDNUM L_PICKUPSTATE L_PICKUPSTREET L_PICKUPTIME L_PICKUPZIP L_PRODCODE L_QTY L_SKU L_TAXAMT L_TRACKINGNUM L_UNSPSCCODE L_UOM L_UPC MICR NATINCL ORDERDATE ORIGID PARTNER PHONENUM PHONETYPE Description Line item handling amount Pickup city Pickup record number Pickup date Pickup record number Pickup state Pickup address Pickup time Pickup postal code Supplier specific product code Line item quantity Line item SKU identifier Line item tax amount Tracking number Universal Standard Products and Services Classification Item unit of measure Item commodity code Data located on the magnetic strip of a credit card National tax included true or false Order date The Reference ID PNREF returned for all transactions The ID provided to you by the authorized Reseller who registered you for the Website Payments Pro Payflow Edition service If you purchased your account directly from PayPal use PayPal This value is case sensitive Telephone number Telephone call type identifier XMLPay Element Item HandlingAmt City Country Date RecordNumber State Street Time Zip SKU Item Quantity SKU Item TaxAmt TrackingNumber UNSPSCCode UnitOfMeasurement UPC MagData or MIC
99. e ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name CustomerValueAddedTaxRegNum type string minOccurs 0 maxOccurs 1 gt lt element name CommCode type string minOccurs 0 maxOccurs 1 gt lt element name EnvironmentalTax type Level3TaxType minOccurs 0 maxOccurs Tus lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs un lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name FreightRate type string minOccurs 0 maxOccurs 1 gt lt element name GenericProductDescription type string minOccurs 0 maxOccurs 1 gt lt element name HandlingRate type string minOccurs 0 maxOccurs 1 gt lt element name InvoiceExpirationDate type string minOccurs 0 maxOccurs 1 gt lt element name LocalTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1
100. e RPRef type RPRefType minOccurs 0 maxOccurs 1 gt lt element name Status type RPStatusType minOccurs 0 maxOccurs 1 gt lt element name Name type RPNameType minOccurs 0 maxOccurs 1 gt lt element name Start type RPDateType minOccurs 0 maxOccurs 1 gt lt element name Term type int minOccurs 0 maxOccurs 1 gt lt element name End type RPDateType minOccurs 0 maxOccurs 1 gt lt element name PayPeriod type PayPeriodType minOccurs 0 maxOccurs 1 gt lt element name MaxFailPayments type int minOccurs 0 maxOccurs 1 gt lt element name RetryNumDays type int minOccurs 0 maxOccurs 1 gt lt element name EMail type EMailType minOccurs 0 maxOccurs 1 gt lt element name CompanyName type CompanyNameType minOccurs 0 maxOccurs 1 gt lt element name Amt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name PaymentsLeft type int minOccurs 0 maxOccurs 1 gt lt element name NextPayment type RPDateType minOccurs 0 maxOccurs 1 gt lt element name AggregateAmt type CurrencyAmount minOccurs 0 maxOccurs In lt element name AggregateOptionalTransAmt type CurrencyAmount minOccurs 0 maxOccurs 1 lt element name NumFailedPayments type int minOccurs 0 maxOccurs 1 gt lt element ref Tender minOccurs 0 maxOccurs
101. e type HostCodeType minOccurs 0 maxOccurs 1 gt Developer s Guide 107 XMLPay Schemas XMLPay Schema lt element lt element lt element lt element lt sequence gt lt complexType gt lt element gt lt element name name HostResponse type string minOccurs 0 maxOccurs 1 gt name AMEXID type string minOccurs 0 maxOccurs 1 gt name BalanceAmount type string minOccurs 0 maxOccurs 1 gt ref ExtData minOccurs 0 maxOccurs unbounded TransactionResult lt complexType content elementOnly gt lt sequence gt lt element name Result type int gt lt element ref BuyerAuthResult minOccurs 0 maxOccurs 1 gt lt element ref ProcessorResult minOccurs 0 maxOccurs 1 gt lt element ref FraudPreprocessResult minOccurs 0 maxOccurs 1 gt lt element ref FraudPostprocessResult minOccurs 0 maxOccurs 1 gt lt element name CardSecure type string minOccurs 0 maxOccurs 1 gt lt element name IAVSResult type string minOccurs 0 maxOccurs 1 gt lt element ref AVSResult minOccurs 0 maxOccurs 1 gt lt element name CVResult type MatchResultEnum minOccurs 0 maxOccurs 1 gt lt element name Message type string minOccurs 0 maxOccurs 1 gt lt element name PNRef type PNRefType minOccurs 0 maxOccurs 1 gt lt element name AuthCode
102. e and provide details on the items being returned ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema Void Transaction A void transaction cancels a pending sale capture or credit Void PNRef ExtData lt Void gt Attribute Description PNRef The transaction to be cancelled is identified by PNRef If the referenced transaction has already been processed the void fails SetExpressCheckout Transaction SetExpressCheckout indicates to the server that you are using Express Checkout to obtain payment from your customer lt SetExpressCheckout gt Authorization Sale ExtData 18 Developer s Guide XMLPay Syntax The XMLPayRequest Document Transactions lt SetExpressCheckout gt Attribute Description Authorization The Express Checkout transaction an authorization for payment or a sale ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema GetExpressCheckout Transaction GetExpressCheckout returns information about the customer using Express Checkout including the name and address on file at PayPal lt SetExpressCheckout gt Authorization Sale ExtData lt SetExpressCheckout gt Attribute Description Authorization The Express Checkout transaction an authorization for payment or a sale ExtData Optional element that may carry extended data
103. e gt lt simpleType name lt maxLength CurrencyAmount base Decimal9_2 gt name Currency type CurrencyCode gt Decimal9_2 base string gt value 12 gt CurrencyCode base string gt value 3 gt ShipEUType base string value 1 gt XMLPay Developer s Guide XMLPay Schemas XMLPay Types Schema lt simpleType gt lt simpleType name TaxRateType base string gt lt maxLength value 6 gt lt simpleType gt lt simpleType name CommodityCodeType base string gt lt maxLength value 8 gt lt simpleType gt lt element name Tender type TenderInfo gt lt complexType name TenderInfo content elementOnly gt lt choice gt lt element ref ACH gt lt element ref Card gt lt element ref Check gt lt element ref Debit gt lt element ref PayPal gt lt choice gt lt complexType gt lt simpleType name TenderTypeEnum base lt enumeration value lt enumeration value lt enumeration value lt enumeration value lt enumeration value lt simpleType gt string gt ACH gt Card gt Check gt Debit gt PayPal gt lt simpleType name TransactionTypeEnum base string lt enumeration value Authorization gt lt enumeration value Capture gt lt enumeration value Sale gt lt enumeration value Credit gt lt enumeration value
104. eResult gt Attribute Description Result Number that indicates outcome of the transaction see Appendix C Transaction Results Message Descriptive message describing Result ProfileID Profile ID of the profile that gets the action RPRef Identifier assigned to the transaction by the payment processing network Status Current status of the profile Name Account holder s name Start Beginning or restarting date for the recurring billing cycle used to calculate when payments should be made Term Number of payments to be made over the life of the agreement End Date that the last payment is due Present only if this is not an unlimited term subscription PayPeriod Specifies how often the payment occurs MaxFailPayments The number of payment periods specified by PayPeriod for which the transaction is allowed to fail before PayPal cancels a profile RetryNumDays The number of consecutive days that PayPal should attempt to process a failed transaction until Approved status is received EMail Customer e mail address CompanyName Company name for this profile Amt Dollar amount US dollars to be billed PaymentsLeft Number of payments left to be billed NextPayment Date that the next payment is due AggregateAmt Amount collected so far for scheduled payments XMLPay Developer s Guide XMLPay Syntax The XMLPayResponse Document Recurring Profiles Attribute AggregateOptionalTransAmt NumFailedPayments Tender
105. ecurring profile details Defined on page 36 Tender Specifies type of payment Modify Recurring Profile Modify any profile value by sending any subset of the profile parameters including an Optional Transaction lt Modify gt RPData Tender ProfileID Modify Attribute Description RPData Describes recurring profile details Defined on page 36 Tender Specifies type of payment ProfileID Profile ID of the profile that you want to modify Cancel Recurring Profile Cancel deactivate a recurring profile Cancel ProfileID Cancel Attribute Description ProfileID Profile ID of the profile that you want to cancel Reactivate Recurring Profile Reactivate a profile with an inactive status Profiles can be deactivated for the following reasons the term has completed the profile reached maximum allowable payment failures or the profile was canceled XMLPay Developer s Guide 23 XMLPay Syntax The XMLPayRequest Document Recurring Profiles lt Reactivate gt RPData Tender ProfileID Reactivate Attribute Description RPData Describes recurring profile details Defined on page 36 Tender Specifies type of payment ProfileID Profile ID of the profile that you want to reactivate Payment Recurring Profile The Payment action performs a real time retry on a previously failed transaction Payment RPData Tender ProfileID Payment Attribute Des
106. ecurringProfileResult attribute 44 RPData attribute 36 ReturnURL PayPal attribute 35 RPData add recurring profile attribute 23 modify recurring profile attribute 23 Payment recurring profile attribute 24 reactivate recurring profile attribute 24 RPData attributes 36 RPRef RecurringProfileResult attribute 43 44 S Sale transaction 65 sale transaction attributes 17 Sale transactions 67 XMLPay Developer s Guide SGML 9 ShipCarrier Invoice attribute 27 ShipFrom Invoice attribute 27 ShipMethod Invoice attribute 27 shipping carrier example 96 shipping method example 96 ShippingAmt Invoice attribute 28 Item attribute 30 ShipTo Invoice attribute 27 RecurringProfileResult attribute 45 ShipTo Name PayPalResult attribute 41 RPData attribute 37 ShipToEU PayPalResult attribute 41 Signature 14 XMLPayResponse attribute 42 XMLPayResponse transaction attribute 38 SKU Invoice attribute 28 Item attribute 29 SS Check attribute 34 Standardized General Markup Language 9 Start RecurringProfileResult attribute 44 RPData attribute 36 State Address attribute 31 Status BuyerAuthResult attribute 42 RecurringProfileResult attribute 44 TransactionResult attribute 39 Street Address attribute 31 StreetMatch AVSResult attribute 40 syntax notation 15 notation element 15 XMLPay 15 159 T TaxAmt 30 Invoice attribute 28 Item attribute 29 Tender add recurring profile attribute 23 modify recurring profile attribute 23 PayD
107. el 3 Invoice lt xml version 1 0 encoding UTF 8 XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Authorization gt lt PayData gt lt Invoice gt lt NationalTaxIncl gt false lt NationalTaxIncl gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Level3Invoice gt lt Count yTax gt lt Amount gt 1 23 lt Amount gt lt CountyTax gt lt Level3Invoice gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt visa lt CardType gt lt CardType gt Switch lt CardType gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200911 lt ExpDate gt lt NameOnCard gt lt Card gt lt Tender gt lt PayData gt lt Authorization gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt XMLPay Developer s Guide 89 XMLPay Examples Line Sale Request Line Item Sale Request lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt
108. element gt lt element name FraudPreprocessResult gt lt complexType content elementOnly gt lt sequence gt lt element name Message type string minOccurs 0 maxOccurs 1 gt lt element name XMLData type string minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name FraudPostprocessResult gt lt complexType content elementOnly gt lt sequence gt lt element name Message type string minOccurs 0 maxOccurs 1 gt lt element name XMLData type string minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name ProcessorResult gt lt complexType content elementOnly gt lt sequence gt lt element name AVSResult type string minOccurs 0 maxOccurs 1 gt lt element name CVResult type string minOccurs 0 maxOccurs 1 gt lt element name CardSecure type string minOccurs 0 maxOccurs 1 gt lt element name ResponseText type string minOccurs 0 maxOccurs 1 gt lt element name AdditionalMessages type string minOccurs 0 maxOccurs 1 gt lt element name SettleDate type string minOccurs 0 maxOccurs 1 gt lt element name STAN type string minOccurs 0 maxOccurs 1 gt lt element name RRN type string minOccurs 0 maxOccurs 1 gt lt element name HostCod
109. ent gt defined elsewhere Indicates an optional element Separates alternative elements any one of which is allowed Indicates that one or more occurrences of an element are allowed Indicates that zero or more occurrences of an element are allowed Note The Payflow SDK SDK download package provides specific examples of XML documents using the Pro client service The XMLPayRequest Document Transactions lt XMLPayRequest Timeout 30 version 2 0 gt lt RequestData gt Vendor Partner lt Transactions gt XMLPay Developer s Guide 15 ESSE XMLPay Syntax The XMLPayRequest Document Transactions Transaction lt Transactions gt lt RequestData gt RequestAuth lt XMLPayRequest gt Attribute Description Vendor Identifies the merchant of record for the transaction within the target payment processing network In a delegated processing model the merchant of record may be different from the submitting party Partner Identifies the submitting party Transaction Defined on page 16 XMLPay supports up to 32 transactions per XMLPay document submission RequestAuth Defined on page 21 Timeout The value of this attribute is ignored Transaction XMLPay supports up to 32 transactions per XMLPay document submission lt Transaction Id CustRef gt Authorization Capture Sale Credit Void ForceCapture Rep atSale GetStatus VerifyEnrollment TransactionUpdat Val
110. esponse gt 78 Developer s Guide XMLPay Examples Card Secure Request Card Secure Request lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Authorization gt lt PayData gt lt Invoice gt lt NationalTaxIncl gt false lt NationalTaxIncl gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt visa lt CardType gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200911 lt ExpDate gt lt NameOnCard gt lt BuyerAuthResult gt lt Status gt Y lt Status gt lt AuthenticationId gt CTEremezUA7PkaDwP 00k lt Authent icationId gt ECI gt 5 lt ECI gt CAVV BwAQAJVyYAQECQJUTMnJgAAAAAAA CAVV XID 8abmKOK1Sf9OujrESKKrKkJCPA4I XID BuyerAuthResult Card lt Tender gt lt PayData gt lt Authorization gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt XMLPay Developer s Guide 79 XMLPay Examples Card Status Request Card Status Request lt xml version 1 0 encoding
111. evel3Invoice CityTax CITYTAXPERCENT City tax rate Level3Invoice CityTax COMMCODE Commercial code for business Level3Invoice cards not typically used CommCode CUSTVATREGNUM Customer value added tax Level3Invoice gt registration number Customer ValueAdded TaxRegNum EVTAXAMT Environmental tax amount Level3Invoice gt EnvironmentalTax XMLPay Developer s Guide 53 ES XMLPay Elements Credit Card Transaction Parameters TABLE 3 3 Level 3 commercial credit card transaction parameters 54 Payflow SDK Parameter Description XMLPay Element EVTAXEXEMPTCODE Environmental tax exempt code Level3Invoice EnvironmentalTax EVTAXPERCENT Environmental tax rate Level3Invoice EnvironmentalTax FREIGHTRATE Rate charged for shipping Level3Invoice FreightRate GENERICPRODDESC Generic product description Level3Invoice GenericProduct Description HANDLINGRATE Rate charged for handling Level3Invoice HandlingRate INVEXPDATE Invoice expiration date Level3Invoice gt InvoiceExpirationDate LOCALTAXAMT Local tax amount Level3Invoice LocalTax LOCALTAXEXEMPTCODE Local tax exemption code Level3Invoice LocalTax LOCALTAXPERCENT Local tax rate Level3Invoice LocalTax NATIONALTAXAMT National tax amount Level3Invoice NationalTax RECURRING Recurring billing indicator REQNAME Name of requestor Level3Invoice gt Requestor REQFIRSTADDR First line of street address for Level3Invoice requestor Requestor REQSECONDADDR Second li
112. gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Set Express Checkout Response XMLPayResponse xmlns http www paypal com XMLPay gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transaction Results gt lt TransactionResult gt lt Result gt 0 lt Result gt lt Message gt Approved lt Message gt lt PayPalResult gt lt Token gt EC 1R668591NV5623643 lt Token gt lt FeeAmount gt 0 lt FeeAmount gt lt PayPalResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Get Express Checkout Request lt xml version 1 0 encoding UTF 8 XMLPayRequest Timeout 30 version 2 0 gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt GetExpressCheckout gt XMLPay Developer s Guide 85 XMLPay Examples Express Checkout Authorization Transaction lt Authorization gt lt PayData gt lt Tender gt lt PayPal gt lt Token gt EC 1R668591NV5623643 lt Token gt lt PayPal gt lt Tender gt lt Invoice gt lt ExtData Name VERBOSITY Value HIGE gt lt Invoice gt lt PayData gt lt Authorization gt lt GetExpressCheckout gt lt Transaction gt lt
113. gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name NationalTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs MANS lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name Requestor minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Name type NameType minOccurs 0 maxOccurs 1 gt lt element ref Address minOccurs 0 maxOccurs 1 gt lt complexType gt 118 XMLPay Developer s Guide XMLPay Schemas XMLPay Types Schema lt element gt lt element name StateAndLocalTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name StateSalesTax type Level3TaxType minOccurs 0 maxOccurs ni lt com
114. he PayPal CancelURL customer does not approve the use of PayPal to pay you CUSTOM Free form field for your own use such as a PayPal ExtData tracking number or other value you want PayPal to return in the Get Express Checkout Details response EMAIL Customer s email address PayPal EMail HANDLINGAMT Total handling amount Item HandlingAmt HDRBACKCOLOR Sets the background color for the header of the PayPal gt HeaderBackColor payment page XMLPay Developer s Guide XMLPay Elements PayPal Express Checkout Request Transaction Parameters TABLE 3 7 Express Checkout request parameters Continued Express Checkout Parameter HDRBORDERCOLOR HDRIMG INVNUM ITEMAMT L_AMTn L_DESCn L_QTYn L_TAXAMTn LOCALECODE MAXAMT MEMO NOSHIPPING NOTE NOTIFYURL ORDERDESC Description Sets the border color around the header of the payment page The border is a 2 pixel perimeter around the header space which is 750 pixels wide by 90 pixels high URL for the image you want to appear at the top left of the payment page The image has a maximum size of 750 pixels wide by 90 pixels high PayPal recommends that you provide an image that is stored on a secure https server Merchant invoice number The merchant invoice number is used for authorizations and settlements and depending on your merchant bank will appear on your customer s credit card statement and your bank reconciliation report If
115. his transaction ID is for a creditable transaction For example you cannot credit an authorization Host not available Duplicate suppression time out Void error See RESPMSG Make sure the transaction ID entered has not already been voided If not then look at the Transaction Detail screen for this transaction to see if it has settled The Batch field is set to a number greater than zero if the transaction has been settled If the transaction has already settled your only recourse is a reversal credit a payment or submit a payment for a credit Time out waiting for host response Referenced auth against order Error Capture error Either an attempt to capture a transaction that is not an authorization transaction type or an attempt to capture an authorization transaction that has already been captured Failed AVS check Address and ZIP code do not match An authorization may still exist on the cardholder s account Merchant sale total will exceed the sales cap with current transaction ACH transactions only Card Security Code CSC Mismatch An authorization may still exist on the cardholder s account XMLPay Developer s Guide 147 Transaction Results TABLE C 1 Payflow transaction RESULT values and RESPMSG text Continued RESULT RESPMSG and Explanation 115 System busy try again later 116 VPS Internal error Failed to lock terminal number 117 Failed merchant rule check One or more of the following
116. http www paypal com XMLPay gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Sale gt lt PayData gt lt Invoice gt lt InvNum gt 1 lt InvNum gt lt Date gt 20020208 lt Date gt lt BillTo gt lt Name gt billtoname lt Name gt lt Address gt lt Street gt street lt Street gt lt City gt city lt City gt lt State gt NY lt State gt lt Zip gt 67890 lt Zip gt lt Country gt US lt Country gt lt Address gt lt EMail gt email lt EMail gt lt TaxExempt gt false lt TaxExempt gt lt BillTo gt lt NationalTaxIncl gt true lt NationalTaxIncl gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Invoice gt lt Tender gt lt Check gt lt CheckType gt P lt CheckType gt lt CheckNum gt 1001 lt CheckNum gt lt MICR gt 12345678904390850001001 lt MICR gt lt DL gt CA123456 lt DL gt lt SS gt 123456789 lt SS gt lt DOB gt 19000601 lt DOB gt lt Check gt lt Tender gt lt PayData gt lt Sale gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt 82 Developer s Guide XMLPay Examples Customer lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Check Sale Response lt xml version 1 0 encoding UTF 8 XMLPayRespon
117. ibute 21 UserPass attributes 21 using ExtData 95 V ValidateAuthentication request example 98 ValidateAuthentication response example 98 ValidateAuthentication transaction attributes 21 ValidateAuthentication transactions 65 Value ExtData attribute 37 Vendor RecurringProfile transaction attribute 22 XMLPayRequest attribute 16 XMLPayResponse attribute 42 XMLPayResponse transaction attribute 38 XMLPay Developer s Guide VerifyEnrollment request example 99 Z VerifyEnrollment response example 84 99 VerifyEnrollment transaction attributes 20 Zip VerifyEnrollment transactions 65 Address attribute 31 ZipMatch Void transaction 65 void transaction attributes 18 AVSResult attribute 40 W W3C XML Signature 25 42 Where to Go For More Information 7 X XID BuyerAuthResult attribute 42 XML 9 about 9 benefits of 9 well formed 9 131 XMLPay core structures 25 instruments 10 messaging 12 operations 11 processing models 11 syntax 15 transaction attributes 16 using 10 XMLPay document examples 69 XMLPayRequest 13 XMLPayRequest attributes 16 XMLPayRequest document 15 to 21 XMLPayRequest document recurring profiles 22 to 24 XMLPayResponse 13 Signature not supported in 14 TransactionReceipts not supported in 14 XMLPayResponse attributes 42 XMLPayResponse document 37 37 to 40 XMLPayResponse document recurring profiles 41 to 45 XMLPayResponse transaction attributes 38 XMLPay Develope
118. ibute Description Street Street address including number City City name State State or province For US addresses two character state codes should be used Zip Postal code Country Country code ISO 3166 Default is US XMLPay Developer s Guide 31 ES XMLPay Syntax Core Structures Tender Tender ACH Card Check Debit PayPal lt Tender gt ACH ACH Automated Clearing House tender detail lt ACH gt AcctType AcctNum ABA Prenote AuthType CheckNum TermCity TermState DL SS DOB DLState BankName SellerMsg BusName ExtData lt ACH gt Attribute Description AcctType Type of the bank account checking or savings AcctNum Account number ABA Bank routing number AuthType Method of authorization Prenote Boolean If true then the purpose of this transaction is not to move money but to establish authorization for future transactions to be submitted on a recurring basis ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema Card Retail Credit Debit and Corporate Purchase Card tender detail lt Card gt CardType CardNum ExpDate 32 XMLPay Developer s Guide XMLPay Syntax Core Structures CVNum MagData NameOnCard ExtData lt Card gt Attribute Description CardType Optional Identifies the type of card for the merchant s records Card types are
119. idateAuthentication SetExpressCheckout GetExpressCheckout DoExpressCheckout lt Transaction gt Attribute Id Description Optional attribute that tracks the transaction through the payment processing network The submitting merchant generates this transaction identifier which must be unique among all transactions submitted by that merchant Id need not be globally unique across merchants since the payment processing network interprets it within the context of the merchant associated with the transaction If an Id attribute is provided in a transaction it will be included in the matching TransactionResult in the resultant XMLPayResult Similarly CustRef is a merchant generated ID identifying a specific customer of this merchant and associating it with this transaction Authorization Transaction An authorization transaction verifies the availability of funds and reserves them for later capture 16 XMLPay Developer s Guide XMLPay Syntax The XMLPayRequest Document Transactions lt Authorization gt lt PayData gt Invoice Tender lt PayData gt ExtData lt Authorization gt Attribute Description PayData Specifies the details of the purchase within Invoice as well as the payment Tender to use ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema Capture Transaction A capture transaction transfers the funds secure
120. identified by PNRef ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema VerifyEnrollment Transaction For the Buyer Authentication Service this transaction is used to determine whether the card holder is enrolled in the 3D Secure program Refer to Payflow Pro Fraud Protection Services User s Guide on the sequence of steps involved in performing a Buyer Authentication transaction This transaction is submitted only to the Buyer Authentication server and not to the core OLTP server lt VerifyEnrollment gt lt PayData gt Invoice Tender lt PayData gt ExtData lt VerifyEnrollment gt Attribute Description PayData Specifies the details of the credit card used in the purchase XMLPay Developer s Guide XMLPay Syntax The XMLPayRequest Document Transactions Attribute Description ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema ValidateAuthentication Transaction For the Buyer Authentication Service this transaction validates the signature on the PARes data returned by the issuing bank and parses the authentication information Refer to Payflow Pro Fraud Protection Services User s Guide on the sequence of steps involved in performing a Buyer Authentication transaction ValidateAuthentication lt PARes gt ExtData lt ValidateAuthentication gt Attribute Description P
121. is available on the PayPal Manager Documentation page 127 Fraud Protection Services Filter Not processed by filters 128 Fraud Protection Services Filter Declined by merchant after being flagged for review by filters 131 Version 1 Payflow Pro SDK client no longer supported Upgrade to the most recent version of the Payflow Pro client 132 Card has not been submitted for update 133 Data mismatch in HTTP retry request 150 Issuing bank timed out 151 Issuing bank unavailable 148 XMLPay Developer s Guide Transaction Results TABLE C 1 Payflow transaction RESULT values and RESPMSG text Continued RESULT 200 201 402 403 404 600 601 1000 1001 1002 1003 1004 1011 1012 1013 1014 1016 1017 1021 1022 1023 1041 1042 RESPMSG and Explanation Reauth error Order error PIM Adapter Unavailable PIM Adapter stream error PIM Adapter Timeout Cybercash Batch Error Cybercash Query Error Generic host error This is a generic message returned by your credit card processor The RESPMSG will contain more information describing the error Buyer Authentication Service unavailable Buyer Authentication Service Transaction timeout Buyer Authentication Service Invalid client version Buyer Authentication Service Invalid timeout value Buyer Authentication Service unavailable Buyer Authentication Service unavailable Buyer Authentication Service unavailable Buyer Authentication Service
122. l Inc reserves the right to make changes to any information herein without further notice Contents Preface 7 Intended Audience 7 Organization of This Document 7 Where to Go For More Information 7 How to Contact Customer Service 8 REVISION HIStOLY y 25 mew da dan Det Ge edhe Rae 8 Chapter 1 XMLPay Overview 9 About XMLa 2 pus Q aus x MED NAN BEL ele dede 9 Benefits of XML 9 Well formed XML Document 9 Using vu wu gu s DURS RARE DER BR ae x 10 XMLPay Instruments 10 XMLPay 11 XMLPay Processing Models 11 Business to Consumer 11 Business to Business 12 XMLPay Messaging 12 XMLPayRequest 13 XMLPayResponse 13 Chapter 2 5 15 Syntax Notation 15 XMLPayRequest Document
123. lectronic Commerce Indicator see ECI elements TransactionResult 39 EMail Invoice attribute 27 PayPal attribute 34 PayPalResult attribute 41 RecurringProfileResult attribute 44 RPData attribute 37 Email PayPalResult attribute 41 End RecurringProfileResult attribute 44 example ACH sale request 70 ACH sale response 71 card authorization request 71 card capture request 73 card capture response 73 card credit request 75 card credit response 75 card force capture request 76 card force capture response 77 card sale request 77 card sale response 78 card secure request 79 card status request 80 XMLPay Developer s Guide card status response 80 card void request 81 card void response 81 check sale request 82 check sale response 83 credit card recurring billing profile 95 customer IP 83 IAVS result request 88 level 3 invoice 89 line item sale request 90 line item sale response 92 merchant description 92 merchant service number 92 processor result 93 shipping carrier 96 shipping method 96 transaction update 97 ValidateAuthentication request 98 ValidateAuthentication response 98 VerifyEnrollment request 99 VerifyEnrollment response 84 99 examples XMLPay document 69 ExpDate Card attribute 33 ExtData ACH attribute 32 authorization transaction attribute 17 capture transaction attribute 17 Card attribute 33 Check attribute 34 credit transaction attribute 18 DoExpressCheckout attribute 19 ForceCa
124. lement that may carry extended data outside the syntax of the XMLPay schema XMLPay Developer s Guide 35 XMLPay Syntax Core Structures RPData Recurring Profile payment and scheduling details lt RPData gt Name TotalAmt 1 Term PayPeriod MaxFailPayments RetryNumDays EMail CompanyName Comment OptionalTrans OptionalTransAmt lt BillTo gt Name Address Phone Fax lt 111 gt lt ShipTo gt Name Address Phone Fax lt ShipTo gt OrigProfileID PaymentNum ExtData RPData Attribute Description Name Account holder s name TotalAmt Dollar amount US dollars to be billed Start Beginning or restarting date for the recurring billing cycle used to calculate when payments should be made Term Number of payments to be made over the life of the agreement PayPeriod Specifies how often the payment occurs MaxFailPayments The number of payment periods specified by PayPeriod for which the transaction is allowed to fail before PayPal cancels a profile RetryNumDays The number of consecutive days that PayPal should attempt to process a failed transaction until Approved status is received 36 Developer s Guide XMLPay Syntax XMLPayResponse Document Transactions Attribute Description EMail Customer e mail address CompanyNa
125. lementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name TaxType type string minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name PickUp gt Developer s Guide 121 122 XMLPay Schemas XMLPay Types Schema lt complexType content elementOnly gt lt sequence gt lt element ref Address minOccurs 0 maxOccurs 1 gt lt element name Time type time minOccurs 0 maxOccurs 1 gt lt element name Date type date minOccurs 0 maxOccurs 1 gt lt element name RecordNumber type RecordType minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name Delivery gt lt complexType content elementOnly gt lt sequence gt lt element name Time type time minOccurs 0 maxOccurs 1 gt lt element name Date type date minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt
126. lementOnly gt lt sequence gt lt element name CardNum type CardNumType minOccurs 0 maxOccurs 1 gt lt element name ExpDate type ExpDateType minOccurs 0 maxOccurs 1 gt lt element name MagData type MagDataType minOccurs 0 maxOccurs 1 gt lt element name NameOnCard type NameType minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name Check gt lt complexType content elementOnly gt lt sequence gt lt element name CheckType type CheckTypeEnum minOccurs 0 maxOccurs 1 gt lt element name AllianceNum type string minOccurs 0 maxOccurs 1 gt lt element name CheckNum type CheckNumType minOccurs 0 maxOccurs 1 gt lt element name MICR type MICRType minOccurs 0 maxOccurs 1 gt lt element name DL type DLType minOccurs 0 maxOccurs 1 gt lt element name SS type SSType minOccurs 0 maxOccurs 1 gt lt element name DOB type date minOccurs 0 maxOccurs 1 gt lt element name DLState type DLStateType minOccurs 0 maxOccurs 1 gt lt element name AuthType type AuthType minOccurs 0 maxOccurs 1 gt lt element name CustomerType type CustomerType minOccurs 0 maxOccurs 1 gt lt element name BankName type
127. lt ForceCapture gt lt Transaction gt lt Transactions gt XMLPay Developer s Guide lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Card Force Capture Response lt xml version 1 0 encoding UTF 8 XMLPayResponse lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt XMLPay Examples s Card Sale Request lt StreetMatch gt Service Not Requested lt StreetMatch gt lt ZipMatch gt Service Not Requested lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt V54A09206761 lt PNRef gt lt AuthCode gt AUTHCO lt AuthCode gt lt HostCode gt 00 lt HostCode gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Card Sale Request lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Sale gt lt PayData gt
128. lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt 74 Developer s Guide XMLPay Examples Card Credit Reference Credit Request Card Credit Response lt xml version 1 0 encoding utf 8 gt lt XMLPayResponse xmlnsz http www paypal com XMLPay lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt verisign lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt Message gt Approved lt Message gt lt PNRef gt V18A0FA3CBC2 lt PNRef gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Card Credit Reference Credit Request lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Credit gt lt PNRef gt V53A09206652 lt PNRef gt lt Credit gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Card Credit Reference Credit Response lt xml version 1 0 encoding UTF 8 lt
129. lt simpleType name RPDateType base string gt lt maxLength value 6 gt XMLPay Developer s Guide 113 114 XMLPay Schemas XMLPay Types Schema lt simpleType gt lt simpleType name PayPeriodType base string gt lt enumeration value Weekly gt lt enumeration value Bi weekly gt lt enumeration value Semi monthly gt lt enumeration value Every four weeks gt lt enumeration value Monthly gt lt enumeration value Quarterly gt lt enumeration value Semi yearly gt lt enumeration value Yearly gt lt simpleType gt lt simpleType name CompanyNameType base string lt maxLength value 127 gt lt simpleType gt lt simpleType name OptionalTransType base string gt lt enumeration value Auth gt lt enumeration value Sale gt lt simpleType gt lt simpleType name RPRefType base string gt lt maxLength value 12 gt lt simpleType gt lt simpleType name RPStatusType base string gt lt simpleType gt lt schema gt XMLPay Types Schema lt xml version 1 0 gt lt schema targetNamespace http www paypal com XMLPay unqualified unqualified http www w3 org 1999 XMLSchema gt lt stub out xmldsig lt import schemaLocation xmldsig core schema xsd gt gt lt element name Signature lt complexType base string content elementOnly gt lt
130. lue CDATA IMPLIED gt lt ELEMEN Time PCDATA gt lt ELEMEN Delivery Time Date gt RecordNumber PCDATA gt PickUp Address Time Date RecordNumber gt CostCenterNumber PCDATA gt TrackingNumber PCDATA gt lt ELEMEN lt ATTLIST lt ELEMEN lt ATTLIS lt ELEMEN FreightAmt PCDATA gt FreightAmt Currency CDATA IMPLIED gt HandlingAmt PCDATA gt HandlingAmt Currency CDATA IMPLIED gt ShipmentNumber PCDATA gt lt ELEMEN lt ELEMEN lt ELEMEN lt ELEMEN lt ATTLIST UNSPSCCode PCDATA gt CatalogNumber PCDATA gt CommCode PCDATA gt Amount PCDATA gt Amount Currency CDATA IMPLIED gt XMLPay Developer s Guide XMLPay DTD m 133 134 XMLPay DTD lt ELEMENT ExemptCode PCDATA gt lt ELEMENT Percent PCDATA gt lt ELEMENT 11 Amount ExemptCode Percent gt lt ELEMENT CityTax Amount ExemptCode Percent gt lt ELEMENT CountySalesTax Amount ExemptCode Percent gt lt ELEMENT CountyTax Amount ExemptCode Percent gt l
131. maxOccurs 1 gt lt element name AddressLinel type AddressLineType minOccurs 0 maxOccurs m s lt element name AddressLine2 type AddressLineType minOccurs 0 maxOccurs 1 gt lt element name AddressLine3 type AddressLineType minOccurs 0 maxOccurs 1 gt lt element name AddressLine4 type AddressLineType minOccurs 0 maxOccurs nm lt element name CountryName type NameType minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt simpleType name NameType base string lt maxLength value 30 gt lt simpleType gt lt simpleType name AddressLineType base string gt lt maxLength value 40 gt lt simpleType gt lt simpleType name StateType base string gt lt maxLength value 2 gt lt simpleType gt lt simpleType name ZipType base string gt lt maxLength value 10 gt lt simpleType gt lt simpleType name CountryCode base string gt lt maxLength value 3 gt lt simpleType gt lt simpleType name EMailType base string gt lt maxLength value 40 gt lt simpleType gt lt simpleType name PhoneNumberType base string gt lt maxLength value 20 gt lt simpleType gt lt complexType name lt attribute lt complexType gt lt simpleType name lt maxLength lt simpleType gt lt simpleType name lt maxLength lt simpleTyp
132. me Company name for this profile Comment Free form comment about the purchase OptionalTrans Defines an optional Authorization for validating the account information or for charging an initial fee OptionalTransAmt Amount of the Optional Transaction BillTo Name Address Information about the buyer Phone and Fax ShipTo Name Address Information about the shipping addresses if different from BillTo Phone and Fax OrigProfileID Profile ID of the profile that gets the action PaymentNum Payment number identifying the failed payment to be retried ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema ExtData lt ExtData Name Value gt Attribute Description Name Name of the extended data element Value Value of the extended data element The XMLPayResponse Document Transactions lt XMLPayResponse gt lt ResponseData gt Vendor Partner lt TransactionResults gt TransactionResult lt TransactionResults gt lt ResponseData gt Signature TransactionReceipts XMLPay Developer s Guide 37 38 XMLPay Syntax The XMLPayResponse Document Transactions lt XMLPayResponse gt Attribute Description Vendor Identifies the merchant of record for the transaction within the payment processing network Partner Identifies the partner who submitted the transaction on behalf of the vendor TransactionResult Defined on page 38 Signa
133. meter data not supported by schema 47 Inquiry recurring profile 24 Inquiry recurring profile attributes 24 InvNum Invoice attribute 27 PayPalResult attribute 41 Invoice capture transaction attribute 17 credit transaction attribute 18 PayData attribute 25 Invoice attributes 27 Item attributes 29 ItemAmt Invoice attribute 28 Items Invoice attribute 27 L level 3 credit card transaction parameters 52 to 58 level 3 invoice example 89 level I purchase card transactions 66 level IT purchase card transactions 66 level purchase card transactions 66 Level3 Invoice Invoice attribute 28 line item sale request example 90 line item sale response example 92 LocaleCode PayPal attribute 35 MagData Card attribute 33 MaxFailPayments RecurringProfileResult attribute 44 RPData attribute 36 XMLPay Developer s Guide MechantServiceNum Invoice attribute 27 Memo Invoice attribute 28 merchant description example 92 Merchant ID 13 merchant service number example 92 MerchantCity MerchantInfo attribute 30 MerchantDescripton Invoice attribute 27 MerchantInfo Invoice attribute 28 MerchantState MerchantInfo attribute 30 MerchantStreet MerchantInfo attribute 30 MerchantZip MerchantInfo attribute 31 Message RecurringProfileResult attribute 43 44 TransactionResult attribute 39 MICR Check attribute 34 modify recurring profile attributes 23 modifying recurring profile 23 N Name ExtData attribute 37 RecurringProfileResult
134. minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name LocalTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name StateAndLocalTax type Level3TaxType minOccurs 0 maxOccurs TIN 120 XMLPay Developer s Guide XMLPay Schemas XMLPay Types Schema lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name StateTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxO
135. nUpdate gt lt complexType content elementOnly gt lt sequence gt lt element name PNRef type PNRefType gt lt element name Action type TransactionUpdateActionEnum gt lt element name RMSID type string minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name SetExpressCheckout gt lt complexType content elementOnly gt lt sequence gt lt choice gt lt element ref Authorization gt lt element ref Sale gt lt choice gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt 106 XMLPay Developer s Guide XMLPay Schemas XMLPay Schema lt sequence gt lt complexType gt lt element gt lt element name GetExpressCheckout gt lt complexType content elementOnly gt lt sequence gt lt choice gt lt element ref Authorization gt lt element ref Sale gt lt choice gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name DoExpressCheckout lt complexType content elementOnly lt sequence gt lt choice gt lt element ref Authorization gt lt element ref Sale gt lt choice gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt lt complexType gt lt
136. nd handling charges For separate shipping and handling amounts use FreightAmt and HandlingAmt respectively Duty fees if applicable Total of all taxes Boolean which when true indicates that the national tax in included in the TaxAmt Grand total item subtotal DiscountAmt ShippingAmt or HandlingAmt FreightAmt DutyAmt TaxAmt Shipping charges without handling included Handling charges without shipping included Sum of cost of all items in this order Free form comment about the purchase See Table 3 3 Level 3 commercial credit card transaction parameters on page 52 Custom memo about the credit Free form field for your own use such as a tracking number or other value you want PayPal to return in the GetExpressCheckout response Description of items the customer is purchasing Optional element that may carry extended data outside the syntax of the XMLPay schema Merchant name and location defined on page 30 Detail of a charge for additional breakdown of the amount defined in AdditionalAmounts on page 31 Merchant product SKU Name of the server that the account holder is connected to Account holder s HTTP browser type Items is a list of line item detail records Item is defined below lt Items gt Item lt Items gt XMLPay Developer s Guide ltem lt Item Number gt SKU UPC Description Quantity UnitOfMeasurement UnitPrice Disco
137. ne of street address for Level3Invoice shipper Requestor REQCITY City of requestor Level3Invoice gt Requestor REQSTATE State of requestor Level3Invoice gt Requestor REQZIP Zip code of requestor Level3Invoice gt Requestor REQCOUNTRY Country of requestor Level3Invoice Requestor SHIPPEDFROMNAME Name of shipper Invoice ShipFrom XMLPay Developer s Guide XMLPay Elements Credit Card Transaction Parameters TABLE 3 3 Level 3 commercial credit card transaction parameters Payflow SDK Parameter Description XMLPay Element SHIPPEDFROMFIRSTADDR First line of street address for Invoice ShipFrom shipper SHIPPEDFROMSECONDADDR Second line of street address for Invoice ShipFrom shipper SHIPPEDFROMCITY City of shipper Invoice ShipFrom SHIPPEDFROMSTATE State of shipper Invoice ShipFrom SHIPPEDFROMZIP Zip code of shipper Invoice ShipFrom SHIPPEDFROMCOUNTRY Country of shipper Invoice ShipFrom STATEANDLOCALTAXAMT State and Local tax amount Level3Invoice gt StateAndLocalTax STATEANDLOCALTAXEXEMPTCODE State and Local tax exempt code Level3Invoice StateAndLocalTax STATEANDLOCALTAXPERCENT State and Local tax rate Level3Invoice gt StateAndLocalTax STATES ALESTAXAMT State tax amount Level3Invoice State Tax STATES ALESTAXEXEMPTCODE State tax exempt code Level3 Invoice StateTax STATESALESTAXPERCENT State tax rate Level3Invoice State Tax STATEGOODSTAXAMT State goods tax amount Level3Invoice gt StateGoodsTax STATEGOODSTAX
138. ng gt lt enumeration value E gt lt enumeration value O gt lt enumeration value X gt lt enumeration value I gt lt enumeration value Y lt enumeration value A gt lt enumeration value U gt lt enumeration value N gt lt enumeration value F gt XMLPay Developer s Guide 109 XMLPay Schemas XMLPay Schema lt simpleType gt lt element name AVSResult gt lt complexType content elementOnly gt lt sequence gt lt element name StreetMatch type MatchResultEnum gt lt element name ZipMatch type MatchResultEnum gt lt sequence gt lt complexType gt lt element gt lt simpleType name AuthCodeType base string gt lt maxLength value 6 gt lt simpleType gt lt simpleType name HostCodeType base string gt lt maxLength value 6 gt lt simpleType gt lt simpleType name StatusType base string gt lt maxLength value 3 gt lt simpleType gt lt simpleType name MatchResultEnum base string lt enumeration value Match gt lt enumeration value No Match gt lt enumeration value Service Not Available gt lt enumeration value Service Not Requested gt lt simpleType gt lt element name UserPass gt lt complexType content elementOnly gt lt sequence gt lt element name User type UserIdType lt element name UserDomain type lt element name Passwor
139. ng minOccurs 0 maxOccurs 1 gt lt element name OSName type string minOccurs 0 maxOccurs 1 gt lt element name OSArchitecture type string minOccurs 0 maxOccurs 1 gt lt element name OSVersion type string minOccurs 0 maxOccurs 1 gt lt element name JavaVersion type string minOccurs 0 maxOccurs 1 gt lt element name Proxy type string minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name RequestData gt lt complexType content elementOnly gt lt sequence gt Developer s Guide 101 XMLPay Schemas XMLPay Schema lt element name Vendor type UserIdType lt element name Partner type UserIdType gt lt choice gt lt element name Transactions gt lt complexType content elementOnly gt lt element ref Transaction minOccurs 1 maxOccurs unbounded gt lt complexType gt lt element gt lt element name RecurringProfiles gt lt complexType content elementOnly gt lt element ref RecurringProfile minOccurs 1 maxOccurs unbounded gt lt complexType gt lt element gt lt element name AccountUpdateRequests gt lt complexType content elementOnly gt lt element ref AccountUpdateRequest minOccurs 1 maxOccurs unbounded gt lt c
140. nkacs bank com ascurl lt ACSUr1 gt lt ECI gt 7 lt ECI gt lt BuyerAuthResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt 100 XMLPay Developer s Guide XMLPay Schemas This appendix contains the XMLPay schema Note The RepeatSale element is defined but not supported XMLPay Schema lt xml version 1 0 gt lt schema targetNamespace http www paypal com XMLPay unqualified unqualified http www w3 org 1999 XMLSchema include schemaLocation XMLPayTypes xsd lt element name XMLPayRequest gt lt complexType content elementOnly gt lt sequence gt lt element ref RequestData gt lt element ref RequestAuth gt lt sequence gt lt attribute name version type string gt lt attribute name request_id type string gt lt attribute name response_id type string gt lt attribute name Timeout type int gt lt complexType gt lt element gt lt element name VersionIntegrationTracking lt complexType content elementOnly gt lt sequence gt lt element name IntegrationType type string minOccurs 0 maxOccurs 1 gt lt element name IntegrationVersion type string minOccurs 0 maxOccurs 1 gt lt element name WrapperType type string minOccurs 0 maxOccurs 1 gt lt element name WrapperVersion type stri
141. nt Recurring Profiles lt XMLPayResponse gt Attribute Vendor Partner RecurringProfileResult Signature TransactionReceipts Description Identifies the merchant of record for the transaction within the payment processing network Identifies the partner who submitted the transaction on behalf of the vendor Defined on page 43 Optional signature over ResponseData executed by the payment processing gateway using the W3C XML Signature syntax This signature may be used to provide integrity protection of the response data and or authentication of the responder if needed transport level security may also be used to provide these protections Optional list of receipts from the payment processing network BuyerAuthResult Response for Buyer Authentication transactions VerifyEnrollment and ValidateAuthentication lt BuyerAuthResult gt Status AuthenticationId PAReq ACSUr1 ECI CAVV XID lt BuyerAuthResult gt Attribute Description Status Status of the transaction AuthenticationId Message id for the response PAReq Payer authentication request returned if cardholder is enrolled ACSUrl The issuer ACS URL at which the cardholder would authenticate by providing the password ECI The Electronic Commerce Indicator value that implies the authentication outcome Defaulted to 7 since cardholder has not authenticated yet CAVV Cardholder Authentication Verification Value XID T
142. nt name ProfileID type ProfileIDType lt element ref RPData minOccurs 0 maxOccurs 1 gt lt element ref Tender minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name Payment gt lt complexType content elementOnly gt lt sequence gt lt element name ProfileID type ProfileIDType lt element ref RPData minOccurs 0 maxOccurs 1 gt lt element ref Tender minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name Inquiry gt lt complexType content elementOnly gt lt element name ProfileID type ProfileIDType lt element name PaymentHistory type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name RPData gt lt complexType content elementOnly gt lt sequence gt lt element name Name type RPNameType minOccurs 0 maxOccurs 1 gt lt element name TotalAmt type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name Start type RPDateType minOccurs 0 maxOccurs 1 gt lt element name Term type int minOccurs 0 maxOccurs 1 gt lt element name PayPeriod type PayPeriodType minOccurs 0 maxOccurs 1 gt XMLPay Developer s Guide 111 XMLPay Schemas XMLPay Schema lt element name MaxFailPayments type int minOccurs 0 m
143. ntAmt TaxAmt Delivery PickUp sh ipmentNumber XMLPay Developer s Guide XMLPay DTD m lt ELEMENT ItemAmt PCDATA gt lt ATTLIST ItemAmt Currency CDATA IMPLIED gt lt ELEMENT Comment PCDATA gt lt ELEMENT AlternateTaxAmount PCDATA gt lt ATTLIST AlternateTaxAmount Currency CDATA IMPLIED gt lt ELEMENT AlternateTaxID PCDATA gt lt ELEMENT BuyingGroup Name Address gt lt ELEMENT CardStart PCDATA gt lt ELEMENT CardIssue PCDATA gt lt ELEMENT CustomerValueAddedTaxRegNum PCDATA gt lt ELEMENT FreightRate PCDATA gt lt ELEMENT GenericProductDescription PCDATA gt lt ELEMENT HandlingRate PCDATA gt lt ELEMENT InvoiceExpirationDate PCDATA gt lt ELEMENT NationalTax Amount ExemptCode Percent gt lt ELEMENT Requestor Name Address gt lt ELEMENT ValueAddedTaxRegNum PCDATA gt lt ELEMENT Level3Invoice AllTax AlternateTaxAmount AlternateTaxID BuyingGroup CardStart CardIssue CountyTax CountySalesTax CityTax CustomerValueAddedTaxRegNum CommCode EnvironmentalTax FreightRate GenericProductDescription HandlingRate InvoiceExpirationDate LocalTax NationalTax Requestor StateAndLocalTax StateSalesTax StateGoodsTax StateTax StateServi
144. nterNumber Purchaser s department number to which the item will be billed TrackingNumber Shipper s tracking code CatalogNumber Merchant s product code SKU may also be used for the same purpose UNSPSCCode Universal Standard Products and Services Classification Global marketplace classification system developed and managed by the Electronic Commerce Code Management Association ECCMA ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema lt MerchantInfo gt MerchantName MerchantStreet MerchantCity MerchantState Merchant Zip MerchantCountryCode lt Merchant Info gt Attribute Description MerchantName Merchant s name MerchantStreet Merchant s street address including number MerchantCity Merchant s city name MerchantState Merchant s state or province For US addresses two character state codes should be used XMLPay Developer s Guide XMLPay Syntax Core Structures Attribute Description MerchantCountryCode Merchant s country code ISO 3166 Default is US MerchantZip Merchant s postal code AdditionalAmounts lt AdditionalAmounts gt Amount1 Amount 2 Amount3 Amount 4 Amount 5 lt AdditionalAmounts gt Attribute Description Amount1 Amount2 Amount3 Amount4 Amount5 Address lt Address gt Street City State Zip Country lt Address gt Attr
145. ntication Service Validate Authentication failed Mismatched or invalid Merchant ID in PARES 1048 Buyer Authentication Service Validate Authentication failed Mismatched or invalid card number in PARES 1049 Buyer Authentication Service Validate Authentication failed Mismatched or invalid currency code in PARES 1050 Buyer Authentication Service Validate Authentication failed Mismatched or invalid XID in PARES 1051 Buyer Authentication Service Validate Authentication failed Mismatched or invalid order date in PARES 1052 Buyer Authentication Service Validate Authentication failed This PARES was already validated for a previous Validate Authentication transaction AVS Result Codes For US customers the Address Verification Service AVS compares the street address and zip code submitted with that on file at the cardholder s bank Any one of the following results can appear in the AVS Street Match and AVS Zip Match fields on the transaction detail screen TABLE C 2 AVS ZIP match results Result Meaning MATCH Information submitted matches information on file with cardholder s bank NO MATCH Information submitted does not match information on file with the cardholder s bank XMLPay Developer s Guide Transaction Results AVS Result Codes Results can vary on the same transaction detail screen In other words AVS Street Match Y and AVS Zip Match N and vice versa could appear on the same t
146. o the Fraud Protection Services To avoid charging you to filter recurring transactions that you know are reliable the fraud filters do not screen recurring transactions To screen a prospective recurring customer submit the transaction data using PayPal Manager s Transaction Terminal page The filters screen the transaction in the normal manner If the transaction triggers a filter then you can follow the normal process to review the filter results Format Y or N Invoice number Invoice date YY YYMMDD ISO 8601 Information about the biller Information about the buyer Buyer s purchase order number Indicates that the buyer is a tax exempt entity Shipping carrier Shipping method Information about the shipping addresses if different from BillFrom and BillTo respectively Summary description of the purchase This field in the case of an Amex purchase card can contain up to four separate descriptions of 40 characters each Full line item breakdown of the purchase Defined on page 28 XMLPay Developer s Guide 27 28 XMLPay Syntax Core Structures Items Attribute DiscountAmt ShippingAmt DutyAmt TaxAmt NationalTaxIncl TotalAmt FreightAmt HandlingAmt ItemAmt Comment Level3Invoice Memo Custom OrderDesc ExtData MerchantInfo AdditionalAmounts SKU CustomerHostName CustomerBrowser Description Discount to be applied to the item subtotal Total of shipping a
147. omplexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name CountySalesTax type Level3TaxType minOccurs 0 maxOccurs gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 17 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name CountyTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name EnvironmentalTax type Level3TaxType minOccurs 0 maxOccurs 1 lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string
148. omplexType gt lt element gt lt choice gt lt element ref VersionIntegrationTracking minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt element name RequestAuth gt lt complexType content elementOnly gt lt choice gt lt element ref UserPass gt lt element ref Signature gt lt choice gt lt complexType gt lt element gt lt element name XMLPayResponse lt complexType content elementOnly gt lt sequence gt lt element ref ResponseData gt lt element ref Signature minOccurs 0 maxOccurs 1 gt lt element name TransactionReceipts minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element ref XMLPayReceipt minOccurs 1 maxOccurs unbounded gt lt complexType gt lt element gt lt sequence gt lt attribute name xmlns type string gt lt attribute name version type string gt lt attribute name request_id type string gt lt attribute name response_id type string gt lt complexType gt lt element gt lt element name ResponseData gt lt complexType content elementOnly gt lt sequence gt lt element name Vendor type UserIdType lt element name Partner type UserIdType gt 102 Developer s Guide XMLPay Schemas XMLPay Schema lt choice gt lt element name TransactionResults gt
149. onse to identify this request as part of the same checkout session XMLPay Element PayPalResult Custom PayPalResult Custom PayPalResult ExtData PayPalResult gt InvNum PayPalResult Payerld PayPalResult PayerStatus PayPalResult Phone PayPalResult PPRef PayPalResult ExtData ShipTo Address City ShipTo Address Country PayPalResult ExtData ShipTo Address State ShipTo Address Zip PayPal Token XMLPay Developer s Guide 63 XMLPay Elements PayPal Express Checkout Response Transaction Parameters 64 XMLPay Developer s Guide XMLPay Transaction Profiles The following tables document the transactions supported for each tender along with the data elements used for each of those transactions ACH Transactions ACH supports the following transactions Sale Credit and Void The following data are used to process ACH transactions Invoice TotalAmt ACH AcctType ACH AcctNum ACH ABA ACH AuthType ACH Prenote BillTo Name Buyer Authentication Transactions Buyer authentication supports the following transactions VerifyEnrollment and ValidateAuthentication For VerifyEnrollment the following data are used to process the transactions required elements are in bold text Invoice TotalAmt with Currency attribute Invoice Description Card CardNum Card ExpDate For ValidateAuthentication the following data are required to process the transactions PARes XMLP
150. outside the syntax of the XMLPay schema DoExpressCheckout Transaction DoExpressCheckout obtains payment through Express Checkout for a Sale transaction or requests an Authorization for a later capture of payment lt DoExpressCheckout gt Authorization Sale ExtData lt DoExpressCheckout gt Attribute Description Authorization The Express Checkout transaction to be carried out an authorization for payment or sale ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema ForceCapture Transaction A ForceCapture transaction captures funds reserved through an out of band authorization for example a voice authorization received over the phone lt ForceCapture gt lt PayData gt Invoice XMLPay Developer s Guide 19 20 XMLPay Syntax The XMLPayRequest Document Transactions Tender lt PayData gt AuthCode ExtData lt ForceCapture gt Attribute Description AuthCode Authorization code received out of band PayData Specifies the details of the purchase within Invoice as well as the payment Tender to use ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema GetStatus Transaction A GetStatus transaction queries the status of a previous transaction lt GetStatus gt PNRe f ExtData lt GetStatus gt Attribute Description PNRef The transaction to query is
151. pe AUResponseText gt lt element name AUSubmitDate type date minOccurs 0 maxOccurs 1 gt lt element ref Tender minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name HTTPCommitResult gt lt complexType content elementOnly gt lt sequence gt lt element name Result type int lt element name Message type string minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded lt sequence gt lt complexType gt lt element gt lt element name BuyerAuthResult gt lt complexType content elementOnly gt lt sequence gt lt element name Status type BuyerAuthStatusEnum gt lt element name AuthenticationId type Base64ShalStringType minOccurs 0 maxOccurs 1 gt lt element name PAReq type BuyerAuthMesgType minOccurs 0 maxOccurs 1 gt lt element name ACSUrl type uriReference minOccurs 0 maxOccurs 1 gt lt element name type ECIType minOccurs 0 maxOccurs 1 gt lt element name type Base64ShalStringType minOccurs 0 maxOccurs 1 gt lt element name XID type Base64ShalStringType minOccurs 0 maxOccurs 1 gt lt sequence gt lt complexType gt lt element gt lt simpleType name BuyerAuthStatusEnum base stri
152. plexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name StateGoodsTax type Level3TaxType minOccurs 0 maxOccurs Le lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name StateTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name StateServicesTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name ExemptCode type string minOccur
153. press Checkout added to your account 26 Invalid vendor account Login information is incorrect Verify that USER VENDOR PARTNER and PASSWORD have been entered correctly VENDOR is your merchant ID and USER is the same as VENDOR unless you created a Payflow Pro user All fields are case sensitive 27 Insufficient partner permissions 28 Insufficient user permissions 29 Invalid XML document This could be caused by an unrecognized XML tag or a bad XML format that cannot be parsed by the system 30 Duplicate transaction 31 Error in adding the recurring profile 32 Error in modifying the recurring profile 33 Error in canceling the recurring profile 146 Developer s Guide Transaction Results TABLE C 1 Payflow transaction RESULT values and RESPMSG text Continued RESULT 34 35 36 37 50 51 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 RESPMSG and Explanation Error in forcing the recurring profile Error in reactivating the recurring profile OLTP Transaction failed Invalid recurring profile ID Insufficient funds available in account Exceeds per transaction limit General error See RESPMSG Transaction type not supported by host Time out value too small Processor not available Error reading response from host Timeout waiting for processor response Try your transaction again Credit error Make sure you have not already credited this transaction or that t
154. pressCheckout Authorization Sale ExtData gt lt ELEMENT DoExpressCheckout Authorization Sale ExtData gt lt ELEMENT Verbosity PCDATA gt lt ELEMENT BrowserUserAgent PCDATA gt lt ELEMENT BrowserTime PCDATA gt lt ELEMENT BrowserCountryCode PCDATA gt lt ELEMEN ransaction Authorization Capture Sale Credit Void ForceCapture RepeatSale GetStatus VerifyEnrollment ValidateAuthentication TransactionUpdate SetExpressCheckout GetExpressCheckout DoExpressCheckout Verbosity BrowserUserAgent BrowserTime BrowserCountryCode gt lt ATTLIS ransaction Id CDATA IMPLIED gt lt ATTLIS ransaction CustRef CDATA IMPLIED gt lt ELEMEN ransactions Transaction gt lt ELEMENT Start PCDATA gt lt ELEMENT Term PCDATA gt lt ELEMENT PayPeriod PCDATA gt lt ELEMENT MaxFailPayments PCDATA gt lt ELEMENT RetryNumDays PCDATA gt lt ELEMENT CompanyName PCDATA gt XMLPay Developer s Guide 139 B XMLPay DTD lt ELEMENT OptionalTrans PCDATA gt lt ELEMENT OptionalTransAmt PCDATA gt lt ATTLIST OptionalTransAmt Currency CDATA IMPLIED gt lt ELEMENT OrigProfileID PCDATA gt lt ELEMENT PaymentNum PCDATA gt
155. pture transaction attribute 20 GetExpressCheckout attribute 19 GetStatus transaction attribute 20 Invoice attribute 28 Item attribute 30 PayPal attribute 35 RecurringProfileResult attribute 43 45 RPData attribute 37 sale transaction attribute 18 SetExpressCheckout attribute 19 TransactionResult attribute 40 ValidateAuthentication transaction attribute 21 VerifyEnrollment transaction attribute 21 ExtData attribute 37 155 ExtData example 95 ExtData using 47 Extensible Markup Language 9 eXtensible Markup Language see XML Fax PayPalResult attribute 41 Invoice attribute 27 RPData attribute 37 FeeAmount PayPalResult attribute 41 ForceCapture transaction attributes 20 Fraud Prevention Service transaction parameters 60 to FraudPostprocessorResult TransactionResult attribute 39 FraudPreprocessorResult TransactionResult attribute 39 FreightAmt 30 Invoice attribute 28 Item attribute 30 G GetStatus transaction attributes 20 H HandlingAmt 30 Invoice attribute 28 Item attribute 30 HeaderBackColor PayPal attribute 35 HeaderBorderColor PayPal attribute 35 HeaderImage PayPal attribute 35 HostCode TransactionResult attribute 39 HostURL TransactionResult attribute 39 HTML 9 HyperText Markup Language 9 156 IAVS result request example 88 IAVSResult TransactionResult attribute 39 Id RecurringProfile attribute 22 RecurringProfileResult attribute 43 XMLPay transaction attribute 16 including para
156. r 0 The value 1 indicates that on the PayPal pages no shipping address fields should be displayed whatsoever Is 1 or 0 The value 1 indicates that the PayPal pages should display the shipping address set by you in the shipping address SHIPTO parameters passed to this Set Express Checkout request not the shipping address on file with PayPal for this customer Displaying the PayPal street address on file does not allow the customer to edit that address Locale of pages displayed by PayPal during Express Checkout Sets the Custom Payment Page Style for payment pages associated with this button link PageStyle corresponds to the HTML variable page_style for customizing payment pages The value is the same as the Page Style Name you chose when adding or editing the page style from the Profile subtab of the My Account tab of your PayPal account A URL for the image you want to appear at the top left of the payment page The image has a maximum size of 750 pixels wide by 90 pixels high PayPal recommends that you provide an image that is stored on a secure https server Sets the border color around the header of the payment page The border is a 2 pixel perimeter around the header space which is 750 pixels wide by 90 pixels high Sets the background color for the header of the payment page Sets the background color for the payment page Identification code for use by third party applications to identify transactions Optional e
157. r lt Vendor gt lt Partner gt partner lt Partner gt 92 Developer s Guide XMLPay Examples Processor Result lt Transactions gt lt Transaction gt lt Authorization gt lt PayData gt lt Invoice gt lt MerchantDescription gt lt MerchantDescription gt lt MerchantServiceNum gt lt MerchantServiceNum gt lt NationalTaxIncl gt false lt NationalTaxIncl gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt visa lt CardType gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200911 lt ExpDate gt lt NameOnCard gt lt Card gt lt Tender gt lt PayData gt lt Authorization gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Processor Result lt xml version 1 0 lt XMLPayResponse gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt ProcessorResult gt lt AVSResult gt Z lt AVSResult gt lt CVResult gt T lt CVResult gt ncoding UTF 8 lt STAN gt 13523 lt STAN gt lt ProcessorResult gt lt AVSResult gt lt StreetMatch gt Service Not Available lt StreetMatch gt l
158. r s Guide 161 162 XMLPay Developer s Guide
159. ransaction ID 42 XMLPay Developer s Guide XMLPay Syntax XMLPayResponse Document Recurring Profiles RecurringProfileResult Non Inquiries Response for Add Modify Cancel Reactivate and Payment actions lt RecurringProfileResult Id gt Result essage ProfileID RPRef TransactionResult ExtData lt RecurringProfileResult gt Attribute Description Result Number that indicates outcome of the transaction see Appendix C Transaction Results Message Descriptive message describing Result ProfileID Profile ID of the profile that gets the action RPRef Identifier assigned to the transaction by the payment processing network TransactionResult ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema Id Identifier assigned to the transaction by the merchant if one was provided in the transaction request Inquiries Response for Inquiry action lt RecurringProfileResult Id gt Result essage ProfileID RPRef Start Term End PayPeriod axFailPayments RetryNumDays EMail CompanyName Amt XMLPay Developer s Guide 43 44 XMLPay Syntax The XMLPayResponse Document Recurring Profiles PaymentsLeft NextPayment AggregateAmt AggregateOptionalTransAmt NumFailedPayments ShipTo ExtData lt RecurringProfil
160. ransaction detail screen When service is unavailable no code is returned XML Pay Developer s Guide 151 C Transaction Results AVS Result Codes 152 XMLPay Developer s Guide Index A ABA ACH attribute 32 AcctNum ACH attribute 32 AcctType ACH attribute 32 ACH transaction parameters 60 transaction profiles 65 ACH attributes 32 ACH sale request example 70 ACH sale response example 71 ACHStatus TransactionResult attribute 39 ACSUrl BuyerAuthResult attribute 42 add recurring profile attributes 23 adding a recurring profile 23 AdditionalAmounts Invoice attribute 28 Address Invoice attribute 27 PayPalResult attribute 41 RPData attribute 37 Address attributes 30 31 Address Verification Service 150 AddressOverride PayPal attribute 35 AggregateAmt RecurringProfileResult attribute 44 AggregateOptionalTransAmt RecurringProfileResult attribute 45 Amountn AdditionalAmounts attribute 31 Amt RecurringProfileResult attribute 44 AuthCode ForceCapture transaction attribute 20 TransactionResult attribute 39 AuthenticationId BuyerAuthResult attribute 42 XMLPay Developer s Guide Authorization DoExpressCheckout attribute 19 GetExpressCheckout attribute 19 SetExpressCheckout attribute 19 authorization transaction attributes 17 AuthType ACH attribute 32 Automated Clearing House see ACH AVS see Address Verification Service AVS Result Codes 150 AVSResult TransactionResult attribute 39 AVSResult attributes 40 41 B2B 1
161. s 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name ValueAddedTax type Level3TaxType minOccurs 0 maxOccurs gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs nq gt lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name ValueAddedTaxRegNum type string minOccurs 0 maxOccurs 1 gt lt element ref ExtData minOccurs 0 maxOccurs unbounded gt lt sequence gt Developer s Guide 119 XMLPay Schemas XMLPay Types Schema lt complexType gt lt element gt lt element name Level3Item gt lt complexType content elementOnly gt lt sequence gt lt element name AllTax minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs In lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name CityTax type Level3TaxType minOccurs 0 maxOccurs 1 gt lt c
162. s 58 credit card transaction parameters 48 to 58 credit card transaction response parameters 58 to 59 Fraud Prevention Service transaction parameters 60 to level 3 credit card transaction parameters 52 to 58 retail credit card transaction parameters 48 to 52 Payflow Pro general parameters to 47 PayflowColor PayPal attribute 35 Payment recurring profile attributes 24 PaymentNum RPData attribute 37 PaymentsLeft RecurringProfileResult attribute 44 PaymentTyp PayPalResult attribute 41 PayPalResult TransactionResult attribute 39 PayPeriod RecurringProfileResult attribute 44 RPData attribute 36 PendingReason PayPalResult attribute 41 Phone Invoice attribute 27 PayPalResult attribute 41 RPData attribute 37 PickUp Address Item attribute 30 PKCS 7 25 PNRef credit transaction attribute 18 GetStatus transaction attribute 20 TransactionResult attribute 39 void transaction attribute 18 PPRef PayPalResult attribute 41 Prenote ACH attribute 32 processor result example 93 ProcessorResult TransactionResult attribute 39 profile ACH transactions 65 buyer authentication 65 check transaction 67 example recurring billing 94 level I purchase card transactions 66 level IT purchase card transactions 66 level III purchase card transactions 66 retail credit card transaction 66 retail debit card transaction 66 ProfileID cancel recurring profile attribute 23 Inquiry recurring profile attribute 24 modify recurring profile attribute 23 Pa
163. se ResponseData lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Service Not Available lt StreetMatch gt lt ZipMatch gt Service Not Available lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt V63A09910356 lt PNRef gt lt AuthCode gt 747PNI lt AuthCode gt lt HostCode gt 00 lt HostCode gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt 72 Developer s Guide XMLPay Examples Card Capture Request Card Capture Request lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Capture gt lt PNRef gt V63A09910356 lt PNRef gt lt Capture gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Card Capture Response lt xml version 1 0 encoding UTF 8 XMLPayResponse ResponseData lt
164. se gt E Value Gonzalez gt lt ExtData gt Do Express Checkout Request lt xml version 1 0 encoding UTF 8 XMLPayRequest Timeout 30 version 2 0 gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt DoExpressCheckout gt lt Authorization gt lt PayData gt lt Invoice gt lt TotalAmt Currency 840 gt 1 23 lt TotalAmt gt lt Invoice gt lt Tender gt lt PayPal gt lt Token gt EC 1R668591NV5623643 lt Token gt PayerID gt 2BUBWABP28LFL lt PayerID gt lt PayPal gt lt Invoice gt ExtData Name VERBOSITY Value HIGE gt lt Invoice gt lt Tender gt lt PayData gt lt Authorization gt lt DoExpressCheckout gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt A Developer s Guide 87 XMLPay Examples IAVS Result Request Do Express Checkout Response XMLPayResponse xmlns http www paypal com XMLPay lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Match lt StreetMatch gt lt ZipMatch gt lt Zip
165. se lt City gt lt State gt CA lt State gt lt Zip gt 95032 lt Zip gt 94 Developer s Guide XMLPay Examples FRA Recurring Billing Profile lt Count ry gt USA lt Country gt lt Address gt lt BillTo gt lt RPData gt lt Add gt lt RecurringProfile gt lt RecurringProfiles gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt v3test lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt Credit Card Recurring Billing Profile Payflow XML does not parse certain name value pair NVP tags For example to pass a value for the CURRENCY tag which is not supported you must pass it as extended data ExtData as shown below lt xml version 1 0 encoding UTF 8 gt lt XMLPayRequest Timeout 30 version 2 0 gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt RecurringProfiles gt lt RecurringProfile Id 1 gt lt Add gt lt Tender gt lt Card gt lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200803 lt ExpDate gt lt NameOnCard gt name lt NameOnCard gt lt Card gt lt Tender gt lt RPData gt lt Name gt Test Profile lt Name gt lt ExtData Name CURRENCY Value EUR gt lt ExtData gt lt TotalAmt gt 1 23 lt TotalAmt gt lt Start gt 12122004 lt Start gt lt Term gt 12 lt Term gt lt PayPeriod gt Weekly lt PayPeriod
166. se xmlns http www paypal com XMLPay lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt AVSResult gt lt StreetMatch gt Service Not Requested lt StreetMatch gt lt ZipMatch gt Service Not Requested lt ZipMatch gt lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt VCNB01775729 lt PNRef gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Customer IP lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 xmlns http www paypal com XMLPay lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt Authorization gt lt PayData gt lt Invoice gt lt Cust IP gt 192 168 100 31 lt CustIP gt lt NationalTaxIncl gt false lt NationalTaxIncl gt lt TotalAmt gt 24 97 lt TotalAmt gt lt Invoice gt lt Tender gt lt Card gt lt CardType gt visa lt CardType gt XMLPay Developer s Guide 83 XMLPay Examples Express Checkout Authorization Transaction lt CardNum gt 5105105105105100 lt CardNum gt lt ExpDate gt 200911 lt ExpDate gt lt Card gt lt Tender gt lt PayData gt
167. ssing applications Business to Consumer In a B2C Sale transaction the Buyer presents a payment instrument for example a credit card number to a Seller to transfer money from the Buyer to the Seller Merchant Web Store Financial e k networks HTTPS typical E 1 XMLPay BUY Buyer Payment Payment y Seller Gateway Processor The Seller uses XMLPay to forward the Buyer s payment information to a Payment Processor The Seller formats an XMLPayRequest and submits it either directly to an XMLPay compliant payment processor or as pictured indirectly via an XMLPay compliant Payment Gateway Responses have the type XMLPayResponse The Buyer to Seller and Payment Gateway to Processor channels are typically left unaffected by use of XML Pay For example XML Pay is typically not used in direct communications between the buyer and the seller Instead conventional HTML form submission or other Internet communication methods are typically used Similarly because Payment Processors often differ considerably the formats they specify for payment requests XML server logic is usually localized at the Payment Gateway leaving the legacy connections between gateways and processors unchanged XMLPay Developer s Guide 11 XMLPay Overview XMLPay Messaging Business to Business When used in support of B2B transactions the Seller does not typically initiate XMLPay requests Instead an aggregator or trading exchange
168. t ELEMENT EnvironmentalTax Amount ExemptCode Percent gt lt ELEMENT LocalTax Amount ExemptCode Percent gt lt ELEMENT StateAndLocalTax Amount ExemptCode Percent gt lt ELEMENT StateTax Amount ExemptCode Percent gt lt ELEMENT StateGoodsTax Amount ExemptCode Percent gt lt ELEMENT StateSalesTax Amount ExemptCode Percent gt lt ELEMENT StateServicesTax Amount ExemptCode Percent gt lt ELEMENT ValueAddedTax Amount ExemptCode Percent gt lt ELEMENT TaxType PCDATA gt lt ELEMENT Level3Item AlITax CityTax CountySalesTax EnvironmentalTax LocalTax StateAndLocalTax StateSalesTax StateServicesTax ValueAddedTax TaxType lt ExtAmt CostCenterNumber Trackin UNSPSCCode CatalogNumber TaxRate TotalAmt ExtData FreightAmt HandlingAmt Level3Item gNumber 2 CommCode lt ATTLIST Item Number CDATA REQUIRED gt ELI Items Item lt EL lt ATT ShippingAmt PC IST ShippingAmt Curr lt EL lt ATTI DutyAmt DutyAmt Currency lt ELE NationalTaxIncl PCDATA gt DATA gt ency CDATA IMPLIED gt CDATA IMPLIED gt PCDATA gt CountyTax StateTax StateGoodsTax ExtData gt Item SKU UPC Description Quantity UnitOfMeasurement UnitPrice Discou
169. t TotalAmt gt lt Item gt lt Items gt Using XMLPay XMLPay defines an XML syntax for payment transaction requests and responses in a payment processing network The typical user of XMLPay is an Internet merchant or merchant aggregator who wants to dispatch credit card corporate purchase card Automated Clearing House ACH or other payment requests to a financial processing network Using the data type definitions specified by XMLPay a user creates a client payment request and dispatches it using a mechanism left unspecified by XMLPay to an associated XMLPay compliant server component Responses also formatted in XML convey the results of the payment requests to the client For specific examples of how to submit XML documents using the Website Payments Pro Payflow Edition client service see the PayPal Manager Download package XMLPay Instruments XMLPay supports payment processing using the following payment instruments e Retail credit and debit cards 10 Developer s Guide XMLPay Overview a XMLPay Processing Models e Corporate purchase cards Levels 1 2 and 3 e Automated Clearing House ACH XMLPay Operations Typical XMLPay operations include e Funds authorization and capture e Sales and repeat sales e Voiding of transactions XMLPay Processing Models XML Pay is intended for use in both Business to Consumer B2C and Business to Business B2B payment proce
170. t ZipMatch gt Service Not Available lt ZipMatch gt XMLPay Developer s Guide 93 XMLPay Examples Recurring Billing Profile lt AVSResult gt lt CVResult gt Service Not Requested lt CVResult gt lt Message gt Approved lt Message gt lt PNRef gt V63A09910356 lt PNRef gt lt AuthCode gt 747PNI lt AuthCode gt lt HostCode gt 00 lt HostCode gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt lt XMLPayResponse gt Recurring Billing Profile This section includes a sample ACH recurring billing profile and a sample credit card billing profile ACH Recurring Billing Profile lt xml version 1 0 encoding UTF 8 lt XMLPayRequest Timeout 30 version 2 0 gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt RecurringProfiles gt lt RecurringProfile Id 10001 gt lt Add gt lt Tender gt lt ACH gt lt AcctType gt C lt AcctType gt lt AcctNum gt 5105105105105100 lt AcctNum gt lt ABA gt 091000019 lt ABA gt lt ACH gt lt Tender gt lt RPData gt lt Name gt Test Profile lt Name gt lt TotalAmt gt 1 23 lt TotalAmt gt lt Start gt 03042004 lt Start gt lt Term gt 12 lt Term gt lt PayPeriod gt Weekly lt PayPeriod gt lt EMail gt a com lt EMail gt lt BillTo gt lt Address gt lt Street gt 123 4th street lt Street gt lt City gt San Jo
171. t complexType content elementOnly gt lt element name MerchantName type string minOccurs 0 maxOccurs 1 gt lt element name MerchantStreet type string minOccurs 0 maxOccurs 1 gt lt element name MerchantCity type string minOccurs 0 maxOccurs 1 gt lt element name MerchantState type string minOccurs 0 maxOccurs 1 gt lt element name MerchantCountryCode type CountryCode minOccurs 0 maxOccurs 1 gt lt element MerchantZip type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name Level3Invoice gt lt complexType content elementOnly gt lt sequence gt lt element name AllTax minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Amount type CurrencyAmount minOccurs 0 maxOccurs gum lt element name ExemptCode type string minOccurs 0 maxOccurs 1 gt lt element name Percent type string minOccurs 0 maxOccurs 1 gt lt complexType gt lt element gt lt element name AlternateTaxAmount type CurrencyAmount minOccurs 0 maxOccurs 1 gt lt element name AlternateTaxID type string minOccurs 0 maxOccurs 1 gt lt element name BuyingGroup minOccurs 0 maxOccurs 1 gt lt complexType content elementOnly gt lt element name Name type NameType minOccurs
172. tCode gt lt OrigResult gt 0 lt OrigResult gt lt TransactionResult gt lt TransactionResults gt lt ResponseData gt XMLPay Developer s Guide 97 XMLPay Examples ValidateAuthentication Request lt XMLPayResponse gt ValidateAuthentication Request lt xml version 1 0 gt lt XMLPayRequest gt lt RequestData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt Transactions gt lt Transaction gt lt ValidateAuthentication gt lt PARes gt pares bloc lt PARes gt lt ValidateAuthentication gt lt Transaction gt lt Transactions gt lt RequestData gt lt RequestAuth gt lt UserPass gt lt User gt user lt User gt lt Password gt password lt Password gt lt UserPass gt lt RequestAuth gt lt XMLPayRequest gt ValidateAuthentication Response lt xml version 1 0 gt lt XMLPayResponse gt lt ResponseData gt lt Vendor gt vendor lt Vendor gt lt Partner gt partner lt Partner gt lt TransactionResults gt lt TransactionResult gt lt Result gt 0 lt Result gt lt Message gt OK lt Message gt lt BuyerAuthResult gt lt Status gt Y lt Status gt lt AuthenticationId gt CTEremezUA7PkaDwP0Qk lt AuthenticationId gt lt ECI gt 5 lt ECI gt lt CAVV gt BwAQAJVy YAQECQJTMnJgAAAAAAA lt CAVV gt lt XID gt 8abmKOK1Sf90ujrESKKrKkJCP41I lt XID gt lt BuyerAuthResult gt lt TransactionResult gt 98 Developer s Guide X
173. tax The XMLPayResponse Document Transactions Element Description ExtData Optional element that may carry extended data outside the syntax of the XMLPay schema Attribute Description Result Number that indicates outcome of the transaction see Appendix C Transaction Results CustRef Reference string that identifies the customer Duplicate Identify if the transaction has been run before AVSResult lt AVSResult gt StreetMatch ZipMatch lt AVSResult gt Attribute Description StreetMatch Indicates whether or not the billing street address matched the bank s records Possible values match no match service not available or service not requested ZipMatch Indicates whether or not the billing zip matched the bank s records Possible values match no match service not available or service not requested PayPalResult lt PayPalResult gt EMail Token PPRef FeeAmount PayerStatus PaymentType PendingReason Custom InvNum Phone Name ShipTo CorrelationID PU gee a ee BARN es I ee lt PayPalResult gt XMLPay Developer s Guide XMLPay Syntax XMLPayResponse Document Recurring Profiles Attribute Description Email Customer s email address PayerID Unique encrypted PayPal customer account identification number Token Value PayPal originally returns in Set Express Checkout response after your first call to
174. three failures occurred An attempt was made to submit a transaction that failed to meet the security settings specified on the PayPal Manager Security Settings page If the transaction exceeded the Maximum Amount security setting then no values are returned for AVS or CSC AVS validation failed The AVS return value should appear in the RESPMSG CSC validation failed The CSC return value should appear in the RESPMSG 118 Invalid keywords found in string fields 119 General failure within PIM Adapter 120 Attempt to reference a failed transaction 121 Not enabled for feature 122 Merchant sale total will exceed the credit cap with current transaction ACH transactions only 125 Fraud Protection Services Filter Declined by filters 126 Fraud Protection Services Filter Flagged for review by filters Important Note Result code 126 indicates that a transaction triggered a fraud filter This is not an error but a notice that the transaction is in a review status The transaction has been authorized but requires you to review and to manually accept the transaction before it will be allowed to settle Result code 126 is intended to give you an idea of the kind of transaction that is considered suspicious to enable you to evaluate whether you can benefit from using the Fraud Protection Services To eliminate result 126 turn the filters off For more information see the Fraud Protection Services documentation for your payments solution It
175. tion Processor specific information Only received if Verbosity is set to High Results from the Fraud Protection Service pre process stage Results from the Fraud Protection Service post process stage information returned from the processor International AVS result value if appropriate Results of the AVS check if appropriate Results of the CV check if appropriate Possible values match no match service not available or service not requested Descriptive message describing Result Identifier assigned to the transaction by the payment processing network Authorization code for the transaction provided by the bank if any Result code returned by the payment processor if any Whereas Result provides a normalized view the transaction status HostCode passes through the back end processor status unmodified URL returned by the payment processor if any to use in referring to the transaction Original result for a transaction queried with GetStatus Current status for a transaction queried with GetStatus Status of the ACH transaction returned by Inquiry transaction The PNRef value associated with the original transaction returned by Inquiry transaction The Message value associated with the original transaction returned by Inquiry transaction URL returned by the payment processor if any to use in referring to a receipt for the transaction XMLPay Developer s Guide 39 40 XMLPay Syn
176. ture Optional signature over ResponseData executed by the payment processing gateway using the W3C XML Signature syntax This signature may be used to provide integrity protection of the response data and or authentication of the responder if needed transport level security may also be used to provide these protections TransactionReceipts Optional list of receipts from the payment processing network TransactionResult lt TransactionResult Id gt Result BuyerAuthResult ProcessorResult FraudPreprocessorResult CardSecure IAVSResult AVSResult CVResult essage PNRef AuthCode HostCode HostURL OrigResult Status ReceiptURL ACHStatus OrigPNRef OrigMessage PayPalResult ExtData lt TransactionResult gt FraudPostprocessorResult XMLPay Developer s Guide XMLPay Syntax The XMLPayResponse Document Transactions Element Result BuyerAuthResult ProcessorResult FraudPreprocessorResult FraudPostprocessorResult CardSecure IAVSResult AVSResult CVResult Message PNRef AuthCode HostCode HostURL OrigResult Status ACHStatus OrigPNRef OrigMessage PayPalResult ReceiptURL Description Number that indicates outcome of the transaction see Appendix C Transaction Results Results of the VerifyEnrollment or ValidateAuthentication transac
177. untAmt ShippingAmt FreightAmt HandlingAmt TotalAmt lt PickUp gt Address Time Date RecordNumber lt PickUp gt lt Delivery gt Date Time lt Delivery gt CostCenterNumber TrackingNumber CatalogNumber UNSPSCCode XMLPay Syntax Core Structures ExtData lt Item gt Attribute Description Number Line number for the item in the invoice SKU Merchant s product code for the item stock keeping unit UPC Item s universal product code Description Item s description Quantity Number of units of this item UnitOfMeasurement provides the units for Quantity ISO 31 UnitPrice Cost of each unit DiscountAmt Discount to be applied to this line item TaxAmt Total of all taxes for this line item XMLPay Developer s Guide 29 30 XMLPay Syntax Core Structures Attribute ShippingAmt FreightAmt HandlingAmt TotalAmt PickUp Address Time Date and RecordNumber Delivery Date and Time Description Total of shipping and handling charges For separate shipping and handling amounts use FreightAmt and HandlingAmt respectively Shipping charges without handling included Handling charges without shipping included Total amount including tax and discount for this line item Quantity UnitPrice TaxAmt DiscountAmt Shipment pickup information Expected delivery date and time Merchantinfo CostCe
178. urs 1 gt lt element name CatalogNumber type CatalogType minOccurs 0 maxOccurs 1 gt lt element name CommCode type CommodityCodeType minOccurs 0 maxOccurs DAME lt element ref Level3Item minOccurs 0 maxOccurs 1 gt lt sequence gt lt attribute name Number type int use required gt lt complexType gt lt element gt lt simpleType name UnitOfMeasurementType base string gt lt maxLength value 12 gt lt simpleType gt lt simpleType name SKUType base string gt lt maxLength value 18 gt lt simpleType gt lt simpleType name UPCType base string gt lt maxLength value 18 gt lt simpleType gt lt element name Address gt lt complexType content elementOnly gt lt sequence gt lt element name Company type CompanyNameType minOccurs 0 maxOccurs 1 gt lt element name Street type NameType minOccurs 0 maxOccurs 1 gt lt element name Street2 type NameType minOccurs 0 maxOccurs 1 gt lt element name City type NameType minOccurs 0 maxOccurs 1 gt XMLPay Developer s Guide 123 124 XMLPay Schemas XMLPay Types Schema lt element name State type StateType minOccurs 0 maxOccurs 1 gt lt element name Zip type ZipType minOccurs 0 maxOccurs 1 gt lt element name Country type CountryCode minOccurs 0
179. veloper s Guide 145 Transaction Results TABLE C 1 Payflow transaction RESULT values and RESPMSG text Continued RESULT RESPMSG and Explanation 10 Too many line items 11 Client time out waiting for response 12 Declined Check the credit card number expiration date and transaction information to make sure they were entered correctly If this does not resolve the problem have the customer call their card issuing bank to resolve 13 Referral Transaction cannot be approved electronically but can be approved with a verbal authorization Contact your merchant bank to obtain an authorization and submit a manual Voice Authorization transaction 14 Invalid Client Certification ID Check the HTTP header If the tag X VPS VIT CLIENT CERTIFICATION ID is missing RESULT code 14 is returned 19 Original transaction ID not found The transaction ID you entered for this transaction is not valid See RESPMSG 20 Cannot find the customer reference number 22 Invalid ABA number 23 Invalid account number Check credit card number and re submit 24 Invalid expiration date Check and re submit 25 Invalid Host Mapping Error is caused by one or more of the following e You are trying to process a tender type such as Discover Card but you are not set up with your merchant bank to accept this card type e You are trying to process an Express Checkout transaction when your account is not set up to do so Contact your account holder to have Ex
180. yment recurring profile attribute 24 reactivate recurring profile attribute 24 RecurringProfileResult attribute 43 44 purchase card level I transactions 66 purchase card level II transactions 66 purchase card level III transactions 66 Q Quantity Item attribute 29 R reactivate recurring profile attributes 24 reactivating a recurring profile 23 ReceiptURL TransactionResult attribute 39 RecordNumber Item attribute 30 Recurring Invoice attribute 27 recurring billing profile example 94 recurring profile adding 23 cancelling 23 Inquiry 24 modifying 23 payment 24 reactivating 23 RecurringProfile XMLPay Developer s Guide RecurringProfile transaction attribute 22 RecurringProfile attributes 22 RecurringProfile transaction attributes 22 RecurringProfileResult XMLPayResponse attribute 42 RecurringProfileResult attributes inquiry 44 non inquiry 43 RecurringProfileResult element 43 RepeatSale element 101 ReqConfirmShippingPayerld PayPal attribute 35 RequestAuth 13 RecurringProfile transaction attribute 22 XMLPayRequest attribute 16 RequestAuth element 21 RESPMSG see also response message 145 response message 145 ResponseData 42 RESULT see also transaction result status response 145 Result RecurringProfileResult attribute 43 44 TransactionResult attribute 39 40 retail credit card transaction parameters 48 to 52 retail credit card transaction profile 66 retail debit card transaction 66 RetryNumDays R
181. you do not provide an invoice number the transaction ID PNREF will be submitted Sum of cost of all items in this order Cost of line item Item description Quantity whole units only Line item tax amount Locale of pages displayed by PayPal during Express Checkout The expected maximum total amount of the complete order including shipping and tax charges Custom memo about the credit Is 1 or 0 1 indicates that on the PayPal pages no shipping address fields should be displayed whatsoever An informal note about this settlement that is displayed to the customer in email and in the customer s transaction history Your URL for receiving Instant Payment Notification IPN about this transaction Description of items the customer is purchasing XMLPay Element PayPal HeaderBorderColor PayPal HeaderImage Invoice gt InvNum Invoice ItemAmt Invoice TotalAmt Item Description Item Quantity Item TaxAmt PayPal LocaleCode PayPal ExtData PayPal ExtData PayPal NoShipping PayPal ExtData PayPal NotifyURL PayPal ExtData XMLPay Developer s Guide 61 XMLPay Elements PayPal Express Checkout Request Transaction Parameters TABLE 3 7 Express Checkout request parameters Continued Express Checkout Parameter PAGESTYLE PAYERID PAYFLOWCOLOR REQCONFIRMSHIPPING RETURNURL SHIPPINGTOTAL SHIPTOCITY SHIPTOCOUNTRY SHIPTOSTATE SHIPTOSTREET SHIPTOSTREE
182. ype AcctNum ABA ExtData Address gt lt ELEMENT Debit CardNum ExpDate MagData NameOnCard ExtData gt lt ELEMENT PayerID PCDATA gt lt ELEMENT Token PCDATA gt lt ELEMENT ReturnURL PCDATA gt lt ELEMENT CancelURL PCDATA gt lt ELEMENT NotifyURL PCDATA gt lt ELEMENT ReqConfirmShipping PCDATA gt lt ELEMENT NoShipping PCDATA gt lt ELEMENT AddressOverride PCDATA gt lt ELEMENT LocaleCode PCDATA gt Developer s Guide 137 B XMLPay DTD lt ELEMENT PageStyle PCDATA gt lt ELEMENT HeaderImage PCDATA gt lt ELEMENT HeaderBorderColor PCDATA gt lt ELEMENT HeaderBackColor PCDATA gt lt ELEMENT PayflowColor PCDATA gt lt ELEMENT ButtonSource PCDATA gt lt ELEMENT MerchantSessionID PCDATA gt lt ELEMENT PayPal EMail PayerID Token ReturnURL CancelURL NotifyURL ReqConfirmShipping NoShipping AddressOverride LocaleCode PageStyle HeaderImage HeaderBorderColor HeaderBackColor PayflowColor ButtonSource MerchantSessionID ExtData gt lt ELEMENT Tender ACH Card Check Debit PayPal lt ELEMENT PayData Invoice Tender gt lt ELEMENT PKCS

PayPal XMLPay - 2009 Developer's Guide

Contents

Download Pdf Manuals

Related Search

Related Contents