PP_NVPAPI_DeveloperGuide

March 16, 2018 | Author: flabbyfatnes5 | Category: Uniform Resource Identifier, Pay Pal, Application Programming Interface, Parameter (Computer Programming), Financial Transaction
Share
Report this link


Comments



Description

Name-Value Pair API Developer GuideLast updated: September 2010 Name-Value Pair API Developer Guide Document Number: 100018.en_US-201009 © 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 S.à r.l. et Cie, S.C.A., Société en Commandite par Actions. Registered office: 22-24 Boulevard Royal, L2449, 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. PayPal, Inc. reserves the right to make changes to any information herein without further notice. Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Chapter 1 PayPal NVP API Overview . . . . . . . . . . . . . . . . . . 11 Integrating with PayPal API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Introducing the PayPal NVP API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Basic Steps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Create a Web Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Get API Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Create and Post the Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Interpret the Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Taking Your Application Live . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Set Up a PayPal Business Account . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Set Up API Credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Modify Your Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Technical Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Request-Response Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Request Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Posting Using HTTPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 API Servers for API Signature Security . . . . . . . . . . . . . . . . . . . . . . . . . 18 API Servers for API Certificate Security . . . . . . . . . . . . . . . . . . . . . . . . . 18 Chapter 2 AddressVerify API Operation . . . . . . . . . . . . . . . . 19 Address Verify Request Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 AddressVerify Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 AddressVerify Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Address Verify Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Name-Value Pair API Developer Guide September 2010 3 Contents Chapter 3 Authorization and Capture API Operation Reference . . . . 21 DoCapture Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 DoCapture Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 DoCapture API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 DoAuthorization API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 DoAuthorization Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 DoAuthorization Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . 24 DoReauthorization API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 DoReauthorization Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . 26 DoReauthorization Response Message . . . . . . . . . . . . . . . . . . . . . . . . . 26 DoVoid API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 DoVoid Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 DoVoid Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Chapter 4 DoDirectPayment API Operation . . . . . . . . . . . . . . 31 DoDirectPayment Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 DoDirectPayment Request Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Credit Card Details Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Payer Information Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Address Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Payment Details Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Payment Details Item Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Ebay Item Payment Details Item Fields . . . . . . . . . . . . . . . . . . . . . . . . . 36 Ship To Address Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 3D Secure Request Fields (U.K. Merchants Only) . . . . . . . . . . . . . . . . . . . 37 DoDirectPayment Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 DoDirectPayment Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 ThreeDSecure Response Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Chapter 5 DoNonReferencedCredit API Operation . . . . . . . . . . . 41 DoNonReferencedCredit Request Fields . . . . . . . . . . . . . . . . . . . . . . . . 41 Credit Card Details Type Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Payer Name Type Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Payer Information Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Address Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 DoNonReferencedCredit Request Message . . . . . . . . . . . . . . . . . . . . . . . . . 41 DoNonReferencedCredit Response Message . . . . . . . . . . . . . . . . . . . . . . . . 44 DoNonReferencedCredit Response Fields . . . . . . . . . . . . . . . . . . . . . . . 44 4 September 2010 Name-Value Pair API Developer Guide Contents Chapter 6 ExpressCheckout API Operations . . . . . . . . . . . . . . 45 Callback API Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Callback Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Callback API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 SetExpressCheckout API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 SetExpressCheckout Request Message . . . . . . . . . . . . . . . . . . . . . . . . 49 SetExpressCheckout Response Message. . . . . . . . . . . . . . . . . . . . . . . . 66 GetExpressCheckoutDetails API Operation . . . . . . . . . . . . . . . . . . . . . . . . . 66 GetExpressCheckoutDetails Request Message . . . . . . . . . . . . . . . . . . . . . 66 GetExpressCheckoutDetails Response Message . . . . . . . . . . . . . . . . . . . . 66 DoExpressCheckoutPayment API Operation . . . . . . . . . . . . . . . . . . . . . . . . 79 DoExpressCheckoutPayment Request Message . . . . . . . . . . . . . . . . . . . . 79 DoExpressCheckoutPayment Response Message . . . . . . . . . . . . . . . . . . . 92 Chapter 7 GetBalance API Operation . . . . . . . . . . . . . . . . . 101 GetBalance Request Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 GetBalance Request Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 GetBalance Response Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 GetBalance Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 Chapter 8 GetPalDetails API Operation . . . . . . . . . . . . . . . 103 GetPalDetails Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103 GetPalDetails Request Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103 GetPalDetails Response Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103 GetPalDetails Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103 Chapter 9 GetTransactionDetails API Operation . . . . . . . . . . . 105 GetTransactionDetails Request Fields. . . . . . . . . . . . . . . . . . . . . . . . . .105 GetTransactionDetails Request Message . . . . . . . . . . . . . . . . . . . . . . . . . .105 GetTransactionDetails Response Message . . . . . . . . . . . . . . . . . . . . . . . . .105 Receiver Information Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106 Payer Information Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106 Payer Name Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106 Address Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107 Payment Information Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108 Payment Item Information Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Payment Item Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Name-Value Pair API Developer Guide September 2010 5 . . . . .134 BillOutstandingAmount Request Message . .144 GetBillingAgreementCustomerDetails Request Message . . . . . . . . . . . . .134 BillOutstandingAmount Response Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125 GetRecurringPaymentsProfileDetails Response Message . . . . . . . . . . . . . . . . . . 117 GetRecurringPaymentsProfileDetails API Operation . . . . . . . . . 115 MassPay Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 ManagePendingTransactionStatus Request Message. . . . . . . . . . . . . . . . . . . . . . . . . . . .141 SetCustomerBillingAgreement Response Message . . 115 MassPay Request Fields . . . . . . . . . . . . . . . . . . 113 ManagePendingTransactionStatus Response Message. . . . . . . .135 UpdateRecurringPaymentsProfile Response Message . . . . . . . . . . . . . . . . . . . . . .133 ManageRecurringPaymentsProfileStatus Response Message . . . . . . . . . . . .126 ManageRecurringPaymentsProfileStatus API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 MassPay Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134 BillOutstandingAmount API Operation . . . . .140 SetCustomerBillingAgreement API Operation . . . . .135 UpdateRecurringPaymentsProfile Request Message . . . . . . . . . . . . . . . . . .133 ManageRecurringPaymentsProfileStatus Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents Auction Information Fields . .144 GetBillingAgreementCustomerDetails Response Message . . . 115 MassPay Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Chapter 12 Recurring Payments and Reference Transactions API Operations117 CreateRecurringPaymentsProfile Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144 6 September 2010 Name-Value Pair API Developer Guide . . . . .125 GetRecurringPaymentsProfileDetails Request Message . . . . . . . . . . . . 118 CreateRecurringPaymentsProfile Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .135 UpdateRecurringPaymentsProfile API Operation . . . . . . . . . 113 Chapter 11 MassPay API Operation . . 112 Subscription Terms Fields . . . . . . . . . . . . . . . . . 113 ManagePendingTransactionStatus Request Fields . . . . . . . . . . . . . . . . . . . . .141 SetCustomerBillingAgreement Request Message. . . . .143 GetBillingAgreementCustomerDetails API Operation . . . . . . . .125 CreateRecurringPaymentsProfile API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 ManagePendingTransactionStatus Response Fields . . . . . . . . . . . . 112 Chapter 10 ManagePendingTransactionStatus API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . .201 Authorization and Capture API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .222 GetBillingAgreementCustomerDetails Errors . .163 TransactionSearch Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149 DoReferenceTransaction Response Message . . . . . . . . . . . . . . . . . . . . .169 DirectPayment API Errors .165 TransactionSearch Request Message . . . . . . . . . . . . . . . . . . . . . . . . .165 TransactionSearch Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 General API Errors . . . . . . . . . .156 Chapter 13 RefundTransaction API Operation . . . . . . . . . . . . . . . . . . . . . . .163 Payer Name Fields . . . . . . . . . . . . . .214 TransactionSearch API Errors . . . . .162 RefundTransaction Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161 RefundTransaction Request Message . . . . . . . . . . . . . . . . . . . . . .216 MassPay API Errors . . . . . . . . . . . . . . . . . . . . . . . . . .168 Validation Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161 RefundTransaction Response Message . . . . . . . . . . . . . . . . . 161 RefundTransaction Request Fields . . . . . . . . . . . . . . . . .165 Appendix A API Error Codes . . . . . . . . . . . . . . . . .146 BAUpdate Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185 GetExpressCheckoutDetails API Errors . . . . . . . . . . . . . . . . . . . . . . . .210 GetTransactionDetails API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .214 RefundTransaction API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224 CreateBillingAgreement Errors. .162 Chapter 14 TransactionSearch API Operation . . . . . . . . . . . . . . . .148 DoReferenceTransaction Request Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 TransactionSearch Request Fields .219 Recurring Payments Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents BAUpdate API Operation . . . . . . . . . . . . . . . . . .224 Name-Value Pair API Developer Guide September 2010 7 .146 BAUpdate Response Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221 SetCustomerBillingAgreement Errors . . . . . . . . . . . . . . . . . . . . .173 SetExpressCheckout API Errors . . . . . . .199 DoExpressCheckoutPayment API Errors . .147 DoReferenceTransaction API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and American Express . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .253 Index . . . . . . . . . . . . . . . . . . . 235 Country Codes as an Unordered List for Adaptive Accounts . . . . . . . . . .252 CVV2 Response Codes for Visa. . . . . . . . . .226 DoReferenceTransaction Errors . . . . . 249 Appendix E AVS and CVV2 Response Codes . . . . . . . .233 ManagePendingTransactionStatus API Errors . . . . . . . . . .252 CVV2 Response Codes for Maestro and Solo. . . . . . . . . Discover. . . . . . .252 CVV2 Response Codes . . . MasterCard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 8 September 2010 Name-Value Pair API Developer Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Discover. . . . . . . . . . . . . . . . . . .Contents UpdateBillingAgreement Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243 Appendix C State and Province Codes . . MasterCard. . . . . . . . . . . . . . . . .251 AVS Response Codes for Maestro and Solo . . . and American Express . . . . . . .251 AVS Response Codes for Visa. . .233 Appendix B Countries and Regions Supported by PayPal . . . . . . . . . . . . .226 AddressVerify API Errors. . . . . . . . 251 AVS Response Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Appendix D Currency Codes . . . . . . . . . . Updated information for 58. added CreateBillingAgreement to Enterprise edition.0: added GetPalDetails API and fields for payment review. Deprecated old fields.4.0: Added Express Checkout fields enabling you to provide gift and insurance options to the PayPal checkout pages. added addtional error codes for ExpressCheckout and updated GetExpressCheckoutDetails response for parallel payments.0. Updated to reflect changes for Version 62.1 Revision History Date 15 September 2010 13 July 2010 11 May 2010 Description Updated for Version 64. Minor update to version 57.0. Added new NVP API fields to use in version 63. including addition of ProtectionEligibilityType field. and added Express Checkout API fields for Immediate Payment and eBay. Revision History Revision history for Name-Value Pair API Developer Guide. Added ReverseTransaction API. Intended Audience The Name-Value Pair API Developer Guide is written for web developers who are implementing solutions using the Name-Value Pair API. TABLE P. Updated for Version 64.0: updated currency table with new currencies. Updated information for 60. 10 March 2010 21 January 2010 7 October 2009 16 June 2009 22 May 2009 Name-Value Pair API Developer Guide September 2010 9 . Updated information for 61.Preface This Document The Name-Value Pair API Developer Guide describes the PayPal Name-Value Pair API. Updated billing agreement API with functionality to obtain the latest billing address and to skip billing agreement creation.0 Express Checkout integrations.0. Bug fixes including updating Line Item Details for Direct Payment and Express Checkout APIs. DoExpressCheckoutPayment.0 in the API call to use recurring payments. Rearranged material.Revision History TABLE P. 2008 June 2008 April 2008 February 2008 January 2008 Description Updated information for 57. added error codes. and moved some material to the Express Checkout Integration Guide.0. September 2007    August 2007 Added recurring payments concepts. Added Fraud Management Filters information. 2008 3 Sept.0: Express Checkout Callback API and error codes. and adding Switch/Solo codes for AVS and CVV2. Updated information for 55. adding SHIPTOCOUNTRYCODE. First public release. Added information about using billing agreements with SetExpressCheckout. April 2007 February 2007 December 2006 October 2006 10 September 2010 Name-Value Pair API Developer Guide . and CreateRecurringPaymentsProfile. and added additional DoReferenceTransaction error codes. Changed recurring payments information. modified SetExpressCheckout. DoReferenceTransaction. Added information about payment review to GetTransactionDetails. Added that the VERSION parameter must be 50. Updates for bug fixes. 2008 23 Sept. Added Recurring Payments APIs: SetCustomerBillingAgreement.     Added billing agreement fields to SetExpressCheckout for recurring payments Updated CreateRecurringPaymentsProfile for new recurring payments features.1 Revision History Date 08 April 2009 26 Nov. Added new recurring payments APIs Added DoNonReferencedCredit API Update eBay auctions for Express Checkout section Added fields for the giropay payment method to Express Checkout APIs Added Direct Payment error 10571. GetBillingAgreementCustomerDetails. changing some parameters to optional in DoDirectPayment. Issue full refunds or multiple partial refunds. Pay one or more recipients using Mass Payment. PayPal posts back a response in NVP format. This is the most straightforward and flexible approach. Capture payments previously authorized through Express Checkout. Name-Value Pair API Developer Guide September 2010 11 . Integrating with PayPal API You can develop with the PayPal NVP API using two different approaches: Integrate Directly You can integrate directly with the PayPal NVP API using the programming language of your choice. View details of a specific transaction. to access PayPal’s business functionality to:    Accept PayPal in checkout on your website using Express Checkout.1      PayPal NVP API Overview This overview describes the PayPal Name-Value Pair (NVP) API at a high level. Reauthorize or void previous authorizations.      The PayPal NVP API makes it easy to add PayPal to your web application. Direct Payment. and ColdFusion. PHP. “Introducing the PayPal NVP API” on page 11 “Basic Steps” on page 12 “Taking Your Application Live” on page 13 “Technical Details” on page 14 “Posting Using HTTPS” on page 18 Introducing the PayPal NVP API The PayPal NVP API is a simple programmatic interface that allows you. the merchant. or Website Payments Standard. Search transactions using a start date or other criteria. Charge a credit card using Direct Payment. You can download web samples that show how to integrate directly using Classic ASP. You construct an NVP string and post it to the PayPal server using HTTPS. This is described in “URL-Encoding” on page 14. 12 September 2010 Name-Value Pair API Developer Guide . Construct the NVP API request string as described in “Request Format” on page 15. you need API credentials. your application communicates with the PayPal Sandbox test environment.com QFZCWN5HZM8VBG7Q A-IzJhZZjhg29XQ2qnhapuwxIDzyAZQ92FRP5dqBzVesOkzbdUONzmOU Create and Post the Request Create an NVP request string and post it to PayPal sandbox server. that identify you. Basic Steps This section describes the basic steps for programming with the PayPal NVP API. 2. You can write your own application or use one of the samples as a starting point. Get API Credentials To access the PayPal API. Add code to your web application to do the following tasks: 1. The NVP format is described in “NVP Format” on page 14. During application development. NOT E : If you are using the samples. either an API signature or API certificate. SDKs are provided for Java and ASP. this signature is already in the code. The SDKs provide simple functions for integrating with the NVP API. Use the following sample API signature and password in your sample programs that run in the PayPal Sandbox test environment. Create a Web Application Your NVP API implementation usually runs in a web application. “Taking Your Application Live” on page 13 describes how to move your application to the live PayPal environment.NET.1 PayPal NVP API Overview Basic Steps Integrate Using an SDK You can integrate with the NVP API using a software development kit (SDK).sdk. URL-encode the name and value parameters in the request to ensure correct transmission of all characters. Details of the Sample API Signature API username API password API signature sdk-three_api1. html. 2.com. create a PayPal business account on https://www. Taking Your Application Live After you have finished coding and testing your application. Name-Value Pair API Developer Guide September 2010 13 . Add code to your web application to do the following tasks: 1. Interpret the Response PayPal processes your request and posts back a response in NVP format. Post the NVP request to the PayPal Sandbox as described in “Posting Using HTTPS” on page 18. Receive the HTTP post response. Set Up API Credentials To use the APIs. Consider storing these values in a secure location other than your web server document root and setting the file permissions so that only the system user that executes your ecommerce application can access it. you need a set of credentials to identify yourself to PayPal. you can also use API certificate. URL-decode the parameter values as described in “URL-Encoding” on page 14.paypal. Take appropriate action for successful and failed responses. you must protect the API signature values in your implementation. The sample code should never be used in production. go to https://www. NOT E : While API signature is recommended.paypal. The sample code does not store these values securely. For instructions on setting up API credentials for the business account.PayPal NVP API Overview Taking Your Application Live 1 3. 3. and extract the NVP string. Create an API signature for your business account. deploy your application to the live PayPal server using your PayPal business account and API credentials for that account. Set Up a PayPal Business Account When you are ready to deploy your application to the live PayPal server.com/IntegrationCenter/ic_certificate. IM PORT AN T : If you are using API signature. URL Format The request and response are in URL-encoded format. For example: FIRSTNAME=Robert&MIDDLENAME=Herbert&LASTNAME=Moore  The values for each field in an NVP string are URL-encoded. NVP is the informal name for the query in the URI specification. which is defined by the Worldwide Web Consortium (W3C). URL-encoding ensures that you can transmit special characters. URL is defined as part of the URI specification. URL-Encoding The request and response are URL-encoded.w3. URL is defined as part of the URI specification.org/Addressing/. Moore & Associates is URL-coded as follows: NAME=Robert+Moore&COMPANY=R%2E+H%2E+Moore+%26+Associates 14 September 2010 Name-Value Pair API Developer Guide .1 PayPal NVP API Overview Technical Details Modify Your Code The request and response are in URL-encoded format. you post an NVP request to PayPal. Technical Details This section describes details of the technologies used by the PayPal NVP API. Request-Response Model When you use the PayPal NVP API. For example. and PayPal posts back an NVP response.org/Addressing/. and characters that have special meaning in a URL. For example: FIRSTNAME=Robert  Name-value pairs are separated by an ampersand (&). H. An NVP string conforms to the following guidelines:  The name is separated from the value by an equal sign (=).w3. characters that are not allowed in a URL. The NVP string is appended to the URL. Find out more about URI at http://www. NVP Format NVP is a way of specifying names and values in a string. the following NVP string: NAME=Robert Moore&COMPANY=R. such as the equal sign and ampersand. Find out more about URI at http://www. which is defined by the Worldwide Web Consortium (W3C). net.URLEncode No built-in function.HttpUtility. The examples in this document use UPPERCASE for parameter names and divide the parameters into required security parameters and body parameters. Parameter names are not case sensitive. Several implementation examples are available on the Internet. Encoding. Name-Value Pair API Developer Guide September 2010 15 .encode java.NET Encode Decode Classic ASP Encode Decode Java Encode Decode PHP Encode Decode ColdFusion Encode Decode Method System.Web.Default) Server. charset]) Request Format Each NVP request consists of required and optional parameters and their values.decode urlencode() urldecode() URLEncodedFormatstring [.PayPal NVP API Overview Technical Details 1 Use the following methods to URL-encode or URL-decode your NVP strings: URL-Encoding Methods Language ASP.URLEncoder. java.Default) System.UrlEncode(buffer.UrlDecode(buffer. charset ] URLDecodeurlEncodedString[.net. Encoding.URLDecoder.HttpUtility.Web. 1 PayPal NVP API Overview Technical Details General Format of a Request Required Security Parameters USER=apiUsername &PWD=apiPassword &SIGNATURE=apiSignature &SUBJECT=optionalThirdPartyEmailAddress &VERSION=56.0. The following is an example of what you should NOT do in production: 16 September 2010 Name-Value Pair API Developer Guide . Set this parameter only if you are calling an API on a different user’s behalf. IM PORT AN T : SUBJECT You must protect the values for USER. such as 56.0 The following parameters are always required: USER PWD VERSION The examples show the required security parameters like this: [requiredSecurityParameters] &METHOD=methodName &otherRequiredAndOptionalParameters Body Parameters In practice. These are your PayPal API credentials. Security Parameters The security parameters are described below. Consider storing these values in a secure location other than your web server document root and setting the file permissions so that only the system user that executes your ecommerce application can access it. You may see sample code where these values are stored in an HTML form. (Optional) Email address of a PayPal account that has granted you permission to make this call. The sample code should never be used in production. you can specify the parameters in any order. If you use an API certificate. Required Security Parameters: API Credentials Parameter USER PWD VERSION=<current version> SIGNATURE Value (Required) Your PayPal API Username. (Required) Your PayPal API Password. After the METHOD parameter. do not include this parameter. PWD. you need to concatenate all parameters and values into a single URL-encoded string. and SIGNATURE in your implementation. (Optional) Your PayPal API signature string. (Required) Version number of the NVP API service. The sample code does not store these values securely. and long message in “API Error Codes” on page 167. API Response Fields Each response includes the ACK field. ACK Parameter Values The following table lists values for the ACK parameter. Error Responses If the ACK value is Error or Warning.. For possible causes of errors and how to correct them. </form> API Parameters A response from the PayPal servers is a URL-encoded name-value pair string. except it has the following general format. Format of an Error Response Response Fields on Error ACK=Error&TIMESTAMP=date/timeOfResponse& CORRELATIONID=debuggingToken&VERSION=VersionNo& BUILD=buildNumber&L_ERRORCODE0=errorCode& L_SHORTMESSAGE0=shortMessage& L_LONGMESSAGE0=longMessage& L_SEVERITYCODE0=severityCode Multiple errors can be returned. Each set of errors has a different numeric suffix.. see the explanation of the specific error code.com> <input type=hidden name=PWD value=abcdefg> <input type=hidden name=SIGNATURE value=xxxxxxxxxxxxxxx> . In a successful response. you can ignore all fields up to and including the BUILD field. If the ACK field’s value is Success or SuccessWithWarning.. The important fields begin after the BUILD field. DO NOT USE IN PRODUCTION! --> <input type=hidden name=USER value=xxxxxx.paypal. Name-Value Pair API Developer Guide September 2010 17 .sandbox.. just like the request. &BUILD=buildNumber &NAME1=value1&NAME2=value2&NAME3=value3&. General Format of a Successful Response Success Response Fields ACK=Success&TIMESTAMP=date/timeOfResponse &CORRELATIONID=debuggingToken&VERSION=. short message.PayPal NVP API Overview Technical Details 1 <form method=post action=https://api-3t.UNPROTECTED VALUES. you should process the API response fields. An error response has the following general format. starting with 0 and incremented by one for each error. API response fields are not returned.paypal..com/nvp> <!-.. com/nvp Live: https://api. Some of the payments were successful. API Servers for API Signature Security If you use an API signature.sandbox. PayPal provides a live server and a Sandbox server that allows you to process transactions in a test environment.paypal.1 PayPal NVP API Overview Posting Using HTTPS ACK Parameter Values Type of Response Successful response.paypal.com/nvp API Servers for API Certificate Security If you use an API certificate.sandbox.com/nvp 18 September 2010 Name-Value Pair API Developer Guide . Error response.paypal. post the request to one of these servers: Sandbox: https://api.paypal.com/nvp Live: https://api-3t. Partially successful response (parallel payments implementations only). post the request to one of these servers: Sandbox: https://api-3t. Value Success SuccessWithWarning PartialSuccess Failure FailureWithWarning Warning Posting Using HTTPS Your web application posts the URL-encoded NVP string over an HTTPS connection to one of the PayPal API servers. Maximum string length: 255 single-byte characters Input mask: ?@?. To pass verification. Alphanumeric plus . the value of Zip must match the first five single-byte characters of the postal code of the verified postal address for the verified PayPal member.2   AddressVerify API Operation Confirms whether a postal address and postal code match those of the specified PayPal account holder. Maximum string length: 35 single-byte characters. To pass verification. . (Required) Postal code to verify. “AddressVerify Request Message” on page 19 “AddressVerify Response Message” on page 20 AddressVerify Request Message Address Verify Request Fields Field METHOD EMAIL Description (Required) Must be AddressVerify. ‘ # \ Whitespace and case of input value are ignored. (Required) Email address of a PayPal member to verify. Maximum string length: 16 single-byte characters. STREET ZIP Name-Value Pair API Developer Guide September 2010 19 .?? (Required) First line of the billing or shipping postal address to verify.. the value of Street must match the first three single-byte characters of a postal address on file for the PayPal member. Whitespace and case of input value are ignored. PayPal prevents the buyer from using an email address or postal address other than those that PayPal verified with this API call. ZIPMATCH COUNTRYCODE TOKEN 20 September 2010 Name-Value Pair API Developer Guide . Unmatched: The request value of the Zip element does not match the ZIP code of the postal address on file for the PayPal member. Confirmed: If the response value of the StreetMatch element is Matched. The token is valid for 24 hours. No comparison of the Zip element was made. N O TE : The values Confirmed and Unconfirmed both indicate that the member email address passed verification. Unconfirmed: PayPal responds that the postal address is unconfirmed. The token contains encrypted information about the member’s email address and postal address. STREETMATCH None: The request value of the Email element does not match any email address on file at PayPal. If you pass the value of the token in the HTML variable address_api_token of Buy Now buttons. Matched: The request value of the Zip element matches the ZIP code of the postal address on file for the PayPal member.2 AddressVerify API Operation AddressVerify Response Message A d d r e s s Ve r i f y R e s p o n s e M e s s a g e Address Verify Response Fields Field CONFIRMATIONCODE Description None: The request value of the Email element does not match any email address on file at PayPal. Character length and limitations: 94 single-byte characters. None: The request value of the Street element was unmatched. the entire postal address is confirmed. Matched: The request value of the Street element matches the first three singlebyte characters of a postal address on file for the PayPal member. No comparison of other request values was made. Unmatched: The request value of the Street element does not match any postal address on file for the PayPal member. Two-character country code (ISO 3166) on file for the PayPal email address. Limitations: Value is a positive number which cannot exceed $10. (Optional) A three-character currency code. Must have two decimal places. (Required) Amount to capture. (Required) The authorization identification number of the payment you want to capture. AMT CURRENCYCODE Name-Value Pair API Developer Guide September 2010 21 . decimal separator must be a period (.).3     Authorization and Capture API Operation Reference This chapter describes the PayPal API operations related to delayed payment settlement: “DoCapture API Operation” on page 21 “DoAuthorization API Operation” on page 23 “DoReauthorization API Operation” on page 26 “DoVoid API Operation” on page 29 DoCapture API Operation Capture an authorized payment. No currency symbol. Default: USD.   “DoCapture Request Message” on page 21 “DoCapture Response Message” on page 23 DoCapture Request Message DoCapture Request Fields Field METHOD AUTHORIZATIONID Description (Required) Must be DoCapture.). and the optional thousands separator must be a comma (. This is the transaction id returned from DoExpressCheckoutPayment or DoDirectPayment. Character length and limits: 19 single-byte characters maximum.000 USD in any currency. Character length and limits: 12 single-byte alphanumeric characters.  The soft descriptor is passed in as JanesFlowerGifts LLC. The value NotComplete indicates that you intend to make additional captures. (period)  {space} If you use any other characters (such as “. an error code is returned. the maximum length of the soft descriptor passed in the API request is: 22 . NOTE: If Complete. (Optional) The soft descriptor is a per transaction description of the payment that is passed to the consumer’s credit card statement. INVNUM (Optional) Your invoice number or other identification number that is displayed to the merchant and customer in his transaction history. If a value for the soft descriptor field is provided.len(<PP * | PAYPAL *>) . which can be toggled between the merchant’s customer service number and PayPal’s customer service number.”). NOTE (Optional) An informational note about this settlement that is displayed to the payer in email and in his transaction history. any remaining amount of the original authorized transaction is automatically voided and all remaining open authorizations are voided.  The merchant descriptor set in the Payment Receiving Preferences is set to EBAY. The resulting descriptor string on the credit card would be: PAYPAL *EBAY JanesFlow SOFTDESCRIPTOR 22 September 2010 Name-Value Pair API Developer Guide .len(<Descriptor set in Payment Receiving Preferences> + 1) For example. Character length and limits: 255 single-byte characters. assume the following conditions:  The PayPal prefix toggle is set to PAYPAL * in PayPal’s admin tools. The value is recorded only if the authorization you are capturing is an order authorization. The maximum length of the total soft descriptor is 22 characters. NOTE: Character length and limits: 127 single-byte alphanumeric characters. the full descriptor displayed on the customer’s statement has the following format: <PP * | PAYPAL *><Merchant descriptor as set in the Payment Receiving Preferences><1 space><soft descriptor> The soft descriptor can contain only the following characters:  Alphanumeric characters  . NOTE: This value on DoCapture will overwrite a value previously set on DoAuthorization. either 4 or 8 characters are used by the PayPal prefix shown in the data format. The soft descriptor does not include the phone number.3 Authorization and Capture API Operation Reference DoCapture API Operation Field COMPLETETYPE Description (Required) The value Complete indicates that this the last capture you intend to make. not a basic authorization.(dash)  * (asterisk)  . Thus. Of this. (Optional) Type of transaction to authorize.Authorization and Capture API Operation Reference DoAuthorization API Operation 3 DoCapture Response Message NOT E : If you use version 56. only the authorization ID.). (Required) The value of the order’s transaction identification number returned by PayPal. No currency symbol. (Optional) A three-character currency code.   “DoAuthorization Request Message” on page 23 “DoAuthorization Response Message” on page 24 DoAuthorization Request Message DoAuthorization Request Fields Field METHOD TRANSACTIONID Description (Required) Must be DoAuthorization. If you need the values of other fields and they are not returned. See “Currency Codes” on page 249. Must have two decimal places. decimal separator must be a period (.000 USD in any currency. and the optional thousands separator must be a comma (. DoCapture Response Fields Field AUTHORIZATIONID Description The authorization identification number you specified in the request. gross amount and payment status are guaranteed to be returned. (Required) Amount to authorize.). which means that the transaction represents a customer order that can be fulfilled over 29 days. payment date.0 or later of the DoCaptue API. Character length and limits: 19 single-byte characters maximum. transaction type. transaction ID. AMT TRANSACTIONENTITY CURRENCYCODE Name-Value Pair API Developer Guide September 2010 23 . Limitations: Value is a positive number which cannot exceed $10. DoAuthorization API Operation Authorize a payment. Character length and limits: 19 single-byte characters maximum. you can obtain their values later by calling GetTransactionDetails or by using the reporting mechanism. The only allowable value is Order. e. The reason for the reversal is specified in the ReasonCode element.  Expired: the authorization period for this payment has been reached.  Denied: You denied the payment. The status of the payment:  None: No status  Canceled-Reversal: A reversal has been canceled.  In-Progress: The transaction has not terminated.g. This happens only if the payment was made from your customer’s bank account. The funds have been removed from your account balance and returned to the buyer.  Reversed: A payment was reversed due to a chargeback or other type of reversal. AuthorizationInfo Fields Field PAYMENTSTATUS Description Status of the payment.  Pending: The payment is pending.  Refunded: You refunded the payment.  Completed: The payment has been completed.  Partially-Refunded: The payment has been partially refunded. for example.  Failed: The payment has failed.  Voided: An authorization for this transaction has been voided. See the PendingReason field for more information. 24 September 2010 Name-Value Pair API Developer Guide . This happens only if the payment was previously pending because of possible reasons described for the PendingReason element.  Processed: A payment has been accepted.3 Authorization and Capture API Operation Reference DoAuthorization API Operation DoAuthorization Response Message DoAuthorization Response Fields Field TRANSACTIONID AMT Description An authorization identification number. when you win a dispute and the funds for the reversal have been returned to you. an authorization may be awaiting completion. The amount you specified in the request. and the funds have been added successfully to your account balance. To change your preference.  order: The payment is pending because it is part of an order that has been authorized but not settled. You must manually accept or deny this payment from your Account Overview. the kind of seller protection in force for the transaction. contact PayPal customer service. You must verify your account before you can accept this payment. You must manually accept or deny this payment. You must capture the funds first.Authorization and Capture API Operation Reference DoAuthorization API Operation 3 Field PENDINGREASON Description N O TE : PendingReason is returned in the response only if PaymentStatus is Pending.  other: The payment is pending for a reason other than those listed above. and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. For more information.  paymentreview: The payment is pending while it is being reviewed by PayPal for risk. which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payment and Item Not Received  PartiallyEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  Ineligible – Seller is not protected under the Seller Protection Policy Since Version 64.  unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed.  address: The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. go to the Preferences section of your Profile.4. PROTECTIONELIGIBILITY Prior to Version 64. which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received  ItemNotReceivedEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  UnauthorizedPaymentEligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payment  Ineligible – Seller is not protected under the Seller Protection Policy PROTECTIONELIGIBILITY TYPE Name-Value Pair API Developer Guide September 2010 25 .  multi-currency: You do not have a balance in the currency sent.  intl: The payment is pending because you hold a non-U.S. the kind of seller protection in force for the transaction.4.  authorization: The payment is pending because it has been authorized but not settled.  echeck: The payment is pending because it was made by an eCheck that has not yet cleared.  verify: The payment is pending because you are not yet verified. account and do not have a withdrawal mechanism. The reason the payment is pending:  none: No pending reason. 000 USD in any currency.3 Authorization and Capture API Operation Reference DoReauthorization API Operation DoReauthorization API Operation   “DoReauthorization Request Message” on page 26 “DoReauthorization Response Message” on page 26 DoReauthorization Request Message DoReauthorization Request Fields Field METHOD AUTHORIZATIONID Description (Required) Must be DoReauthorization. Must have two decimal places. No currency symbol.). See “Currency Codes” on page 249. (Required) The value of a previously authorized transaction identification number returned by PayPal. decimal separator must be a period (. AMT CURRENCYCODE DoReauthorization Response Message DoReauthorization Response Fields Field AUTHORIZATIONID Description A new authorization identification number. Limitations: Value is a positive number which cannot exceed $10. and the optional thousands separator must be a comma (.). Character length and limits:19 single-byte characters maximum. Character length and limits: 19 single-byte characters maximum. 26 September 2010 Name-Value Pair API Developer Guide . (Required) Amount to reauthorize. A three-character currency code. g.  Processed: A payment has been accepted. when you win a dispute and the funds for the reversal have been returned to you. Name-Value Pair API Developer Guide September 2010 27 . an authorization may be awaiting completion. and the funds have been added successfully to your account balance.Authorization and Capture API Operation Reference DoReauthorization API Operation 3 Authorization Information Fields Field PAYMENTSTATUS Description Status of the payment. This happens only if the payment was made from your customer’s bank account.  Refunded: You refunded the payment. The status of the payment:  None: No status  Canceled-Reversal: A reversal has been canceled.  Expired: the authorization period for this payment has been reached.  Completed: The payment has been completed.  In-Progress: The transaction has not terminated.  Pending: The payment is pending. See the PendingReason field for more information.  Voided: An authorization for this transaction has been voided. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element. for example. The funds have been removed from your account balance and returned to the buyer.  Failed: The payment has failed. The reason for the reversal is specified in the ReasonCode element.  Partially-Refunded: The payment has been partially refunded.  Reversed: A payment was reversed due to a chargeback or other type of reversal.  Denied: You denied the payment. e. You must capture the funds first. You must manually accept or deny this payment from your Account Overview. You must verify your account before you can accept this payment. account and do not have a withdrawal mechanism.  order: The payment is pending because it is part of an order that has been authorized but not settled. which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received  ItemNotReceivedEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  UnauthorizedPaymentEligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payment  Ineligible – Seller is not protected under the Seller Protection Policy PROTECTIONELIGIBILITY TYPE 28 September 2010 Name-Value Pair API Developer Guide .  echeck: The payment is pending because it was made by an eCheck that has not yet cleared. contact PayPal customer service.  intl: The payment is pending because you hold a non-U. To change your preference. which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payment and Item Not Received  PartiallyEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  Ineligible – Seller is not protected under the Seller Protection Policy Since Version 64. PROTECTIONELIGIBILITY Prior to Version 64.4. The reason the payment is pending:  none: No pending reason.  unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed. and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment.  verify: The payment is pending because you are not yet verified.  paymentreview: The payment is pending while it is being reviewed by PayPal for risk.  other: The payment is pending for a reason other than those listed above.  address: The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. You must manually accept or deny this payment.3 Authorization and Capture API Operation Reference DoReauthorization API Operation Field PENDINGREASON Description N O TE : PendingReason is returned in the response only if PaymentStatus is Pending.4.  authorization: The payment is pending because it has been authorized but not settled.  multi-currency: You do not have a balance in the currency sent. For more information. the kind of seller protection in force for the transaction. the kind of seller protection in force for the transaction. go to the Preferences section of your Profile.S.   “DoVoid Request Message” on page 29 “DoVoid Response Message” on page 29 DoVoid Request Message DoVoid Request Fields Field METHOD AUTHORIZATIONID Description (Required) Must be DoVoid. Character length and limits: 19 single-byte characters. Character length and limits: 255 single-byte characters DoVoid Response Message DoVoid Response Fields Field AUTHORIZATIONID Description The authorization identification number you specified in the request. (Required) The original authorization ID specifying the authorization to void or. to void an order.Authorization and Capture API Operation Reference DoVoid API Operation 3 DoVoid API Operation Void an order or an authorization. and not the reauthorization. the order ID. Character length and limits: 19 single-byte characters. I MP O R T ANT : If you are voiding a transaction that has been reauthorized. use the ID from the original authorization. Name-Value Pair API Developer Guide September 2010 29 . NOTE (Optional) An informational note about this void that is displayed to the payer in email and in his transaction history. 3 Authorization and Capture API Operation Reference DoVoid API Operation 30 September 2010 Name-Value Pair API Developer Guide . (Optional) How you want to obtain payment:  Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization & Capture. RETURNFMFDETAILS (Optional) Flag to indicate whether you want the results returned by Fraud Management Filters. Character length and limitations: 15 single-byte characters. Character length and limit: Up to 13 single-byte alphabetic characters. Default: Sale NOTE: Order is not allowed for Direct Payment. By default. IPADDRESS (Required) IP address of the payer’s browser.255. you do not receive this information.do not receive FMF details (default)  1 .  0 .  Sale indicates that this is a final sale for which you are requesting payment.receive FMF details Name-Value Pair API Developer Guide September 2010 31 . for example: 255.4   DoDirectPayment API Operation Process a credit card payment.255.255. including periods. “DoDirectPayment Request Message” on page 31 “DoDirectPayment Response Message” on page 38 DoDirectPayment Request Message DoDirectPayment Request Fields Field METHOD PAYMENTACTION Description (Required) Must be DoDirectPayment. NOTE: PayPal records this IP addresses as a means to detect possible fraud. To comply with credit card processing regulations. Interac debit cards are not supported. NOTE: If the credit card type is Maestro or Solo. MasterCard. No spaces or punctutation. Allowable values:  Visa  MasterCard  Discover  Amex  Maestro: See note. MasterCard. including leading zero. For UK. Your Merchant Account settings determine whether this field is required. either STARTDATE or ISSUENUMBER must be specified. Credit card expiration date. Character length for American Express: exactly four digits. only Maestro.Character length: two numeric digits maximum.4 DoDirectPayment API Operation DoDirectPayment Request Message Credit Card Details Fields Field CREDITCARDTYPE Description (Required) Type of credit card. Format: MMYYYY Character length and limitations: Six single-byte alphanumeric characters. Character length and limitations: numeric characters only. Character length for Visa. For Canada. (Optional) Issue number of Maestro or Solo card. This field is required if you are using recurring payments with direct payments. EXPDATE CVV2 STARTDATE ISSUENUMBER 32 September 2010 Name-Value Pair API Developer Guide . and Visa are allowable. only MasterCard and Visa are allowable. Character length and limitations: Up to ten single-byte alphabetic characters. Must conform with modulo and length required by each credit card type. and Discover: exactly three digits. including leading zero. Solo. Discover. version 2.  Solo: See note. Character length: Must be six digits. the MMYYYY format. In addition. ACCT (Required) Credit card number. Card Verification Value. the CURRENCYCODE must be GBP. (Optional) Month and year that Maestro or Solo card was issued. you must not store this value after a transaction has been completed. (Optional) Phone number. Character length and limitations: 40 single-byte characters. Character limit: Two single-byte characters. Character length and limitations: 100 single-byte characters. STREET2 CITY STATE COUNTRYCODE ZIP SHIPTOPHONENUM Name-Value Pair API Developer Guide September 2010 33 . (Required) Country code. (Optional) Second street address. Character length and limit: 20 single-byte characters. (Required) U. Character length and limitations: 40 single-byte characters. Character length and limitations: 20 single-byte characters. Character length and limitations: 25 single-byte characters. Character length and limitations: 25 single-byte characters. (Required) State or province.S.DoDirectPayment API Operation DoDirectPayment Request Message 4 Payer Information Fields Field EMAIL Description (Optional) Email address of payer. Character length and limitations: 100 single-byte characters. (Required) Payer’s last name. (Required) Payer’s first name. Character length and limitations: 127 single-byte characters. (Required) Name of city. FIRSTNAME LASTNAME Address Fields Field STREET Description (Required) First street address. ZIP code or other country-specific postal code. SHIPPINGAMT (Optional) Total shipping costs for this order. include them in this value.). No currency symbol. Equivalent to nine characters maximum for USD. Must have two decimal places.). Character length and limitations: Must not exceed $10. Purchase-specific fields will be ignored. If shipping cost and tax charges are known. and the optional thousands separator must be a comma (. and the optional thousands separator must be a comma (. Equivalent to nine characters maximum for USD. Regardless of currency. you must also specify a value for ITEMAMT. if not. this value should be the current sub-total of the order. decimal separator must be a period (. If the transaction includes one or more one-time purchases. NOTE: If you specify a value for SHIPPINGAMT. No currency symbol. NOTE: If you specify a value for HANDLINGAMT. and the optional thousands separator must be a comma (. Regardless of currency. Regardless of currency. Set this field to 0 if the transaction does not include a one-time purchase. decimal separator must be a period (. (Optional) Sum of cost of all items in this order. for example.). this field must be equal to the sum of the purchases. (Optional) A three-character currency code. and the optional thousands separator must be a comma (. No currency symbol.).). you must also specify a value for ITEMAMT. Must have two decimal places.). decimal separator must be a period (.000 USD in any currency.000 USD in any currency. 34 September 2010 Name-Value Pair API Developer Guide . Default: USD.). decimal separator must be a period (. No currency symbol. and the optional thousands separator must be a comma (.000 USD in any currency. TAXAMT (Optional) Sum of tax for all items in this order.4 DoDirectPayment API Operation DoDirectPayment Request Message Payment Details Fields Field AMT Description (Required) The total cost of the transaction to the customer.).). Limitations: Must not exceed $10. NOTE: TAXAMT is required if you specify L_TAXAMTn Character length and limitations: Must not exceed $10. decimal separator must be a period (. Equivalent to nine characters maximum for USD.000 USD in any currency. Limitations: Must not exceed $10. No currency symbol.000 USD in any currency. NOTE: CURRENCYCODE ITEMAMT ITEMAMT is required if you specify L_AMTn. Character length and limitations: Must not exceed $10.). when you set up a billing agreement for a recurring payment that is not immediately charged. HANDLINGAMT (Optional) Total handling costs for this order. NOTE: The value you specify is only available if the transaction includes a purchase. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. Character length and limitations: 32 single-byte alphanumeric characters (Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. Character length and limitations: 127 single-byte alphanumeric characters CUSTOM (Optional) A free-form field for your own use. Character length and limitations: 127 single-byte characters L_DESCn Name-Value Pair API Developer Guide September 2010 35 .DoDirectPayment API Operation DoDirectPayment Request Message 4 Field DESC Description (Optional) Description of items the customer is purchasing. NOTE: The value you specify is only available if the transaction includes a purchase. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. L_NAME1). If you do not specify this value in the request.048 single-byte alphanumeric characters Payment Details Item Fields Field L_NAMEn Description (Optional) Item name. These parameters must be ordered sequentially beginning with 0 (for example L_NAME0. NOTE: The value you specify is only available if the transaction includes a purchase. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. Character length and limitations: 127 single-byte characters (Optional) Item description. Character length and limitations: 127 single-byte alphanumeric characters BUTTONSOURCE (Optional) An identification code for use by third-party applications to identify transactions. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails. Character length and limitations: 256 single-byte alphanumeric characters INVNUM (Optional) Your own invoice or tracking number. I MP O R T ANT : NOTIFYURL The notify URL only applies to DoExpressCheckoutPayment. the notification URL from your Merchant Profile is used. if one exists. Character length and limitations: 2. These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMORDERID0.000 USD in any currency. These parameters must be ordered sequentially beginning with 0 (for example L_TAXAMT0. Equivalent to nine characters maximum for USD. Character length: 255 single-byte characters (Optional) Auction order identification number. Character length and limitations: Any positive integer (Optional) Item sales tax. you must specify a value for ITEMAMT. If you specify a value for L_AMTn. No currency symbol. L_TAXAMT1). These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMAUCTIONTXNID0.4 DoDirectPayment API Operation DoDirectPayment Request Message Field L_AMTn Description (Optional) Cost of item. No currency symbol. Ebay Item Payment Details Item Fields Field L_EBAYITEMNUMBERn Description (Optional) Auction item number.). Equivalent to nine characters maximum for USD. Regardless of currency. and the optional thousands separator must be a comma (.). Regardless of currency. NOTE: L_QTYn L_TAXAMTn Character length and limitations: Must not exceed $10. These parameters must be ordered sequentially beginning with 0 (for example L_AMT0. These parameters must be ordered sequentially beginning with 0 (for example L_QTY0. decimal separator must be a period (. L_EBAYITEMNUMBER1). These parameters must be ordered sequentially beginning with 0 (for example L_NUMBER0.). and the optional thousands separator must be a comma (. Character length: 64 single-byte characters L_EBAYITEMAUCTIONTX NIDn L_EBAYITEMORDERIDn 36 September 2010 Name-Value Pair API Developer Guide . Character length: 765 single-byte characters (Optional) Auction transaction identification number. L_AMT1).). decimal separator must be a period (. NOTE: L_NUMBERn (Optional) Item number. L_EBAYITEMAUCTIONTXNID1).000 USD in any currency. L_EBAYITEMORDERID1). These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMNUMBER0. NOTE: Character length and limitations: Must not exceed $10. Character length and limitations: 127 single-byte characters (Optional) Item quantity. L_NUMBER1). L_QTY1). Character length and limit: 20 single-byte characters. Character length and limitations: 100 single-byte characters. Character length and limitations: 32 single-byte characters. If the cmpi_lookup request returns Y for Enrolled. Required if using a shipping address. set this field to blank. Name of city. Merchants Only) Field AUTHSTATUS3D Description (Optional) A value returned by the Cardinal Centinel.DoDirectPayment API Operation DoDirectPayment Request Message 4 Ship To Address Fields Field SHIPTONAME Description Person’s name associated with this shipping address. State or province. MPIVENDOR3DS CAVV ECI3DS Name-Value Pair API Developer Guide September 2010 37 . otherwise. set this field to blank. First street address. Required if using a shipping address. Country code. SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRY SHIPTOPHONENUM 3D Secure Request Fields (U. (Optional) A value returned by the Cardinal Centinel. If the cmpi_lookup request returns Y for Enrolled. Character length and limitations: 20 single-byte characters. Required if using a shipping address. set this field to the Cavv value returned by cmpi_authenticate. U. (Optional) A value returned by the Cardinal Centinel. (Optional) Phone number.S. otherwise. shipping address. ZIP code or other country-specific postal code. Character length and limitations: 40 single-byte characters. set this field to the PAResStatus value returned by cmpi_authenticate. Character length and limitations: 40 single-byte characters. Set this field to the Enrolled value returned by cmpi_lookup. Required if using a shipping address. may be required for other countries.K. (Optional) Second street address.S. otherwise. (Optional) A value returned by the Cardinal Centinel. Required if using a U. If the cmpi_lookup request returns Y for Enrolled. Required if using a shipping address. set this field to the EciFlag value returned by cmpi_authenticate. Character limit: 2 single-byte characters. set this field to the EciFlag value returned by cmpi_lookup. Character length and limitations: 100 single-byte characters. N O TE : If the PaymentAction of the request was Authorization. See “AVS Response Codes” on page 251 for possible values. set this field to the Xid value returned by cmpi_authenticate. the value of TransactionID is your AuthorizationID for use with the Authorization & Capture APIs. Character limit: One single-byte alphanumeric character Result of the CVV2 check by PayPal. If the cmpi_lookup request returns Y for Enrolled.4 DoDirectPayment API Operation DoDirectPayment Response Message Field XID Description (Optional) A value returned by the Cardinal Centinel. Character length and limitations: 19 single-byte characters. CVV2MATCH 38 September 2010 Name-Value Pair API Developer Guide . AMT AVSCODE This value is the amount of the payment as specified by you on DoDirectPaymentRequest for reference transactions with direct payments. otherwise set this field to blank. DoDirectPayment Response Message DoDirectPayment Response Fields Field TRANSACTIONID Description Unique transaction ID of the payment. Address Verification System response code. starting from 0. or C  Bad result: 4.DoDirectPayment API Operation DoDirectPayment Response Message 4 Field L_FMFfilterIDn Description Filter ID. (PENDING. n. the filter NAME. or DENY). starting from 0. L_FMFfilterNAMEn ThreeDSecure Response Fields Field VPAS Description Returned only for Verified by Visa transactions. REPORT. Visa Payer Authentication Service status indicating whether Verified by Visa confirms that the information received is acceptable. 7. n. or DENY). and the entry number. including the filter type. the filter ID. including the filter type (PENDING. 0. A. Filter ID is one of the following values:  1 = AVS No Match  2 = AVS Partial Match  3 = AVS Unavailable/Unsupported  4 = Card Security Code (CSC) Mismatch  5 = Maximum Transaction Amount  6 = Unconfirmed Address  7 = Country Monitor  8 = Large Order Number  9 = Billing/Shipping Address Mismatch  10 = Risky ZIP Code  11 = Suspected Freight Forwarder Check  12 = Total Purchase Price Minimum  13 = IP Address Velocity  14 = Risky Email Address Domain Check  15 = Risky Bank Identification Number (BIN) Check  16 = Risky IP Address Range  17 = PayPal Fraud Model Filter name. Authentication:  Good result: 2 or D  Bad result: 1 Attempted authentication:  Good result: 3. or 9 No liability shift: Blank. REPORT. or B Name-Value Pair API Developer Guide September 2010 39 . 8. 6. and the entry number. MasterCard:  01: Merchant Liability  02: Issuer Liability Visa:  05: Issuer Liability  06: Issuer Liability  07: Merchant Liability 40 September 2010 Name-Value Pair API Developer Guide . in rare cases. This might not be the same value received from the merchant. PayPal might be required to use a different ECI for authorisation based on the full set of 3-D Secure values provided from the cmpi_authenticate request.4 DoDirectPayment API Operation DoDirectPayment Response Message Field ECISUBMITTED3DS Description The Electronic Commerce Indicator (ECI) that PayPal submitted with the payment authorisation request. and the optional thousands separator must be a comma (. Similar to a “memo” field. NETAMT TAXAMT SHIPPINGAMT NOTE Name-Value Pair API Developer Guide September 2010 41 . (Optional) Field used by merchant to record why this credit was issued to a buyer. GBP. The only valid currencies are AUD.). The only valid currencies are AUD. Must have two decimal places. No currency symbol. Limitations: Must not exceed $10. decimal separator must be a period (.).000 USD in any currency.). decimal separator must be a period (. Limitations: Must not exceed $10. String field. The only valid currencies are AUD. JPY. and the optional thousands separator must be a comma (. and the optional thousands separator must be a comma (. decimal separator must be a period (.).000 USD in any currency. “DoNonReferencedCredit Request Message” on page 41 “DoNonReferencedCredit Response Message” on page 44 DoNonReferencedCredit Request Message DoNonReferencedCredit Request Fields Field METHOD AMT Description (Required) Must be DoNonReferencedCredit. and USD. (Optional) Sum of tax for all items in this order. No currency symbol. EUR.).). Must have two decimal places. Must have two decimal places. EUR. including shipping.000 USD in any currency. JPY.). Limitations: The value must be zero or greater and cannot exceed $10. Amount = NetAmount + ShippingAmount + TaxAmount (Optional) Total amount of all items in this transaction. CAD. JPY. (Optional) Total shipping costs in this transaction.). EUR. and tax. CAD. No currency symbol. CAD. (Required) Total of order.5   DoNonReferencedCredit API Operation Issue a credit to a card not referenced by the original transaction.000 USD in any currency. Freeform text. handling. and USD. and the optional thousands separator must be a comma (. Limitations: Value must be zero or greater and cannot exceed $10. Must have two decimal places. GBP. GBP. No currency symbol. decimal separator must be a period (. and USD. EUR. Format: MMYYYY Character length and limitations: Six single-byte alphanumeric characters. Discover. including leading zero. and Discover: exactly three digits. the MMYYYY format. Default: USD. version 2. Solo. (Optional) Issue number of Maestro or Solo card. Interac debit cards are not supported. Credit card expiration date. Character length for American Express: exactly four digits. Character length and limitations: Up to ten single-byte alphabetic characters. NOTE: If the credit card type is Maestro or Solo. Allowable values:  Visa  MasterCard  Discover  Amex  Maestro: See note. MasterCard. MasterCard. No spaces or punctutation.  Solo: See note. For Canada. Character length for Visa. (Optional) Month and year that Maestro or Solo card was issued. JPY. In addition. The only valid currencies are AUD. and USD. either STARTDATE or ISSUENUMBER must be specified. Your Merchant Account settings determine whether this field is required. and Visa are allowable. the CURRENCYCODE must be GBP. Character length: Must be six digits. only MasterCard and Visa are allowable. GBP. you must not store this value after a transaction has been completed. CAD. Credit Card Details Type Fields Field CREDITCARDTYPE Description (Required) Type of credit card. Character length and limitations: numeric characters only.5 DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message Field CURRENCYCODE Description (Required) Currency code. For UK. Must conform with modulo and length required by each credit card type. only Maestro.Character length: two numeric digits maximum. This field is required if you are using recurring payments with direct payments. ACCT (Required) Credit card number. EXPDATE CVV2 STARTDATE ISSUENUMBER 42 September 2010 Name-Value Pair API Developer Guide . including leading zero.To comply with credit card processing regulations. Card Verification Value. Character length and limitations: 127 single-byte characters. Character length and limitations: 40 single-byte characters. (Optional) Payer’s suffix Character length and limitations: 12 single-byte characters. Character length and limitations: 20 single-byte characters. (Optional) Payer’s last name Character length and limitations: 25 single-byte characters. Character length and limitations: 100 single-byte characters. FIRSTNAME MIDDLENAME LASTNAME SUFFIX Payer Information Fields Field EMAIL Description (Optional) Email address of payer. Character length and limitations: 25 single-byte characters. (Required) Name of city. Character length and limitations: 25 single-byte characters. Character length and limitations: 100 single-byte characters. Character length and limitations: 25 single-byte characters. (Optional) Second street address. (Required) State or province. (Optional) Payer’s middle name. (Optional) Payer’s first name.DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message 5 Payer Name Type Fields Field SALUTATION Description (Optional) Payer’s salutation. (Required) Payer’s first name. Character length and limitations: 25 single-byte characters. STREET2 CITY STATE Name-Value Pair API Developer Guide September 2010 43 . Character length and limitations: 40 single-byte characters. (Required) Payer’s last name. FIRSTNAME LASTNAME Address Fields Field STREET Description (Required) First street address. CURRENCYCODE 44 September 2010 Name-Value Pair API Developer Guide . and USD. EUR. Character length and limit: 20 single-byte characters. ZIP code or other country-specific postal code. (Required) U. Character length and limitations: 17 single-byte alphanumeric characters. (Optional) Phone number. ZIP SHIPTOPHONENUM DoNonReferencedCredit Response Message DoNonReferencedCredit Response Fields Field TRANSACTIONID Description Unique identifier of a transaction. Character length and limitations: 20 single-byte characters. JPY. Currency code. GBP.S.5 DoNonReferencedCredit API Operation DoNonReferencedCredit Response Message Field COUNTRYCODE Description (Required) Country code. Character limit: Two single-byte characters. The only valid currencies are AUD. CAD. 6     ExpressCheckout API Operations This chapter describes the PayPal API operations related to Express Checkout transactions: “Callback API Operation” on page 45 “SetExpressCheckout API Operation” on page 49 “GetExpressCheckoutDetails API Operation” on page 66 “DoExpressCheckoutPayment API Operation” on page 79 Callback API Operation Updates the PayPal Review page with shipping options. insurance. Character length and limitations: 20 single-byte characters (Required) The three-character currency code for the transaction from the Express Checkout API. Default: USD CURRENCYCODE Name-Value Pair API Developer Guide September 2010 45 .   “Callback API Request Message” on page 45 “Callback Response Message” on page 47 Callback API Request Message Callback Request Fields Field METHOD TOKEN Description (Required) Must be Callback. the value of which was returned by SetExpressCheckout response. and tax information. (Optional) A timestamped token. L_QTY0. L_NUMBERn L_DESCn L_AMTn L_QTYn L_ITEMWEIGHTVALUEn L_ITEMWEIGHTUNITn L_ITEMHEIGHTVALUEn L_ITEMHEIGHTUNITn 46 September 2010 Name-Value Pair API Developer Guide .Austria  BE . L_ITEMWEIGHTVALUE1). Item unit quantity from the Express Checkout API. L_NUMBER1). L_NAMEn Item name from the Express Checkout API. Character length and limitations: Any two-character country code. These parameters must be ordered sequentially beginning with 0 (for example. The weight of the item.China  DE . Item number from the Express Checkout API. Item description from the Express Checkout API.Switzerland  CN . L_QTY1). These parameters must be ordered sequentially beginning with 0 (for example. L_NAME0. L_DESC0.Germany  ES . ITEMHEIGHTVALUE1). L_DESC1).Poland  US . These parameters must be ordered sequentially beginning with 0 (for example. Item unit price from the Express Checkout API.Australia  AT . The height of the item. L_AMT1). L_NUMBER0. L_NAME1). These parameters must be ordered sequentially beginning with 0 (for example.Canada  CH .France  IT .Belgium  CA . These parameters must be ordered sequentially beginning with 0 (for example.Netherlands  PL . L_ITEMHEIGHTVALUE0.Spain  GB . These parameters must be ordered sequentially beginning with 0 (for example. L_ITEMWEIGHTVALUE0. You can pass this data to the shipping carrier as is without having to make an additional database query.United States Any other value will default to US.United Kingdom  FR . L_AMT0.Italy  NL .6 ExpressCheckout API Operations Callback API Operation Field LOCALECODE Description (Optional) Locale of pages displayed by PayPal during Express Checkout. You can pass this data to the shipping carrier as is without having to make an additional database query. The following two-character country codes are supported by PayPal:  AU . These parameters must be ordered sequentially beginning with 0 (for example. Name of city. ITEMLENGTHVALUE0. ITEMLENGTHVALUE1).’ Name-Value Pair API Developer Guide September 2010 47 . may be required for other countries.. The value is always CallbackResponse. Required if using a shipping address. Country code. Character limit: 2 single-byte characters. Character length and limitations: 20 single-byte characters.S. Character length and limitations: 100 single-byte characters. U. Character length and limitations: 100 single-byte characters. Required if using a shipping address. Character length and limitations: 40 single-byte characters. L_ITEMWIDTHVALUE1). Required if using a shipping address. Required if using a U. (Optional) Indicates whether or not PayPal should display insurance in a drop-down list on the Review page. These parameters must be ordered sequentially beginning with 0 (for example.ExpressCheckout API Operations Callback API Operation 6 Field L_ITEMWIDTHVALUEn L_ITEMWIDTHUNITn Description The width of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. L_ITEMLENGTHVALUEn L_ITEMLENGTHUNITn SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRY Callback Response Message Callback Response Fields Field METHOD CURRENCYCODE OFFERINSURANCEOPTIO N Description (Required) The method sent to the PayPal server. Required if using a shipping address. These parameters must be ordered sequentially beginning with 0 (for example. shipping address. When the value is true. (Required) The three-character currency code for the transaction from the Express Checkout API. PayPal displays the drop-down with the associated amount and the string ‘Yes. Character length and limitations: 40 single-byte characters.S. State or province. You can pass this data to the shipping carrier as is without having to make an additional database query. The length of the item. L_ITEMWIDTHVALUE0. Second street address. First street address. ZIP code or other country-specific postal code. Equivalent to nine characters maximum for USD.’ (Optional) If you do not ship to the buyer’s shipping address.0 or greater. Regardless of currency. L_SHIPPINGAMOUNT1). N O TE : L_SHIPPINGOPTIONLAB ELn L_SHIPPINGOPTIONAMO UNTn Character length and limitations: Must not exceed $10. OFFERINSURANCEOPTIO N NO_SHIPPING_OPTION_ DETAILS (Optional) Indicates whether or not PayPal should display insurance in a drop-down list on the Review page. L_SHIPPINGALABEL0. L_SHIPPINGLABEL1). Ground. and the optional thousands separator must be a comma (.). such as Air. set this field to 1. and the optional thousands separator must be a comma (. L_SHIPPINGOPTIONNAME0. N O TE : Character length and limitations: Must not exceed $10.).000 USD in any currency.6 ExpressCheckout API Operations Callback API Operation Field L_SHIPPINGOPTIONNAM En Description (Required) Is the internal/system name of a shipping option. 48 September 2010 Name-Value Pair API Developer Guide . The value of CALLBACKVERSION in SetExpressCheckout request must be 61. No currency symbol. No currency symbol. Equivalent to nine characters maximum for USD. L_SHIPPINGOPTIONISD EFAULT L_TAXAMTn (Required) The option that is selected by default for the buyer and is also reflected in the “default” total. When the value is true. Equivalent to nine characters maximum for USD. These parameters must be ordered sequentially beginning with 0 (for example. These parameters must be ordered sequentially beginning with 0 (for example.000 USD in any currency. and the optional thousands separator must be a comma (. (Optional) New tax amount based on this shipping option and the shipping address. These parameters must be ordered sequentially beginning with 0 (for example. Examples: Air: Next Day. Ground: 5-7 days. L_SHIPPINGAMOUNT0. Expedited: 3-5 days. N O TE : Character length and limitations: Must not exceed $10.).). No currency symbol. or Expedited. Character length and limitations: 50 characters (Required) The label for the shipping option as displayed to the buyer. L_SHIPPINGOPTIONNAME1).000 USD in any currency. Regardless of currency. PayPal displays the drop-down with the associated amount and the string ‘Yes. which is a part of the callback request.). decimal separator must be a period (. Character length and limitations: 50 characters (Required) Is the amount for this shipping option. L_INSURANCEAMOUNTn (Optional) New insurance amount based on this shipping option and the shipping address.). decimal separator must be a period (. These labels can be localized based on the buyer’s locale. decimal separator must be a period (. Regardless of currency. this field is ignored. decimal separator must be a period (. If the transaction includes one or more one-time purchases. this value should be the current sub-total of the order. If the transaction does not include a one-time purchase.0. including shipping cost and tax charges. Limitations: Must not exceed $10. NOTE: AMT (deprecated) MAXAMT RETURNURL PayPal recommends that the value be the final review page on which the customer confirms the order and payment or billing agreement.).). If shipping cost and tax charges are known. this field must be equal to the sum of the purchases. (Optional) The expected maximum total amount of the complete order.00). (Optional) A timestamped token. Character length and limitations: 2048 characters Name-Value Pair API Developer Guide September 2010 49 . and the optional thousands separator must be a comma (. and the optional thousands separator must be a comma (. Limitations: Must not exceed $10. when you set up a billing agreement for a recurring payment.   “SetExpressCheckout Request Message” on page 49 “SetExpressCheckout Response Message” on page 66 SetExpressCheckout Request Message SetExpressCheckout Request Fields Field METHOD TOKEN Description (Required) Must be SetExpressCheckout.000 USD in any currency. the value of which was returned by SetExpressCheckout response. if not. Must have two decimal places. include them in this value. No currency symbol. (Required) URL to which the customer’s browser is returned after choosing to pay with PayPal. If the transaction includes one or more one-time purchases. set this field to 0.ExpressCheckout API Operations SetExpressCheckout API Operation 6 SetExpressCheckout API Operation Initiates an Express Checkout transaction. No currency symbol. (Required) The total cost of the transaction to the customer. For recurring payments. PayPal uses this value to validate the buyer’s funding source. Must have two decimal places. Character length and limitations: 20 single-byte characters This field is deprecated since version 53. for example. decimal separator must be a period (.000 USD in any currency. you should pass the expected average transaction amount (default 25.).). Use PAYMENTREQUEST_0_AMT instead. 1 This field is available since version 53.PayPal displays the shipping address on the PayPal pages  1 . Allowable values: 0. 1 NOSHIPPING (Optional) Determines where or not PayPal displays shipping address fields on the PayPal pages. The note is returned in the GetExpressCheckoutDetails response and the DoExpressCheckoutPayment response. Character length and limitations: 1024 characters This field is available since version 53. PayPal obtains it from the buyer’s account profile Character length and limitations: Four single-byte numeric characters. The acceptable range for the override is 1 to 6 seconds.6 ExpressCheckout API Operations SetExpressCheckout API Operation Field CANCELURL Description (Required) URL to which the customer is returned if he does not approve the use of PayPal to pay you. Allowable values: 0. (Optional) An override for you to request more or less time to be able to process the callback request and respond. 50 September 2010 Name-Value Pair API Developer Guide . Character length and limitations: One single-byte numeric character.PayPal does not display shipping address fields whatsoever  2 . NOTE: PayPal recommends that the value be the original page on which the customer chose to pay with PayPal or establish a billing agreement. It must start with HTTPS for production integration. Allowable values: 0.If you do not pass the shipping address.0. PayPal uses the default value of 3 seconds. It can start with HTTPS or HTTP for sandbox testing. Character length and limitations: One single-byte numeric character. Character length and limitations: 2048 characters CALLBACK (Optional) URL to which the callback request from PayPal is sent.0. If you specify a value greater than 6. 2  0 . NOTE: CALLBACKTIMEOUT REQCONFIRMSHIPPING Setting this field overrides the setting you have specified in your Merchant Account Profile. Character length and limitations: An integer between 1 and 6 (Optional) The value 1 indicates that you require that the customer’s shipping address on file with PayPal be a confirmed address. 1. ALLOWNOTE (Optional) The value 1 indicates that the customer may enter a note to the merchant on the PayPal page during checkout. Displaying the PayPal street address on file does not allow the customer to edit that address. PayPal recommends that you provide an image that is stored on a secure (https) server. The image has a maximum size of 750 pixels wide by 90 pixels high. LOCALECODE PAGESTYLE (Optional) Sets the Custom Payment Page Style for payment pages associated with this button/link.Germany  ES . If you do not specify an image. Character length and limitation: Six character HTML hexadecimal color code in ASCII HDRIMG HDRBORDERCOLOR Name-Value Pair API Developer Guide September 2010 51 . By default.Canada  CH .Australia  AT .Belgium  CA . Character length and limitations: One single-byte numeric character. not the shipping address on file with PayPal for this customer.United Kingdom  FR .Switzerland  CN .Netherlands  PL .China  DE . The following two-character country codes are supported by PayPal:  AU .Italy  NL . Character length and limitations: 30 single-byte alphabetic characters (Optional) URL for the image you want to appear at the top left of the payment page.ExpressCheckout API Operations SetExpressCheckout API Operation 6 Field ADDROVERRIDE Description (Optional) The value 1 indicates that the PayPal pages should display the shipping address set by you in this SetExpressCheckout request.Poland  US .Austria  BE . Character length and limitations: Any two-character country code. The border is a 2-pixel perimeter around the header space. Allowable values: 0. the business name is displayed. This value corresponds to the HTML variable page_style for customizing payment pages.France  IT . the color is black.United States Any other value will default to US. 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. 1 (Optional) Locale of pages displayed by PayPal during Express Checkout. Character length and limit: 127 single-byte alphanumeric characters (Optional) Sets the border color around the header of the payment page.Spain  GB . which is 750 pixels wide by 90 pixels high. NOTE: PAYFLOWCOLOR PAYMENTACTION (deprecated) You cannot set this value to Sale in SetExpressCheckout request and then change this value to Authorization or Order on the final API DoExpressCheckoutPayment request. Character length and limitation: Six character HTML hexadecimal color code in ASCII (Optional) Sets the background color for the payment page. By default. Use PAYMENTREQUEST_0_PAYMENTACTION instead. the color is white. Character length and limit: 127 single-byte alphanumeric characters (Optional) Type of checkout flow:  Sole: Buyer does not need to create a PayPal account to check out. Passing Sole has no effect if PayPal Account Optional is turned off in your account LANDINGPAGE (Optional) Type of PayPal page to display:  Billing: non-PayPal account  Login: PayPal account login (Optional) Type of channel:  Merchant: non-auction seller  eBayItem: eBay auction CHANNELTYPE 52 September 2010 Name-Value Pair API Developer Guide . If the transaction does not include a one-time purchase. (Optional) How you want to obtain payment:  Sale indicates that this is a final sale for which you are requesting payment.6 ExpressCheckout API Operations SetExpressCheckout API Operation Field HDRBACKCOLOR Description (Optional) Sets the background color for the header of the payment page. PayPal uses this value to pre-fill the PayPal membership sign-up portion of the PayPal login page. Character length and limitation: Six character HTML hexadecimal color code in ASCII This field is deprecated.  Mark: Buyer must have a PayPal account to check out. the value may be set to Sale or the same value (either Authorization or Order) in DoExpressCheckoutPayment. the color is white. (Default)  Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization & Capture. By default. Character length and limit: Up to 13 single-byte alphabetic characters Default value: Sale EMAIL (Optional) Email address of the buyer as entered during checkout. this field is ignored. If the value is set to Authorization or Order in SetExpressCheckout.  Order indicates that this payment is an order authorization subject to settlement with PayPal Authorization & Capture. NOTE: SOLUTIONTYPE You can pass Mark to selectively override the PayPal Account Optional setting if PayPal Account Optional is turned on in your merchant account. This is referred to as PayPal Account Optional. ). at least 2 survey answer options need to be present. Allowable values are 0 and 1 GIFTWRAPNAME (Optional) Label for the gift wrap option such as “Box with ribbon”.000 USD in any currency. Must have two decimal places. Use this field only if you are using giropay or bank transfer payment methods in Germany. If the survey question is present. Use this field only if you are using giropay or bank transfer payment methods in Germany.ExpressCheckout API Operations SetExpressCheckout API Operation 6 Field GIROPAYSUCCESSURL Description (Optional) The URL on the merchant site to redirect to after a successful giropay payment. Limitations: Must not exceed $10. (Optional) The URL on the merchant site to redirect to after a successful giropay payment. and the optional thousands separator must be a comma (. Limitations: 16 single-byte characters (Optional) Enable gift message widget on the PayPal Review page. Use this field only if you are using giropay or bank transfer payment methods in Germany.00. Limitations: 50 single-byte characters (Optional) The version of the Instant Update API that your callback server uses. Allowable values are 0 and 1 (Optional) Text for the survey question on the PayPal Review page. NOTE: GIROPAYCANCELURL BANKTXNPENDINGURL BRANDNAME CUSTOMERSERVICENUMB ER GIFTMESSAGEENABLE GIFTRECEIPTENABLE GIFTWRAPENABLE If the value 1 is passed for this field values for the gift wrap amount and gift wrap name are not passed. GIFTWRAPAMOUNT BUYEREMAILOPTINENAB LE SURVEYQUESTION CALLBACKVERSION Name-Value Pair API Developer Guide September 2010 53 . Allowable values are 0 and 1 (Optional) Enable gift wrap widget on the PayPal Review page. No currency symbol. the gift wrap name will not be displayed and the gift wrap amount will display as 0. Limitations: 25 single-byte characters (Optional) Label for the gift wrap option such as “Blue box with ribbon”. (Optional) A label that overrides the business name in the PayPal account on the PayPal hosted checkout pages. The default is the current version. (Optional) Enable buyer email opt-in on the PayPal Review page. Allowable values are 0 and 1 (Optional) Enable gift receipt widget on the PayPal Review page.). (Optional) The URL on the merchant site to transfer to after a bank transfer payment. Character length and limitations: 127 single-byte alphanumeric characters (Optional) Merchant Customer Service number displayed on the PayPal Review page. decimal separator must be a period (. Character length and limitations: 40 single-byte characters. EET You can specify up to 10 payments. where n is a digit between 0 and 9. inclusive. where n is a digit between 0 and 9. PAYMENTREQUEST_n_SHIPTOSTA State or province. SHIPTONAME (deprecated) You can specify up to 10 payments. where n is a digit between 0 and 9. Use PAYMENTREQUEST_0_SHIPTOSTREET2 instead. EET2 You can specify up to 10 payments. Required if using a shipping address. Use PAYMENTREQUEST_0_SHIPTOCITY instead. Y You can specify up to 10 payments. Use PAYMENTREQUEST_0_SHIPTONAME instead.0. Use PAYMENTREQUEST_0_SHIPTOSTATE instead. TE You can specify up to 10 payments. Required if using a E shipping address.0. SHIPTONAME is deprecated since version 63. PAYMENTREQUEST_n_SHIPTOSTR (Optional) Second street address. Character length and limitations: 100 single-byte characters. Character length and limitations: 40 single-byte characters. SHIPTOSTATE (deprecated) inclusive. Answers are displayed only if a valid survey question is present. Character length and limitations: 32 single-byte characters. Character length and limitations: 100 single-byte characters.0.0. Required if using a shipping address. PAYMENTREQUEST_n_SHIPTOCIT Name of city. where n is a digit between 0 and 9. SHIPTOSTREET is deprecated since version 63.0. 54 September 2010 Name-Value Pair API Developer Guide . Required if using a shipping address. SHIPTOSTREET (deprecated) inclusive.6 ExpressCheckout API Operations SetExpressCheckout API Operation Field SURVEYENABLE Description (Optional) Enable survey functionality. Limitations: 15 single-byte characters L_SURVEYCHOICEn AddressType Fields Field Description PAYMENTREQUEST_n_SHIPTONAM Person’s name associated with this shipping address. SHIPTOSTATE is deprecated since version 63. SHIPTOSTREET2 is deprecated since version 63. SHIPTOCITY is deprecated since version 63. SHIPTOSTREET2 (deprecated) inclusive. Use PAYMENTREQUEST_0_SHIPTOSTREET instead. PAYMENTREQUEST_n_SHIPTOSTR First street address. SHIPTOCITY (deprecated) inclusive. Allowable values are 0 and 1 (Optional) Possible options for the survey answers on the PayPal Review page. where n is a digit between 0 and 9. inclusive.0. inclusive. Use PAYMENTREQUEST_0_SHIPTOPHONENUM instead. NTRYCODE You can specify up to 10 payments. Use PAYMENTREQUEST_0_AMT instead. PAYMENTREQUEST_n_SHIPTOCOU Country code. Limitations: Must not exceed $10. Purchase-specific fields will be ignored. where n is a digit between 0 and 9. SHIPTOCOUNTRY is deprecated since version 63. where n is a digit between 0 and 9. Set this field to 0 if the transaction does not include a one-time purchase.000 USD in any currency.). Character length and limitations: 20 single-byte characters. Character length and limit: 20 single-byte characters. Required if using a shipping address. PAYMENTREQUEST_n_CUR RENCYCODE CURRENCYCODE (deprecated) Name-Value Pair API Developer Guide September 2010 55 . ZIP code or other country-specific postal code. Use PAYMENTREQUEST_0_SHIPTOZIP instead. when you set up a billing agreement for a recurring payment that is not immediately charged. Field PAYMENTREQUEST_n_AMT AMT (deprecated) Description (Required) The total cost of the transaction to the customer. (Optional) A three-character currency code. this value should be the current sub-total of the order. SHIPTOZIP is deprecated since version 63. decimal separator must be a period (. You can specify up to 10 payments.ExpressCheckout API Operations SetExpressCheckout API Operation 6 Field Description PAYMENTREQUEST_n_SHIPTOZIP U.S. If the transaction includes one or more one-time purchases. Character limit: 2 single-byte characters. inclusive. SHIPTOPHONENUM (deprecated) inclusive.0. where n is a digit between 0 and 9. where n is a digit between 0 and 9. shipping address. this field must be equal to the sum of the purchases.). PAYMENTREQUEST_n_SHIPTOPHO (Optional) Phone number. if not. SHIPTOPHONENUM is deprecated since version 63.0. SHIPTOZIP (deprecated) You can specify up to 10 payments. each representing one payment you are hosting on your marketplace. Must have two decimal places. If shipping cost and tax charges are known. Required if using a U. for example. AMT is deprecated since version 63. Default: USD. No currency symbol. NENUM You can specify up to 10 payments. Payment Details Type Fields When implementing parallel payments. Use PAYMENTREQUEST_0_CURRENCYCODE instead. You can specify up to 10 payments. Use PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE instead.0.S. may be required for other countries. include them in this value. where n is a digit between 0 and 9. CURRENCYCODE is deprecated since version 63. and the optional thousands separator must be a comma (.0. you can create up to 10 sets of payment details type parameter fields. SHIPTOCOUNTRY (deprecated) inclusive. 6 ExpressCheckout API Operations SetExpressCheckout API Operation Field PAYMENTREQUEST_n_ITE MAMT ITEMAMT (deprecated) Description (Optional) Sum of cost of all items in this order. NOTE: PAYMENTREQUEST_n_ITEMAMT is required if you specify L_PAYMENTREQUEST_n_AMTm. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Must have two decimal places, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). ITEMAMT is deprecated since version 63.0. Use PAYMENTREQUEST_0_ITEMAMT instead. PAYMENTREQUEST_n_SHI PPINGAMT SHIPPINGAMT (deprecated) (Optional) Total shipping costs for this order. NOTE: If you specify a value for PAYMENTREQUEST_n_SHIPPINGAMT, you must also specify a value for PAYMENTREQUEST_n_ITEMAMT. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD. SHIPPINGAMT is deprecated since version 63.0. Use PAYMENTREQUEST_0_SHIPPINGAMT instead. PAYMENTREQUEST_n_INS URANCEOPTIONOFFERED INSURANCEOPTIONOFFER ED (deprecated) (Optional) If true, the Insurance drop-down on the PayPal Review page displays the string ‘Yes’ and the insurance amount. If true, the total shipping insurance for this order must be a positive number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: true or false INSURANCEOPTIONOFFERED is deprecated since version 63.0. Use PAYMENTREQUEST_0_INSURANCEOPTIONOFFERED instead. (Optional) Total handling costs for this order. NOTE: PAYMENTREQUEST_n_HAN DLINGAMT HANDLINGAMT (deprecated) If you specify a value for PAYMENTREQUEST_n_HANDLINGAMT, you must also specify a value for PAYMENTREQUEST_n_ITEMAMT. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD. HANDLINGAMT is deprecated since version 63.0. Use PAYMENTREQUEST_0_HANDLINGAMT instead. 56 September 2010 Name-Value Pair API Developer Guide ExpressCheckout API Operations SetExpressCheckout API Operation 6 Field PAYMENTREQUEST_n_TAX AMT TAXAMT (deprecated) Description (Optional) Sum of tax for all items in this order. NOTE: PAYMENTREQUEST_n_TAXAMT is required if you specify L_PAYMENTREQUEST_n_TAXAMTm You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD. TAXAMT is deprecated since version 63.0. Use PAYMENTREQUEST_0_TAXAMT instead. PAYMENTREQUEST_n_DES C DESC (deprecated) (Optional) Description of items the customer is purchasing. The value you specify is only available if the transaction includes a purchase; this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: 127 single-byte alphanumeric characters DESC is deprecated since version 63.0. Use PAYMENTREQUEST_0_DESC instead. (Optional) A free-form field for your own use. NOTE: PAYMENTREQUEST_n_CUS TOM CUSTOM (deprecated) The value you specify is only available if the transaction includes a purchase; this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: 256 single-byte alphanumeric characters CUSTOM is deprecated since version 63.0. Use PAYMENTREQUEST_0_CUSTOM instead. PAYMENTREQUEST_n_INV NUM INVNUM (deprecated) (Optional) Your own invoice or tracking number. NOTE: The value you specify is only available if the transaction includes a purchase; this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: 127 single-byte alphanumeric characters INVNUM is deprecated since version 63.0. Use PAYMENTREQUEST_0_INVNUM instead. Name-Value Pair API Developer Guide September 2010 57 6 ExpressCheckout API Operations SetExpressCheckout API Operation Field PAYMENTREQUEST_n_NOT IFYURL NOTIFYURL (deprecated) Description (Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. If you do not specify this value in the request, the notification URL from your Merchant Profile is used, if one exists. I MP O R T ANT : The notify URL only applies to DoExpressCheckoutPayment. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: 2,048 single-byte alphanumeric characters NOTIFYURL is deprecated since version 63.0. Use PAYMENTREQUEST_0_NOTIFYURL instead. PAYMENTREQUEST_n_NOT ETEXT NOTETEXT (deprecated) (Optional) Note to the merchant. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: 255 single-byte characters NOTETEXT is deprecated since version 63.0. Use PAYMENTREQUEST_0_NOTETEXT instead. (Optional) Transaction identification number of the transaction that was created. NOTE: PAYMENTREQUEST_n_TRA NSACTIONID TRANSACTIONID (deprecated) This field is only returned after a successful transaction for DoExpressCheckout has occurred. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. TRANSACTIONID is deprecated since version 63.0. Use PAYMENTREQUEST_0_TRANSACTIONID instead. (Optional) The payment method type. Specify the value InstantPaymentOnly. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. ALLOWEDPAYMENTMETHOD is deprecated since version 63.0. Use PAYMENTREQUEST_0_ALLOWEDPAYMENTMETHOD instead. PAYMENTREQUEST_n_ALL OWEDPAYMENTMETHOD ALLOWEDPAYMENTMETHOD (deprecated) 58 September 2010 Name-Value Pair API Developer Guide ExpressCheckout API Operations SetExpressCheckout API Operation 6 Field PAYMENTREQUEST_n_PAY MENTACTION PAYMENTACTION (deprecated) Description How you want to obtain payment. When implementing parallel payments, this field is required and must be set to Order.  Sale indicates that this is a final sale for which you are requesting payment. (Default)  Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization & Capture.  Order indicates that this payment is an order authorization subject to settlement with PayPal Authorization & Capture. If the transaction does not include a one-time purchase, this field is ignored. NOTE: You cannot set this value to Sale in SetExpressCheckout request and then change this value to Authorization or Order on the final API DoExpressCheckoutPayment request. If the value is set to Authorization or Order in SetExpressCheckout, the value may be set to Sale or the same value (either Authorization or Order) in DoExpressCheckoutPayment. Default value: Sale You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limit: Up to 13 single-byte alphabetic characters PAYMENTACTION is deprecated since version 63.0. Use PAYMENTREQUEST_0_PAYMENTACTION instead. PAYMENTREQUEST_n_PAY MENTREQUESTID PAYMENTREQUESTID (deprecated) A unique identifier of the specific payment request, which is required for parallel payments. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limit: Up to 127 single-byte characters PAYMENTREQUESTID is deprecated since version 63.0. Use PAYMENTREQUEST_0_PAYMENTREQUESTID instead. Payment Details Item Type Fields Field L_PAYMENTREQUEST_n_NA MEm L_NAMEn (deprecated) Description (Optional) Item name. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NAME0, L_PAYMENTREQUEST_n_NAME1). Introduced in Version 53.0. Character length and limitations: 127 single-byte characters L_NAMEn is deprecated since version 63.0. Use L_PAYMENTREQUEST_0_NAMEm instead. Name-Value Pair API Developer Guide September 2010 59 6 ExpressCheckout API Operations SetExpressCheckout API Operation Field L_PAYMENTREQUEST_n_DE SCm L_DESCn (deprecated) Description (Optional) Item description. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_DESC0, L_PAYMENTREQUEST_n_DESC1). Introduced in Version 53.0. Character length and limitations: 127 single-byte characters L_DESCn is deprecated since version 63.0. Use L_PAYMENTREQUEST_0_DESCm instead. (Optional) Cost of item. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_AMT0, L_PAYMENTREQUEST_n_AMT1). Introduced in Version 53.0. Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD. NOT E : L_PAYMENTREQUEST_n_AM Tm L_AMTn (deprecated) If you specify a value for L_PAYMENTREQUEST_n_AMTm, you must specify a value for PAYMENTREQUEST_n_ITEMAMT. L_AMTn is deprecated since version 63.0. Use L_PAYMENTREQUEST_0_AMTm instead. L_PAYMENTREQUEST_n_NU MBERm L_NUMBERn (deprecated) (Optional) Item number. Introduced in Version 53.0. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NUMBER0, L_PAYMENTREQUEST_n_NUMBER1). L_NUMBERn is deprecated since version 63.0. Use L_PAYMENTREQUEST_0_NUMBERm instead. (Optional) Item quantity. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_QTY0, L_PAYMENTREQUEST_n_QTY1). Introduced in Version 53.0. Character length and limitations: Any positive integer L_QTYn is deprecated since version 63.0. Use L_PAYMENTREQUEST_0_QTYm instead. L_PAYMENTREQUEST_n_QT Ym L_QTYn (deprecated) 60 September 2010 Name-Value Pair API Developer Guide NOT E : Character length and limitations: Must not exceed $10. Use L_PAYMENTREQUEST_0_ITEMLENGTHVALUEm and L_PAYMENTREQUEST_0_ITEMLENGTHUNITn instead. and m specifies the list item within the payment.). L_PAYMENTREQUEST_n_IT EMWEIGHTVALUEm. You can specify up to 10 payments. L_PAYMENTREQUEST_n_ITEMLENGTHVALUE1). Use L_PAYMENTREQUEST_0_ITEMWEIGHTVALUEm and L_PAYMENTREQUEST_0_ITEMWEIGHTUNITm instead.). and the optional thousands separator must be a comma (. where n is a digit between 0 and 9. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_TAXAMT0. You can pass this data to the shipping carrier as is without having to make an additional database query. L_TAXAMTn is deprecated since version 63. Use L_PAYMENTREQUEST_0_TAXAMTm instead. L_PAYMENTREQUEST_n_TAXAMT1). Equivalent to nine characters maximum for USD. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMWEIGHTVALUE0. where n is a digit between 0 and 9. Character length and limitations: Any positive integer L_ITEMLENGTHVALUEn and L_ITEMLENGTHUNITm are deprecated since version 63.0. No currency symbol. You can pass this data to the shipping carrier as is without having to make an additional database query. and m specifies the list item within the payment. inclusive. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMLENGTHVALUE0. L_PAYMENTREQUEST_n_IT EMWEIGHTUNITm L_ITEMWEIGHTVALUEn and L_ITEMWEIGHTUNITn (deprecated) (Optional) Item weight corresponds to the weight of the item. L_ITEMWEIGHTTVALUEn and L_ITEMWEIGHTUNITn are deprecated since version 63. inclusive. and m specifies the list item within the payment. You can specify up to 10 payments. where n is a digit between 0 and 9. L_PAYMENTREQUEST_n_ITEMWEIGHTVALUE1). You can specify up to 10 payments. L_PAYMENTREQUEST_n_IT EMLENGTHUNITm L_ITEMLENGTHVALUEn and L_ITEMLENGHTUNITn (deprecated) Name-Value Pair API Developer Guide September 2010 61 .ExpressCheckout API Operations SetExpressCheckout API Operation 6 Field L_PAYMENTREQUEST_n_TA XAMTm L_TAXAMTn (deprecated) Description (Optional) Item sales tax.0. (Optional) Item length corresponds to the length of the item. Regardless of currency.000 USD in any currency. decimal separator must be a period (. L_PAYMENTREQUEST_n_IT EMLENGTHVALUEm.0. inclusive. Character length and limitations: Any positive integer L_ITEMHEIGHTVALUEn and L_ITEMHEIGHTUNITm are deprecated since version 63. 62 September 2010 Name-Value Pair API Developer Guide .0. (Optional) Item height corresponds to the height of the item.6 ExpressCheckout API Operations SetExpressCheckout API Operation Field L_PAYMENTREQUEST_n_IT EMWIDTHVALUEm. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMHEIGHTVALUE0. Character length and limitations: Any positive integer L_ITEMWIDTHVALUEn and L_ITEMWIDTHUNITm are deprecated since version 63. where n is a digit between 0 and 9. L_PAYMENTREQUEST_n_ITEMURL1).0. (Optional) URL for the item. L_PAYMENTREQUEST_n_IT EMHEIGHTVALUEm. You can specify up to 10 payments. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMWIDTHVALUE0. and m specifies the list item within the payment. L_PAYMENTREQUEST_n_ITEMWIDTHVALUE1). You can pass this data to the shipping carrier as is without having to make an additional database query. L_ITEMURLn is deprecated since version 63. inclusive. Use L_PAYMENTREQUEST_0_ITEMHEIGHTVALUEm and L_PAYMENTREQUEST_0_ITEMHEIGHTUNITn instead. You can specify up to 10 payments. inclusive. You can pass this data to the shipping carrier as is without having to make an additional database query. inclusive. Use L_PAYMENTREQUEST_0_ITEMURLm instead. Use L_PAYMENTREQUEST_0_ITEMWIDTHVALUEm and L_PAYMENTREQUEST_0_ITEMWIDTHUNITn instead. where n is a digit between 0 and 9. where n is a digit between 0 and 9. You can specify up to 10 payments. Use PAYMENTREQUEST_0_SELLERID instead. L_PAYMENTREQUEST_n_IT EMWIDTHUNITm L_ITEMWIDTHVALUEn and L_ITEMWIDTHUNITn (deprecated) Description (Optional) Item width corresponds to the width of the item. L_PAYMENTREQUEST_n_IT EMHEIGHTUNITm L_ITEMHEIGHTVALUEn and L_ITEMHEIGHTUNITn (deprecated) L_PAYMENTREQUEST_n_IT EMURLm L_ITEMURLn (deprecated) Seller Details Type Fields Field PAYMENTREQUEST_n_SELL ERID SELLERID (deprecated) Description (Optional) The unique non-changing identifier for the seller at the marketplace site. This ID is not displayed. and m specifies the list item within the payment.0. inclusive. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMURL0. You can specify up to 10 payments. and m specifies the list item within the payment. Character length and limitations: 13 single-byte alphanumeric characters SELLERID is deprecated since version 63.0. L_PAYMENTREQUEST_n_ITEMHEIGHTVALUE1). where n is a digit between 0 and 9. inclusive. L_PAYMENTREQUEST_n_EBAYITEMORDERID1). You can specify up to 10 payments. Use L_PAYMENTREQUEST_0_EBAYITEMORDERIDm instead. and m specifies the list item within the payment. where n is a digit between 0 and 9. L_PAYMENTREQUESST_n_E BAYITEMAUCTIONTXNIDm L_EBAYITEMAUCTIONTXNI Dn (deprecated) L_PAYMENTREQUEST_n_EB AYITEMORDERIDm L_EBAYITEMORDERIDn (deprecated) Name-Value Pair API Developer Guide September 2010 63 . L_PAYMENTREQUEST_n_EBAYITEMNUMBER1). inclusive.0. Character length and limitations: 127 single-byte alphanumeric characters Ebay Item Payment Details Item Type Fields Field L_PAYMENTREQUEST_n_EB AYITEMNUMBERm L_EBAYITEMNUMBERn (deprecated) Description (Optional) Auction item number. You can specify up to 10 payments. Character length: 765 single-byte characters L_EBAYITEMNUMBERn is deprecated since version 63. where n is a digit between 0 and 9. You can specify up to 10 payments. You can specify up to 10 payments.0. Use L_PAYMENTREQUEST_0_EBAYAUCTIONTXNIDm instead. Character length: 64 single-byte characters L_EBAYITEMORDERIDn is deprecated since version 63. For parallel payments. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNID0. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMORDERID0. this field is required and must contain the Payer Id or the email address of the merchant. (Optional) Auction order identification number. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMNUMBER0. Character length: 255 single-byte characters L_EBAYAUCTIONTXNIDn is deprecated since version 63. Use L_PAYMENTREQUEST_0_EBAYITEMNUMBERm instead. inclusive. and m specifies the list item within the payment. where n is a digit between 0 and 9. inclusive. where n is a digit between 0 and 9.0. (Optional) Auction transaction identification number. and m specifies the list item within the payment. L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNID1).ExpressCheckout API Operations SetExpressCheckout API Operation 6 Field PAYMENTREQUEST_n_SELL ERPAYPALACCOUNTID Description Unique identifier for the merchant. L_PAYMENTREQUEST_n_EBAYITEMCARTID1). It is not OK to have no default. it is different. Buyer Details Fields Field BUYERID Description (Optional) The unique identifier provided by eBay for this buyer. BUYERUSERNAME BUYERREGISTRATIONDA TE FundingSourceDetailsType Fields Field ALLOWPUSHFUNDING Description (Optional) Whether the merchant can accept push funding:  0 — Merchant can accept push funding  1 — Merchant cannot accept push funding N O TE : This field overrides the setting in the merchant's PayPal account. Shipping Options Type Fields Field Description L_SHIPPINGOPTIONISDEF (Optional) Shipping option. Character length and limitations: Boolean: true or false. Character length and limitations: 255 single-byte characters xs:string (Optional) The user name of the user at the marketplaces site. xs:dateTime (Optional) Date when the user registered with the marketplace. where n is a digit between 0 and 9. Use L_PAYMENTREQUEST_0_EBAYITEMCARTIDm instead. Required if specifying the Callback URL. AULTn When the value of this flat rate shipping option is true. In the case of eBay. and m specifies the list item within the payment. You can specify up to 10 payments.6 ExpressCheckout API Operations SetExpressCheckout API Operation Field L_PAYMENTREQUEST_n_EB AYCARTIDm L_EBAYITEMCARTIDn (deprecated) Description (Optional) The unique identifier provided by eBay for this order from the buyer. The value may or may not be the same as the username. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMCARTID0. 64 September 2010 Name-Value Pair API Developer Guide . NOT E : There must be ONE and ONLY ONE default. inclusive. PayPal selects it by default for the buyer and reflects it in the “default” total.0. Character length: 255 single-byte characters L_EBAYITEMCARTIDn is deprecated since version 63. which is required for reference transactions. Other defined values are not valid. and the optional thousands separator must be a comma (. For example. which is required for each recurring payment billing agreement. (Optional) Specifies type of PayPal payment you require for the billing agreement.000 USD in any currency. Character length and limitations: 256 single-byte alphanumeric bytes. Billing Agreement Details Type Fields Field BILLINGTYPE Description Type of billing agreement. The internal name of the shipping option such as Air. Required if specifying the Callback URL. Character length and limitations: 127 single-byte alphanumeric bytes. NOTE: For recurring payments. Required if specifying the Callback URL. Character length and limitations: 50 character-string. Must have two decimal places. Name-Value Pair API Developer Guide September 2010 65 . Tn The amount of the flat rate shipping option. Ground. Description of goods or services associated with the billing agreement. customer will be billed at “9.  Any  InstantOnly NOTE: L_BILLINGAGREEMENTD ESCRIPTIONn L_PAYMENTTYPEn For recurring payments. this field is ignored. this field is ignored. decimal separator must be a period (.ExpressCheckout API Operations SetExpressCheckout API Operation 6 Field L_SHIPPINGOPTIONNAMEn Description (Optional) Shipping option. and so forth. PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions.). Limitations: Must not exceed $10.). L_SHIPPINGOPTIONAMOUN (Optional) Shipping option. No currency symbol. L_BILLINGAGREEMENTC USTOMn (Optional) Custom annotation field for your own use.99 per month for 2 years”. Expedited. Character length and limitations: 20 single-byte characters 66 September 2010 Name-Value Pair API Developer Guide . Character length and limitations: 20 single-byte characters GetExpressCheckoutDetails API Operation Obtain information about an Express Checkout transaction. Character length and limitations: 20 single-byte characters GetExpressCheckoutDetails Response Message GetExpressCheckoutDetails Response Fields Field TOKEN Description The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request.6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation SetExpressCheckout Response Message SetExpressCheckout Response Fields Field TOKEN Description A timestamped token by which you identify to PayPal that you are processing this payment with Express Checkout. The token expires after three hours. the value of the token in the response is identical to the value in the request. the value of which was returned by SetExpressCheckout response.   “GetExpressCheckoutDetails Request Message” on page 66 “GetExpressCheckoutDetails Response Message” on page 66 GetExpressCheckoutDetails Request Message GetExpressCheckoutDetails Request Fields Field METHOD TOKEN Description (Required) Must be GetExpressCheckoutDetails. (Required) A timestamped token.If you set the token in the SetExpressCheckout request. as set by you in the Custom element of SetExpressCheckout request. Character length and limitations: 256 single-byte alphanumeric characters Your own invoice or tracking number. N O TE : NOTE REDIRECTREQUIRED Use this field only if you are using giropay or bank transfer payment methods in Germany. If the buyer has a negative PayPal account balance. This amount will be represented by a negative amount. Character length and limitations: 255 single-byte characters Flag to indicate whether you need to redirect the customer to back to PayPal after completing the transaction. Limitations: 150 single-byte characters Returns true if the buyer requested a gift receipt on the PayPal Review page and false if the buyer did not. PayPal adds the negative balance to the transaction amount. the transaction identification number of the resulting transaction is returned. CHECKOUTSTATUS ebl:CheckoutStatusType Returns the status of the checkout session.ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 Field CUSTOM Description A free-form field for your own use. Character length and limitations: 127 single-byte alphanumeric characters Payer’s contact telephone number. The text entered by the buyer on the PayPal website if the ALLOWNOTE field was set to 1 in SetExpressCheckout. which is represented as a positive value. GIFTMESSAGE The gift message entered by the buyer on the PayPal Review page. as set by you in the element of the same name in SetExpressCheckout request. Possible values are:  PaymentActionNotInitiated  PaymentActionFailed  PaymentActionInProgress  PaymentCompleted If payment is completed. Return the gift wrap name only if the gift option on the PayPal Review page is selected by the buyer. Limitations: 25 single-byte characters GIFTRECEIPTENABLE GIFTWRAPNAME Name-Value Pair API Developer Guide September 2010 67 . This field is deprecated. N O TE : INVNUM PHONENUM PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one. Character length and limitations: Field mask is XXX-XXX-XXXX (for US numbers) or +XXX XXXXXXXX (for international numbers) PAYPALADJUSTMENT A discount or gift certificate offered by PayPal to the buyer. Character length and limitations: 25 single-byte characters. Character length and limitations: 20 single-byte characters.6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field GIFTWRAPAMOUNT Description Return the amount only if the gift option on the PayPal Review page is selected by the buyer. Payer’s business name. Character length and limitations: Two single-byte characters. Limitations: 127 single-byte characters The survey question on the PayPal Review page. Valid values are:  verified  unverified Character length and limitations: 10 single-byte alphabetic characters. Character length and limitations: 127 single-byte characters. Payer’s first name. Status of payer. decimal separator must be a period (. Payer’s middle name. Limitations: 15 single-byte characters BUYERMARKETINGEMAIL SURVEYQUESTION SURVEYCHOICESELECTE D Payer Information Fields for Digital Goods Field EMAIL Description Email address of payer. Limitations: Must not exceed $10. Limitations: 50 single-byte characters The survey response selected by the buyer on the PayPal Review page. Payer Name Fields Field SALUTATION Description Payer’s salutation. Character length and limitations: 127 single-byte characters.). Must have two decimal places. Character length and limitations:13 single-byte alphanumeric characters. and the optional thousands separator must be a comma (.).000 USD in any currency. COUNTRYCODE Payer’s country of residence in the form of ISO standard 3166 two-character country codes. Unique PayPal customer account identification number. Character length and limitations: 25 single-byte characters. No currency symbol. The buyer email address opted in by the buyer on the PayPal Review page. PAYERID PAYERSTATUS BUSINESS FIRSTNAME MIDDLENAME 68 September 2010 Name-Value Pair API Developer Guide . PAYMENTREQUEST_n_SHIPTOSTA State or province. EET Character length and limitations: 100 single-byte characters.ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 Field LASTNAME Description Payer’s last name. SHIPTONAME is deprecated since version 63. PAYMENTREQUEST_n_SHIPTOSTR First street address. where n is a digit between 0 and 9. SHIPTOCITY (deprecated) inclusive. SHIPTOCITY is deprecated since version 63. Character length and limitations: 32 single-byte characters. SHIPTOSTREET (deprecated) You can specify up to 10 payments. Use PAYMENTREQUEST_0_SHIPTOCITY instead. where n is a digit between 0 and 9. Character length and limitations: 12 single-byte characters.0. Use PAYMENTREQUEST_0_SHIPTOSTREET2 instead. PAYMENTREQUEST_n_SHIPTOSTR Second street address. SHIPTOSTATE (deprecated) inclusive. Character length and limitations: 40 single-byte characters. where n is a digit between 0 and 9. SHIPTOSTREET2 (deprecated) inclusive. Use PAYMENTREQUEST_0_SHIPTOSTATE instead. Use PAYMENTREQUEST_0_SHIPTOSTREET instead. where n is a digit between 0 and 9. TE You can specify up to 10 payments. SHIPTOSTREET is deprecated since version 63. E You can specify up to 10 payments. Name-Value Pair API Developer Guide September 2010 69 . Address Type Fields SUFFIX Field Description PAYMENTREQUEST_n_SHIPTONAM Person’s name associated with this shipping address. PAYMENTREQUEST_n_SHIPTOCIT Name of city. EET2 You can specify up to 10 payments. Character length and limitations: 25 single-byte characters. Character length and limitations: 100 single-byte characters.0. SHIPTONAME (deprecated) inclusive. Character length and limitations: 40 single-byte characters. inclusive. Use PAYMENTREQUEST_0_SHIPTONAME instead. where n is a digit between 0 and 9. Y You can specify up to 10 payments. SHIPTOSTREET2 is deprecated since version 63. Payer’s suffix.0.0.0. SHIPTOSTATE is deprecated since version 63. inclusive. Use PAYMENTREQUEST_0_SHIPTOZIP instead.0. ATUS Valid values are: ADDRESSSTATUS (deprecated)  none  Confirmed  Unconfirmed You can specify up to 10 payments. Character length and limit: 20 single-byte characters. where n is a digit between 0 and 9. each representing one payment you are hosting on your marketplace. you can create up to 10 sets of payment details type parameter fields. NENUM You can specify up to 10 payments. NTRYCODE You can specify up to 10 payments.S. PAYMENTREQUEST_n_SHIPTOCOU Country code. PAYMENTREQUEST_n_ADDRESSST Status of street address on file with PayPal. Use PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE instead. 70 September 2010 Name-Value Pair API Developer Guide . where n is a digit between 0 and 9. ADDRESSSTATUS is deprecated since version 63. SHIPTOCOUNTRY is deprecated since version 63. where n is a digit between 0 and 9. Character limit: 2 single-byte characters.0.0. SHIPTOCOUNTRY (deprecated) inclusive. SHIPTOPHONENUM (deprecated) inclusive. SHIPTOZIP is deprecated since version 63. Payment Details Type Fields When implementing parallel payments. Use PAYMENTREQUEST_0_ADDRESSSTATUS instead. where n is a digit between 0 and 9. SHIPTOZIP (deprecated) You can specify up to 10 payments.6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST_n_SHIPTOZIP U. PAYMENTREQUEST_n_SHIPTOPHO Phone number. SHIPTOPHONENUM is deprecated since version 63. Character length and limitations: 20 single-byte characters.0. ZIP code or other country-specific postal code. inclusive. Use PAYMENTREQUEST_0_SHIPTOPHONENUM instead. No currency symbol. No currency symbol. Must have two decimal places. Sum of cost of all items in this order. and the optional thousands separator must be a comma (. You can specify up to 10 payments.ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 Field PAYMENTREQUEST_n_AMT AMT (deprecated) Description The total cost of the transaction to the customer. Regardless of currency.). A three-character currency code. where n is a digit between 0 and 9. and the optional thousands separator must be a comma (. Use PAYMENTREQUEST_n_ITEMAMT instead.). Use PAYMENTREQUEST_n_CURRENCYCODE instead. Set this field to 0 if the transaction does not include a one-time purchase. decimal separator must be a period (.000 USD in any currency. Character length and limitations: Must not exceed $10. this field must be equal to the sum of the purchases.0.0. Default: USD. Purchase-specific fields will be ignored. ITEMAMT is deprecated since version 63. You can specify up to 10 payments. You can specify up to 10 payments. inclusive. Use PAYMENTREQUEST_n_AMT instead. decimal separator must be a period (.). inclusive. if not. PAYMENTREQUEST_n_CURRE NCYCODE CURRENCYCODE (deprecated) PAYMENTREQUEST_n_ITEMA MT ITEMAMT (deprecated) PAYMENTREQUEST_n_SHIPP INGAMT SHIPPINGAMT (deprecated) Name-Value Pair API Developer Guide September 2010 71 . Use PAYMENTREQUEST_n_SHIPPINGAMT instead. If the transaction includes one or more one-time purchases. and the optional thousands separator must be a comma (. inclusive.0. Equivalent to nine characters maximum for USD.).000 USD in any currency. CURRENCYCODE is deprecated since version 63. where n is a digit between 0 and 9. No currency symbol. when you set up a billing agreement for a recurring payment that is not immediately charged. where n is a digit between 0 and 9.). Limitations: Must not exceed $10. decimal separator must be a period (. You can specify up to 10 payments. AMT is deprecated since version 63. where n is a digit between 0 and 9.).000 USD in any currency. inclusive. If shipping cost and tax charges are known. Limitations: Must not exceed $10. this value should be the current sub-total of the order. Total shipping costs for this order. SHIPPINGAMT is deprecated since version 63.0. for example. Must have two decimal places. include them in this value. Use PAYMENTREQUEST_n_TAXAMT instead. inclusive. the Insurance drop-down on the PayPal Review page displays the string ‘Yes’ and the insurance amount. where n is a digit between 0 and 9.0. the total shipping insurance for this order must be a positive number.0.000 USD in any currency.). where n is a digit between 0 and 9.0. inclusive. decimal separator must be a period (. You can specify up to 10 payments. where n is a digit between 0 and 9. Regardless of currency. TAXAMT is deprecated since version 63. inclusive.). Total handling costs for this order.6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field PAYMENREQUEST_n_INSURA NCEOPTIONOFFERED INSURANCEOPTIONOFFERED (deprecated) Description If true. Equivalent to nine characters maximum for USD.). and the optional thousands separator must be a comma (. You can specify up to 10 payments. Use PAYMENTREQUEST_n_INSURANCEOPTIONOFFERED instead. Equivalent to nine characters maximum for USD. NOTE: PAYMENTREQUEST_n_HANDL INGAMT HANDLINGAMT (deprecated) PAYMENTREQUEST_n_TAXAM T TAXAMT (deprecated) PAYMENTREQUEST_n_DESC DESC (deprecated) The value you specify is only available if the transaction includes a purchase. You can specify up to 10 payments. decimal separator must be a period (. Description of items the customer is purchasing. You can specify up to 10 payments. HANDLINGAMT is deprecated since version 63. If true. Use PAYMENTREQUEST_n_DESC instead. Character length and limitations: Must not exceed $10. Character length and limitations: true or false INSURANCEOPTIONOFFERED is deprecated since version 63. inclusive. Character length and limitations: 127 single-byte alphanumeric characters DESC is deprecated since version 63.). this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged.000 USD in any currency. 72 September 2010 Name-Value Pair API Developer Guide . Sum of tax for all items in this order. where n is a digit between 0 and 9. Character length and limitations: Must not exceed $10. No currency symbol. and the optional thousands separator must be a comma (.0. Use PAYMENTREQUEST_n_HANDLINGAMT instead. No currency symbol. Regardless of currency. Character length and limitations: 2. Character length and limitations: 127 single-byte alphanumeric characters INVNUM is deprecated since version 63.048 single-byte alphanumeric characters NOTIFYURL is deprecated since version 63. where n is a digit between 0 and 9. where n is a digit between 0 and 9. PAYMENTREQUEST_n_INVNU M INVNUM (deprecated) Your own invoice or tracking number. where n is a digit between 0 and 9. Use PAYMENTREQUEST_n_NOTETEXT instead. You can specify up to 10 payments. Use PAYMENTREQUEST_n_NOTIFYURL instead. You can specify up to 10 payments. where n is a digit between 0 and 9. Character length and limitations: 256 single-byte alphanumeric characters CUSTOM is deprecated since version 63. inclusive.0. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails.0.0. Use PAYMENTREQUEST_n_INVNUM instead. You can specify up to 10 payments. Name-Value Pair API Developer Guide September 2010 73 . PAYMENTREQUEST_n_NOTET EXT NOTETEXT (deprecated) Note to the merchant. NOTE: The value you specify is only available if the transaction includes a purchase. Character length and limitations: 255 single-byte characters NOTETEXT is deprecated since version 63. inclusive. if one exists. I M POR T ANT : The notify URL only applies to DoExpressCheckoutPayment. the notification URL from your Merchant Profile is used.ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 Field PAYMENTREQUEST_n_CUSTO M CUSTOM (deprecated) Description A free-form field for your own use. inclusive. You can specify up to 10 payments. Use PAYMENTREQUEST_n_CUSTOM instead. NOTE: The value you specify is only available if the transaction includes a purchase.0. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. If you do not specify this value in the request. PAYMENTREQUEST_n_NOTIF YURL NOTIFYURL (deprecated) Your URL for receiving Instant Payment Notification (IPN) about this transaction. inclusive. PAYMENTREQUEST_n_PAYME NTREQUESTID PAYMENTREQUESTID (deprecated) Payment Details Item Type Fields Field L_PAYMENTREQUEST_n_NAME m Description Item name. Item description.0. Specify the value InstantPaymentOnly. You can specify up to 10 payments. inclusive. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NAME0.0. where n is a digit between 0 and 9. L_PAYMENTREQUEST_n_NAME1). You can specify up to 10 payments. inclusive. You can specify up to 10 payments. Character length and limitations: 127 single-byte characters PAYMENTREQUESTID is deprecated since version 63.0.0. where n is a digit between 0 and 9. The unique identifier of the specific payment in the case of parallel payments.6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field PAYMENTREQUEST_n_TRANS ACTIONID TRANSACTIONID (deprecated) Description Transaction identification number of the transaction that was created. Use PAYMENTREQUEST_n_TRANSACTIONID instead. inclusive. Character length and limitations: 127 single-byte characters L_NAMEn is deprecated in version 63. TRANSACTIONID is deprecated since version 63. and m specifies the list item within the payment. L_NAMEn (deprecated) L_PAYMENTREQUEST_n_DESC m L_DESCn (deprecated) 74 September 2010 Name-Value Pair API Developer Guide . PAYMENTREQUEST_n_ALLOW EDPAYMENTMETHOD ALLOWEDPAYMENTMETHOD (deprecated) The payment method type. Use PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD instead. You can specify up to 10 payments. Use PAYMENTREQUEST_n_PAYMENTREQUESTID instead. ALLOWEDPAYMENTMETHOD is deprecated since version 63. and m specifies the list item within the payment. inclusive. Use L_PAYMENTREQUEST_0_NAMEm instead. Character length and limitations: 127 single-byte characters L_DESCn is deprecated in version 63. where n is a digit between 0 and 9.0. You can specify up to 10 payments. where n is a digit between 0 and 9. This value will be the same as the one passed in the SetExpressCheckout request. Use L_PAYMENTREQUEST_0_DESCm instead. inclusive. where n is a digit between 0 and 9. NOTE: This field is only returned after a successful transaction for DoExpressCheckout has occurred. 0. Regardless of currency. where n is a digit between 0 and 9.0.). Use L_PAYMENTREQUEST_0_QTYm instead. Character length and limitations: Any positive integer L_QTYn is deprecated in version 63. where n is a digit between 0 and 9. and m specifies the list item within the payment. where n is a digit between 0 and 9. You can specify up to 10 payments. L_PAYMENTREQUEST_n_AMT1).). These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_QTY0. where n is a digit between 0 and 9. L_PAYMENTREQUEST_n_NUMB ERm L_NUMBERn (deprecated) Item number. you must specify a value for PAYMENTREQUEST_n_ITEMAMT.0. decimal separator must be a period (. inclusive. Use L_PAYMENTREQUEST_0_NUMBERm instead. L_PAYMENTREQUEST_n_TAXAMT1). and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_TAXAMT0. inclusive. Equivalent to nine characters maximum for USD. No currency symbol. Equivalent to nine characters maximum for USD. L_PAYMENTREQUEST_n_QTY m L_QTYn (deprecated) L_PAYMENTREQUEST_n_TAXA MTm L_TAXAMTn (deprecated) Name-Value Pair API Developer Guide September 2010 75 . You can specify up to 10 payments.ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 Field L_PAYMENTREQUEST_n_AMT m Description Cost of item. Use L_PAYMENTREQUEST_0_TAXAMTm instead. L_PAYMENTREQUEST_n_NUMBER1). Item sales tax. decimal separator must be a period (. No currency symbol. L_TAXAMTn is deprecated in version 63.000 USD in any currency. L_PAYMENTREQUEST_n_QTY1). and the optional thousands separator must be a comma (.). These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_AMT0. You can specify up to 10 payments. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NUMBER0.0. Regardless of currency. and m specifies the list item within the payment. inclusive. and the optional thousands separator must be a comma (. NOT E : L_AMTn (deprecated) If you specify a value for L_PAYMENTREQUEST_n_AMTm. L_AMTn is deprecated in version 63. Use L_PAYMENTREQUEST_0_AMTm instead. Character length and limitations: 127 single-byte characters L_NUMBERn is deprecated in version 63. Character length and limitations: Must not exceed $10.).000 USD in any currency. and m specifies the list item within the payment. inclusive. Item quantity. You can specify up to 10 payments. Character length and limitations: Must not exceed $10. where n is a digit between 0 and 9. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMLENGTHVALUE0. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMHEIGHTVALUE0. L_PAYMENTREQUEST_n_ITEMWEIGHTVALUE1). where n is a digit between 0 and 9. You can pass this data to the shipping carrier as is without having to make an additional database query. Character length and limitations: Any positive integer L_ITEMLENGTHVALUEn and L_ITEMLENGTHUNITn are deprecated in version 63. Item width corresponds to the width of the item. inclusive. Item height corresponds to the height of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. Use L_PAYMENTREQUEST_0_ITEMLENGTHVALUEm and L_PAYMENTREQUEST_0_ITEMLENGTHUNITm instead. inclusive. inclusive. Item length corresponds to the length of the item. L_PAYMENTREQUEST_n_ITEMHEIGHTVALUE1). L_PAYMENTREQUEST_n_ITEM HEIGHTUNITm L_ITEMHEIGHTVALUEn and L_ITEMHEIGHTUNITn (deprecated) 76 September 2010 Name-Value Pair API Developer Guide . You can specify up to 10 payments. Use L_PAYMENTREQUEST_0_ITEMWEIGTHTVALUEm and L_PAYMENTREQUEST_0_ITEMWEIGHTUNITminstead. L_PAYMENTREQUEST_n_ITEM WEIGHTUNITm L_ITEMWEIGHTVALUEn and L_ITEMWEIGHTUNITn (deprecated) Description Item weight corresponds to the weight of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. where n is a digit between 0 and 9. Character length and limitations: Any positive integer L_ITEMHEIGHTVALUEn and L_ITEMHEIGHTUNITn are deprecated in version 63. You can specify up to 10 payments. L_PAYMENTREQUEST_n_ITEMLENGTHVALUE1). Character length and limitations: Any positive integer L_ITEMWIDTHVALUEn and L_ITEMWIDTHUNITn are deprecated in version 63. You can pass this data to the shipping carrier as is without having to make an additional database query. You can specify up to 10 payments. L_PAYMENTREQUEST_n_ITEMWIDTHVALUE1). You can specify up to 10 payments.0.0. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMWEIGHTVALUE0. where n is a digit between 0 and 9. and m specifies the list item within the payment. L_PAYMENTREQUEST_n_ITEM LENGTHUNITm L_ITEMLENGTHVALUEn and L_ITEMLENGTHUNITn (deprecated) L_PAYMENTREQUEST_n_ITEM WIDTHVALUEm. and m specifies the list item within the payment. and m specifies the list item within the payment. Character length and limitations: Any positive integer L_ITEMWEIGTHTVALUEn and L_ITEMWEIGHTUNITn are deprecated in version 63. inclusive. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMWIDTHVALUE0. Use L_PAYMENTREQUEST_n_ITEMWIDTHVALUEm and L_PAYMENTREQUEST_n_ITEMWIDTHUNITm instead. L_PAYMENTREQUEST_n_ITEM WIDTHUNITm L_ITEMWIDTHVALUEn and L_ITEMWIDTHUNITn (deprecated) L_PAYMENTREQUEST_n_ITEM HEIGHTVALUEm. Use L_PAYMENTREQUEST_n_ITEMHEIGHTVALUEm and L_ITEMHEIGHTUNITm instead. and m specifies the list item within the payment.0.0.6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field L_PAYMENTREQUEST_n_ITEM WEIGHTVALUEm. L_PAYMENTREQUEST_n_ITEM LENGTHVALUEm. and m specifies the list item within the payment. where n is a digit between 0 and 9. Character length and limitations: true or false INSURANCEOPTIONSELEC TED SHIPPINGOPTIONISDEFA ULT Name-Value Pair API Developer Guide September 2010 77 . Character length: 64 single-byte characters EBAYITEMORDERIDn is deprecated since 63. Is one of the following values:  API . You can specify up to 10 payments. You can specify up to 10 payments.0. Character length: 255 single-byte characters EBAYITEMCARTIDn is deprecated since 63. and m specifies the list item within the payment. and m specifies the list item within the payment. inclusive.ExpressCheckout API Operations GetExpressCheckoutDetails API Operation 6 EbayItemPaymentDetailsItemType Fields Field L_PAYMENTREQUEST_n_EB AYITEMNUMBERm EBAYITEMNUMBERn (deprecated) Description Auction item number. You can specify up to 10 payments. Auction order identification number.Callback  API . where n is a digit between 0 and 9. inclusive. inclusive. Use L_PAYMENTREQUEST_0_EBAYITEMORDERIDm instead. You can specify up to 10 payments. Character length: 765 single-byte characters EBAYITEMNUMBERn is deprecated since 63. Auction transaction identification number.0. where n is a digit between 0 and 9. Is true if the buyer chose the default shipping option.0. Character length: 255 single-byte characters EBAYITEMAUCTIONTXNIDn is deprecated since 63. L_PAYMENTREQUEST_n_EB AYITEMAUCTIONTXNIDm EBAYITEMAUCTIONTXNIDn (deprecated) L_PAYMENTREQUEST_n_EB AYITEMORDERIDm EBAYITEMORDERIDn (deprecated) L_PAYMENTREQUEST_n_EB AYITEMCARTIDm EBAYITEMCARTIDn (deprecated) User Selected Options Type Fields Field SHIPPINGCALCULATIONM ODE Description Describes how the options that were presented to the user were determined.0. Use L_PAYMENTREQUEST_0_EBAYITEMCARTIDm instead. Use L_PAYMENTREQUEST_0_EBAYAUCTIONTXNIDm instead. The unique identifier provided by eBay for this order from the buyer. inclusive. and m specifies the list item within the payment.Flatrate The Yes/No option that was chosen by the buyer for insurance. Use L_PAYMENTREQUEST_0_EBAYAUCTIONTXNIDm instead. where n is a digit between 0 and 9. inclusive.). inclusive.000 USD in any currency. You can specify up to 10 payments. You can specify up to 10 payments. where n is a digit between 0 and 9. inclusive. available since version 64.0. Character length and limitations: 127 single-byte alphanumeric characters Payment Request Info Type Fields Field Description PAYMENTREQUEST_n_TRAN Transaction ID for a bucket of 1 to 10 parallel payment requests. You can specify up to 10 payments. 78 September 2010 Name-Value Pair API Developer Guide . where n is a digit between 0 and 9. PAYMENTREQUEST_n_PAYM Payment request ID for a parallel payment in the bucket of 1 to 10 parallel payment ENTREQUESTID requests. where n is a digit between 0 and 9. where n is a digit between 0 and 9. No currency symbol.). The name of the shipping option such as air or ground. inclusive. inclusive. You can specify up to 10 payments. where n is a digit between 0 and 9.0. You can specify up to 10 payments. and the optional thousands separator must be a comma (.6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field SHIPPINGOPTIONAMOUNT Description The shipping amount that was chosen by the buyer Limitations: Must not exceed $10. inclusive. xs:string Payment error code. For parallel payments. decimal separator must be a period (. available since SACTIONID version 64. this field contains either the Payer Id or the email address of the merchant. Payment Error Type Fields Field PAYMENTREQUEST_n_SH ORTMESSAGE PAYMENTREQUEST_n_LO NGMESSAGE PAYMENTREQUEST_n_ER RORCODE Description xs:string Payment error short message. where n is a digit between 0 and 9. xs:string Payment error long message. SHIPPINGOPTIONNAME Seller Details Type Fields Field PAYMENTREQUEST_n_SELLER PAYPALACCOUNTID Description Unique identifier for the merchant. You can specify up to 10 payments. Must have two decimal places.  Sale indicates that this is a final sale for which you are requesting payment. the billing agreement is created when you call the DoExpressCheckoutPayment API operation. (Required) How you want to obtain payment:  Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization & Capture. (Required) The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request. xs:string Application-specific error values indicating more about the error condition. You can specify up to 10 payments. Character length and limit: Up to 13 single-byte alphabetic characters Name-Value Pair API Developer Guide September 2010 79 . Use PAYMENTREQUEST_n_PAYMENTACTION instead. where n is a digit between 0 and 9.   “DoExpressCheckoutPayment Request Message” on page 79 “DoExpressCheckoutPayment Response Message” on page 92 DoExpressCheckoutPayment Request Message DoExpressCheckoutPayment Request Fields Field METHOD TOKEN Description (Required) Must be DoExpressCheckoutPayment. You can specify up to 10 payments. NOTE: PAYMENTACTION (deprecated) You cannot set this value to Sale on SetExpressCheckout request and then change this value to Authorization on the final PayPal Express Checkout API DoExpressCheckoutPayment request. If you set up a billing agreement in your SetExpressCheckout API call. DoExpressCheckoutPayment API Operation Completes an Express Checkout transaction. Character length and limitations: 20 single-byte characters This field is deprecated. inclusive. inclusive. where n is a digit between 0 and 9.ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field PAYMENTREQUEST_n_SE VERITYCODE PAYMENTREQUEST_n_AC K Description xs:string Payment error severity code.  Order indicates that this payment is is an order authorization subject to settlement with PayPal Authorization & Capture. and the optional thousands separator must be a comma (. Must have two decimal places. (Optional) The buyer email address opted in by the buyer on the PayPal Review page. decimal separator must be a period (. No currency symbol.). 80 September 2010 Name-Value Pair API Developer Guide . Otherwise pass false.Character length and limitations: 13 single-byte alphanumeric characters. Limitations: 15 single-byte characters (Optional) An identification code for use by third-party applications to identify transactions.  0 .do not receive FMF details (default)  1 . Character length and limitations: 32 single-byte alphanumeric characters RETURNFMFDETAILS GIFTMESSAGE GIFTRECEIPTENABLE GIFTWRAPNAME GIFTWRAPAMOUNT BUYERMARKETINGEMAIL SURVEYQUESTION SURVEYCHOICESELECTE D BUTTONSOURCE Payment Details Type Fields When implementing parallel payments. (Optional) Flag to indicate whether you want the results returned by Fraud Management Filters. Limitations: 25 single-byte characters (Optional) The amount only if the gift option on the PayPal Review page was selected by the buyer. Limitations: Must not exceed $10.). you can create up to 10 sets of payment details type parameter fields. (Optional) The gift wrap name only if the gift option on the PayPal Review page was selected by the buyer. Limitations: 50 single-byte characters (Optional) The survey response selected by the buyer on the PayPal Review page. each representing one payment you are hosting on your marketplace. Limitations: 127 single-byte characters (Optional) The survey question on the PayPal Review page.receive FMF details (Optional) The gift message entered by the buyer on the PayPal Review page.000 USD in any currency. Limitations: 150 single-byte characters (Optional) Pass true if a gift receipt was selected by the buyer on the PayPal Review page. you do not receive this information. By default.6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field PAYERID Description (Required) Unique PayPal customer account identification number as returned by GetExpressCheckoutDetails response. inclusive. Must have two decimal places. Regardless of currency.).0. CURRENCYCODE is deprecated since version 63. You can specify up to 10 payments. include them in this value.). N O TE : If you specify a value for PAYMENTREQUEST_n_SHIPPINGAMT. where n is a digit between 0 and 9. Default: USD. when you set up a billing agreement for a recurring payment that is not immediately charged. No currency symbol. No currency symbol.). where n is a digit between 0 and 9. if not. You can specify up to 10 payments. where n is a digit between 0 and 9. Must have two decimal places. If shipping cost and tax charges are known.000 USD in any currency. You can specify up to 10 payments.0. inclusive. Limitations: Must not exceed $10. Name-Value Pair API Developer Guide September 2010 81 . and the optional thousands separator must be a comma (.0.). (Optional) A three-character currency code. If the transaction includes one or more one-time purchases. Limitations: Must not exceed $10.0. and the optional thousands separator must be a comma (. where n is a digit between 0 and 9. Equivalent to nine characters maximum for USD. PAYMENTREQUEST_n_SHIPPIN GAMT SHIPPINGAMT (deprecated) (Optional) Total shipping costs for this order.ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field PAYMENTREQUEST_n_AMT AMT (deprecated) Description (Required) The total cost of the transaction to the customer. inclusive. this value should be the current sub-total of the order. and the optional thousands separator must be a comma (. decimal separator must be a period (. for example. Use PAYMENTREQUEST_0_CURRENCYCODE instead. Use PAYMENTREQUEST_0_ITEMAMT instead.). decimal separator must be a period (. Character length and limitations: Must not exceed $10. this field must be equal to the sum of the purchases. AMT is deprecated since version 63. Set this field to 0 if the transaction does not include a one-time purchase. No currency symbol. you must also specify a value for PAYMENTREQUEST_n_ITEMAMT. inclusive. Use PAYMENTREQUEST_0_AMT instead. Purchase-specific fields will be ignored. N O TE : PAYMENTREQUEST_n_CURRENC YCODE CURRENCYCODE (deprecated) PAYMENTREQUEST_n_ITEMAMT ITEMAMT (deprecated) PAYMENTREQUEST_n_ITEMAMT is required if you specify L_PAYMENTREQUEST_n_AMTm. ITEMAMT is deprecated since version 63. You can specify up to 10 payments. Use PAYMENTREQUEST_0_SHIPPINGAMT instead.000 USD in any currency. (Optional) Sum of cost of all items in this order.). decimal separator must be a period (. SHIPPINGAMT is deprecated since version 63.000 USD in any currency. decimal separator must be a period (. Regardless of currency.). inclusive. Use PAYMENTREQUEST_0_SHIPPINGDISCAMT instead. You can specify up to 10 payments. Equivalent to nine characters maximum for USD. You can specify up to 10 payments.). Equivalent to nine characters maximum for USD.). and the optional thousands separator must be a comma (. and the optional thousands separator must be a comma (.000 USD in any currency. decimal separator must be a period (. where n is a digit between 0 and 9. Regardless of currency. Use PAYMENTREQUEST_0_INSURANCEAMTOFFERED instead. (Optional) Shipping discount for this order.000 USD in any currency. Character length and limitations: true or false INSURANCEOPTIONOFFERED is deprecated since version 63. You can specify up to 10 payments. Character length and limitations: Must not exceed $10. N O TE : PAYMENTREQUEST_n_SHIPDIS CAMT SHIPPINGDISCAMT (deprecated) PAYMENTREQUEST_n_INSURAN CEOPTIONOFFERED INSURANCEOPTIONOFFERED (deprecated) PAYMENTRREQUEST_n_HANDLI NGAMT HANDLINGAMT (deprecated) If you specify a value for PAYMENTREQUEST_n_HANDLINGAMT. HANDLINGAMT is deprecated since version 63. the total shipping insurance for this order must be a positive number. The value must be a non-negative currency amount or null if insurance options are offered. (Optional) Total handling costs for this order.0. decimal separator must be a period (. No currency symbol.0. you must also specify a value for PAYMENTREQUEST_n_ITEMAMT. Character length and limitations: Must not exceed $10. inclusive.000 USD in any currency. the Insurance drop-down on the PayPal Review page displays the string ‘Yes’ and the insurance amount. inclusive.). specified as a negative number.0. (Optional) If true.6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field PAYMENTREQUEST_n_INSURAN CEAMT INSURANCEAMT (deprecated) Description (Optional) Total shipping insurance costs for this order. 82 September 2010 Name-Value Pair API Developer Guide . If true. Use PAYMENTREQUEST_0_HANDLINGAMT instead. where n is a digit between 0 and 9. SHIPPINGDISCAMT is deprecated since version 63. Character length and limitations: Must not exceed $10. You can specify up to 10 payments. INSURANCEAMT is deprecated since version 63. where n is a digit between 0 and 9.0.). and the optional thousands separator must be a comma (. where n is a digit between 0 and 9. Regardless of currency. Equivalent to nine characters maximum for USD.). No currency symbol. No currency symbol. Use PAYMENTREQUEST_0_INSURANCEAMT instead. inclusive. and the optional thousands separator must be a comma (.ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field PAYMENTREQUEST_n_TAXAMT TAXAMT (deprecated) Description (Optional) Sum of tax for all items in this order.0. N O TE : PAYMENTREQUEST_n_TAXAMT is required if you specify L_PAYMENTREQUEST_n_TAXAMTm You can specify up to 10 payments. Character length and limitations: Must not exceed $10. where n is a digit between 0 and 9. Regardless of currency. N O TE : The value you specify is only available if the transaction includes a purchase. TAXAMT is deprecated since version 63. inclusive. inclusive. where n is a digit between 0 and 9. Use PAYMENTREQUEST_0_CUSTOM instead. N O TE : The value you specify is only available if the transaction includes a purchase. decimal separator must be a period (. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. Character length and limitations: 127 single-byte alphanumeric characters INVNUM is deprecated since version 63.0. No currency symbol. Use PAYMENTREQUEST_0_DESC instead. N O TE : The value you specify is only available if the transaction includes a purchase.000 USD in any currency. PAYMENTREQUEST_n_CUSTOM CUSTOM (deprecated) (Optional) A free-form field for your own use. Equivalent to nine characters maximum for USD. inclusive. You can specify up to 10 payments. where n is a digit between 0 and 9.). Character length and limitations: 256 single-byte alphanumeric characters CUSTOM is deprecated since version 63. You can specify up to 10 payments.0. where n is a digit between 0 and 9. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. Use PAYMENTREQUEST_0_TAXAMT instead. inclusive.0. Name-Value Pair API Developer Guide September 2010 83 . You can specify up to 10 payments. PAYMENTREQUEST_n_INVNUM INVNUM (deprecated) (Optional) Your own invoice or tracking number.). Character length and limitations: 127 single-byte alphanumeric characters DESC is deprecated since version 63. Use PAYMENTREQUEST_0_INVNUM instead. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. PAYMENTREQUEST_n_DESC DESC (deprecated) (Optional) Description of items the customer is purchasing. You can specify up to 10 payments. If you do not specify this value in the request. Use PAYMENTREQUEST_0_NOTIFYURL instead. PAYMENTREQUEST_n_NOTETEX T NOTETEXT (deprecated) (Optional) Note to the merchant. PAYMENTREQUEST_n_ALLOWED PAYMENTMETHOD ALLOWEDPAYMENTMETHOD (deprecated) (Optional) The payment method type. PAYMENTREQUEST_n_TRANSAC TIONID TRANSACTIONID (deprecated) (Optional) Transaction identification number of the transaction that was created. Use PAYMENTREQUEST_0_NOTETEXT instead.0. inclusive. inclusive. where n is a digit between 0 and 9. inclusive. the notification URL from your Merchant Profile is used. A per transaction description of the payment that is passed to the buyer’s credit card statement. You can specify up to 10 payments. 84 September 2010 Name-Value Pair API Developer Guide . ALLOWEDPAYMENTMETHOD is deprecated since version 63.0.0. inclusive. Use PAYMENTREQUEST_0_SOFTDESCRIPTOR instead. where n is a digit between 0 and 9.0. Use PAYMENTREQUEST_0_ALLOWEDPAYMENTMETHOD instead. You can specify up to 10 payments. Specify the value InstantPaymentOnly. Character length and limitations: 255 single-byte characters NOTETEXT is deprecated since version 63. where n is a digit between 0 and 9.0. if one exists. Use PAYMENTREQUEST_0_TRANSACTIONID instead. SOFTDESCRIPTOR is deprecated since version 63. where n is a digit between 0 and 9. I MP O R TAN T : The notify URL only applies to DoExpressCheckoutPayment. inclusive. where n is a digit between 0 and 9. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails. You can specify up to 10 payments. Character length and limitations: 2. N O TE : This field is only returned after a successful transaction for DoExpressCheckout has occurred. TRANSACTIONID is deprecated since version 63. You can specify up to 10 payments.048 single-byte alphanumeric characters NOTIFYURL is deprecated since version 63.6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field PAYMENTREQUEST_n_NOTIFYU RL NOTIFYURL (deprecated) Description (Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. N O TE : PAYMENTREQUEST_n_SOFTDES CRIPTOR SOFTDESCRIPTOR (deprecated) Ignore when PAYMENTREQUEST_n_PAYMENTACTION=Order. Use PAYMENTREQUEST_0_SHIPTONAME instead. Character length and limitations: 32 single-byte characters. When implementing parallel payments. this field is ignored. Name-Value Pair API Developer Guide September 2010 85 .0. You can specify up to 10 payments. SHIPTONAME (deprecated) inclusive. where n is a digit between 0 and 9. where n is a digit between 0 and 9. Required when implementing parallel payments. where n is a digit between 0 and 9. Character length and limit: Up to 13 single-byte alphabetic characters PAYMENTACTION is deprecated since version 63. Use PAYMENTREQUEST_0_PAYMENTREQUESTID instead. PAYMENTREQUEST_n_PAYMENT REQUESTID PAYMENTREQUESTID (deprecated) A unique identifier of the specific payment request. N O TE : You cannot set this value to Sale in SetExpressCheckout request and then change this value to Authorization or Order on the final API DoExpressCheckoutPayment request. which is required for parallel payments. Address Fields Field Description PAYMENTREQUEST_n_SHIPTONAM Person’s name associated with this shipping address. If the value is set to Authorization or Order in SetExpressCheckout. SHIPTONAME is deprecated since version 63. Required if using a E shipping address. inclusive. you must set this field to Order. (Default)  Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization & Capture. inclusive. You can specify up to 10 payments.0. Use PAYMENTREQUEST_0_PAYMENTACTION instead.ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field PAYMENTRREQUEST_n_PAYMEN TACTION PAYMENTACTION (deprecated) Description How you want to obtain payment. Character length and limit: Up to 127 single-byte characters PAYMENTREQUESTID is deprecated since version 63. Default value: Sale You can specify up to 10 payments. the value may be set to Sale or the same value (either Authorization or Order) in DoExpressCheckoutPayment. If the transaction does not include a one-time purchase.0.  Order indicates that this payment is an order authorization subject to settlement with PayPal Authorization & Capture.  Sale indicates that this is a final sale for which you are requesting payment. 0. may be required for other countries. Character limit: 2 single-byte characters. where n is a digit between 0 and 9. Use PAYMENTREQUEST_0_SHIPTOSTATE instead. where n is a digit between 0 and 9. Y You can specify up to 10 payments. NTRYCODE You can specify up to 10 payments.0. Required if using a U. PAYMENTREQUEST_n_SHIPTOSTR (Optional) Second street address. Required if using a shipping address. Character length and limitations: 40 single-byte characters. SHIPTOCOUNTRY is deprecated since version 63.0.0. Required if using a shipping address. SHIPTOZIP (deprecated) You can specify up to 10 payments. Required if using a shipping address. ZIP code or other country-specific postal code. SHIPTOCITY (deprecated) inclusive. Required if using a shipping address. where n is a digit between 0 and 9.0. inclusive. PAYMENTREQUEST_n_SHIPTOZIP U. Use PAYMENTREQUEST_0_SHIPTOSTREET instead. SHIPTOSTATE (deprecated) inclusive. EET You can specify up to 10 payments. SHIPTOSTREET2 is deprecated since version 63. SHIPTOCOUNTRY (deprecated) inclusive. 86 September 2010 Name-Value Pair API Developer Guide . SHIPTOCITY is deprecated since version 63. PAYMENTREQUEST_n_SHIPTOCIT Name of city.S. Use PAYMENTREQUEST_0_SHIPTOCOUNTRYCODE instead. PAYMENTREQUEST_n_SHIPTOCOU Country code. Character length and limitations: 100 single-byte characters. SHIPTOSTATE is deprecated since version 63. Character length and limitations: 20 single-byte characters.S. where n is a digit between 0 and 9. Use PAYMENTREQUEST_0_SHIPTOZIP instead. PAYMENTREQUEST_n_SHIPTOSTA State or province. Use PAYMENTREQUEST_0_SHIPTOCITY instead. Character length and limitations: 100 single-byte characters. SHIPTOSTREET2 (deprecated) inclusive. shipping address. EET2 You can specify up to 10 payments. Character length and limitations: 40 single-byte characters. SHIPTOZIP is deprecated since version 63. SHIPTOSTREET is deprecated since version 63. Use PAYMENTREQUEST_0_SHIPTOSTREET2 instead. where n is a digit between 0 and 9. where n is a digit between 0 and 9.0. TE You can specify up to 10 payments.6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST_n_SHIPTOSTR First street address. SHIPTOSTREET (deprecated) inclusive. where n is a digit between 0 and 9. where n is a digit between 0 and 9.). Use L_PAYMENTREQUEST_0_DESCm instead. where n is a digit between 0 and 9. Character length and limitations: Must not exceed $10. Character length and limitations: 127 single-byte characters L_DESCn is deprecated since version 63. You can specify up to 10 payments. decimal separator must be a period (. L_PAYMENTREQUEST_n_NAME1). NOT E : L_PAYMENTREQUEST_n_DE SCm L_DESCn (deprecated) L_PAYMENTREQUEST_n_AM Tm L_AMTn (deprecated) If you specify a value for L_PAYMENTREQUEST_n_AMTm. Introduced in Version 53. You can specify up to 10 payments. (Optional) Item description. Introduced in Version 53. and m specifies the list item within the payment. and the optional thousands separator must be a comma (.000 USD in any currency. you must specify a value for PAYMENTREQUEST_n_ITEMAMT.ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field Description PAYMENTREQUEST_n_SHIPTOPHO (Optional) Phone number. where n is a digit between 0 and 9. SHIPTOPHONENUM (deprecated) inclusive.0. NENUM You can specify up to 10 payments. Use L_PAYMENTREQUEST_0_NAMEm instead.0. Character length and limitations: 127 single-byte characters L_NAMEn is deprecated since version 63. Character length and limit: 20 single-byte characters. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_AMT0. SHIPTOPHONENUM is deprecated since version 63.0. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_DESC0. Name-Value Pair API Developer Guide September 2010 87 . Use L_PAYMENTREQUEST_0_AMTm instead. inclusive.0. Introduced in Version 53. Payment Details Item Type Fields Field L_PAYMENTREQUEST_n_NA MEm L_NAMEn (deprecated) Description (Optional) Item name. No currency symbol. Use PAYMENTREQUEST_0_SHIPTOPHONENUM instead. Regardless of currency. inclusive. L_PAYMENTREQUEST_n_DESC1). These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NAME0. L_PAYMENTREQUEST_n_AMT1).0. L_AMTn is deprecated since version 63. and m specifies the list item within the payment. You can specify up to 10 payments. (Optional) Cost of item. and m specifies the list item within the payment.0.). inclusive. Equivalent to nine characters maximum for USD.0. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_QTY0.). L_PAYMENTREQUEST_n_IT EMWEIGHTVALUEm. L_NUMBERn is deprecated since version 63. decimal separator must be a period (. inclusive. where n is a digit between 0 and 9.0. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NUMBER0. You can pass this data to the shipping carrier as is without having to make an additional database query.). Equivalent to nine characters maximum for USD. Regardless of currency. L_PAYMENTREQUEST_n_NUMBER1). You can specify up to 10 payments. L_PAYMENTREQUEST_n_ITEMWEIGHTVALUE1). You can specify up to 10 payments.0. and m specifies the list item within the payment. and m specifies the list item within the payment. inclusive. NOT E : L_PAYMENTREQUEST_n_QT Ym L_QTYn (deprecated) L_PAYMENTREQUEST_n_TA XAMTm L_TAXAMTn (deprecated) Character length and limitations: Must not exceed $10. You can specify up to 10 payments. (Optional) Item quantity.6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field L_PAYMENTREQUEST_n_NU MBERm L_NUMBERn (deprecated) Description (Optional) Item number.0. L_ITEMWEIGHTTVALUEn and L_ITEMWEIGHTUNITn are deprecated since version 63.0. L_PAYMENTREQUEST_n_IT EMWEIGHTUNITm L_ITEMWEIGHTVALUEn and L_ITEMWEIGHTUNITn (deprecated) (Optional) Item weight corresponds to the weight of the item. and the optional thousands separator must be a comma (. You can specify up to 10 payments. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_TAXAMT0. L_TAXAMTn is deprecated since version 63. Character length and limitations: Any positive integer L_QTYn is deprecated since version 63. Use L_PAYMENTREQUEST_0_NUMBERm instead. No currency symbol. Use L_PAYMENTREQUEST_0_QTYm instead. Use L_PAYMENTREQUEST_0_ITEMWEIGHTVALUEm and L_PAYMENTREQUEST_0_ITEMWEIGHTUNITm instead. Introduced in Version 53. where n is a digit between 0 and 9. 88 September 2010 Name-Value Pair API Developer Guide . and m specifies the list item within the payment. Use L_PAYMENTREQUEST_0_TAXAMTm instead.0. L_PAYMENTREQUEST_n_TAXAMT1). and m specifies the list item within the payment.000 USD in any currency. where n is a digit between 0 and 9. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMWEIGHTVALUE0. inclusive. inclusive. Introduced in Version 53. (Optional) Item sales tax. L_PAYMENTREQUEST_n_QTY1). where n is a digit between 0 and 9.0. 0. where n is a digit between 0 and 9. You can specify up to 10 payments. Use L_PAYMENTREQUEST_0_ITEMWIDTHVALUEm and L_PAYMENTREQUEST_0_ITEMWIDTHUNITn instead. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMURL0. Use L_PAYMENTREQUEST_0_ITEMURLm instead. and m specifies the list item within the payment. Character length and limitations: Any positive integer L_ITEMHEIGHTVALUEn and L_ITEMHEIGHTUNITm are deprecated since version 63. and m specifies the list item within the payment.0. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMHEIGHTVALUE0. (Optional) URL for the item. L_PAYMENTREQUEST_n_IT EMWIDTHUNITm L_ITEMWIDTHVALUEn and L_ITEMWIDTHUNITn (deprecated) L_PAYMENTREQUEST_n_IT EMHEIGHTVALUEm. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMLENGTHVALUE0. Use L_PAYMENTREQUEST_0_ITEMLENGTHVALUEm and L_PAYMENTREQUEST_0_ITEMLENGTHUNITn instead. (Optional) Item width corresponds to the width of the item. You can specify up to 10 payments. Character length and limitations: Any positive integer L_ITEMLENGTHVALUEn and L_ITEMLENGTHUNITm are deprecated since version 63. L_PAYMENTREQUEST_n_IT EMWIDTHVALUEm. L_PAYMENTREQUEST_n_IT EMLENGTHUNITm L_ITEMLENGTHVALUEn and L_ITEMLENGHTUNITn (deprecated) Description (Optional) Item length corresponds to the length of the item. L_PAYMENTREQUEST_n_ITEMWIDTHVALUE1). L_PAYMENTREQUEST_n_ITEMURL1). L_PAYMENTREQUEST_n_ITEMLENGTHVALUE1). L_PAYMENTREQUEST_n_ITEMHEIGHTVALUE1). These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMWIDTHVALUE0. Use L_PAYMENTREQUEST_0_ITEMHEIGHTVALUEm and L_PAYMENTREQUEST_0_ITEMHEIGHTUNITn instead. where n is a digit between 0 and 9. Character length and limitations: Any positive integer L_ITEMWIDTHVALUEn and L_ITEMWIDTHUNITm are deprecated since version 63. L_PAYMENTREQUEST_n_IT EMHEIGHTUNITm L_ITEMHEIGHTVALUEn and L_ITEMHEIGHTUNITn (deprecated) L_PAYMENTREQUEST_n_IT EMURLm L_ITEMURLn (deprecated) Name-Value Pair API Developer Guide September 2010 89 .0. You can specify up to 10 payments. where n is a digit between 0 and 9.ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field L_PAYMENTREQUEST_n_IT EMLENGTHVALUEm. You can specify up to 10 payments. You can pass this data to the shipping carrier as is without having to make an additional database query. You can pass this data to the shipping carrier as is without having to make an additional database query.0. inclusive. inclusive. and m specifies the list item within the payment. inclusive. where n is a digit between 0 and 9. You can pass this data to the shipping carrier as is without having to make an additional database query. (Optional) Item height corresponds to the height of the item. inclusive. and m specifies the list item within the payment. L_ITEMURLn is deprecated since version 63. inclusive. where n is a digit between 0 and 9.0. (Optional) Auction transaction identification number.0. L_PAYMENTREQUEST_n_EBAYITEMCARTID1). and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNID0. inclusive. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMORDERID0. L_PAYMENTREQUEST_n_EBAYITEMNUMBER1). You can specify up to 10 payments.0. and m specifies the list item within the payment. Use L_PAYMENTREQUEST_0_EBAYITEMNUMBERm instead. Character length: 765 single-byte characters L_EBAYITEMNUMBERn is deprecated since version 63. Character length: 64 single-byte characters L_EBAYITEMORDERIDn is deprecated since version 63. where n is a digit between 0 and 9. You can specify up to 10 payments. (Optional) The unique identifier provided by eBay for this order from the buyer. You can specify up to 10 payments. where n is a digit between 0 and 9. L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNID1). L_PAYMENTREQUEST_n_EBAYITEMORDERID1). and m specifies the list item within the payment. Use L_PAYMENTREQUEST_0_EBAYAUCTIONTXNIDm instead. Character length: 255 single-byte characters L_EBAYAUCTIONTXNIDn is deprecated since version 63. Character length: 255 single-byte characters L_EBAYITEMCARTIDn is deprecated since version 63.0. You can specify up to 10 payments. and m specifies the list item within the payment.6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation EbayItemPaymentDetailsItemType Fields Field L_PAYMENTREQUEST_n_EB AYITEMNUMBERm L_EBAYITEMNUMBERn (deprecated) Description (Optional) Auction item number. L_PAYMENTREQUESST_n_E BAYITEMAUCTIONTXNIDm L_EBAYITEMAUCTIONTXNI Dn (deprecated) L_PAYMENTREQUEST_n_EB AYITEMORDERIDm L_EBAYITEMORDERIDn (deprecated) L_PAYMENTREQUEST_n_EB AYCARTIDm L_EBAYITEMCARTIDn (deprecated) 90 September 2010 Name-Value Pair API Developer Guide . Use L_PAYMENTREQUEST_0_EBAYITEMCARTIDm instead. where n is a digit between 0 and 9. (Optional) Auction order identification number. Use L_PAYMENTREQUEST_0_EBAYITEMORDERIDm instead. inclusive. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMCARTID0. inclusive. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMNUMBER0. 0. decimal separator must be a period (. (Optional)The name of the shipping option such as air or ground. and the optional thousands separator must be a comma (. No currency symbol. inclusive. inclusive. Use PAYMENTREQUEST_0_SELLERUSERNAME instead. Use PAYMENTREQUEST_0_SELLERREGISTRATIONDATE instead. This ID is not displayed.).0. where n is a digit between 0 and 9.000 USD in any currency. (Optional) Date when the seller registered with the marketplace.0. Character length and limitations: true or false (Optional) The shipping amount that was chosen by the buyer Limitations: Must not exceed $10. SELLERUSERNAME is deprecated since version 63.ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 UserSelectedOptions Fields Field INSURANCEOPTIONSELEC TED SHIPPINGOPTIONISDEFA ULT SHIPPINGOPTIONAMOUNT Description (Optional) The Yes/No option that was chosen by the buyer chose for insurance. Must have two decimal places. where n is a digit between 0 and 9. Use PAYMENTREQUEST_0_SELLERID instead. (Optional) Is true if the buyer chose the default shipping option. where n is a digit between 0 and 9.). xs:string (Optional) The current name of the seller or business at the marketplace site. SELLERREGISTRATIONDATE is deprecated since version 63. Character length and limitations: 13 single-byte alphanumeric characters SELLERID is deprecated since version 63. You can specify up to 10 payments. PAYMENTREQUEST_n_SELL ERUSERNAME SELLERUSERNAME (deprecated) PAYMENTREQUEST_n_SELL ERREGISTRATIONDATE SELLERREGISTRATIONDAT E (deprecated) Name-Value Pair API Developer Guide September 2010 91 . This name may be shown to the buyer. SHIPPINGOPTIONNAME Seller Details Type Fields Field PAYMENTREQUEST_n_SELL ERID SELLERID (deprecated) Description (Optional) The unique non-changing identifier for the seller at the marketplace site. inclusive. You can specify up to 10 payments. You can specify up to 10 payments. Character length and limitations: 20 single-byte characters Information about the payment. N O TE : PAYMENTTYPE NOTE REDIRECTREQUIRED Use this field only if you are using giropay or bank transfer payment methods in Germany. Filter ID. 92 September 2010 Name-Value Pair API Developer Guide . SUCCESSPAGEREDIRECT REQUESTED L_FMFfilterIDn (deprecated) Flag to indicate whether you need to redirect the customer to back to PayPal after completing the transaction. The text entered by the buyer on the PayPal website if the ALLOWNOTE field was set to 1 in SetExpressCheckout. This field is available since version 53.6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation DoExpressCheckoutPayment Response Message DoExpressCheckoutPayment Response Fields Field TOKEN Description The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request. Character length and limitations: 255 single-byte characters Flag to indicate whether you need to redirect the customer to back to PayPal for guest checkout after successfully completing the transaction. REPORT. the filter ID.0. or DENY). Filter ID is one of the following values:  1 = AVS No Match  2 = AVS Partial Match  3 = AVS Unavailable/Unsupported  4 = Card Security Code (CSC) Mismatch  5 = Maximum Transaction Amount  6 = Unconfirmed Address  7 = Country Monitor  8 = Large Order Number  9 = Billing/Shipping Address Mismatch  10 = Risky ZIP Code  11 = Suspected Freight Forwarder Check  12 = Total Purchase Price Minimum  13 = IP Address Velocity  14 = Risky Email Address Domain Check  15 = Risky Bank Identification Number (BIN) Check  16 = Risky IP Address Range  17 = PayPal Fraud Model This field is deprecated since version 63. and the entry number. starting from 0. n. including the filter type.0. (PENDING. Use L_PAYMENTINFO_0_FMFfilterIDn instead. ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field L_FMFfilterNAMEn (deprecated) Description Filter name, including the filter type, (PENDING, REPORT, or DENY), the filter NAME, and the entry number, n, starting from 0. This field is deprecated since version 63.0. Use L_PAYMENTINFO_0_FMFfilterNAMEn instead. Payment Information Fields When implementing parallel payments, up to 10 payment info type sets of payment info type parameter fields can be returned, each representing one payment you are hosting on your marketplace. Field PAYMENTINFO_n_TRANS ACTIONID TRANSACTIONID (deprecated) Description Unique transaction ID of the payment. NOTE: If the PaymentAction of the request was Authorization or Order, this value is your AuthorizationID for use with the Authorization & Capture APIs. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations:19 single-byte characters TRANSACTIONID is deprecated since version 63.0. Use PAYMENTINFO_n_TRANSACTIONID instead. PAYMENTINFO_n_TRANS ACTIONTYPE TRANSACTIONTYPE (deprecated) The type of transaction Character length and limitations:15 single-byte characters Valid values:  cart  express-checkout You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. TRANSACTIONTYPE is deprecated since version 63.0. Use PAYMENTINFO_0_TRANSACTIONTYPE instead. PAYMENTINFO_n_PAYME NTTYPE PAYMENTTYPE (deprecated) Indicates whether the payment is instant or delayed. Character length and limitations: Seven single-byte characters Valid values:  none  echeck  instant You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. PAYMENTTYPE is deprecated since version 63.0. Use PAYMENTINFO_0_PAYMENTTYPE instead. PAYMENTINFO_n_ORDER TIME ORDERTIME (deprecated) Time/date stamp of payment ORDERTIME is deprecated since version 63.0. Use PAYMENTINFO_0_ORDERTIME instead. Name-Value Pair API Developer Guide September 2010 93 6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field PAYMENTINFO_n_AMT AMT (deprecated) Description The final amount charged, including any shipping and taxes from your Merchant Profile. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD. AMT is deprecated since version 63.0. Use PAYMENTINFO_0_AMT instead. A three-character currency code. Default: USD. CURRENCYCODE is deprecated since version 63.0. Use PAYMENTINFO_0_CURRENCYCODE instead. PayPal fee amount charged for the transactionCharacter length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. FEEAMT is deprecated since version 63.0. Use PAYMENTINFO_0_FEEAMT instead. Amount deposited in your PayPal account after a currency conversion. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. SETTLEAMT is deprecated since version 63.0. Use PAYMENTINFO_0_SETTLEAMT instead. Tax charged on the transaction. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD. TAXAMT is deprecated since version 63.0. Use PAYMENTINFO_0_TAXAMT instead. Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency. If the customer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the customer’s account.Character length and limitations: a decimal that does not exceed 17 characters, including decimal point You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. EXCHANGERATE is deprecated since version 63.0. Use PAYMENTINFO_0_EXCHANGERATE instead. PAYMENTINFO_n_CURRE NCYCODE CURRENCYCODE (deprecated) PAYMENTINFO_n_FEEAM T FEEAMT (deprecated) PAYMENTINFO_n_SETTL EAMT SETTLEAMT (deprecated) PAYMENTINFO_n_TAXAM T TAXAMT (deprecated) PAYMENTINFO_n_EXCHA NGERATE EXCHANGERATE (deprecated) 94 September 2010 Name-Value Pair API Developer Guide ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field PAYMENTINFO_n_PAYME NTSTATUS PAYMENTSTATUS (deprecated) Description Status of the payment. The status of the payment:  None: No status  Canceled-Reversal: A reversal has been canceled; for example, when you win a dispute and the funds for the reversal have been returned to you.  Completed: The payment has been completed, and the funds have been added successfully to your account balance.  Denied: You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element.  Expired: the authorization period for this payment has been reached.  Failed: The payment has failed. This happens only if the payment was made from your customer’s bank account.  In-Progress: The transaction has not terminated, e.g. an authorization may be awaiting completion.  Partially-Refunded: The payment has been partially refunded.  Pending: The payment is pending. See the PendingReason field for more information.  Refunded: You refunded the payment.  Reversed: A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer. The reason for the reversal is specified in the ReasonCode element.  Processed: A payment has been accepted.  Voided: An authorization for this transaction has been voided. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. PAYMENTSTATUS is deprecated since version 63.0. Use PAYMENTINFO_0_PAYMENTSTATUS instead. Name-Value Pair API Developer Guide September 2010 95 6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field PAYMENTINFO_n_PENDI NGREASON PENDINGREASON (deprecated) Description NOTE: PendingReason is returned in the response only if PaymentStatus is Pending. The reason the payment is pending:  none: No pending reason.  address: The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.  authorization: The payment is pending because it has been authorized but not settled. You must capture the funds first.  echeck: The payment is pending because it was made by an eCheck that has not yet cleared.  intl: The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview.  multi-currency: You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment.  order: The payment is pending because it is part of an order that has been authorized but not settled.  paymentreview: The payment is pending while it is being reviewed by PayPal for risk.  unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed.  verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.  other: The payment is pending for a reason other than those listed above. For more information, contact PayPal customer service. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. PENDINGREASON is deprecated since version 63.0. Use PAYMENTINFO_0_PENDINGREASON instead. 96 September 2010 Name-Value Pair API Developer Guide ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field PAYMENTINFO_n_REASO NCODE REASONCODE (deprecated) Description The reason for a reversal if TransactionType is reversal:  none: No reason code  chargeback: A reversal has occurred on this transaction due to a chargeback by your customer.  guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee.  buyer-complaint: A reversal has occurred on this transaction due to a complaint about the transaction from your customer.  refund: A reversal has occurred on this transaction because you have given the customer a refund.  other: A reversal has occurred on this transaction due to a reason not listed above. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. REASONCODE is deprecated since version 63.0. Use PAYMENTINFO_0_REASONCODE instead. PAYMENTINFO_n_PROTE CTIONELIGIBILITY PROTECTIONELIGIBILI TY (deprecated) Prior to Version 64.4, the kind of seller protection in force for the transaction, which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received  PartiallyEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  Ineligible – Seller is not protected under the Seller Protection Policy You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. PROTECTIONELIGIBILITY is deprecated since version 63.0. Use PAYMENTINFO_0_PROTECTIONELIGIBILITY instead. PAYMENTINFO_n_PROTE CTIONELIGIBILITYTYP E Since Version 64.4, the kind of seller protection in force for the transaction, which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received  ItemNotReceivedEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  UnauthorizedPaymentEligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payment  Ineligible – Seller is not protected under the Seller Protection Policy You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. PAYMENTINFO_n_EBAYI TEMAUCTIONTXNID EBAYITEMAUCTIONTXNI D (deprecated) The eBay transaction identification number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Character length and limitations: 255 single-byte characters EBAYITEMAUCTIONTXNID is deprecated since version 63.0. Use PAYMENTINFO_0_EBAYITEMAUCTIONTXNID instead. Name-Value Pair API Developer Guide September 2010 97 (PENDING. inclusive. or DENY). and the entry number. Character length and limit: Up to 127 single-byte characters PAYMENTREQUESTID is deprecated since version 63. m. inclusive. Filter ID. and m specifies the list item within the payment. the filter ID. the filter NAME. and m specifies the list item within the payment. 98 September 2010 Name-Value Pair API Developer Guide . You can specify up to 10 payments. where n is a digit between 0 and 9. (PENDING. Filter ID is one of the following values:  1 = AVS No Match  2 = AVS Partial Match  3 = AVS Unavailable/Unsupported  4 = Card Security Code (CSC) Mismatch  5 = Maximum Transaction Amount  6 = Unconfirmed Address  7 = Country Monitor  8 = Large Order Number  9 = Billing/Shipping Address Mismatch  10 = Risky ZIP Code  11 = Suspected Freight Forwarder Check  12 = Total Purchase Price Minimum  13 = IP Address Velocity  14 = Risky Email Address Domain Check  15 = Risky Bank Identification Number (BIN) Check  16 = Risky IP Address Range  17 = PayPal Fraud Model You can specify up to 10 payments.6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field PAYMENTREQUEST_n_PA YMENTREQUESTID PAYMENTREQUESTID (deprecated) Description The unique identifier of the specific payment request. starting from 0. Use PAYMENTINFO_0_PAYMENTREQUESTID instead.0. where n is a digit between 0 and 9. The value should match the one passed in the DoExpressCheckout request. L_FMFfilterNAMEn is deprecated since version 63. REPORT. Use L_PAYMENTINFO_n_FMFfilterIDn instead. where n is a digit between 0 and 9.0. or DENY).0. m. inclusive. You can specify up to 10 payments. L_PAYMENTINFO_n_FMF filterIDm L_FMFfilterIDn (deprecated) L_PAYMENTINFO_n_FMF filterNAMEm L_FMFfilterNAMEn (deprecated) Filter name. You can specify up to 10 payments. starting from 0. and the entry number. inclusive. REPORT. including the filter type. including the filter type. Payment Error Type Fields Field PAYMENTREQUEST_n_SH ORTMESSAGE Description xs:string Payment error short message. L_FMFfilterIDn is deprecated since version 63. where n is a digit between 0 and 9. Use L_PAYMENTINFO_n_FMFfilterNAMEn instead. inclusive.ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 6 Field PAYMENTREQUEST_n_LO NGMESSAGE PAYMENTREQUEST_n_ER RORCODE PAYMENTREQUEST_n_SE VERITYCODE PAYMENTREQUEST_n_AC K Description xs:string Payment error long message. where n is a digit between 0 and 9. inclusive. INSURANCEOPTIONSELEC TED SHIPPINGOPTIONISDEFA ULT SHIPPINGOPTIONAMOUNT SHIPPINGOPTIONNAME Seller Details Type Fields Field PAYMENTREQUEST_n_SELLER PAYPALACCOUNTID Description Unique identifier for the merchant. xs:string Payment error severity code. and the optional thousands separator must be a comma (. inclusive.).000 USD in any currency. decimal separator must be a period (. UserSelectedOptions Fields Field SHIPPINGCALCULATIONM ODE Description Describes how the options that were presented to the user were determined. where n is a digit between 0 and 9. xs:string Application-specific error values indicating more about the error condition. inclusive. where n is a digit between 0 and 9. Is true if the buyer chose the default shipping option. No currency symbol. this field contains either the Payer Id or the email address of the merchant. For parallel payments. The name of the shipping option such as air or ground. You can specify up to 10 payments. Must have two decimal places. Is one of the following values:  API . where n is a digit between 0 and 9. xs:string Payment error code. You can specify up to 10 payments.). Character length and limitations: 127 single-byte alphanumeric characters Name-Value Pair API Developer Guide September 2010 99 . Character length and limitations: true or false The shipping amount that was chosen by the buyer Limitations: Must not exceed $10. where n is a digit between 0 and 9.Callback  API . You can specify up to 10 payments.Flatrate The Yes/No option that was chosen by the buyer for insurance. You can specify up to 10 payments. You can specify up to 10 payments. inclusive. 6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation 100 September 2010 Name-Value Pair API Developer Guide . “GetBalance Request Message” on page 101 “GetBalance Response Message” on page 101 GetBalance Request Message GetBalance Request Fields Field METHOD RETURNALLCURRENCIES Description (Required) Must be GetBalance. GetBalance Response Message GetBalance Response Fields Field L_AMTn L_CURRENCYCODEn Description The available balance and associated currency code for the primary currency holding. prior versions return only the balance for the primary currency holding. Name-Value Pair API Developer Guide September 2010 101 . The currency code associated with the holding.Return the balance for each currency holding NOTE: You can only include this field with API VERSION 51 and later.Return only the balance for the primary currency holding  1 . which is one of the following values:  0 . such as USD. (Optional) Whether to return all currencies.7   GetBalance API Operation Obtain the available balance for a PayPal account. 7 GetBalance API Operation GetBalance Response Message 102 September 2010 Name-Value Pair API Developer Guide . Name-Value Pair API Developer Guide September 2010 103 . You need the account number when working with dynamic versions of PayPal buttons and logos. and other information about your account. which is the PayPal-assigned merchant account number. “GetPalDetails Request Message” on page 103 “GetPalDetails Response Message” on page 103 GetPalDetails Request Message GetPalDetails Request Fields Field METHOD Description (Required) Must be GetPalDetails. GetPalDetails Response Message GetPalDetails Response Fields Field PAL Description The PayPal-assigned merchant account number.8   GetPalDetails API Operation Obtain your Pal ID. Germany  ES .Spain  GB .China  DE . which is one of the following locales:  AU .United Kingdom  FR .Austria  BE .Australia  AT .Switzerland  CN .Italy  NL .United States 104 September 2010 Name-Value Pair API Developer Guide .Belgium  CA .8 GetPalDetails API Operation GetPalDetails Response Message Field LOCALE Description A two-character country code representing the merchant’s default locale.Poland  US .France  IT .Netherlands  PL .Canada  CH . NOTE: The details for some kinds of transactions cannot be retrieved with GetTransactionDetails. (Required) Unique identifier of a transaction. “GetTransactionDetails Request Message” on page 105 “GetTransactionDetails Response Message” on page 105 GetTransactionDetails Request Message GetTransactionDetails Request Fields Field METHOD TRANSACTIONID Description Must be GetTransactionDetails. You cannot obtain details of bank transfer withdrawals. GetTransactionDetails Response Message NOT E : All fields defined in the formal structure of GetTransactionDetailsResponse are not necessarily returned.9   GetTransactionDetails API Operation Obtain information about a specific transaction. Character length and limitations: 17 single-byte alphanumeric characters. Data are returned in a response only if PayPal has recorded data that corresponds to the field. Name-Value Pair API Developer Guide September 2010 105 . for example. Payer’s business name. SHIPTOCOUNTRYCODE Payer’s country of residence in the form of ISO standard 3166 two-character country codes. This value is the same as the value of the recipient's referral ID. Valid values are:  verified  unverified Character length and limitations: 10 single-byte alphabetic characters. Character length and limitations: 127 single-byte characters. Character length and limitations: Two single-byte characters. PAYERID PAYERSTATUS PAYERBUSINESS Payer Name Fields Field SALUTATION Description Payer’s salutation. the value of Receiver is still your primary email address. Character length and limitations: 25 single-byte characters. Character length and limitations: 127 single-byte alphanumeric characters Unique account ID of the payment recipient (the seller). Character length and limitations:13 single-byte alphanumeric characters.9 GetTransactionDetails API Operation GetTransactionDetails Response Message Receiver Information Fields Field RECEIVEREMAIL Description Primary email address of the payment recipient (the seller). Payer’s first name. If you are the recipient of the payment and the payment is sent to your non-primary email address. Unique PayPal customer account identification number. Character length and limitations: 20 single-byte characters. Status of payer. Character length and limitations: 127 single-byte characters. RECEIVERID Payer Information Fields Field EMAIL Description Email address of payer. Character length and limitations: 25 single-byte characters. FIRSTNAME MIDDLENAME 106 September 2010 Name-Value Pair API Developer Guide . Payer’s middle name. Character length and limitations: 32 single-byte characters. Valid values are:  none  Confirmed  Unconfirmed Person’s name associated with this address. Character length and limitations: 12 single-byte characters.GetTransactionDetails API Operation GetTransactionDetails Response Message 9 Field LASTNAME Description Payer’s last name.S. Character length and limitations: 100 single-byte characters. ADDRESSSTATUS SHIPTONAME SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRYCODE SHIPTOPHONENUM Name-Value Pair API Developer Guide September 2010 107 . Country code. Character length and limitations: 20 single-byte characters. U. Country code. Valid values are:  eBay  PayPal Status of street address on file with PayPal. Character length and limitations: 25 single-byte characters. Character limit: Two single-byte characters. Name of city. SUFFIX Address Fields Field ADDRESSOWNER Description eBay company that maintains this address. ZIP code or other country-specific postal code. State or province. Character length and limitations: 100 single-byte characters.S. Character length and limitations: 40 single-byte characters. First street address. Required for U. Character length and limitations: 40 single-byte characters. Character limit: Two single-byte characters. Payer’s suffix. addresses only. Second street address. Regardless of currency. Character length and limitations: 17 single-byte characters        PARENTTRANSACTIONID Parent or related transaction identification number. The final amount charged.000 USD in any currency.000 USD in any currency. Equivalent to nine characters maximum for USD. Capture of an order authorization.). No currency symbol. and the optional thousands separator is a comma (. A three-character currency code. Capture of an order. This field is populated for the following transaction types: Reversal. decimal separator is a period (. and the optional thousands separator is a comma (.). Void of an order. No currency symbol. Reauthorization of a transaction. PayPal fee amount charged for the transactionCharacter length and limitations: Does not exceed $10.). The value of ParentTransactionID is the original OrderID. Regardless of currency. The value of ParentTransactionID is the original OrderID. including any shipping and taxes from your Merchant Profile. Authorization of an order.). Equivalent to nine characters maximum for USD. Character length and limitations: Seven single-byte characters Valid values:  none  echeck  instant Time/date stamp of payment. For example: 2006-08-15T17:23:15Z. Character length and limits: 16 digits in xxxx-xxxx-xxxx-xxxx format RECEIPTID Receipt identification number Character length and limits: 16 digits in xxxx-xxxx-xxxx-xxxx format The type of transaction Valid values:  cart  express-checkout Character length and limitations:15 single-byte characters PAYMENTTYPE Indicates whether the payment is instant or delayed. TRANSACTIONTYPE ORDERTIME AMT CURRENCYCODE FEEAMT 108 September 2010 Name-Value Pair API Developer Guide .9 GetTransactionDetails API Operation GetTransactionDetails Response Message Payment Information Fields Field TRANSACTIONID Description Unique transaction ID of the payment. Reversal. decimal separator is a period (. Character length and limitations: Does not exceed $10. Capture of an authorized transaction. The value of ParentTransactionID is the original OrderID. for example. Tax charged on the transaction.). decimal separator is a period (.  Voided: An authorization for this transaction has been voided. Equivalent to nine characters maximum for USD.Character length and limitations: a decimal that does not exceed 17 characters.  Reversed: A payment was reversed due to a chargeback or other type of reversal.  Failed: The payment has failed.  Partially-Refunded: The payment has been partially refunded.GetTransactionDetails API Operation GetTransactionDetails Response Message 9 Field SETTLEAMT TAXAMT Description Amount deposited in your PayPal account after a currency conversion.  Processed: A payment has been accepted. the conversion occurs in the customer’s account.  In-Progress: The transaction has not terminated. If the customer chooses to pay with a currency other than the non-primary currency. including decimal point Status of the payment.g. No currency symbol.  Completed: The payment has been completed. when you win a dispute and the funds for the reversal have been returned to you. Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency. EXCHANGERATE PAYMENTSTATUS Name-Value Pair API Developer Guide September 2010 109 .  Pending: The payment is pending. The reason for the reversal is specified in the ReasonCode element.  Denied: You denied the payment. Character length and limitations: Does not exceed $10.  Expired: the authorization period for this payment has been reached. an authorization may be awaiting completion. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element. e. The funds have been removed from your account balance and returned to the buyer. This happens only if the payment was made from your customer’s bank account.000 USD in any currency. Regardless of currency.  Refunded: You refunded the payment. The status of the payment:  None: No status  Canceled-Reversal: A reversal has been canceled.). and the funds have been added successfully to your account balance. See the PendingReason field for more information. and the optional thousands separator is a comma (. You must capture the funds first. You must manually accept or deny this payment.  verify: The payment is pending because you are not yet verified.  order: The payment is pending because it is part of an order that has been authorized but not settled.  guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee.  multi-currency: You do not have a balance in the currency sent. REASONCODE The reason for a reversal if TransactionType is reversal:  none: No reason code  chargeback: A reversal has occurred on this transaction due to a chargeback by your customer. and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment.9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field PENDINGREASON Description NOTE: PendingReason is returned in the response only if PaymentStatus is Pending.  authorization: The payment is pending because it has been authorized but not settled. account and do not have a withdrawal mechanism. 110 September 2010 Name-Value Pair API Developer Guide .  paymentreview: The payment is pending while it is being reviewed by PayPal for risk.  other: A reversal has occurred on this transaction due to a reason not listed above. go to the Preferences section of your Profile. For more information.  unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed.  refund: A reversal has occurred on this transaction because you have given the customer a refund. You must verify your account before you can accept this payment. The reason the payment is pending:  none: No pending reason. To change your preference.  buyer-complaint: A reversal has occurred on this transaction due to a complaint about the transaction from your customer. You must manually accept or deny this payment from your Account Overview.  other: The payment is pending for a reason other than those listed above.  intl: The payment is pending because you hold a non-U. contact PayPal customer service.S.  address: The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments.  echeck: The payment is pending because it was made by an eCheck that has not yet cleared. L_DESC1). Name-Value Pair API Developer Guide September 2010 111 . the kind of seller protection in force for the transaction. which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received  ItemNotReceivedEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  UnauthorizedPaymentEligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payment  Ineligible – Seller is not protected under the Seller Protection Policy PROTECTIONELIGIBILI TYTYPE Payment Item Information Fields Field INVNUM Description Invoice number you set in the original transaction.4. These parameters must be ordered sequentially beginning with 0 (for example L_DESC0.4. the kind of seller protection in force for the transaction.GetTransactionDetails API Operation GetTransactionDetails Response Message 9 Field PROTECTIONELIGIBILI TY Description Prior to Version 64. CUSTOM NOTE SALESTAX Payment Item Fields Field L_DESCn Description Amount of tax charged on payment. Character length and limitations: 127 single-byte alphanumeric characters Custom field you set in the original transaction. which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received  PartiallyEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  Ineligible – Seller is not protected under the Seller Protection Policy Since Version 64. Character length and limitations: 255 single-byte alphanumeric characters Amount of tax charged on payment. Character length and limitations: 127 single-byte alphanumeric characters Memo entered by your customer in PayPal Website Payments note field. L_OPTIONSVALUE0. PayPal option values corresponding to option names of an item in the shopping cart. item_number1. each name corresponds to an option value. Character length and limitations: no limit PERIOD 112 September 2010 Name-Value Pair API Developer Guide . Subscription Terms Fields Field AMT Description The amount subscriber is to be charged in one payment. L_NUMBER1). PayPal option names for an item in the shopping cart. L_OPTIONSVALUE1). and so forth. Character length and limitations: no limit Cost of item. L_OPTIONSNAMES0.Character length and limitations: 127 single-byte alphanumeric characters These parameters must be ordered sequentially beginning with 0 (for example L_NUMBER0. For example. Counter used for multi-item auction payments. L_AMT1). These parameters must be ordered sequentially beginning with 0 (for example L_AMT0. L_OPTIONSNAME1). Character length and limitations: no limit The period of time that the subscriber will be charged. The option names are ordered sequentially beginning with 0 (for example. If this was a shopping cart transaction. The option names are ordered sequentially beginning with 0 (for example. There can be multiple option names per item. PayPal appends the number of the item to the HTML item_number variable. item_number2. Auction’s close date.9 GetTransactionDetails API Operation GetTransactionDetails Response Message Field L_NUMBERn Description Item number set by you. L_QTYn L_AMTn L_OPTIONSNAMEn L_OPTIONSVALUEn Auction Information Fields Field BUYERID CLOSINGDATE MULTIITEM Description Customer’s auction ID. Quantity set by you or entered by the customer. Name-Value Pair API Developer Guide September 2010 113 .rejects the payment ManagePendingTransactionStatus Response Message ManagePendingTransactionStatus Response Fields Field TRANSACTIONID Description The transaction ID of the transaction whose payment has been denied or accepted. (Required) The operation you want to perform on the transaction. (Required) The transaction ID of the payment transaction. which is one of the following actions:  Accept . “ManagePendingTransactionStatus Request Message” on page 113 “ManagePendingTransactionStatus Response Message” on page 113 ManagePendingTransactionStatus Request Message ManagePendingTransactionStatus Request Fields Field METHOD TRANSACTIONID ACTION Description (Required) Must be ManagePendingTransactionStatus.accepts the payment  Deny .10   ManagePendingTransactionStatus API Operation Accept or deny a pending transaction held by Fraud Management Filters. which is one of the following values:  Pending  Processing  Completed  Denied  Reversed  Display Only  Partially Refunded  Created Refunded 114 September 2010 Name-Value Pair API Developer Guide .10 ManagePendingTransactionStatus API Operation ManagePendingTransactionStatus Response Message Field STATUS Description The status of the transaction. See “Currency Codes” on page 249. Character length and limitations: 255 single-byte alphanumeric characters. Name-Value Pair API Developer Guide September 2010 115 . (Optional) The subject line of the email that PayPal sends when the transaction is completed. The subject line is the same for all recipients. A three-character currency code. Must be EmailAddress or UserID CURRENCYCODE RECEIVERTYPE MassPay Response Message MassPay Response Fields The fields in the response are the standard response header fields. (Optional) Indicates how you identify the recipients of payments in this call to MassPay.11   MassPay API Operation Make a payment to one or more PayPal account holders. “MassPay Request Message” on page 115 “MassPay Response Message” on page 115 MassPay Request Message MassPay Request Fields Field METHOD EMAILSUBJECT Description (Required) Must be MassPay. 11 MassPay API Operation MassPay Response Message 116 September 2010 Name-Value Pair API Developer Guide . the description in the recurring payments profile must match the description of a billing agreement. NOT E : There is a one-to-one correspondence between billing agreements and recurring payments profiles. use SetExpressCheckout to initiate creation of a billing agreement.12          Recurring Payments and Reference Transactions API Operations This chapter describes the PayPal API operations related to recurring payments and reference transactions: “CreateRecurringPaymentsProfile API Operation” on page 117 “GetRecurringPaymentsProfileDetails API Operation” on page 125 “ManageRecurringPaymentsProfileStatus API Operation” on page 133 “BillOutstandingAmount API Operation” on page 134 “UpdateRecurringPaymentsProfile API Operation” on page 135 “SetCustomerBillingAgreement API Operation” on page 141 “GetBillingAgreementCustomerDetails API Operation” on page 144 “BAUpdate API Operation” on page 146 “DoReferenceTransaction API Operation” on page 148 CreateRecurringPaymentsProfile API Operation Create a recurring payments profile.0 and later. For version 54.   “CreateRecurringPaymentsProfile Request Message” on page 118 “CreateRecurringPaymentsProfile Response Message” on page 125 Name-Value Pair API Developer Guide September 2010 117 . The API operation creates a profile and an associated billing agreement. You must invoke the CreateRecurringPaymentsProfile API operation for each profile you want to create. To associate a a recurring payments profile with its billing agreement. Must be a valid date. Character length and limitations: 127 single-byte alphanumeric characters. NOTE: Tokens expire after approximately 3 hours. A timestamped token. in UTC/GMT format. the value of which was returned in the response to the first call to SetExpressCheckout. You can also use the token returned in the SetCustomerBillingAgreement response. NOTE: This field must match the corresponding billing agreement description included in the SetExpressCheckout request.12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation CreateRecurringPaymentsProfile Request Message CreateRecurringPaymentsProfile Request Fields Field METHOD TOKEN Description (Required) Must be CreateRecurringPaymentsProfile. the name in the buyer’s PayPal account is used. Schedule Details Fields Field DESC Description (Required) Description of the recurring payment. Each CreateRecurringPaymentsProfile request creates a single recurring payments profile. If you include both token and credit card number. If not present. the token is used and credit card number is ignored. Either this token or a credit card number is required. Call CreateRecurringPaymentsProfile once for each billing agreement included in SetExpressCheckout request and use the same token for each call. PROFILEREFERENCE (Optional) The merchant’s own unique reference or invoice number. (Required) The date when billing for this profile begins. Character length and limitations: 32 single-byte characters. Character length and limitations: 127 single-byte alphanumeric characters 118 September 2010 Name-Value Pair API Developer Guide . NOTE: PROFILESTARTDATE The profile may take up to 24 hours for activation. Recurring Payments Profile Details Fields Field SUBSCRIBERNAME Description (Optional) Full name of the person receiving the product or service paid for by the recurring payment. billing is done on the 1st and 15th of each month. TOTALBILLINGCYCLES (Optional) The number of billing cycles for payment period. if the value is greater than 0. One of the following values:  Day  Week  SemiMonth  Month  Year For SemiMonth. Valid values: Must be NoAutoBill or AddToNextBilling. the maximum value for billing frequency is 12. the regular payment period will expire after the trial period is finished and continue at the billing frequency for TotalBillingCycles cycles. Character length and limitations: Number string representing an integer.  For the regular payment period. An IPN message is sent to the merchant when the specified number of failed payments is reached. if the billing cycle is Week. AUTOBILLAMT Billing Period Details Fields Field BILLINGPERIOD Description (Required) Unit for billing during this subscription period.. (Optional) This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle. if no value is specified or the value is 0. NOTE: If the billing period is SemiMonth. if the billing cycle is Month. The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid.  For the regular payment period. the maximum value for billing frequency is 52. Name-Value Pair API Developer Guide September 2010 119 . BILLINGFREQUENCY (Required) Number of billing periods that make up one billing cycle. NOTE: The combination of BillingPeriod and BillingFrequency cannot exceed one year. Similarly. the regular payment period continues until the profile is canceled or deactivated. The combination of billing frequency and billing period must be less than or equal to one year.Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation 12 Field MAXFAILEDPAYMENTS Description (Optional) The number of scheduled payments that can fail before the profile is automatically suspended. For example. the billing frequency must be 1. The combination of billing frequency and billing period must be less than or equal to one year. Regardless of currency. required if you specify an optional trial period.000 USD in any currency. TRIALBILLINGFREQUEN CY Number of billing periods that make up one billing cycle. No currency symbol. NOTE: All amounts in the CreateRecurringPaymentsProfile request must have the same currency.000 USD in any currency. CURRENCYCODE (Required) A three-character currency code. required if you specify an optional trial period. TRIALTOTALBILLINGCY CLES TRIALAMT (Optional) The number of billing cycles for trial payment period. For example. Regardless of currency.12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field AMT Description (Required) Billing amount for each billing cycle during this payment period. Character length and limitations: Does not exceed $10. Equivalent to nine characters maximum for USD. and the optional thousands separator is a comma (. NOTE: All amounts in the CreateRecurringPaymentsProfile request must have the same currency. if the billing cycle is Month. Billing amount for each billing cycle during this payment period.). decimal separator is a period (. required if you specify an optional trial period. Character length and limitations: Does not exceed $10. Default: USD 120 September 2010 Name-Value Pair API Developer Guide . TRIALBILLINGPERIOD Unit for billing during this subscription period. NOTE: If the billing period is SemiMonth. Similarly. the maximum value for billing frequency is 12. No currency symbol.).. the maximum value for billing frequency is 52. if the billing cycle is Week. and the optional thousands separator is a comma (.). NOTE: The combination of BillingPeriod and BillingFrequency cannot exceed one year. Equivalent to nine characters maximum for USD. One of the following values:  Day  Week  SemiMonth  Month  Year For SemiMonth.). decimal separator is a period (. the billing frequency must be 1. billing is done on the 1st and 15th of each month. This amount does not include shipping and tax amounts. This amount does not include shipping and tax amounts. PayPal should add the failed payment amount to the outstanding balance for this recurring payment profile. Regardless of currency. When this flag is set to ContinueOnFailure. NOTE: All amounts in the request must have the same currency. and the optional thousands separator is a comma (. Character length and limitations: Does not exceed $10. Regardless of currency. No currency symbol. Actvation Details Fields Field INITAMT Description (Optional) Initial non-recurring payment amount due immediately upon profile creation.000 USD in any currency.). PayPal will notify you by IPN that the pending profile has been canceled.). Use an initial amount for enrolment or set-up fees. PayPal will notify you by IPN that the pending profile has been activated. decimal separator is a period (. decimal separator is a period (. PayPal will create the recurring payment profile. If the initial payment clears. and the optional thousands separator is a comma (. If the payment fails. No currency symbol. NOTE: All amounts included in the request must have the same currency. and the optional thousands separator is a comma (.). You should check your IPN messages or PayPal account for updates of the payment status.000 USD in any currency.).000 USD in any currency. Regardless of currency. Equivalent to nine characters maximum for USD. but will place it into a pending status until the initial payment is completed.Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation 12 Field SHIPPINGAMT Description (Optional) Shipping amount for each billing cycle during this payment period.). Equivalent to nine characters maximum for USD. NOTE: All amounts in the request must have the same currency. Name-Value Pair API Developer Guide September 2010 121 . decimal separator is a period (. Character length and limitations: Does not exceed $10. If this field is not set or is set to CancelOnFailure. You can override this default behavior by setting this field to ContinueOnFailure. Character length and limitations: Does not exceed $10. PayPal will suspend the pending profile in the event that the initial payment amount fails. Character length and limitations: ContinueOnFailure or CancelOnFailure. which indicates that if the initial payment amount fails. No currency symbol. a success code will be returned to the merchant in the CreateRecurringPaymentsProfile response and the recurring payments profile will be activated for scheduled billing immediately. Equivalent to nine characters maximum for USD.). FAILEDINITAMTACTION (Optional) By default. TAXAMT (Optional) Tax amount for each billing cycle during this payment period. 12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Ship To Address Fields Field SHIPTONAME Description Person’s name associated with this shipping address. Solo.  Solo: See note. Required if using a shipping address. NOTE: If the credit card type is Maestro or Solo. and Visa are allowable. For Canada. shipping address. only MasterCard and Visa are allowable. Character limit: 2 single-byte characters. Character length and limitations: 100 single-byte characters. Required if using a shipping address. Character length and limitations: 40 single-byte characters. Required if using a U.S. ZIP code or other country-specific postal code. (Optional) Phone number. Allowable values:  Visa  MasterCard  Discover  Amex  Maestro: See note. Interac debit cards are not supported. Name of city. may be required for other countries. Required if using a shipping address. Character length and limitations: 100 single-byte characters. the CURRENCYCODE must be GBP. U. Character length and limitations: Up to ten single-byte alphabetic characters. Character length and limitations: 20 single-byte characters. MasterCard. either STARTDATE or ISSUENUMBER must be specified. Character length and limitations: 32 single-byte characters. 122 September 2010 Name-Value Pair API Developer Guide . only Maestro. SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRY SHIPTOPHONENUM Credit Card Details Fields Field CREDITCARDTYPE Description (Required) Type of credit card. (Optional) Second street address. Character length and limit: 20 single-byte characters. Required if using a shipping address. For UK. Discover.S. First street address. In addition. Required if using a shipping address. Country code. State or province. Character length and limitations: 40 single-byte characters. (Optional) Status of payer. COUNTRYCODE (Optional) Payer’s country of residence in the form of ISO standard 3166 twocharacter country codes. (Optional) Payer’s business name. Credit card expiration date. you must not store this value after a transaction has been completed. and Discover: exactly three digits. Character length for American Express: exactly four digits. Character length and limitations: 127 single-byte characters. Must conform with modulo and length required by each credit card type. EXPDATE CVV2 STARTDATE ISSUENUMBER Payer Information Fields Field EMAIL Description (Required) Email address of payer. Character length and limitations: 127 single-byte characters. Character length and limitations: numeric characters only. MasterCard. including leading zero. (Optional) Unique PayPal customer account identification number. Valid values are:  verified  unverified Character length and limitations: 10 single-byte alphabetic characters. Format: MMYYYY Character length and limitations: Six single-byte alphanumeric characters. Character length and limitations: Two single-byte characters. Card Verification Value. Character length and limitations:13 single-byte alphanumeric characters. PAYERID PAYERSTATUS BUSINESS Name-Value Pair API Developer Guide September 2010 123 . Character length for Visa. version 2. Your Merchant Account settings determine whether this field is required. the MMYYYY format. (Optional) Month and year that Maestro or Solo card was issued. Character length: Must be six digits.To comply with credit card processing regulations. This field is required if you are using recurring payments with direct payments. including leading zero. (Optional) Issue number of Maestro or Solo card.Character length: two numeric digits maximum. No spaces or punctutation.Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation 12 Field ACCT Description (Required) Credit card number. S.12 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Payer Name Fields Field SALUTATION Description (Optional) Payer’s salutation. Character length and limitations: 20 single-byte characters. Character length and limitations: 100 single-byte characters. (Required) Name of city. (Required) U. Address Fields Field STREET Description (Required) First street address. Character length and limitations: 25 single-byte characters. Character length and limit: 20 single-byte characters. Character limit: Two single-byte characters. (Required) State or province. (Optional) Second street address. (Optional) Phone number. Character length and limitations: 40 single-byte characters. ZIP code or other country-specific postal code. FIRSTNAME MIDDLENAME LASTNAME SUFFIX STREET2 CITY STATE COUNTRYCODE ZIP SHIPTOPHONENUM 124 September 2010 Name-Value Pair API Developer Guide . Character length and limitations: 100 single-byte characters. (Optional) Payer’s last name Character length and limitations: 25 single-byte characters. Character length and limitations: 40 single-byte characters. (Optional) Payer’s middle name. (Required) Country code. (Optional) Payer’s suffix Character length and limitations: 12 single-byte characters. Character length and limitations: 20 single-byte characters. Character length and limitations: 25 single-byte characters. (Optional) Payer’s first name. Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation 12 CreateRecurringPaymentsProfile Response Message CreateRecurringPaymentsProfile Response Fields Field PROFILEID Description A unique identifier for future reference to the details of this recurring payment.The system is in the process of creating the recurring payment profile. Please check your IPN messages for an update.The recurring payment profile has been successfully created and activated for scheduled payments according the billing instructions from the recurring payments profile. Name-Value Pair API Developer Guide September 2010 125 .   “GetRecurringPaymentsProfileDetails Request Message” on page 125 “GetRecurringPaymentsProfileDetails Response Message” on page 126 GetRecurringPaymentsProfileDetails Request Message GetRecurringPaymentsProfileDetails Request Fields Field METHOD PROFILEID Description (Required) Must be GetRecurringPaymentsProfileDetails. Character length and limitations: 14 single-byte alphanumeric characters.  PendingProfile . 19 character profile IDs are supported for compatibility with previous versions of the PayPal API. (Required) Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response.  ActiveProfile . STATUS GetRecurringPaymentsProfileDetails API Operation Obtain information about a recurring payments profile. Character length and limitations: Up to 14 single-byte alphanumeric characters. Status of the recurring payment profile. Total amount collected thus far for scheduled payments. Character length and limitations: Must not exceed $10. decimal separator must be a period (.000 USD in any currency. 126 September 2010 Name-Value Pair API Developer Guide . and the optional thousands separator must be a comma (.12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation GetRecurringPaymentsProfileDetails Response Message GetRecurringPaymentsProfileDetails Response Fields Field PROFILEID STATUS Description Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid. Total amount collected thus far for optional payments. Must have two decimal places.).).). DESC AUTOBILLOUTAMT MAXFAILEDPAYMENTS AGGREGATEAMOUNT AGGREGATEOPTIONALAM OUNT FINALPAYMENTDUEDATE Recurring Payments Profile Details Fields Field SUBSCRIBERNAME Description Full name of the person receiving the product or service paid for by the recurring payment. Must have two decimal places. the name in the buyer’s PayPal account is used.  ActiveProfile  PendingProfile  CancelledProfile  SuspendedProfile  ExpiredProfile Description of the recurring payment. Final scheduled payment due date before the profile expires. If not present. The number of scheduled payments that can fail before the profile is automatically suspended. and the optional thousands separator must be a comma (. Character length and limitations: 127 single-byte alphanumeric characters.000 USD in any currency. Character length and limitations: Must not exceed $10. Status of the recurring payment profile. This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle. Character length and limitations: 32 single-byte characters. Character length and limitations: Number string representing an integer. Valid values: NoAutoBill or AddToNextBilling. decimal separator must be a period (.). No currency symbol. No currency symbol. S. Name of city.S. U. in UTC/GMT format. Character length and limitations: 40 single-byte characters. Character limit: Two single-byte characters. Must be a valid date. Ship To AddressType Fields Field ADDRESSSTATUS Description Status of street address on file with PayPal. Character length and limitations: 20 single-byte characters. SHIPTONAME SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRYCODE Name-Value Pair API Developer Guide September 2010 127 . Valid values are:  none  Confirmed  Unconfirmed Person’s name associated with this address. addresses only. Character length and limitations: 100 single-byte characters. First street address. Character length and limitations: 100 single-byte characters. ZIP code or other country-specific postal code. PROFILEREFERENCE The merchant’s own unique reference or invoice number. Character length and limitations: 40 single-byte characters. Required for U.Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation 12 Field PROFILESTARTDATE Description The date when billing for this profile begins. Character length and limitations: 127 single-byte alphanumeric characters. Country code. Character length and limitations: 32 single-byte characters. NOTE: The profile may take up to 24 hours for activation. Second street address. State or province. .. billing is done on the 1st and 15th of each month. Use this field with API version 53. NOTE: If the billing period is SemiMonth. NOTE: If the billing period is SemiMonth. the maximum value for billing frequency is 12. BILLINGFREQUENCY Number of billing periods that make up one billing cycle. REGULARBILLINGPERIO D Unit for billing during this regular subscription period. NOTE: The combination of RegularBillingPeriod and RegularBillingFrequency cannot exceed one year. Similarly. the billing frequency must be 1. For example.0 and later.0 and later. the maximum value for billing frequency is 12. the maximum value for billing frequency is 52. the billing frequency must be 1. the maximum value for billing frequency is 52. One of the following values:  Day  Week  SemiMonth  Month  Year For SemiMonth. 128 September 2010 Name-Value Pair API Developer Guide . if the billing cycle is Week. if the billing cycle is Month.12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Billing Period Details Fields Field BILLINGPERIOD Description Unit for billing during this subscription period. NOTE: The combination of BillingPeriod and BillingFrequency cannot exceed one year. For example. Use this field with API version 53. billing is done on the 1st and 15th of each month. if the billing cycle is Month. The combination of billing frequency and billing period must be less than or equal to one year. REGULARBILLINGFREQU ENCY Number of billing periods that make up one regular billing cycle. if the billing cycle is Week. One of the following values:  Day  Week  SemiMonth  Month  Year For SemiMonth. The combination of billing frequency and billing period must be less than or equal to one year. Similarly. if the value is greater than 0. Character length and limitations: Does not exceed $10.). Use this field with API version 53.0 and later. the regular payment period continues until the profile is canceled or deactivated. the regular payment period will expire after the trial period is finished and continue at the billing frequency for TotalBillingCycles cycles. REGULARAMT Billing amount for each billing cycle during this regular payment period. Regardless of currency. SHIPPINGAMT Shipping amount for each billing cycle during this payment period.).  For the regular payment period. The number of billing cycles for the regular payment period.000 USD in any currency.000 USD in any currency. if the value is greater than 0.  For the regular payment period. if no value is specified or the value is 0. Equivalent to nine characters maximum for USD. decimal separator is a period (.). and the optional thousands separator is a comma (. and the optional thousands separator is a comma (. the value must be greater than 0.  For the regular payment period. the regular payment period will expire after the trial period is finished and continue at the billing frequency for RegularTotalBillingCycles cycles.).  For the trial period. NOTE: REGULARTOTALBILLING CYCLES AMT All amounts in the CreateRecurringPaymentsProfile request must have the same currency. This amount does not include shipping and tax amounts. No currency symbol. This amount does not include shipping and tax amounts. Character length and limitations: Does not exceed $10.  For the regular payment period.0 and later. NOTE: All amounts in the request must have the same currency. Regardless of currency. the regular payment period continues until the profile is canceled or deactivated. Character length and limitations: Does not exceed $10.).Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation 12 Field TOTALBILLINGCYCLES Description The number of billing cycles for payment period (either the regular payment period or the trial period). and the optional thousands separator is a comma (. Use this field with API version 53. Name-Value Pair API Developer Guide September 2010 129 . Equivalent to nine characters maximum for USD. decimal separator is a period (.). No currency symbol. Regardless of currency. decimal separator is a period (. No currency symbol. Billing amount for each billing cycle during this payment period. if no value is specified or the value is 0. Equivalent to nine characters maximum for USD. NOTE: All amounts in the CreateRecurringPaymentsProfile request must have the same currency.000 USD in any currency. The current past due or outstanding balance for this profile. Regardless of currency.).000 USD in any currency. NUMCYCLESREMAINING OUTSTANDINGBALANCE 130 September 2010 Name-Value Pair API Developer Guide . CURRENCYCODE (Required) A three-character currency code. decimal separator is a period (. The number of billing cycles completed in the current active subscription period.0 and later.000 USD in any currency.). TAXAMT Tax amount for each billing cycle during this payment period.000 USD in any currency. NOTE: All amounts in the request must have the same currency. Regardless of currency.0 and later. and the optional thousands separator is a comma (.0 and later.12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field REGULARSHIPPINGAMT Description Shipping amount for each billing cycle during this regular payment period. and the optional thousands separator is a comma (. and the optional thousands separator is a comma (. A billing cycle is considered completed when payment is collected or after retry attempts to collect payment for the current billing cycle have failed.).). Equivalent to nine characters maximum for USD.). No currency symbol. decimal separator is a period (. No currency symbol. Default: USD (Required) A three-character currency code. NOTE: All amounts in the request must have the same currency. The number of billing cycles remaining in the current active subscription period. REGULARTAXAMT Tax amount for each billing cycle during this regular payment period.).000 USD in any currency. Default: USD REGULARCURRENCYCODE Recurring Payments Summary Details Fields Field NEXTBILLINGDATE NUMCYCYLESCOMPLETED Description The next scheduled billing date. No currency symbol. Character length and limitations: Does not exceed $10. Equivalent to nine characters maximum for USD. decimal separator is a period (. NOTE: All amounts in the request must have the same currency. Character length and limitations: Does not exceed $10. Character length and limitations: Does not exceed $10. Regardless of currency. Use this field with API version 53. Use this field with API version 53. Equivalent to nine characters maximum for USD.). Character length and limitations: Does not exceed $10. Regardless of currency. decimal separator is a period (. and the optional thousands separator is a comma (. in YYYY-MM-DD format. Equivalent to nine characters maximum for USD. Use this field with API version 53.). No currency symbol. In addition. Regardless of currency. either StartMonth and StartYear or IssueNumber must be specified. Must conform with modulo and length required by each credit card type. Format: MMYYYY Character length and limitations: Six single-byte alphanumeric characters. in YYYY-MM-DD format. Month and year that Maestro or Solo card was issued. Character length and limitations: Does not exceed $10. Issue number of Maestro or Solo card.000 USD in any currency. Equivalent to nine characters maximum for USD. The date of the last successful payment received for this profile.  Solo: See important note. and the optional thousands separator is a comma (. decimal separator is a period (. including leading zero. Allowable values:  Visa  MasterCard  Discover  Amex  Maestro: See important note. NOTE: If the credit card type is Maestro or Solo. the MMYYYY format. Character length: Must be six digits.). EXPDATE STARTDATE ISSUENUMBER Name-Value Pair API Developer Guide September 2010 131 . No spaces or punctutation.Character length: two numeric digits maximum. This field is required if you are using recurring payments with direct payments. the currencyId must be GBP. Character length and limitations: numeric characters only.). The amount of the last successful payment received for this profile. including leading zero. Credit Card Details Fields Field CREDITCARDTYPE Description Type of credit card. ACCT Credit card number. Only the last 4 digits of the credit card number are returned.Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation 12 Field FAILEDPAYMENTCOUNT LASTPAYMENTDATE LASTPAYMENTAMT Description The total number of failed billing cycles for this profile. Character length and limitations: Up to ten single-byte alphabetic characters. No currency symbol. Credit card expiration date. FIRSTNAME LASTNAME ADDRESSSTATUS SHIPTONAME SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRYCODE SHIPTOPHONENUM 132 September 2010 Name-Value Pair API Developer Guide . Character length and limitations: 100 single-byte characters. State or province. Name of city. Character length and limitations: 40 single-byte characters. Character length and limitations: 40 single-byte characters. Character length and limitations: 127 single-byte characters. U. Character length and limitations: 32 single-byte characters. Address Fields Field ADDRESSOWNER Description eBay company that maintains this address. Character length and limitations: 20 single-byte characters.12 Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Payer Info Fields Field EMAIL Description Email address of payer. Valid values are:  none  Confirmed  Unconfirmed Person’s name associated with this address. Character limit: Two single-byte characters. Payer’s last name. Second street address.S. Character length and limitations: 25 single-byte characters. Country code. Character limit: Two single-byte characters. Required for U. First street address. Valid values are:  eBay  PayPal Status of street address on file with PayPal.S. ZIP code or other country-specific postal code. Payer’s first name. Country code. Character length and limitations: 100 single-byte characters. Character length and limitations: 25 single-byte characters. addresses only. ACTION NOTE Name-Value Pair API Developer Guide September 2010 133 . (Optional) The reason for the change in status. (Required) The action to be performed to the recurring payments profile. (Required) Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. suspend.Only profiles in Active state can be suspended.Only profiles in Active or Suspended state can be canceled. 19 character profile IDs are supported for compatibility with previous versions of the PayPal API. this message will be included in the email notification to the buyer when the status of the profile is successfully changed. and can also be seen by both you and the buyer on the Status History page of the PayPal account.Recurring Payments and Reference Transactions API Operations ManageRecurringPaymentsProfileStatus API Operation 12 ManageRecurringPaymentsProfileStatus API Operation Cancel. For profiles created using Express Checkout. Character length and limitations: 14 single-byte alphanumeric characters.   “ManageRecurringPaymentsProfileStatus Request Message” on page 133 “ManageRecurringPaymentsProfileStatus Response Message” on page 134 ManageRecurringPaymentsProfileStatus Request Message ManageRecurringPaymentsProfileStatus Request Fields Field METHOD PROFILEID Description (Required) Must be ManageRecurringPaymentsProfileStatus.Only profiles in a suspended state can be reactivated.  Suspend .  Reactivate . Must be one of the following:  Cancel . or reactivate a recurring payments profile. Character length and limitations: Does not exceed $10.12 Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API Operation ManageRecurringPaymentsProfileStatus Response Message ManageRecurringPaymentsProfileStatus Response Fields Field PROFILEID Description Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response.Profile status is not Active or Suspended.   “BillOutstandingAmount Request Message” on page 134 “BillOutstandingAmount Response Message” on page 135 BillOutstandingAmount Request Message BillOutstandingAmount Request Fields Field METHOD PROFILEID Description (Required) Must be BillOutstandingAmount.Profile status is not Active. Character length and limitations: 14 single-byte alphanumeric characters. Equivalent to nine characters maximum for USD. The amount must be less than or equal to the current outstanding balance of the profile. and the optional thousands separator is a comma (.  Suspend .).  Reactivate .Profile status is not Suspended. For each action. decimal separator is a period (. Regardless of currency. PayPal will attempt to bill the entire outstanding balance amount. NOTE: The profile must have a status of either Active or Suspended.000 USD in any currency. (Required) Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. If no value is specified. Errors are returned in the following cases:  Cancel . an error is returned if the recurring payments profile has a status that is not compatible with the action. BillOutstandingAmount API Operation Bill the buyer for the outstanding balance associated with a recurring payments profile.). 19 character profile IDs are supported for compatibility with previous versions of the PayPal API. AMT (Optional) The amount to bill. No currency symbol. 134 September 2010 Name-Value Pair API Developer Guide . This message will be included in the email notification to the buyer for the recurring payments profile update. This note can also be seen by both you and the buyer on the Status History page of the PayPal account. (Optional) The reason for the update to the recurring payments profile.Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation 12 Field NOTE Description (Optional) The reason for the non-scheduled payment. UpdateRecurringPaymentsProfile API Operation Update a recurring payments profile. this message will be included in the email notification to the buyer for the non-scheduled payment transaction. For profiles created using Express Checkout.   “UpdateRecurringPaymentsProfile Request Message” on page 135 “UpdateRecurringPaymentsProfile Response Message” on page 140 UpdateRecurringPaymentsProfile Request Message UpdateRecurringPaymentsProfile Request Fields Field METHOD PROFILEID Description (Required) Must be UpdateRecurringPaymentsProfile. An error is returned if the profile specified in the BillOutstandingAmount request has a status of canceled or expired. and can also be seen by both you and the buyer on the Status History page of the PayPal account. 19 character profile IDs are supported for compatibility with previous versions of the PayPal API. NOTE Name-Value Pair API Developer Guide September 2010 135 . (Required) Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. Character length and limitations: 14 single-byte alphanumeric characters. BillOutstandingAmount Response Message BillOutstandingAmount Response Fields Field PROFILEID Description Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. Character length and limitations: 127 single-byte alphanumeric characters.000 USD in any currency.). Regardless of currency.). TAXAMT (Optional) Tax amount for each billing cycle during the regular payment period. Character length and limitations: Does not exceed $10. NOTE: SUBSCRIBERNAME PROFILEREFERENCE ADDITIONALBILLINGCY CLES AMT For recurring payments with Express Checkout.).). Regardless of currency. Regardless of currency. decimal separator is a period (. and the optional thousands separator is a comma (. Regardless of currency. No currency symbol.000 USD in any currency. decimal separator is a period (. Equivalent to nine characters maximum for USD. Character length and limitations: Does not exceed $10. No currency symbol. No currency symbol. (Optional) The number of additional billing cycles to add to this profile.). the name in the buyer’s PayPal account is used. OUTSTANDINGAMT (Optional) The current past due or outstanding amount for this profile.). the payment amount can be increased by no more than 20% every 180 days (starting when the profile is created). Equivalent to nine characters maximum for USD. not including shipping and tax amounts. and the optional thousands separator is a comma (. decimal separator is a period (. NOTE: All amounts in the request must have the same currency. Equivalent to nine characters maximum for USD. (Optional) Billing amount for each cycle in the subscription period. SHIPPINGAMT (Optional) Shipping amount for each billing cycle during the regular payment period.). (Optional) This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle.12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field DESC Description (Optional) Description of the recurring payment. Character length and limitations: Does not exceed $10. No currency symbol. AUTOBILLOUTAMT 136 September 2010 Name-Value Pair API Developer Guide . Character length and limitations: Does not exceed $10. Valid values: Must be NoAutoBill or AddToNextBilling. (Optional) Full name of the person receiving the product or service paid for by the recurring payment. You can only decrease the outstanding amount—it cannot be increased. and the optional thousands separator is a comma (. Equivalent to nine characters maximum for USD. decimal separator is a period (.). (Optional) The merchant’s own unique reference or invoice number. Character length and limitations: 127 single-byte alphanumeric characters. Character length and limitations: 32 single-byte characters.000 USD in any currency.000 USD in any currency. If not present. and the optional thousands separator is a comma (. NOTE: All amounts in the request must have the same currency. Required if using a shipping address. The specified value cannot be less than the current number of failed payments for this profile. Name-Value Pair API Developer Guide September 2010 137 . Name of city. Required if using a shipping address. SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRY SHIPTOPHONENUM Billing Period Details Fields Field TOTALBILLINGCYCLES Description (Optional) The number of billing cycles for payment period. in UTC/GMT format. Character length and limitations: Number string representing an integer. Required if using a shipping address. Ship To Address Fields Field SHIPTONAME Description Person’s name associated with this shipping address. Must be a valid date.Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation 12 Field MAXFAILEDPAYMENTS Description (Optional) The number of failed payments allowed before the profile is automatically suspended. State or province. if the value is greater than 0. Required if using a shipping address. Required if using a U. Character length and limit: 20 single-byte characters.S. Country code. Character length and limitations: 100 single-byte characters. (Optional) The date when billing for this profile begins. (Optional) Phone number. NOTE: PROFILESTARTDATE The profile may take up to 24 hours for activation. Required if using a shipping address. Character length and limitations: 40 single-byte characters.S. Character length and limitations: 20 single-byte characters. (Optional) Second street address. Character length and limitations: 32 single-byte characters.  For the regular payment period. may be required for other countries. Character limit: 2 single-byte characters. Character length and limitations: 40 single-byte characters. the regular payment period will expire after the trial period is finished and continue at the billing frequency for TotalBillingCycles cycles. Character length and limitations: 100 single-byte characters. if no value is specified or the value is 0. ZIP code or other country-specific postal code.  For the regular payment period. the regular payment period continues until the profile is canceled or deactivated. First street address. shipping address. U. Regardless of currency.000 USD in any currency. decimal separator is a period (. This amount does not include shipping and tax amounts. NOTE: All amounts in the CreateRecurringPaymentsProfile request must have the same currency. NOTE: All amounts in the request must have the same currency.).000 USD in any currency. This amount does not include shipping and tax amounts. NOTE: SHIPPINGAMT All amounts in the request must have the same currency. 138 September 2010 Name-Value Pair API Developer Guide . Regardless of currency. and the optional thousands separator is a comma (. No currency symbol. Equivalent to nine characters maximum for USD. No currency symbol. required if you specify an optional trial period. CURRENCYCODE (Required) A three-character currency code. Default: USD (Optional) Shipping amount for each billing cycle during this payment period.000 USD in any currency. Character length and limitations: Does not exceed $10. TAXAMT (Optional) Tax amount for each billing cycle during this payment period. TRIALTOTALBILLINGCY CLES TRIALAMT (Optional) The number of billing cycles for trial payment period. No currency symbol.). No currency symbol.12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field AMT Description (Required) Billing amount for each billing cycle during this payment period. decimal separator is a period (.).). Regardless of currency.). and the optional thousands separator is a comma (. decimal separator is a period (. and the optional thousands separator is a comma (.). Billing amount for each billing cycle during this payment period.). Equivalent to nine characters maximum for USD. Character length and limitations: Does not exceed $10. Character length and limitations: Does not exceed $10. and the optional thousands separator is a comma (.).000 USD in any currency. decimal separator is a period (. Character length and limitations: Does not exceed $10. NOTE: All amounts in the CreateRecurringPaymentsProfile request must have the same currency. Equivalent to nine characters maximum for USD. Equivalent to nine characters maximum for USD. Regardless of currency. Credit card expiration date. This field is required if you are using recurring payments with direct payments. and Visa are allowable. Discover. (Optional) Issue number of Maestro or Solo card. Character length: Must be six digits. MasterCard.To comply with credit card processing regulations. Solo. Format: MMYYYY Character length and limitations: Six single-byte alphanumeric characters. Character length and limitations: 127 single-byte characters.  Solo: See note. Character length for Visa. either STARTDATE or ISSUENUMBER must be specified. For UK. EXPDATE CVV2 STARTDATE ISSUENUMBER Payer Information Fields Field EMAIL Description (Optional) Email address of payer. the MMYYYY format. including leading zero. Character length and limitations: numeric characters only. and Discover: exactly three digits. the CURRENCYCODE must be GBP. only Maestro. including leading zero. Your Merchant Account settings determine whether this field is required. Must conform with modulo and length required by each credit card type. ACCT (Required) Credit card number. For Canada. Character length and limitations: Up to ten single-byte alphabetic characters. version 2.Character length: two numeric digits maximum. In addition. only MasterCard and Visa are allowable. Card Verification Value. Name-Value Pair API Developer Guide September 2010 139 . you must not store this value after a transaction has been completed. MasterCard. Allowable values:  Visa  MasterCard  Discover  Amex  Maestro: See note. Character length for American Express: exactly four digits. Interac debit cards are not supported. (Optional) Month and year that Maestro or Solo card was issued. No spaces or punctutation. NOTE: If the credit card type is Maestro or Solo.Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation 12 Credit Card Details Fields Field CREDITCARDTYPE Description (Required) Type of credit card. ZIP code or other country-specific postal code. (Required) U. Character length and limitations: 25 single-byte characters. Character length and limitations: 100 single-byte characters. (Required) Payer’s last name. Address Fields LASTNAME Field STREET Description (Required) First street address. Character length and limit: 20 single-byte characters. 140 September 2010 Name-Value Pair API Developer Guide . Character length and limitations: 100 single-byte characters. (Optional) Second street address. Character length and limitations: 20 single-byte characters. (Optional) Phone number. Character length and limitations: 40 single-byte characters. Character length and limitations: 40 single-byte characters.S. Character length and limitations: 25 single-byte characters. (Required) Name of city. Character limit: Two single-byte characters. (Required) State or province. STREET2 CITY STATE COUNTRYCODE ZIP SHIPTOPHONENUM UpdateRecurringPaymentsProfile Response Message UpdateRecurringPaymentsProfile Response Fields Field PROFILEID Description Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response. An error is returned if the profile specified in the BillOutstandingAmount request has a status of canceled or expired.12 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field FIRSTNAME Description (Required) Payer’s first name. (Required) Country code. Use the SetExpressCheckout API operation instead. do not use the SetCustomerBillingAgreement API operation to set up a billing agreement. Character length and limitations: no limit.   “SetCustomerBillingAgreement Request Message” on page 141 “SetCustomerBillingAgreement Response Message” on page 143 SetCustomerBillingAgreement Request Message SetCustomerBillingAgreement Request Fields Field METHOD RETURNURL Description (Required) Must be SetCustomerBillingAgreement. NOTE: PayPal recommends that the value be the final review page on which the customer confirms the billing agreement.0 or later of the API.Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation 12 SetCustomerBillingAgreement API Operation Initiates the creation of a billing agreement. NOTE: PayPal recommends that the value be the original page on which the customer chose to pay with PayPal or establish a billing agreement. (Required) URL to which the customer’s browser is returned after choosing to pay with PayPal. Character length and limitations: no limit. CANCELURL (Required) URL to which the customer is returned if he does not approve the use of PayPal to pay you. Name-Value Pair API Developer Guide September 2010 141 . NOT E : If you are using Express Checkout with version 54. Character length and limitation: Six character HTML hexadecimal color code in ASCII.Austria  BE .Canada  CH . PAGESTYLE (Optional) Sets the Custom Payment Page Style for payment pages associated with this button/link. (Optional) Sets the border color around the header of the payment page.Poland  US . the color is white. HDRIMG HDRBORDERCOLOR HDRBACKCOLOR PAYFLOWCOLOR 142 September 2010 Name-Value Pair API Developer Guide .China  DE .Netherlands  PL . 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.Germany  ES .12 Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field LOCALECODE Description (Optional) Locale of pages displayed by PayPal during checkout. The border is a 2-pixel perimeter around the header space. which is 750 pixels wide by 90 pixels high. This value corresponds to the HTML variable page_style for customizing payment pages. Character length and limitations: 30 single-byte alphabetic characters.United States Any other value will default to US.France  IT . (Optional) A URL for the image you want to appear at the top left of the payment page. Character length and limitations: Six character HTML hexadecimal color code in ASCII.Italy  NL . Character length and limitations: 127 single-byte alphanumeric characters. The image has a maximum size of 750 pixels wide by 90 pixels high.Belgium  CA . By default. (Optional) Sets the background color for the payment page.Spain  GB . Character length and limitations: Any two-character country code. PayPal recommends that you provide an image that is stored on a secure (https) server.Australia  AT . (Optional) Sets the background color for the header of the payment page.United Kingdom  FR . The following two-character country codes are supported by PayPal:  AU .Switzerland  CN . Character length and limitation: Six character HTML hexadecimal color code in ASCII. which is required for reference transactions. Character length and limitations: 256 single-byte alphanumeric bytes. this field is ignored.99 per month for 2 years”. SetCustomerBillingAgreement Response Message SetCustomerBillingAgreement Response Fields Field TOKEN Description A unique time-stamped token. NOTE: For recurring payments.Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation 12 Field EMAIL Description (Optional) Email address of the buyer as entered during checkout. PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions. Name-Value Pair API Developer Guide September 2010 143 . Character length and limitations: 20 single-byte characters. this field is ignored. Character length and limit: 127 single-byte alphanumeric characters. customer will be billed at “9. L_BILLINGAGREEMENTC USTOMn (Optional) Custom annotation field for your own use. N O TE : The token expires after three hours.  Any  InstantOnly NOTE: L_BILLINGAGREEMENTD ESCRIPTIONn L_PAYMENTTYPEn For recurring payments. Description of goods or services associated with the billing agreement. which uniquely identifies this transaction for subsequent API calls. which is required for each recurring payment billing agreement. (Optional) Specifies type of PayPal payment you require for the billing agreement. For example. PayPal uses this value to pre-fill the PayPal membership sign-up portion of the PayPal login page. BillingAgreementDetails Fields Field BILLINGTYPE Description Type of billing agreement. Character length and limitations: 127 single-byte alphanumeric bytes. Other defined values are not valid. (Required) The time-stamped token returned in the SetCustomerBillingAgreement response. Character length and limitations: 127 single-byte characters. Character length and limitations:13 single-byte alphanumeric characters. SHIPTOCOUNTRYCODE Payer’s country of residence in the form of ISO standard 3166 two-character country codes. Unique PayPal customer account identification number. NOTE: The token expires after three hours. Status of payer. PAYERID PAYERSTATUS 144 September 2010 Name-Value Pair API Developer Guide .12 Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation G e t B i l l i n g A g r e e m e n t C u s t o m e r D e ta i l s A P I O p e r a t i o n Obtain information about a billing agreement’s PayPal account holder. GetBillingAgreementCustomerDetails Response Message GetBillingAgreementCustomerDetails Response Fields Payer Information Fields Field EMAIL Description Email address of payer.   “GetBillingAgreementCustomerDetails Request Message” on page 144 “GetBillingAgreementCustomerDetails Response Message” on page 144 GetBillingAgreementCustomerDetails Request Message GetBillingAgreementCustomerDetails Request Fields Field METHOD TOKEN Description (Required) Must be GetBillingAgreementCustomerDetails. Character length and limitations: 20 single-byte characters. Valid values are:  verified  unverified Character length and limitations: 10 single-byte alphabetic characters. Character length and limitations: Two single-byte characters. Character length and limitations: 25 single-byte characters. Payer’s first name. Character length and limitations: 12 single-byte characters. Character length and limitations: 25 single-byte characters. FIRSTNAME MIDDLENAME LASTNAME SUFFIX SHIPTONAME SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE Name-Value Pair API Developer Guide September 2010 145 . Second street address. Required for U. Character length and limitations: 40 single-byte characters. Payer’s suffix.Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation 12 Field PAYERBUSINESS Description Payer’s business name. Character length and limitations: 100 single-byte characters. Name of city. Character length and limitations: 40 single-byte characters. Payer’s middle name. PayerNameType Fields Field SALUTATION Description Payer’s salutation. Valid values are:  none  Confirmed  Unconfirmed Person’s name associated with this address. Character length and limitations: 20 single-byte characters. Payer’s last name. Character length and limitations: 25 single-byte characters. Character length and limitations: 100 single-byte characters. State or province. Address Fields Field ADDRESSSTATUS Description Status of street address on file with PayPal. Character length and limitations: 32 single-byte characters. addresses only. Character length and limitations: 127 single-byte characters.S. First street address. 99 per month for 2 years”. For example. such as a billing agreement ID or a reference transaction ID that is associated with a billing agreement.S. Country code.the billing agreement has been cancelled NOTE: If you do not pass a billing agreement status value. SHIPTOCOUNTRYCODE BAUpdate API Operation Update or delete a billing agreement. this field is ignored. which is required for each recurring payment billing agreement. Character length and limitations: 256 single-byte alphanumeric bytes.12 Recurring Payments and Reference Transactions API Operations BAUpdate API Operation Field SHIPTOZIP Description U. The current status of the billing agreement. (Optional) Type of billing agreement. ZIP code or other country-specific postal code. the BAUpdate response returns the buyer’s latest billing address. Character length and limitations: 127 single-byte alphanumeric bytes.   “BAUpdate Request Message” on page 146 “BAUpdate Response Message” on page 147 BAUpdate Request Message BAUpdate Request Fields Field METHOD REFERENCEID BILLINGAGREEMENTSTA TUS Description (Required) Must be BillAgreementUpdate. 146 September 2010 Name-Value Pair API Developer Guide . NOTE: L_BILLINGAGREEMENTC USTOMn For recurring payments. customer will be billed at “9. Character limit: Two single-byte characters. PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions. which is one of the following values:  Active . (Optional) Custom annotation field for your own use.the billing agreement is currently active  Canceled . (Required) An ID. L_BILLINGAGREEMENTD ESCRIPTIONn (Optional) Description of goods or services associated with the billing agreement. Character length and limitations: 20 single-byte characters. The current status of the billing agreement.the billing agreement has been cancelled Maximum amount for this billing agreement. which is one of the following values:  Active . Custom annotation field for your own use. Character length and limitations: Two single-byte characters. Status of payer. which is required for each recurring payment billing agreement. Payer’s business name. Character length and limitations: 127 single-byte characters. Description of goods or services associated with the billing agreement. N O TE : L_BILLINGAGREEMENTM AXn This field only has a value if the customer signed up for PayPal using Preapproved Payments. PAYERID PAYERSTATUS PAYERBUSINESS Name-Value Pair API Developer Guide September 2010 147 .the billing agreement is currently active  Canceled . Payer Information Fields Field EMAIL Description Email address of payer. (Optional) Type of billing agreement. Character length and limitations: 127 single-byte alphanumeric bytes.Recurring Payments and Reference Transactions API Operations BAUpdate API Operation 12 BAUpdate Response Message BAUpdate Response Fields Field L_BILLINGTYPEn L_BILLINGAGREEMENTD ESCRIPTIONn L_BILLINGAGREEMENTC USTOMn BILLINGAGREEMENTSTA TUS Description Type of billing agreement. Character length and limitations: 127 single-byte characters. Unique PayPal customer account identification number. it is included for backwards compatibility with legacy systems. Character length and limitations: 256 single-byte alphanumeric bytes. Valid values are:  verified  unverified Character length and limitations: 10 single-byte alphabetic characters. Character length and limitations:13 single-byte alphanumeric characters. SHIPTOCOUNTRYCODE Payer’s country of residence in the form of ISO standard 3166 two-character country codes. addresses only. U. Character length and limitations: 32 single-byte characters. Character length and limitations: 25 single-byte characters. Character length and limitations: 100 single-byte characters. First billing street address. Character length and limitations: 25 single-byte characters. Character length and limitations: 25 single-byte characters. Character length and limitations: 20 single-byte characters. Character length and limitations: 40 single-byte characters. Billing country code. Second billing street address.S. Bill To Address Fields Field BILLINGNAME Description Billing name associated with this billing address.12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Payer Name Fields Field SALUTATION Description Payer’s salutation. Character length and limitations: 100 single-byte characters. FIRSTNAME MIDDLENAME LASTNAME SUFFIX STREET STREET2 CITY STATE ZIP COUNTRYCODE DoReferenceTransaction API Operation Process a payment from a buyer’s account. Character limit: Two single-byte characters.S. Billing state or province. Payer’s suffix. Character length and limitations: 40 single-byte characters. Character length and limitations: 20 single-byte characters. Payer’s middle name. which is identified by a previous transaction. Payer’s first name. Required for U. Payer’s last name. Name of billing city. Character length and limitations: 12 single-byte characters. billing zip code or other country-specific postal code.  “DoReferenceTransaction Request Message” on page 149 148 September 2010 Name-Value Pair API Developer Guide . (Optional) Flag to indicate whether you want the results returned by Fraud Management Filters.receive FMF details RETURNFMFDETAILS Name-Value Pair API Developer Guide September 2010 149 .do not receive FMF details (default)  1 . By default.  Sale indicates that this is a final sale for which you are requesting payment.  0 . (Optional) How you want to obtain payment:  Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization & Capture. or a billing agreement ID. (Required) A transaction ID from a previous purchase.Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12  “DoReferenceTransaction Response Message” on page 156 DoReferenceTransaction Request Message DoReferenceTransaction Request Fields Field METHOD REFERENCEID PAYMENTACTION Description (Required) Must be DoReferenceTransaction. you do not receive this information. such as a credit card charge using the DoDirectPayment API. (Optional) Second street address. assume the following conditions:  The PayPal prefix toggle is set to PAYPAL * in PayPal’s admin tools. Character length and limitations: 32 single-byte characters. SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE 150 September 2010 Name-Value Pair API Developer Guide . Character length and limitations: 40 single-byte characters. an error code is returned. State or province.len(<PP * | PAYPAL *>) . Character length and limitations: 40 single-byte characters. If a value for the soft descriptor field is provided. Required if using a shipping address. Character length and limitations: 100 single-byte characters. Of this. the maximum length of the soft descriptor passed in the API request is: 22 . the full descriptor displayed on the customer’s statement has the following format: <PP * | PAYPAL *><Merchant descriptor as set in the Payment Receiving Preferences><1 space><soft descriptor> The soft descriptor can contain only the following characters:  Alphanumeric characters  . which can be toggled between the merchant’s customer service number and PayPal’s customer service number. (period)  {space} If you use any other characters (such as “.The soft descriptor does not include the phone number.  The soft descriptor is passed in as JanesFlowerGifts LLC The resulting descriptor string on the credit card would be: PAYPAL *EBAY JanesFlow Ship To Address Fields Field SHIPTONAME Description Person’s name associated with this shipping address. Character length and limitations: 100 single-byte characters. Thus.”).12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field SOFTDESCRIPTOR Description (Optional) The soft descriptor is a per transaction description of the payment that is passed to the consumer’s credit card statement. either 4 or 8 characters are used by the PayPal prefix shown in the data format. First street address. Name of city. Required if using a shipping address.(dash)  * (asterisk)  .  The merchant descriptor set in the Payment Receiving Preferences is set to EBAY.The maximum length of the total soft descriptor is 22 characters. Required if using a shipping address.len(<Descriptor set in Payment Receiving Preferences> + 1) For example. Required if using a shipping address. for example. Equivalent to nine characters maximum for USD. Purchase-specific fields will be ignored. Country code.000 USD in any currency. this field must be equal to the sum of the purchases. No currency symbol. decimal separator must be a period (. shipping address. you must also specify a value for ITEMAMT. SHIPPINGAMT (Optional) Total shipping costs for this order. and the optional thousands separator must be a comma (. and the optional thousands separator must be a comma (. decimal separator must be a period (. Required if using a shipping address. No currency symbol. include them in this value. Limitations: Must not exceed $10.). (Optional) Sum of cost of all items in this order. ZIP code or other country-specific postal code. if not. If the transaction includes one or more one-time purchases. Set this field to 0 if the transaction does not include a one-time purchase.000 USD in any currency.S. SHIPTOCOUNTRY SHIPTOPHONENUM Payment Details Fields Field AMT Description (Required) The total cost of the transaction to the customer. NOTE: CURRENCYCODE ITEMAMT ITEMAMT is required if you specify L_AMTn. If shipping cost and tax charges are known. Character limit: 2 single-byte characters. decimal separator must be a period (. Required if using a U. Must have two decimal places.S.). Must have two decimal places. this value should be the current sub-total of the order. Default: USD. No currency symbol. Character length and limitations: 20 single-byte characters. when you set up a billing agreement for a recurring payment that is not immediately charged.). Regardless of currency. Character length and limitations: Must not exceed $10. Limitations: Must not exceed $10.).). (Optional) A three-character currency code.000 USD in any currency.Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 Field SHIPTOZIP Description U. and the optional thousands separator must be a comma (. NOTE: If you specify a value for SHIPPINGAMT. Name-Value Pair API Developer Guide September 2010 151 .). Character length and limit: 20 single-byte characters. (Optional) Phone number. may be required for other countries. Character length and limitations: 127 single-byte alphanumeric characters CUSTOM (Optional) A free-form field for your own use. DESC (Optional) Description of items the customer is purchasing. decimal separator must be a period (. and the optional thousands separator must be a comma (. Character length and limitations: 2. NOTE: TAXAMT is required if you specify L_TAXAMTn Character length and limitations: Must not exceed $10. you must also specify a value for ITEMAMT. and the optional thousands separator must be a comma (. Regardless of currency. the notification URL from your Merchant Profile is used. decimal separator must be a period (. I MP O R T ANT : NOTIFYURL The notify URL only applies to DoExpressCheckoutPayment. Equivalent to nine characters maximum for USD. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. No currency symbol. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged. NOTE: The value you specify is only available if the transaction includes a purchase.). NOTE: The value you specify is only available if the transaction includes a purchase.12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field HANDLINGAMT Description (Optional) Total handling costs for this order. this field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged.000 USD in any currency. Character length and limitations: 256 single-byte alphanumeric characters INVNUM (Optional) Your own invoice or tracking number.).000 USD in any currency. if one exists. TAXAMT (Optional) Sum of tax for all items in this order. If you do not specify this value in the request. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails. Character length and limitations: Must not exceed $10.). NOTE: If you specify a value for HANDLINGAMT. Regardless of currency.048 single-byte alphanumeric characters 152 September 2010 Name-Value Pair API Developer Guide . Equivalent to nine characters maximum for USD. Character length and limitations: 127 single-byte alphanumeric characters BUTTONSOURCE (Optional) An identification code for use by third-party applications to identify transactions.). No currency symbol. NOTE: The value you specify is only available if the transaction includes a purchase. Character length and limitations: 32 single-byte alphanumeric characters (Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMNUMBER0.000 USD in any currency. NOTE: L_QTYn L_TAXAMTn Character length and limitations: Must not exceed $10. L_NAME1). If you specify a value for L_AMTn.000 USD in any currency. These parameters must be ordered sequentially beginning with 0 (for example L_NUMBER0. L_EBAYITEMNUMBER1). No currency symbol. and the optional thousands separator must be a comma (.). Ebay Item Payment Details Item Fields Field L_EBAYITEMNUMBERn Description (Optional) Auction item number. L_AMT1). Character length: 765 single-byte characters Name-Value Pair API Developer Guide September 2010 153 . NOTE: L_DESCn L_AMTn Character length and limitations: Must not exceed $10. NOTE: L_NUMBERn (Optional) Item number. These parameters must be ordered sequentially beginning with 0 (for example L_AMT0.). and the optional thousands separator must be a comma (. Character length and limitations: 127 single-byte characters (Optional) Item description. you must specify a value for ITEMAMT. Equivalent to nine characters maximum for USD.). L_NUMBER1). decimal separator must be a period (. No currency symbol.Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 Payment Details Item Fields Field L_NAMEn Description (Optional) Item name. Character length and limitations: 127 single-byte characters (Optional) Item quantity. decimal separator must be a period (.). These parameters must be ordered sequentially beginning with 0 (for example L_NAME0. Regardless of currency. These parameters must be ordered sequentially beginning with 0 (for example L_QTY0. L_QTY1). Equivalent to nine characters maximum for USD. These parameters must be ordered sequentially beginning with 0 (for example L_TAXAMT0. Regardless of currency. L_TAXAMT1). Character length and limitations: 127 single-byte characters (Optional) Cost of item. Character length and limitations: Any positive integer (Optional) Item sales tax. EXPDATE CVV2 STARTDATE 154 September 2010 Name-Value Pair API Developer Guide . Character length for American Express: exactly four digits. Allowable values:  Visa  MasterCard  Discover  Amex  Maestro: See note. NOTE: If the credit card type is Maestro or Solo. Character length: 255 single-byte characters (Optional) Auction order identification number. Credit card expiration date. Solo. MasterCard. For UK. only MasterCard and Visa are allowable. the CURRENCYCODE must be GBP.  Solo: See note. (Optional) Month and year that Maestro or Solo card was issued. either STARTDATE or ISSUENUMBER must be specified. Character length: Must be six digits. Format: MMYYYY Character length and limitations: Six single-byte alphanumeric characters. version 2. and Discover: exactly three digits.To comply with credit card processing regulations. you must not store this value after a transaction has been completed. the MMYYYY format. Character length: 64 single-byte characters L_EBAYITEMORDERIDn Reference Credit Card Details Fields Field CREDITCARDTYPE Description (Optional) Type of credit card. Character length and limitations: numeric characters only. This field is required if you are using recurring payments with direct payments. including leading zero. For Canada. No spaces or punctutation. L_EBAYITEMAUCTIONTXNID1). ACCT (Optional) Credit card number. including leading zero. Must conform with modulo and length required by each credit card type. L_EBAYITEMORDERID1). and Visa are allowable. Discover. (Optional) Card Verification Value. These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMAUCTIONTXNID0. Character length for Visa. Character length and limitations: Up to ten single-byte alphabetic characters. MasterCard. only Maestro. Interac debit cards are not supported. These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMORDERID0.12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field L_EBAYITEMAUCTIONTX NIDn Description (Optional) Auction transaction identification number. In addition. (Required) Payer’s first name.Character length: two numeric digits maximum.S. ZIP code or other country-specific postal code. (Optional) Phone number. Character length and limitations: 20 single-byte characters. Character length and limitations: 40 single-byte characters. Character length and limitations: 25 single-byte characters. Character length and limitations: 127 single-byte characters. Character length and limitations: 100 single-byte characters. Character length and limitations: 25 single-byte characters. Character limit: Two single-byte characters. (Required) Payer’s last name. (Optional) U. Character length and limit: 20 single-byte characters. (Optional) Second street address. Character length and limitations: 40 single-byte characters. (Optional) State or province. (Optional) Name of city. FIRSTNAME LASTNAME STREET2 CITY STATE COUNTRYCODE ZIP SHIPTOPHONENUM Name-Value Pair API Developer Guide September 2010 155 . Payer Information Fields Field EMAIL Description (Optional) Email address of payer. Address Fields Field STREET Description (Optional) First street address. ((Optional)) Country code.Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 Field ISSUENUMBER Description (Optional) Issue number of Maestro or Solo card. Character length and limitations: 100 single-byte characters. the filter ID. including the filter type (PENDING. and the entry number. CVV2MATCH BILLINGAGREEMENTID L_FMFfilterIDn L_FMFfilterNAMEn Payment Information Fields Field TRANSACTIONID Description Unique transaction ID of the payment. n. REPORT. n. Character length and limitations: 17 single-byte characters 156 September 2010 Name-Value Pair API Developer Guide . Returned if the value of ReferenceID in the request is a billing agreement identification number. the filter NAME. starting from 0. starting from 0. See “AVS Response Codes” on page 15 for possible values. or DENY). Character limit: One single-byte alphanumeric character Result of the CVV2 check by PayPal. Filter ID. including the filter type (PENDING. or DENY). and the entry number. REPORT. Filter ID is one of the following values:  1 = AVS No Match  2 = AVS Partial Match  3 = AVS Unavailable/Unsupported  4 = Card Security Code (CSC) Mismatch  5 = Maximum Transaction Amount  6 = Unconfirmed Address  7 = Country Monitor  8 = Large Order Number  9 = Billing/Shipping Address Mismatch  10 = Risky ZIP Code  11 = Suspected Freight Forwarder Check  12 = Total Purchase Price Minimum  13 = IP Address Velocity  14 = Risky Email Address Domain Check  15 = Risky Bank Identification Number (BIN) Check  16 = Risky IP Address Range  17 = PayPal Fraud Model Filter name.12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation DoReferenceTransaction Response Message DoReferenceTransaction Response Fields for Express Checkout Field AVSCODE Description Address Verification System response code. Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 Field PARENTTRANSACTIONID Description        Parent or related transaction identification number. This field is populated for the following transaction types: Reversal. Capture of an authorized transaction. Reversal. Reauthorization of a transaction. Capture of an order. The value of ParentTransactionID is the original OrderID. Authorization of an order. The value of ParentTransactionID is the original OrderID. Capture of an order authorization. Void of an order. The value of ParentTransactionID is the original OrderID. Character length and limits: 16 digits in xxxx-xxxx-xxxx-xxxx format RECEIPTID Receipt identification number Character length and limits: 16 digits in xxxx-xxxx-xxxx-xxxx format The type of transaction Valid values:  cart  express-checkout Character length and limitations:15 single-byte characters PAYMENTTYPE Indicates whether the payment is instant or delayed. Character length and limitations: Seven single-byte characters Valid values:  none  echeck  instant Time/date stamp of payment. For example: 2006-08-15T17:23:15Z. The final amount charged, including any shipping and taxes from your Merchant Profile. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD. A three-character currency code. PayPal fee amount charged for the transactionCharacter length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD. Amount deposited in your PayPal account after a currency conversion. TRANSACTIONTYPE ORDERTIME AMT CURRENCYCODE FEEAMT SETTLEAMT Name-Value Pair API Developer Guide September 2010 157 12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field TAXAMT Description Tax charged on the transaction. Character length and limitations: Does not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator is a period (.), and the optional thousands separator is a comma (,). Equivalent to nine characters maximum for USD. Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency. If the customer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the customer’s account.Character length and limitations: a decimal that does not exceed 17 characters, including decimal point Status of the payment. The status of the payment:  None: No status  Canceled-Reversal: A reversal has been canceled; for example, when you win a dispute and the funds for the reversal have been returned to you.  Completed: The payment has been completed, and the funds have been added successfully to your account balance.  Denied: You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element.  Expired: the authorization period for this payment has been reached.  Failed: The payment has failed. This happens only if the payment was made from your customer’s bank account.  In-Progress: The transaction has not terminated, e.g. an authorization may be awaiting completion.  Partially-Refunded: The payment has been partially refunded.  Pending: The payment is pending. See the PendingReason field for more information.  Refunded: You refunded the payment.  Reversed: A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer. The reason for the reversal is specified in the ReasonCode element.  Processed: A payment has been accepted.  Voided: An authorization for this transaction has been voided. EXCHANGERATE PAYMENTSTATUS 158 September 2010 Name-Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation 12 Field PENDINGREASON Description NOTE: PendingReason is returned in the response only if PaymentStatus is Pending. The reason the payment is pending:  none: No pending reason.  address: The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.  authorization: The payment is pending because it has been authorized but not settled. You must capture the funds first.  echeck: The payment is pending because it was made by an eCheck that has not yet cleared.  intl: The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview.  multi-currency: You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment.  order: The payment is pending because it is part of an order that has been authorized but not settled.  paymentreview: The payment is pending while it is being reviewed by PayPal for risk.  unilateral: The payment is pending because it was made to an email address that is not yet registered or confirmed.  verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.  other: The payment is pending for a reason other than those listed above. For more information, contact PayPal customer service. REASONCODE The reason for a reversal if TransactionType is reversal:  none: No reason code  chargeback: A reversal has occurred on this transaction due to a chargeback by your customer.  guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee.  buyer-complaint: A reversal has occurred on this transaction due to a complaint about the transaction from your customer.  refund: A reversal has occurred on this transaction because you have given the customer a refund.  other: A reversal has occurred on this transaction due to a reason not listed above. Name-Value Pair API Developer Guide September 2010 159 12 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field PROTECTIONELIGIBILI TY Description Prior to Version 64.4, the kind of seller protection in force for the transaction, which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received  PartiallyEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  Ineligible – Seller is not protected under the Seller Protection Policy Since Version 64.4, the kind of seller protection in force for the transaction, which is one of the following values:  Eligible – Seller is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received  ItemNotReceivedEligible – Seller is protected by PayPal's Seller Protection Policy for Item Not Received  UnauthorizedPaymentEligible – Seller is protected by PayPal's Seller Protection Policy for Unauthorized Payment  Ineligible – Seller is not protected under the Seller Protection Policy PROTECTIONELIGIBILI TYTYPE 160 September 2010 Name-Value Pair API Developer Guide 13   RefundTransaction API Operation Issue a refund to the PayPal account holder associated with a transaction. “RefundTransaction Request Message” on page 161 “RefundTransaction Response Message” on page 162 RefundTransaction Request Message RefundTransaction Request Fields Field METHOD TRANSACTIONID Description (Required) Must be RefundTransaction. (Required) Unique identifier of a transaction. Character length and limitations: 17 single-byte alphanumeric characters. (Optional) Your own invoice or tracking number. Character length and limitations: 127 single-byte alphanumeric characters Type of refund you are making:  Full - default  Partial (Optional) Refund amount. Amount is required if RefundType is Partial. NOTE: INVOICEID REFUNDTYPE AMT If RefundType is Full, do not set the Amount. CURRENCYCODE NOTE A three-character currency code. This field is required for partial refunds. Do not use this field for full refunds. (Optional) Custom memo about the refund. Character length and limitations: 255 single-byte alphanumeric characters. Name-Value Pair API Developer Guide September 2010 161 13 RefundTransaction API Operation RefundTransaction Response Message R e f u n d Tr a n s a c t i o n R e s p o n s e M e s s a g e RefundTransaction Response Fields Field REFUNDTRANSACTIONID Description Unique transaction ID of the refund. Amount subtracted from PayPal balance of original recipient of payment to make this refund. Total of all refunds associated with this transaction. Amount refunded to original payer. Character length and limitations:17 single-byte characters. Transaction fee refunded to original recipient of payment. FEEREFUNDAMT GROSSREFUNDAMT NETREFUNDAMT TOTALREFUNDEDAMT 162 September 2010 Name-Value Pair API Developer Guide . Can also be a non-primary email. this is the primary email. The value must be in UTC/GMT format. No wildcards are allowed. (Optional) Search by the PayPal Account Optional receipt ID. (Optional) Search by the buyer’s email address. (Optional) Search by the transaction ID. not the items purchased. Character length and limitations: 19 single-byte characters maximum. This field searches the records for items sold by the merchant. Name-Value Pair API Developer Guide September 2010 163 . as set by you for the original transaction. (Optional) Search by the receiver’s email address.14   TransactionSearch API Operation Search transaction history for transactions that meet the specified criteria. If the merchant account has only one email. NOTE: ENDDATE EMAIL RECEIVER RECEIPTID TRANSACTIONID INVNUM No wildcards are allowed. Character length and limitations: 127 single-byte alphanumeric characters. (Optional) The latest transaction date to be included in the search. “TransactionSearch Request Message” on page 163 “TransactionSearch Response Message” on page 165 TransactionSearch Request Message TransactionSearch Request Fields Field METHOD STARTDATE Description (Required) Must be TransactionSearch. (Required) The earliest transaction date at which to start the search. The returned results are from the merchant’s transaction records. (Optional) Search by invoice identification key. Character length and limitations: 127 single-byte characters maximum. Character length and limitations: Must be at least 11 and no more than 25 single-byte numeric characters maximum. not the items purchased. AUCTIONITEMNUMBER TRANSACTIONCLASS (Optional) Search by auction item number of the purchased goods. You cannot search for bank transfer withdrawals. 164 September 2010 Name-Value Pair API Developer Guide . NOTE: No wildcards are allowed. This field searches the records for items sold by the merchant. CURRENCYCODE (Optional) Search by currency code. such as dashes or spaces. for example. (Optional) Search by classification of transaction.14 TransactionSearch API Operation TransactionSearch Request Message Field ACCT Description (Optional) Search by credit card number. is ignored. Some kinds of possible classes of transactions are not searchable with this field. Special punctuation. as set by you for the original transaction.  All: all transaction classifications  Sent: only payments sent  Received: only payments received  MassPay: only mass payments  MoneyRequest: only money requests  FundsAdded: only funds added to balance  FundsWithdrawn: only funds withdrawn from balance  Referral: only transactions involving referrals  Fee: only transactions involving fees  Subscription: only transactions involving subscriptions  Dividend: only transactions involving dividends  Billpay: only transactions involving BillPay Transactions  Refund: only transactions involving funds  CurrencyConversions: only transactions involving currency conversions  BalanceTransfer: only transactions involving balance transfers  Reversal: only transactions involving BillPay reversals  Shipping: only transactions involving UPS shipping fees  BalanceAffecting: only transactions that affect the account balance  ECheck: only transactions involving eCheck (Optional) Search by transaction amount. NOTE: AMT You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.  Processing: The payment is being processed. (Optional) Payer’s last name Character length and limitations: 25 single-byte characters. Name-Value Pair API Developer Guide September 2010 165 .  Reversed: A payment was reversed due to a chargeback or other type of reversal. (Optional) Payer’s suffix Character length and limitations: 12 single-byte characters. Payer Name Fields Field SALUTATION Description (Optional) Payer’s salutation. Character length and limitations: 25 single-byte characters. The funds have been removed from your account balance and returned to the buyer.  Denied: You denied the payment. Character length and limitations: 20 single-byte characters. FIRSTNAME MIDDLENAME LASTNAME SUFFIX TransactionSearch Response Message TransactionSearch Response Fields Field L_TIMESTAMPn L_TIMEZONEn L_TYPEn Description The date and time (in UTC/GMT format) the transaction occurred. This happens only if the payment was previously pending. (Optional) Payer’s middle name. The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason field. The time zone of the transaction.  Success: The payment has been completed and the funds have been added successfully to your account balance. Character length and limitations: 25 single-byte characters. The type of the transaction.TransactionSearch API Operation TransactionSearch Response Message 14 Field STATUS Description (Optional) Search by transaction status:  Pending: The payment is pending. (Optional) Payer’s first name. L_NAMEn L_TRANSACTIONIDn L_STATUSn L_AMTn L_FEEAMTn L_NETAMTn 166 September 2010 Name-Value Pair API Developer Guide . Seller’s transaction ID. Display name of the payer. The status of the transaction. The total gross amount charged. The net amount of the transaction. The fee that PayPal charged for the transaction. If the payment is negative.14 TransactionSearch API Operation TransactionSearch Response Message Field L_EMAILn Description The email address of either the payer or the payment recipient (the “payee”). this field is the recipient of the funds. If the payment amount is positive. this field is the paying customer. including any profile shipping cost and taxes. “General API Errors” on page 168 “Validation Errors” on page 169 “DirectPayment API Errors” on page 173 “SetExpressCheckout API Errors” on page 185 “GetExpressCheckoutDetails API Errors” on page 199 “DoExpressCheckoutPayment API Errors” on page 201 “Authorization and Capture API Errors” on page 210 “GetTransactionDetails API Errors” on page 214 “TransactionSearch API Errors” on page 214 “RefundTransaction API Errors” on page 216 “MassPay API Errors” on page 219 “Recurring Payments Errors” on page 221 “SetCustomerBillingAgreement Errors” on page 222 “GetBillingAgreementCustomerDetails Errors” on page 224 “CreateBillingAgreement Errors” on page 224 “UpdateBillingAgreement Errors” on page 226 “DoReferenceTransaction Errors” on page 226 “AddressVerify API Errors” on page 233 “ManagePendingTransactionStatus API Errors” on page 233 Name-Value Pair API Developer Guide September 2010 167 .A                    API Error Codes The PayPal API can return multiple errors for any operation. 10002 10002 10006 10008 10101 Authentication/Authoriza tion Failed Authentication/Authoriza tion Failed Version error Security error This API Temporarily Unavailable API access is disabled for this account Client certificate is disabled Version is not supported Security header is not valid This API is temporarily unavailable. Contact your PayPal account manager for resolution.A API Error Codes General API Errors General API Errors General API Errors Error Code 10002 Short Message Authentication/Authoriza tion Failed Long Message Username/Password is incorrect Correcting This Error This error can be caused by an incorrect API username. or an invalid API signature. Please try later. For your security. 10002 10002 10002 10002 10002 10002 10002 10002 Authentication/Authoriza tion Failed Authentication/Authoriza tion Failed Internal Error Authentication/Authoriza tion Failed Authentication/Authoriza tion Failed Authentication/Authoriza tion Failed Authentication/Authoriza tion Failed Restricted account You do not have permission to make this API call Account is locked or inactive Internal Error Internal Error Account is not verified This call is not defined in the database! Token is not valid Account is restricted Your PayPal merchant account has been restricted. Make sure that all three of these values are correct. 168 September 2010 Name-Value Pair API Developer Guide . an incorrect API password. PayPal does not report exactly which of these three values might be in error. API Error Codes Validation Errors A Va l i d a t i o n E r r o r s Validation Errors Error Code 81000 81001 81002 81003 81004 81100 81101 81102 81103 81104 81105 81106 81107 81108 81109 81110 81111 81112 81113 81114 81115 81116 81117 81118 81119 81120 81121 Short Message Missing Parameter Invalid Parameter Unspecified Method Unspecified Method Unspecified Method Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Long Message Required Parameter Missing : Unable to identify parameter A Parameter is Invalid : Unable to identify parameter Method Specified is not Supported No Method Specified No Request Received OrderTotal (Amt) : Required parameter missing MaxAmt : Required parameter missing ReturnURL: Required parameter missing NotifyURL : Required parameter missing CancelURL : Required parameter missing ShipToStreet : Required parameter missing ShipToStreet2 : Required parameter missing ShipToCity : Required parameter missing ShipToState : Required parameter missing ShipToZip : Required parameter missing Country : Required parameter missing ReqConfirmShipping : Required parameter missing NoShipping : Required parameter missing AddrOverride : Required parameter missing LocaleCode : Required parameter missing PaymentAction : Required parameter missing Email : Required parameter missing Token : Required parameter missing PayerID : Required parameter missing ItemAmt : Required parameter missing ShippingAmt : Required parameter missing HandlingAmt : Required parameter missing Name-Value Pair API Developer Guide September 2010 169 . A API Error Codes Validation Errors Error Code 81122 81123 81124 81125 81126 81127 81128 81129 81130 81131 81132 81133 81134 81135 81136 81137 81138 81139 81140 81141 81142 81143 81144 81145 81146 81147 81148 81149 81150 81200 81201 Short Message Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Missing Parameter Invalid Parameter Long Message TaxAmt : Required parameter missing IPAddress : Required parameter missing ShipToName : Required parameter missing L_Amt : Required parameter missing Amt : Required parameter missing L_TaxAmt : Required parameter missing AuthorizationID : Required parameter missing CompleteType : Required parameter missing CurrencyCode : Required parameter missing TransactionID : Required parameter missing TransactionEntity : Required parameter missing Acct : Required parameter missing ExpDate : Required parameter missing FirstName : Required parameter missing LastName : Required parameter missing Street : Required parameter missing Street2 : Required parameter missing City : Required parameter missing State : Required parameter missing Zip : Required parameter missing CountryCode : Required parameter missing RefundType : Required parameter missing StartDate : Required parameter missing EndDate : Required parameter missing MPID : Required parameter missing CreditCardType : Required parameter missing User : Required parameter missing Pwd : Required parameter missing Version : Required parameter missing Amt : Invalid parameter MaxAmt : Invalid parameter 170 September 2010 Name-Value Pair API Developer Guide . API Error Codes Validation Errors A Error Code 81203 81205 81206 81207 81208 81209 81210 81211 81212 81213 81214 81215 81219 81220 81221 81222 81223 81224 81225 81226 81227 81229 81230 81232 81234 81235 81236 81237 81238 81239 81243 Short Message Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Long Message NotifyURL : Invalid parameter ShipToStreet : Invalid parameter ShipToStreet2 : Invalid parameter ShipToCity : Invalid parameter ShipToState : Invalid parameter ShipToZip : Invalid parameter Country : Invalid parameter ReqConfirmShipping : Invalid parameter Noshipping : Invalid parameter AddrOverride : Invalid parameter LocaleCode : Invalid parameter PaymentAction : Invalid parameter ItemAmt : Invalid parameter ShippingAmt : Invalid parameter HandlingTotal Amt : Invalid parameter TaxAmt : Invalid parameter IPAddress : Invalid parameter ShipToName : Invalid parameter L_Amt : Invalid parameter Amt : Invalid parameter L_TaxAmt : Invalid parameter CompleteType : Invalid parameter CurrencyCode : Invalid parameter TransactionEntity : Invalid parameter ExpDate : Invalid parameter FirstName : Invalid parameter LastName : Invalid parameter Street : Invalid parameter Street2 : Invalid parameter City : Invalid parameter RefundType : Invalid parameter Name-Value Pair API Developer Guide September 2010 171 . A API Error Codes Validation Errors Error Code 81244 81245 81247 81248 81249 81250 81251 99998 Short Message Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Invalid Parameter Internal Error Transaction refused because of an invalid argument. See additional error messages for details. Long Message StartDate : Invalid parameter EndDate : Invalid parameter CreditCardType : Invalid parameter Username : Invalid parameter Password : Invalid parameter Version : Invalid parameter Internal Service Error Currency is not supported 172 September 2010 Name-Value Pair API Developer Guide . This transaction cannot be processed due to an invalid merchant configuration. Invalid argument Invalid Configuration Invoice ID value exceeds maximum allowable length. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Shipping total is invalid. because of an invalid argument. The currencies of the shopping Transaction refused cart amounts must be the same. Tax total is invalid. Corrective Action 10401 Order total is missing. See additional error messages for details. Please try later or use other PaymentAction. See additional error messages for details. See additional error messages for details. Occurs when you have not agreed to the billing agreement. Item total is invalid. Handling total is invalid. Occurs when the billing agreement is disabled or inactive. See additional error messages for details.API Error Codes DirectPayment API Errors A DirectPayment API Errors DirectPayment API Errors Error Code 10102 Short Message PaymentAction of Order Temporarily Unavailable Long Message PaymentAction of Order is temporarily unavailable. See additional error messages for details. Transaction refused because of an invalid argument. This transaction cannot be processed due to an invalid merchant configuration. See additional error messages for details. Transaction refused because of an invalid argument. 10418 10426 10427 10428 10429 10432 10500 10501 Invalid Configuration Name-Value Pair API Developer Guide September 2010 173 . Transaction refused because of an invalid argument. Please enter a valid credit card. Corrective Action The credit card used is expired. Please enter a credit card. Please enter a valid Credit Card Verification Number. This transaction cannot be processed. The total amount and item amounts do not match. This transaction cannot be processed. The merchant selected a value for the PaymentAction field that is not supported. This transaction cannot be processed. The first name of the buyer is required for this merchant. Please enter a valid credit card expiration date. This transaction cannot be processed. Please contact PayPal Customer Service.A API Error Codes DirectPayment API Errors Error Code 10502 Short Message Invalid Data Long Message This transaction cannot be processed. 10507 Invalid Configuration This transaction cannot be processed.this is a PayPal internal error. This transaction cannot be processed. You must submit an IP address of the buyer with each API call. This transaction cannot be processed. Try another card type. Please enter a last name. and the merchant account is not able to accept such transactions. 10504 Invalid Data The CVV provided is invalid. 10505 Gateway Decline The transaction was refused because the AVS response returned the value of N. The CVV is between 3-4 digits long. This transaction cannot be processed. This transaction cannot be processed. This transaction cannot be processed. This transaction cannot be processed. The last name of the buyer is required for this merchant. 174 September 2010 Name-Value Pair API Developer Guide . 10508 Invalid Data 10509 10510 10511 Invalid Data Invalid Data Invalid Data 10512 Invalid Data 10513 Invalid Data 10519 10520 10521 Invalid Data Invalid Data Invalid Data 10523 Internal Error None . The credit card entered is invalid. Please enter a first name. The credit card field was blank. Your PayPal account is restricted contact PayPal for more information. Please use a valid credit card. The credit card type is not supported. The credit card type entered is not currently supported by PayPal. The expiration date must be a two-digit month and four-digit year. The transaction was declined by the maximum amount filter managed by the merchant. The credit card entered is invalid. change your risk settings on PayPal. This transaction cannot be processed. 10535 Gateway Decline 10536 Invalid Data The merchant entered an invoice ID that is already associated with a transaction by the same merchant. To accept this transaction. By default. The credit card entered is currently restricted by PayPal. This transaction cannot be processed. 10541 Gateway Decline 10542 Invalid Data Name-Value Pair API Developer Guide September 2010 175 . The transaction was declined by PayPal. Please enter a valid credit card number and type. change your risk settings on PayPal. Please enter a valid email address. This transaction cannot be processed. Corrective Action The merchant entered a amount of zero. Please enter a valid credit card number and type. Please enter a valid credit card number and type. The amount to be charged is zero. Contact PayPal for more information. 10539 10540 Filter Decline Invalid Data This transaction cannot be processed. To accept this transaction. To change this setting. log into PayPal or contact customer service. This transaction cannot be processed. Please enter a valid credit card number and type. 10537 Filter Decline This transaction cannot be processed.API Error Codes DirectPayment API Errors A Error Code 10525 Short Message Invalid Data Long Message This transaction cannot be processed. This transaction cannot be processed. This transaction cannot be processed. 10538 Filter Decline This transaction cannot be processed. Contact PayPal for more information. The transaction cannot be processed due to an invalid address. The email address provided by the buyer is in an invalid format. Contact PayPal for more information. This transaction cannot be processed. The credit card entered is invalid. The transaction was declined by PayPal because of an invalid address. 10527 Invalid Data 10534 Gateway Decline The credit card entered is currently restricted by PayPal. the invoice ID must be unique for all transactions. 10526 Invalid Data The currency code entered is not supported. The transaction was declined by the country filter managed by the merchant. The currency is not supported at this time. This transaction cannot be processed. Contact PayPal for more information. Check your account settings. 10554 Filter Decline 10555 Filter Decline This transaction cannot be processed. This transaction cannot be processed. 10549 Invalid Configuration 10550 Invalid Configuration 10552 Invalid Configuration 10553 Gateway Decline This transaction cannot be processed. The merchant’s account is not able to process transactions. This transaction cannot be processed. The transaction was declined by PayPal because of possible fraudulent activity. The transaction was declined because of a merchant risk filter for AVS. The transaction was declined because of a merchant risk filter for AVS. The merchan’s account is not able to process transactions. The transaction was declined by PayPal because of possible fraudulent activity on the IP address. The merchant account attempting the transaction does not have a confirmed email address with PayPal. Contact PayPal for more information. Access to Direct Payment was disabled for your account. Contact PayPal for more information.this is a PayPal internal error. Check your account settings. The merchant account attempting the transaction is not a business account at PayPal. This transaction cannot be processed. Contact PayPal for more information. Corrective Action The transaction was declined by PayPal. This transaction cannot be processed. The merchant attempted a transaction where the amount exceeded the upper limit for that merchant. 10546 Gateway Decline 10547 10548 Internal Error Invalid Configuration This transaction cannot be processed. This transaction cannot be processed. Contact PayPal for more information. The merchant account attempting the transaction is not able to process Direct Payment transactions. 176 September 2010 Name-Value Pair API Developer Guide . This transaction cannot be processed.A API Error Codes DirectPayment API Errors Error Code 10544 10545 Short Message Gateway Decline Gateway Decline Long Message This transaction cannot be processed. the merchant has set to decline transaction when the AVS returned a partial match. None . Specifically. Specifically. the merchant has set to decline transaction when the AVS returned a no match (AVS = N). although the Card Security Code (CSC) had too few. The long error message will tell you what field is invalid. If you want to require valid CVV values. or invalid characters. This transaction cannot be processed. 10702 Invalid Data Name-Value Pair API Developer Guide September 2010 177 . There was a problem processing this transaction.API Error Codes DirectPayment API Errors A Error Code 10556 Short Message Filter Decline Long Message This transaction cannot be processed. but with invalid Card Security Code (CSC) format. Specifically. The long error message will tell you what field is invalid. the invalid CSC was not given to the card issuer for its approval process. Corrective Action The transaction was declined because of a merchant risk filter for AVS. too many. 10561 Invalid Data There’s an error with this transaction. This transaction was approved. the merchant has set to decline transaction when the AVS was unsupported. Please enter a valid address1 in the billing address. There’s an error with this transaction. This transaction cannot be processed. Please enter complete billing address. Please enter a valid credit card expiration year. Please enter a valid billing address. change the risk control settings in your account profile. This transaction cannot be processed. Based on your account profile settings. 10562 Invalid Data 10563 Invalid Data 10564 10565 10566 10567 Gateway Decline Merchant country unsupported Credit card type unsupported Invalid Data 10571 Transaction approved. Please enter a valid credit card number and type. This transaction cannot be processed. Please enter a valid credit card expiration month. The credit card type is not supported. There’s an error with this transaction. The merchant country is not supported. There was a problem with a particular field in the address. 10701 Invalid Data There was a problem with a particular field in the address. Please enter an address1 in the billing address. Please enter a valid address2 in the billing address. The long error message will tell you what field is invalid. There was a problem with a particular field in the address. There’s an error with this transaction. The long error message will tell you what field is invalid. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. There’s an error with this transaction. Please enter a city in the billing address. There was a problem with a particular field in the address.A API Error Codes DirectPayment API Errors Error Code 10703 Short Message Invalid Data Long Message There’s an error with this transaction. Please enter an address1 in the billing address. The long error message will tell you what field is invalid. Please enter a valid state in the billing address. Corrective Action There was a problem with a particular field in the address. There was a problem with a particular field in the address. There’s an error with this transaction. There was a problem with a particular field in the address. There’s an error with this transaction. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. Please enter a complete billing address. There’s an error with this transaction. There’s an error with this transaction. Please enter a valid country in the billing address. There was a problem with a particular field in the address. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. There’s an error with this transaction. Please enter a valid postal code in the billing address. 10704 Invalid Data 10705 Invalid Data 10706 Invalid Data 10707 Invalid Data 10708 Invalid Data 10709 Invalid Data 10709 Invalid Data 10710 Invalid Data 10710 Invalid Data 178 September 2010 Name-Value Pair API Developer Guide . The long error message will tell you what field is invalid. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. Please enter a city in the billing address. Please enter a valid city in the billing address. The long error message will tell you what field is invalid. There’s an error with this transaction. There’s an error with this transaction. The long error message will tell you what field is invalid. Please enter a valid billing address. There was a problem with a particular field in the address. There’s an error with this transaction. There’s an error with this transaction. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. There’s an error with this transaction. Please enter a valid city and state in the billing address. The long error message will tell you what field is invalid. There was a problem with a particular field in the address. There was a problem with a particular field in the address. There’s an error with this transaction. There’s an error with this transaction. There’s an error with this transaction. Corrective Action There was a problem with a particular field in the address. There was a problem with a particular field in the address. There’s an error with this transaction. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. There’s an error with this transaction. The long error message will tell you what field is invalid. There’s an error with this transaction. Please enter a valid postal code in the billing address. Please enter your five digit postal code in the billing address. There was a problem with a particular field in the address.API Error Codes DirectPayment API Errors A Error Code 10711 Short Message Invalid Data Long Message There’s an error with this transaction. Please enter a valid shipping address. There was a problem with a particular field in the address. Please enter a country in the billing address. There was a problem with a particular field in the address. There was a problem with a particular field in the address. Please enter a valid state in the billing address. Please enter your state in the billing address. 10712 Invalid Data 10713 Invalid Data 10713 Invalid Data 10714 Invalid Data 10715 Invalid Data 10716 Invalid Data 10717 Invalid Data 10718 Invalid Data 10719 Invalid Data Name-Value Pair API Developer Guide September 2010 179 . The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. Please enter a country in the billing address. The long error message will tell you what field is invalid. Please enter your five digit postal code in the billing address. There’s an error with this transaction. Please enter a complete shipping address. Please enter a valid address1 in the shipping address. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid.A API Error Codes DirectPayment API Errors Error Code 10720 Short Message Invalid Data Long Message There’s an error with this transaction. There was a problem with a particular field in the address. Please enter a valid country in the shipping address. There’s an error with this transaction. There was a problem with a particular field in the address. There’s an error with this transaction. There’s an error with this transaction. There’s an error with this transaction. The long error message will tell you what field is invalid. Please enter your five digit postal code in the shipping address. There was a problem with a particular field in the address. Please enter a valid city in the shipping address. Please enter an address1 in the shipping address. There’s an error with this transaction. Please enter a valid address2 in the shipping address. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. Please enter a valid state in the shipping address. There was a problem with a particular field in the address. 10721 Invalid Data 10722 Invalid Data 10723 Invalid Data 10724 Invalid Data 10725 Invalid Data 10726 Invalid Data 10726 Invalid Data 10727 Invalid Data 10727 Invalid Data 180 September 2010 Name-Value Pair API Developer Guide . There was a problem with a particular field in the address. There’s an error with this transaction. Please enter a complete shipping address. There’s an error with this transaction. Corrective Action There was a problem with a particular field in the address. Please enter an address1 in the shipping address. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. There’s an error with this transaction. The long error message will tell you what field is invalid. There was a problem with a particular field in the address. API Error Codes DirectPayment API Errors A Error Code 10728 Short Message Invalid Data Long Message There’s an error with this transaction. Please enter a country in the shipping address. There was a problem with a particular field in the address. There’s an error with this transaction. Please enter a city in the shipping address. Corrective Action There was a problem with a particular field in the address. Please enter a valid shipping address. There’s an error with this transaction. There’s an error with this transaction. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. There’s an error with this transaction. There was a problem with a particular field in the address. 10728 Invalid Data 10729 Invalid Data 10730 Invalid Data 10731 Invalid Data 10731 Invalid Data 10732 Invalid Data 10733 Invalid Data 10734 Invalid Data 10735 Invalid Data Name-Value Pair API Developer Guide September 2010 181 . The long error message will tell you what field is invalid. Please enter your five digit postal code in the shipping address. There’s an error with this transaction. There was a problem with a particular field in the address. There’s an error with this transaction. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. There was a problem with a particular field in the address. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. The long error message will tell you what field is invalid. Please enter your state in the shipping address. There was a problem with a particular field in the address. The long error message will tell you what field is invalid. There was a problem with a particular field in the address. There’s an error with this transaction. Please enter a valid state in the shipping address. Please enter a country in the shipping address. There’s an error with this transaction. Please enter your five digit postal code in the shipping address. Please enter your five digit postal code in the shipping address. There was a problem with a particular field in the address. There’s an error with this transaction. Please enter a city in the shipping address. but the state provided is not a valid state in either country. The long error message will tell you what field is invalid. There’s an error with this transaction. The IP address must be in a format such as 123.456. There was a problem with a particular field in the address. Contact PayPal if you wish to change this setting. The merchant provided an address either in the United States or Canada. The merchant should attempt another card. This transaction cannot be processed due to an unsupported currency. 10750 Invalid Data 10751 Invalid Data 10752 Gateway Decline 10754 10755 Gateway Decline Invalid Data 182 September 2010 Name-Value Pair API Developer Guide . The long error message will tell you what field is invalid.123. Corrective Action There was a problem with a particular field in the address. There was a problem with a particular field in the address. The transaction was declined by the issuing bank. The transaction was declined by PayPal. not PayPal. This transaction cannot be processed. but no CVV was provided with this transaction. The merchant entered an IP address that was in an invalid format. The long error message will tell you what field is invalid.A API Error Codes DirectPayment API Errors Error Code 10736 Short Message Invalid Data Long Message There’s an error with this transaction. There was a problem with a particular field in the address. There’s an error with this transaction. There was a problem with a particular field in the address. Please enter a valid state in the shipping address. The currency code entered by the merchant is not supported. This transaction cannot be processed.456. The merchant’s configuration requires a CVV to be entered. Please enter a valid city and state in the shipping address. The long error message will tell you what field is invalid. This transaction cannot be processed. Contact PayPal for more information. Please enter a valid country code in the billing address. This transaction cannot be processed. Please use a valid country on the billing address. Please enter a valid country code in the shipping address. This transaction cannot be processed. Please enter a valid state in the billing address. The long error message will tell you what field is invalid. 10744 Invalid Data 10745 Invalid Data 10746 Invalid Data 10747 Invalid Data 10748 Invalid Data This transaction cannot be processed without a Credit Card Verification Number. This transaction cannot be processed. The transaction was declined by PayPal. This transaction cannot be processed at this time. You can control whether a Fraud Management Filter will deny a transaction by changing the filter's settings in the profile. Please enter a valid credit card number and type. This transaction cannot be processed. Please try again later.this is a PayPal internal error. Please check the status of your first transaction before placing another order. Can occur when a buyer submits multiple. Please try again later. Corrective Action None . 10759 Gateway Decline 10760 Invalid Configuration 10761 Gateway Decline 10762 10763 10764 Gateway Decline Invalid Data This transaction cannot be processed at this time. Payment Pending your review in Fraud Management Filters Transaction blocked by your settings in FMF Could not process your request to accept/deny the transaction This transaction cannot be processed This transaction cannot be processed.API Error Codes DirectPayment API Errors A Error Code 10756 Short Message Gateway Decline Long Message The transaction cannot be processed. Name-Value Pair API Developer Guide September 2010 183 . Contact PayPal for more information. please contact PayPal. This transaction cannot be processed. This transaction cannot be processed. The country listed for your business address is not currently supported. The CVV is between 3-4 digits long. The CVV provide is invalid.this is a PayPal internal error. This transaction cannot be processed. If the problem persists. The transaction was declined by PayPal. identical transactions in quick succession. Payment Pending your review in Fraud Management Filters Transaction blocked by your settings in FMF Could not process your request to accept/deny the transaction This transaction cannot be processed because it has already been denied by a Fraud Management Filter 11610 11611 11612 11821 You cannot capture a payment after it has been denied by a Fraud Management Filter. There’s been an error due to invalid API username and/or password. Please try again later. 10758 Invalid Configuration The API username or password is incorrect for this merchant. The country and billing address associated with this credit card do not match. The transaction was declined because PayPal is currently processing a transaction by the same buyer for the same amount. None . The merchant’s country of residence listed in their PayPal account is not currently supported to allow Direct Payment transactions. This transaction cannot be processed. The merchant should attempt another card. not PayPal. Transaction is not compliant due to missing or invalid 3-D Secure authentication values. The transaction was declined because the CVV entered does not match the credit card. This transaction cannot be processed. Please enter a valid credit card number and type. This transaction cannot be processed. 12001 Check ECI. Please use a valid credit card. Contact PayPal for more information. 15001 The transaction was rejected by PayPal because of excessive failures over a short period of time for this credit card. The transaction was declined by the issuing bank. The merchant should attempt another card. Transaction is not compliant due to missing or invalid 3-D Secure authentication values. not PayPal. This transaction has been completed. Gateway Decline Long Message Transaction is not compliant due to missing or invalid 3-D Secure authentication values. Corrective Action Check ECI. 15004 Gateway Decline This transaction cannot be processed. 15002 15003 Gateway Decline Invalid Configuration This transaction cannot be processed. This transaction cannot be processed. but the total of items in the cart did not match the total of all items. This transaction cannot be processed.A API Error Codes DirectPayment API Errors Error Code 12000 Short Message Transaction is not compliant due to missing or invalid 3-D Secure authentication values. 15005 Processor Decline 15006 Processor Decline 15007 Processor Decline 15008 Invalid Data 184 September 2010 Name-Value Pair API Developer Guide . ECI3DS. XID fields. Contact PayPal for more information. Contact PayPal for more information. The transaction was declined because the merchant does not have a valid commercial entity agreement on file with PayPal. CAVV. ECI3DS. The transaction was declined by the issuing bank. CAVV. Please enter a valid Credit Card Verification Number. The transaction was declined by the issuing bank because of an expired credit card. The transaction was declined by PayPal. The merchant should attempt another card. XID fields. Missing argument. 10004 Transaction refused because of an invalid argument. OtherPaymentMethodLabel is missing. Internal Error Missing argument. See additional error messages for details. One or more of these giropay URLs is missing: giropaySuccessURL.. See additional error messages for details. Transaction refused because of an invalid argument. Name-Value Pair API Developer Guide September 2010 185 .API Error Codes SetExpressCheckout API Errors A SetExpressCheckout API Errors SetExpressCheckout API Errors Error Code 10001 10001 10003 10003 10003 10003 Short Message ButtonSource value truncated. 10004 RegistrationDate of buyer is invalid. 10004 OtherPaymentMethodType is invalid. 10004 Invalid item URL. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. OtherPaymentMethodType is missing. 10004 10004 Invalid value for request billing address parameter. Missing argument. Missing argument.. Transaction refused because of an invalid argument. BanktxnPendingURL. Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details. See additional error messages for details. See additional error messages for details. The transaction id is not valid Correcting This Error. Long Message The transaction could not be loaded Internal Error OtherPaymentMethodID is missing. See additional error messages for details. Transaction refused because of an invalid argument. giropayCancelURL. 10004 Invalid eBay buyer feedback recent negative count. See additional error messages for details.. See additional error messages for details. 186 September 2010 Name-Value Pair API Developer Guide .. 10004 Invalid eBay seller feedback overall positive count.A API Error Codes SetExpressCheckout API Errors Error Code 10004 Short Message Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. See additional error messages for details. 10004 Invalid eBay buyer feedback total negative count. See additional error messages for details. Transaction refused because of an invalid argument. 10004 Invalid eBay buyer feedback recent positive count. 10004 Invalid eBay buyer feedback overall negative count. See additional error messages for details. 10004 Invalid eBay seller feedback overall negative count. See additional error messages for details. 10004 Invalid eBay seller feedback total positive count. Correcting This Error. Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details. 10004 Invalid eBay buyer feedback total positive count. See additional error messages for details. 10004 SellerRegistrationDate is invalid. See additional error messages for details. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Long Message Invalid eBay buyer feedback overall positive count. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. Permission denied Long Message Invalid eBay seller feedback total negative count.API Error Codes SetExpressCheckout API Errors A Error Code 10004 Short Message Transaction refused because of an invalid argument.. 10004 Invalid eBay seller feedback recent negative count. Transaction refused because of an invalid argument. You do not have permission to make this API call 10005 10005 10005 10007 Name-Value Pair API Developer Guide September 2010 187 . See additional error messages for details. 10004 Invalid eBay seller feedback recent positive count. It must be 0 or 1 or an empty string.. See additional error messages for details. Merchant not enabled to use OtherPaymentMethodDetails. Option not supported. Transaction refused because of an invalid argument. See additional error messages for details. 10004 Invalid eBay item transaction date. Transaction ID is not supported. Transaction refused because of an invalid argument. See additional error messages for details. Merchant not enabled to use enhanced checkout data. Option not supported. Option not supported. Transaction refused because of an invalid argument. 10004 Invalid eBay item buyer protection type. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Correcting This Error. 10004 AllowPushFunding value specified is invalid. 10004 Multiple eBay order IDs not allowed. See additional error messages for details. See additional error messages for details. 10004 Invalid eBay item payment hold risk. See additional error messages for details. ReturnURL is missing. please use another Solution Type. See additional error messages for details.. Transaction refused because of an invalid argument. See additional error messages for details. Please try later. Your Solution Type is temporarily unavailable. Correcting This Error. OrderTotal is missing. Invalid token 10405 CancelURL is missing. Please contact Customer Service. See additional error messages for details. 10404 Transaction refused because of an invalid argument. See additional error messages for details. Invalid token. You’re not authorized to access this info. Express Checkout temporarily unavailable. Transaction refused because of an invalid argument. 10410 188 September 2010 Name-Value Pair API Developer Guide . Long Message Non-ASCII invoice id is not supported. Transaction refused because of an invalid argument. If possible. See additional error messages for details. 10402 This merchant account is not permitted to set PaymentAction to Authorization. 10103 10400 10401 Order total is invalid.A API Error Codes SetExpressCheckout API Errors Error Code 10010 10101 10102 Short Message Invalid Invoice Option not supported. 10407 Invalid buyer email address (BuyerEmail). PaymentAction of Order Temporarily Unavailable Please use another Solution Type. Authorization only is not allowed for merchant. Please try later or use other PaymentAction.. PaymentAction of Order is temporarily unavailable. 10409 Express Checkout token was issued for a merchant account other than yours. Transaction refused because of an invalid argument. 10413 Transaction refused because of an invalid argument. If you receive this error. If you get this error. You might also want to update the values for ReturnURL and CancelURL. because you already know the final OrderTotal.API Error Codes SetExpressCheckout API Errors A Error Code 10411 Short Message This Express Checkout session has expired. Long Message This Express Checkout session has expired. Token value is no longer valid. if necessary. (Do not reuse the expired token value on SetExpressCheckout request. Correcting This Error.) However... and provide a button to return to PayPal. See additional error messages for details The totals of the cart item amounts do not match order amounts. you must return your customer to PayPal to approve the use of PayPal again. Name-Value Pair API Developer Guide September 2010 189 . research why might occur and modify your implementation of Express Checkout to ensure that you generate unique invoice identification numbers. PayPal checks that InvoiceID values are unique for any particular merchant. Display an error message to inform the customer that the transaction expired. You might not be able to correct this error during an actual checkout. you are effectively restarting the entire checkout process. be sure to update the value for that element if appropriate. PayPal returns error code 10412. If you send an InvoiceID value already associated with another transaction in the PayPal system. 10412 Duplicate invoice Payment has already been made for this InvoiceID. In this situation. Correcting This Error. 10426 10427 Shipping total is invalid. 10418 Transaction refused because of an invalid argument. See additional error messages for details The currencies of the shopping cart amounts must be the same. See additional error messages for details Transaction refused because of an invalid argument.A API Error Codes SetExpressCheckout API Errors Error Code 10415 Short Message Transaction refused because of an invalid argument. 10425 Express Checkout has been disabled for this merchant. PayPal allows a token only once for a successful transaction. 190 September 2010 Name-Value Pair API Developer Guide . Please contact Customer Service.. See additional error messages for details Transaction refused because of an invalid argument. 10431 Item amount is invalid. See additional error messages for details. PayPal recommends that you disable the button after your customer has clicked it. See additional error messages for details Express Checkout has been disabled for this merchant. Long Message A successful transaction has already been completed for this token. Transaction refused because of an invalid argument. Handling this error If you determine that your customers are clicking your “Place Order” button twice.. See additional error messages for details Transaction refused because of an invalid argument. Item total is invalid. See additional error messages for details Transaction refused because of an invalid argument. 10430 Item amount is missing. 10428 Handling total is invalid. See additional error messages for details Transaction refused because of an invalid argument. 10429 Tax total is invalid. Sale is only allowed PaymentAction.. 10437 cpp-header-image value exceeds maximum allowable length. Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details. 10438 cpp-header-image value exceeds maximum allowable length. Transaction refused because of an invalid argument. Name-Value Pair API Developer Guide September 2010 191 . See additional error messages for details. Transaction refused because of an invalid argument. 10440 cpp-header-image value exceeds maximum allowable length. Long Message Invoice ID value exceeds maximum allowable length. See additional error messages for details. See additional error messages for details ButtonSource value truncated. 10436 PageStyle value exceeds maximum allowable length. See additional error messages for details. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. See additional error messages for details Transaction refused because of an invalid argument. 10442 10446 The ButtonSource element value exceeds maximum allowable length. See additional error messages for details Transaction refused because of an invalid argument.API Error Codes SetExpressCheckout API Errors A Error Code 10432 Short Message Transaction refused because of an invalid argument. 10434 Value of Custom element has been truncated. 10441 The NotifyURL element value exceeds maximum allowable length.. Transaction refused because of an invalid argument. 10439 cpp-header-image value exceeds maximum allowable length. 10433 Value of Order Description has been truncated. Correcting This Error. removed. or unavailable Order not found eBay user password incorrect Item ID and Transaction ID mismatch eBay user invalid Duplicate Item ID Duplicate Order ID Correcting This Error. 10469 10470 10471 Express Auctions is unavailable Solution Type passed as Sole while ExpressO feature is turned off ReturnURL is missing 10472 CancelURL is missing 10473 Multiple Order IDs are not supported 192 September 2010 Name-Value Pair API Developer Guide ..A API Error Codes SetExpressCheckout API Errors Error Code 10457 10458 10459 10460 10461 10462 10463 10464 10465 10467 10468 Short Message Error occurred in communicating to eBay Error occurred in communicating to eBay Error occurred in communicating to eBay Error occurred in communicating to eBay Error occurred in communicating to eBay Error occurred in communicating to eBay Error occurred in communicating to eBay Error occurred in communicating to eBay Error occurred in communicating to eBay Error occurred in communicating to eBay Transaction refused because of an invalid argument. See additional error messages for details Error occurred in communicating to eBay Long Message eBay API creation error eBay API unknown failure eBay API failure Parsing error Item number invalid.. See additional error messages for details Transaction refused because of an invalid argument. See additional error messages for details PaymentAction of Order Temporarily Unavailable Wowo flag is off for ExpressO feature Transaction refused because of an invalid argument. 10475 Transaction refused because of an invalid argument..API Error Codes SetExpressCheckout API Errors A Error Code 10474 Short Message Invalid Data Long Message This transaction cannot be processed. See additional error messages for details Invalid Data Invalid Data Invalid Data 10476 10477 10478 Maximum number of billing agreements exceeded More than one billing agreement specified for reference transaction Recurring payments profile description must be provided if the billing agreement type is recurring payments Billing agreement types cannot be mixed in the same request Invalid billing agreement type The transaction was refused because the country was prohibited as a result of your Country Monitor Risk Control Settings. Payment declined by your Risk Controls settings: PayPal Risk Model. There was an error in the Shipping Address Country field The field Shipping Address1 is required The field Shipping Address City is required The field Shipping Address State is required 10479 10480 10537 Invalid Data Invalid Data Risk Control Country Filter Failure 10538 Risk Control Max Amount Failure 10539 Payment declined by your Risk Controls settings: PayPal Risk Model. The transaction was refused because the maximum amount was excceeded as a result of your Maximum Amount Risk Control Settings.. The country code in the shipping address must match the buyer's country of residence This transaction cannot be completed with PaymentAction of Sale Correcting This Error. Shipping Address Country Error Shipping Address1 Empty Shipping Address City Empty Shipping Address State Empty 10725 10727 10728 10729 Name-Value Pair API Developer Guide September 2010 193 . You cannot pass both the new and deprecated order description. and Postal Code failed. OtherPaymentMethodLabel exceeds maximum length. Exceeds maximum length. Exceeds maximum length.A API Error Codes SetExpressCheckout API Errors Error Code 10730 10731 10736 10800 11001 11001 11001 11001 11001 11001 11001 11547 Short Message Shipping Address Postal Code Empty Shipping Address Country Empty Shipping Address Invalid City State Postal Code Invalid Data Exceeds maximum length. Exceeds maximum length. OtherPaymentMethodLabelDescripti on exceeds maximum length. OtherPaymentMethodID exceeds maximum length. Correcting This Error. 11601 11602 11801 11802 11803 11804 194 September 2010 Name-Value Pair API Developer Guide . Check URLs and other long strings. You cannot pass both the new and deprecated Custom parameter. OtherPaymentMethodLongDescripti on exceeds maximum length. Exceeds maximum length.. Recurring payments temporarily unavailable. Your request is too long. Recurring payments temporarily unavailable. State. Value of NoteText element is truncated. Exceeds maximum length. try again later Request for billing address failed Request for billing address failed Invalid Data Invalid Data Invalid Data Invalid Data Long Message The field Shipping Address Postal Code is required The field Shipping Address Country is required A match of the Shipping Address City. OtherPaymentMethodIcon exceeds maximum length. Exceeds maximum length. Billing address request is not enabled for merchant Feature not yet available You cannot pass both new and deprecated parameter address fields. You cannot pass both the new and deprecated Invoice ID parameter.. OtherPaymentMethodLongDescripti onTitle exceeds maximum length. you must specify a longer timeout Line items are required when specify a callback URL for flate rate shipping options The callback URL must not exceed 1. You cannot pass both the new and deprecated ProfileAddressChangeDate parameter. Invalid callback URL.. See additional error messages for details Callback URL is wrong type 11811 Invalid Shipping Discount. See additional error messages for details Invalid Data Transaction refused because of an invalid argument. Item sales tax is invalid.API Error Codes SetExpressCheckout API Errors A Error Code 11805 Short Message Invalid Data Long Message You cannot pass both the new and deprecated order total or amount parameters. 11806 Invalid Data 11807 Invalid Data 11810 Transaction refused because of an invalid argument. Ensure that your callback URL starts with https://. See additional error messages for details Callback options missing Invalid callback timeout Line items missing You must specify callback options when you specify a callback URL The callback timeout is is zero. 11812 11813 The value of Description parameter has been truncated. Correcting This Error. You cannot pass both the new and deprecated ShippingMethod parameter.024 characters Callback URL is too long Name-Value Pair API Developer Guide September 2010 195 . Callback URL is wrong type. See additional error messages for details Transaction refused because of an invalid argument. Invalid Insurance Amount. 11814 11815 Invalid data Transaction refused because of an invalid argument. you must use the HTTPS Invalid value for AllowNote.. you must specify a name and amount for each shipping option type More than one shipping option type is marked as the default. you must specify a longer timeout value Flat-rate shipping options are missing. you can only specify one default shipping option at a time You must specify one shipping option type as the default The callback timeout is zero.. line items are required when you specify a callback URL for flat-rate shipping options Maximum amount of order not specified. you must specify flat-rate shipping options when you specify a callback URL Invalid shipping total. you must specify a shipping total when using a flat-rate shipping option Correcting This Error. Invalid shipping options 11821 Invalid shipping options 11822 Multiple default shipping options specified 11823 11824 11825 No default shipping option specified Invalid callback timeout Flat-rate shipping options are missing 11826 Invalid shipping total 11827 Line items missing 11828 Maximum amount of order not specified 11829 Shipping total is missing 196 September 2010 Name-Value Pair API Developer Guide .A API Error Codes SetExpressCheckout API Errors Error Code Short Message Multiple default shipping options specified No default shipping option specified Invalid shipping total Long Message You can only specify one default shipping option at a time You must specify a default shipping option Invalid shipping total.. you must specify the estimated value of the order when using a flat-rate shipping option Shipping total is missing. it should equal the shipping amount of the default shipping option Invalid shipping options. it should equal the shipping amount of the selected shipping option Line items missing. you must specify a name and amount for each shipping option Invalid shipping options. Immediate Payment item was not found. 11831 11832 Callback URL is too long Maximum amount of order is less than itemized amounts 12109 12124 12200 12201 Option not supported. 12205 12207 12208 Cart ID is required for Immediate Payment item. including handling. it must not exceed 1. Parallel payments functionality is not available Invalid Data Payment Request ID is missing 13100 13101 13102 Name-Value Pair API Developer Guide September 2010 197 . shipping. Buyer ID is not present. the value of all items. eBay item amount does not match Express Checkout API item amount. and insurance cannot be greater than the maximum amount of the order Seller blocks payments via eBay checkout for all eBay items. Parallel payments functionality is not available Payment action of Order is only supported for parallel payments Payment Request ID is mandatory for parallel payments Correcting This Error.API Error Codes SetExpressCheckout API Errors A Error Code 11830 Short Message Insurance amount is missing Long Message Insurance amount is missing. Please check that the item is a valid Immediate Payment item. The item specified is either not valid or is not currently available for purchase as an Immediate Payment item.024 characters Maximum amount of order is less than itemized amounts. Express Checkout not supported for you. Cart ID is required for Immediate Payment item. eBay Transaction ID and eBay Order ID must be null. Option not supported. Callback URL is too long. tax. eBay item amount must match Express Checkout API item amount. Only one Immediate Payment item can be paid for in a single PayPal payment transaction. 12202 More than one eBay item is present. you have offered insurance but have not specified an amount.. they should contain null values. If the fields are present. Requests for eBay Immediate Payment items should not contain either eBay transaction ID or eBay order ID.. Buyer ID must be specified to process an Immediate Payment item. . mixed Payment Action not supported The Buyer returned without completing the payment Seller ID is mandatory for parallel payments The transaction is in progress for this token. 13111 13114 13115 13116 198 September 2010 Name-Value Pair API Developer Guide . The Payment Action passed should be unique. Merchant is not eligible for parallel payments. See Additional error messages for details.. Correcting This Error. You cannot pass both the new and deprecated PaymentAction parameter.A API Error Codes SetExpressCheckout API Errors Error Code 13103 13104 Short Message Duplicate Payment Request ID passed Transaction refused because of an invalid argument. Billing Agreement is not supported for parallel payments. Due to some technical diffculties the Multi Payments for Sale is not avaliable now please try again later. Multi Payments Sale is Not allowed Mixed Payment action not supported Buyer Didn't Complete Seller ID Missing Transaction refused because of an invalid argument. See additional error messages for details. Invalid Data Invalid Data Long Message Payment Request ID must be unique for parallel payments Number of payment requests exceeds maximum number of supported requests. 13105 13106 13108 13110 Merchant is not eligible. Missing argument. See additional error messages for details. Transaction refused because of an invalid argument.. Missing argument. See additional error messages for details. Transaction refused because of an invalid argument.. 10004 Transaction refused because of an invalid argument. OtherPaymentMethodLabel is missing.API Error Codes GetExpressCheckoutDetails API Errors A GetExpressCheckoutDetails API Errors GetExpressCheckoutDetails API Errors Error Code 10001 10001 10001 10001 10003 10003 10003 10003 Short Message Internal Error Internal Error ButtonSource value truncated. One or more of these giropay URLs is missing: giropaySuccessURL. giropayCancelURL. BanktxnPendingURL. Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details. ButtonSource value truncated. Long Message Internal Error Transaction failed due to internal error The transaction could not be loaded The transaction could not be loaded OtherPaymentMethodID is missing. Permission denied 10004 10004 10004 You can not get the details for this type of transaction The transaction could not be loaded 10004 The transaction id is not valid 10007 You do not have permission to make this API call Name-Value Pair API Developer Guide September 2010 199 . See additional error messages for details. OtherPaymentMethodType is missing. The transaction id is not valid Correcting This Error. Invalid transaction type Transaction refused because of an invalid argument. Missing argument. Missing argument. The transaction is in progress for this token. Long Message You do not have permission to get the details of this transaction You do not have permission to make this API call Express Checkout token is missing. Transaction refused because of an invalid argument. Invalid token This Express Checkout session has expired. Correcting This Error. Express Checkout token was issued for a merchant account other than yours. Cannot Pay Seller. See additional error messages for details.A API Error Codes GetExpressCheckoutDetails API Errors Error Code 10007 10007 10408 10409 10410 10411 Short Message Permission denied Permission denied Express Checkout token is missing. Buyer Cannot Pay.. 13112 13113 13116 200 September 2010 Name-Value Pair API Developer Guide . You’re not authorized to access this info.. The Buyer will not be able to Pay the seller for this transaction The Buyer cannot pay with PayPal for this transaction. Invalid token. Token value is no longer valid. This Express Checkout session has expired. Name-Value Pair API Developer Guide September 2010 201 . See additional error messages for details.API Error Codes DoExpressCheckoutPayment API Errors A DoExpressCheckoutPayment API Errors DoExpressCheckoutPayment API Errors Error Code 10001 10001 Short Message Internal Error Internal Error Long Message Transaction failed due to internal error Warning an internal error has occurred. Transaction refused because of an invalid argument.. Transaction refused because of an invalid argument. See additional error messages for details. Internal Error Transaction refused because of an invalid argument. Transaction refused because of an invalid argument.. 10004 Invalid eBay seller feedback total positive count. See additional error messages for details. The transaction id is not valid Correcting This Error. See additional error messages for details. 10004 10004 Invalid item URL. The transaction id may not be correct The transaction could not be loaded Internal Error Transaction refused because of an invalid argument. See additional error messages for details. 10001 10001 10004 ButtonSource value truncated. See additional error messages for details. See additional error messages for details. 10004 SellerRegistrationDate is invalid. Transaction refused because of an invalid argument. 10004 Invalid eBay seller feedback overall negative count. See additional error messages for details. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. 10004 Invalid eBay seller feedback overall positive count. 10004 Invalid eBay seller feedback recent positive count. Invalid token Long Message Invalid eBay seller feedback total negative count. Transaction refused because of an invalid argument. 10004 Invalid eBay item buyer protection type. See additional error messages for details. See additional error messages for details. Express Checkout token is missing. 10410 202 September 2010 Name-Value Pair API Developer Guide . Correcting This Error. See additional error messages for details. 10004 Multiple eBay order IDs not allowed. Transaction refused because of an invalid argument.. You’re not authorized to access this info. Transaction refused because of an invalid argument. See additional error messages for details. 10004 Invalid eBay item payment hold risk. 10408 10409 Express Checkout token is missing. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument.A API Error Codes DoExpressCheckoutPayment API Errors Error Code 10004 Short Message Transaction refused because of an invalid argument. See additional error messages for details.. See additional error messages for details. 10004 Invalid eBay item transaction date. Invalid token. 10004 Invalid eBay seller feedback recent negative count. See additional error messages for details. Transaction refused because of an invalid argument. 10007 10406 You do not have permissions to make this API call The PayerID value is invalid. Permission denied Transaction refused because of an invalid argument. Express Checkout token was issued for a merchant account other than yours. The totals of the cart item amounts do not match order amounts. Instruct the customer to use an alternative payment method. A successful transaction has already been completed for this token. You have exceeded the maximum number of payment attempts for this token.. Duplicate invoice Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Token value is no longer valid.. See additional error messages for details. See additional error messages for details. Instruct the customer that PayPal is unable to process the payment and redisplay alternative payment methods with which the customer can pay. See additional error messages for details. See additional error messages for details. 10419 10420 Express Checkout PayerID is missing. Express Checkout PayerID is missing. Transaction refused because of an invalid argument. 10412 10413     ItemTotal ShippingTotal HandlingTotal TaxTotal If you get this error. Transaction refused because of an invalid argument. Express Checkout PaymentAction is missing. Long Message This Express Checkout session has expired. The amount exceeds the maximum amount for a single transaction. Payment has already been made for this InvoiceID. The currencies of the shopping cart amounts must be the same. 10415 10416 10417 10418 Transaction refused because of an invalid argument. The transaction cannot complete successfully.API Error Codes DoExpressCheckoutPayment API Errors A Error Code 10411 Short Message This Express Checkout session has expired. Name-Value Pair API Developer Guide September 2010 203 . 10414 Transaction refused because of an invalid argument. research why it might have occurred and modify your implementation of Express Checkout to ensure proper addition of the values. See additional error messages for details. Transaction cannot complete. See additional error messages for details. Correcting This Error. See additional error messages for details. PayPal recommends that you return your customer to PayPal to review and approve new valid funding sources. Long Message This Express Checkout session belongs to a different customer. Invoice ID value exceeds maximum allowable length. See additional error messages for details. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. 10429 Tax total is invalid. along with a button or hyperlink to return to PayPal. Shipping address is invalid. Customer must choose new funding sources. 10431 10432 Item amount is invalid. 10422 10424 If you receive this error message. See additional error messages for details. 10426 Transaction refused because of an invalid argument.. Token value mismatch. 204 September 2010 Name-Value Pair API Developer Guide . See additional error messages for details. 10427 Shipping total is invalid. Transaction refused because of an invalid argument. Item amount is invalid. Verify that your programs are properly associating the Tokens and PayerIDs. 10428 Handling total is invalid.. See additional error messages for details. Transaction refused because of an invalid argument.A API Error Codes DoExpressCheckoutPayment API Errors Error Code 10421 Short Message This Express Checkout session belongs to a different customer. 10433 Value of OrderDescription element has been truncated. See additional error messages for details. Correcting This Error. The customer must return to PayPal to select new funding sources. Item total is invalid. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. you should consider trapping the error to display a message to the customer describing what happened. Although this error is rare. See additional error messages for details. ButtonSource value truncated. PaymentAction of Order is not allowed with Unilateral and Non-Credentialed authentication. 10482 Name-Value Pair API Developer Guide September 2010 205 . This transaction cannot be processed at this time. Correcting This Error. 10441 10442 10443 10444 10445 10446 10474 10481 Transaction refused because of an invalid argument. The transaction currency specified must be the same as previously specified. A confirmed email is required to make this API call. See additional error messages for details.. Transaction refused because of an invalid argument. The ButtonSource element value exceeds maximum allowable length. PaymentAction of Authorization is not allowed with Unilateral and NonCredentialed authentication. Please try again later.API Error Codes DoExpressCheckoutPayment API Errors A Error Code 10434 Short Message Transaction refused because of an invalid argument. This transaction cannot be processed. The country code in the shipping address must match the buyer’s country of residence. Transaction refused because of an invalid argument. The buyer selects the country of residence when they sign up for their PayPal account. This transaction cannot be processed at this time. Transaction refused because of an invalid argument. See additional error messages for details. This transaction cannot be completed with PaymentAction of Order. The country of residence is displayed after the dash in the title on the Account Overview page. See additional error messages for details. Transaction refused because of an invalid argument. Unconfirmed email Invalid Data Long Message Value of Custom element has been truncated. See additional error messages for details. Please try again later. See additional error messages for details.. 10435 The customer has not yet confirmed payment for this Express Checkout session. Transaction refused because of an invalid argument. The NotifyURL element value exceeds maximum allowable length. See additional error messages for details. . and Postal Code failed. Value of NoteText element is truncated. Payment declined by your Risk Controls settings: PayPal Risk Model. There was an error in the Shipping Address Country field The field Shipping Address1 is required The field Shipping Address City is required The field Shipping Address State is required The field Shipping Address Postal Code is required The field Shipping Address Country is required A match of the Shipping Address City. 10538 Risk Control Max Amount Failure 10539 Payment declined by your Risk Controls settings: PayPal Risk Model. Payment Pending your review in Fraud Management Filters Transaction blocked by your settings in FMF Could not process your request to accept/deny the transaction Correcting This Error.. Shipping Address Country Error Shipping Address1 Empty Shipping Address City Empty Shipping Address State Empty Shipping Address Postal Code Empty Shipping Address Country Empty Shipping Address Invalid City State Postal Code Exceeds maximum length. The transaction was refused because the maximum amount was excceeded as a result of your Maximum Amount Risk Control Settings.A API Error Codes DoExpressCheckoutPayment API Errors Error Code 10537 Short Message Risk Control Country Filter Failure Long Message The transaction was refused because the country was prohibited as a result of your Country Monitor Risk Control Settings. Payment Pending your review in Fraud Management Filters Transaction blocked by your settings in FMF Could not process your request to accept/deny the transaction 10725 10727 10728 10729 10730 10731 10736 11001 11610 11611 11612 206 September 2010 Name-Value Pair API Developer Guide . State. Name-Value Pair API Developer Guide September 2010 207 . it should equal the shipping amount of the selected shipping option Invalid shipping options. your order total can be updated and then you'll be able to complete checkout. Invalid shipping amount. See additional error messages for details Invalid shipping amount Long Message Invalid Order URL. Invalid shipping options 11821 Invalid shipping options 11826 Invalid shipping total 12125 PP incentive no longer available.. Correcting This Error. you must specify a name and amount for each shipping option type Invalid shipping total. Please go back to PayPal so that the code(s) can be removed.. Incentive temporarily unavailable. We're having problems processing redemption codes at this time. You can try to check out again at a later time or complete your payment without the discount applied. you must specify a name and amount for each shipping option Invalid shipping options. The item specified is either not valid or is not currently available for purchase as an Immediate Payment item. 12126 Payment could not be processed at this time. Your payment has not been processed.API Error Codes DoExpressCheckoutPayment API Errors A Error Code 11820 Short Message Transaction refused because of an invalid argument. it should equal the shipping amount of the selected shipping option There's a problem with the redemption code(s) you entered and can't be used at this time. 12201 Immediate Payment item was not found. Your payment has not been processed. Please check that the item is a valid Immediate Payment item. You cannot pass both the new and deprecated PaymentAction parameter. Order and Authorization are not acceptable values for PaymentAction when the item is an Immediate Payment Cart ID is required for Immediate Payment item. Parallel payments functionality is not available Payment action of Order is only supported for parallel payments Payment Request ID is mandatory for parallel payments Payment Request ID must be unique for parallel payments Number of payment requests exceeds maximum number of supported requests.A API Error Codes DoExpressCheckoutPayment API Errors Error Code 12203 Short Message Payment rolled back because of pending item. Correcting This Error. One or more payment requests failed. Check individual payment responses for more information. The value of PaymentAction must be Sale for Immediate Payment item... Cart ID is required for Immediate Payment item. Error occurred causing transaction reversal. Long Message Payment was not created because it would have been in a pending state. 12204 12206 Transaction reversed. eBay item amount does not match Express Checkout API item amount. Invalid Data 13103 13104 13106 13107 Parallel payments partially successful. which is unacceptable for Immediate Payment items. eBay item amount does not match Express Checkout API item amount. See Additional error messages for details. Parallel payments functionality is not available Invalid Data 12207 12208 13100 13101 13102 Payment Request ID is missing Duplicate Payment Request ID passed Transaction refused because of an invalid argument. 208 September 2010 Name-Value Pair API Developer Guide . mixed Payment Action not supported Seller ID is mandatory for parallel payments The transaction is in progress for this token. 13111 Mixed Payment action not supported Seller ID Missing Transaction refused because of an invalid argument. The Payment Action passed should be unique. See additional error messages for details.API Error Codes DoExpressCheckoutPayment API Errors A Error Code 13110 Short Message Multi Payments Sale is Not allowed Long Message Due to some technical diffculties the Multi Payments for Sale is not avaliable now please try again later.. Correcting This Error. 13115 13116 Name-Value Pair API Developer Guide September 2010 209 .. Authorization has already been completed.. Correcting This Error.. 210 September 2010 Name-Value Pair API Developer Guide . Contact the buyer. The buyer account is restricted. Close the order or authorization. 10601 Authorization expired. 10600 Authorization voided. DoAuthorization DoCapture DoAuthorization DoCapture DoReauthorization DoVoid DoAuthorization DoCapture DoReauthorization DoVoid DoAuthorization DoCapture DoReauthorization DoVoid DoAuthorization DoCapture DoReauthorization DoVoid Close the order or authorization. Authorization has expired. Exceed max Long Message Internal Error Transaction failed due to internal error Invalid argument You do not have permissions to make this API call Account is locked or inactive Invalid argument Retry the request at a later time or close order.A API Error Codes Authorization and Capture API Errors Authorization and Capture API Errors Authorization & Capture API Error Messages Error Code 10001 10001 10004 10007 Short Message Internal Error Internal Error Internal Error Permission denied Transaction refused Transaction refused because of an invalid argument.. 10603 The buyer is restricted. 10602 Authorization completed. Close the order or authorization. Returned By API Call. 10009 10010 10202 Transaction would exceed user’s monthly maximum Authorization is voided. See additional error messages for details.. not a reauthorization. please contact the buyer. Retry the request with a PayPal-supported currency. It must include both buyer and seller to make an auth.. Currency of capture must be the same as currency of authorization. Returned By API Call. Transaction id is invalid. 10610 Amount limit exceeded. You can void only the original authorization. and retry the request. Contact customer service.. Review the order to ensure customer and seller are both PayPal members. Long Message Authorization transaction cannot be unilateral. Amount specified exceeds allowable limit. Unsupported currency. 10608 Funding source missing. Transaction rejected. 10609 Invalid transactionID.API Error Codes Authorization and Capture API Errors A Error Code 10604 Short Message Authorization must include both buyer and seller. 10613 Currency mismatch. Maxmimum number of allowable settlements has been reached. Authorization & Capture feature unavailable. Contact PayPal Customer Service. Check the validity of the authorization ID and reattempt the request. No more settlement for the authorization. The funding source is missing. Cannot void reauth. 10612 No more settlement. 10611 Not enabled. Authorization & Capture feature is not enabled for the merchant. Currency is not supported. Contact PayPal Customer Service. Contact the buyer. Contact the buyer.. 10614 DoVoid Name-Value Pair API Developer Guide September 2010 211 . Close the order. DoAuthorization Correcting This Error. Void the authorization. 10605 DoAuthorization DoCapture DoAuthorization DoCapture DoReauthorization DoAuthorization DoCapture DoReauthorization DoVoid DoAuthorization DoCapture DoReauthorization DoAuthorization DoCapture DoReauthorization DoVoid DoAuthorization DoCapture DoReauthorization DoAuthorization DoCapture DoReauthorization DoCapture 10606 10607 Auth&Capture unavailable.. Buyer cannot pay. DoCapture Ensure that the currencies are the same. Reattempt the request with a lower amount. expired. DoReauthorization Capture the authorization or reauthorize outside of honor period. 212 September 2010 Name-Value Pair API Developer Guide . Reauthorization not allowed.. Transaction already voided or expired. Capture or close the authorization 10616 DoReauthorization 10617 Reauthorization is not allowed inside honor period. Long Message You can reauthorize only the original authorization. not a reauthorization. or completed. Order is voided. Order has expired.. 10624 Payment has already been made for this Invoice ID. Check the length of the invoice ID and reattempt the request.. Review the invoice ID and reattempt the request. 10623 Maximum number of authorization allowed for the order is reached. 10620 Order has already been voided. 10621 Close this order. Close this order. 10618 DoAuthorization DoCapture DoReauthorization DoVoid DoCapture 10619 Invoice ID value exceeds maximum allowable length. Capture this order. 10622 Order is voided.. Capture the reauthorization. Order has already been voided. expired.A API Error Codes Authorization and Capture API Errors Error Code 10615 Short Message Cannot reauth reauth. Returned By API Call. Close the order or authorization. DoAuthorization DoCapture DoVoid DoAuthorization DoCapture DoVoid DoAuthorization DoCapture DoVoid DoAuthorization DoCapture DoReauthorization DoVoid DoAuthorization Close this order. Maximum number of reauthorization allowed for the auth is reached. Invoice ID value exceeds maximum allowable length. DoReauthorization Correcting This Error. or completed. Maximum number of reauthorization allowed for the auth is reached. Duplicate invoice Maximum number of authorization allowed for the order is reached. Transaction has already been voided or expired. Order has expired. . See additional error messages for details. This authorization can only be handled through the marketplace which created it. Reauthorization not allowed.API Error Codes Authorization and Capture API Errors A Error Code 10625 Short Message Transaction refused because of an invalid argument. It cannot directly be voided. The Invoice ID field can only be used with DoCapture. Reattempt the request with a lower amount. Risk Long Message The amount exceeds the maximum amount for a single transaction. Item amount is invalid. 10629 Reauthorization is not allowed for this type of authorization. Please try again later. DoAuthorization DoCapture DoReauthorization Correcting This Error. Please try again later. reauthorized... This authorization cannot be voided. Use DoAuthorization to authorize the an order. 10627 Transaction refused because of an invalid argument. DoAuthorization DoCapture DoReauthorization DoAuthorization DoReauthorization DoVoid Contact the buyer. Item amount is invalid. The invoice ID field is not supported for basic authorizations. Name-Value Pair API Developer Guide September 2010 213 . See additional error messages for details. or captured against. Check the item amount to ensure that it is not zero or negative. or captured against. 10628 This transaction cannot be processed at this time. Processor Warning. Returned By API Call.. 10630 DoAuthorization DoCapture DoAuthorization 10631 11094 The authorization is being processed. DoAuthorization DoCapture DoReauthorization DoVoid DoReauthorization Retry the request at a later time. 10626 Transaction refused due to risk model. This transaction cannot be processed at this time. reauthorized. Transaction refused because of an invalid argument.A API Error Codes GetTransactionDetails API Errors GetTransactionDetails API Errors GetTransactionDetails API Errors Error Code 10001 Short Message Internal Error Long Message Internal Error TransactionSearch API Errors TransactionSearch API Errors Error Code 10001 10001 10003 Short Message Internal Error ButtonSource value truncated. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details. Long Message Internal Error The transaction could not be loaded Start date is a required parameter 10004 Start date is invalid 10004 End date is invalid 10004 Currency is not supported 10004 Transaction class is not supported 10004 Receipt id is not valid 214 September 2010 Name-Value Pair API Developer Guide . Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details. See additional error messages for details. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument.API Error Codes TransactionSearch API Errors A Error Code 10004 Short Message Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details. Please change your search parameters if you wish to see all your results. See additional error messages for details. See additional error messages for details. Name-Value Pair API Developer Guide September 2010 215 . Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. Permission denied Permission denied Search warning Long Message Payer email is invalid 10004 Auction item id is not valid 10004 Receiver email is invalid 10004 You can not search for a transaction id and a receipt id 10004 Receiver can only be specified for payments you’ve received 10004 The transaction id is not valid 10007 10007 11002 You do not have permission to search for this transaction You do not have permission to make this API call The number of results were truncated. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details. See additional error messages for details. Internal Error Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. See additional error messages for details. 10004 You can not specify a partial amount with a full refund 10004 A transaction id is required 10004 The partial refund amount must be a positive amount 10004 You can not specify a partial amount with a full refund 10004 A transaction id is required 10004 Transaction class is not supported 216 September 2010 Name-Value Pair API Developer Guide . Transaction refused because of an invalid argument.. See additional error messages for details. Transaction refused because of an invalid argument.A API Error Codes RefundTransaction API Errors RefundTransaction API Errors RefundTransaction API Errors Error Code 10001 10001 10001 10001 10004 Short Message Internal Error Internal Error ButtonSource value truncated.. Transaction refused because of an invalid argument. Long Message Internal Error Warning an internal error has occurred. See additional error messages for details. See additional error messages for details. The transaction id may not be correct The transaction could not be loaded Internal Error The partial refund amount must be a positive amount Correcting This Error. Transaction refused because of an invalid argument. . See additional error messages for details.API Error Codes RefundTransaction API Errors A Error Code 10004 Short Message Transaction refused because of an invalid argument. only a refund of the full or full remaining amount of the transaction can be issued You are over the time limit to perform a refund on this transaction Can not do a full refund after a partial refund Account is locked or inactive The partial refund must be the same currency as the original transaction 10009 10009 10009 Transaction refused Transaction refused Transaction refused 10009 10009 10009 10009 Transaction refused Transaction refused Transaction refused Transaction refused Name-Value Pair API Developer Guide September 2010 217 . 10009 Transaction refused The partial refund amount must be less than or equal to the original transaction amount The partial refund amount must be less than or equal to the remaining amount The partial refund amount is not valid Because a complaint case exists on this transaction.. Permission denied Permission denied Transaction refused Long Message The transaction id is not valid Correcting This Error. Ensure that you have sufficient funds in your PayPal balance and that you have verified the associated bank account. 10007 10007 10009 You do not have permission to refund this transaction You do not have permissions to make this API call You do not have a verified ACH This error can be caused by insufficient funds in your PayPal balance to cover the amount of the refund and either your not having yet verified the bank account associated with your PayPal account or your not having any bank account associated with your PayPal account at all. See additional error messages for details.A API Error Codes RefundTransaction API Errors Error Code 10009 10009 10009 10009 10009 10009 10011 11001 Short Message Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Invalid transaction id value Transaction refused because of an invalid argument... 218 September 2010 Name-Value Pair API Developer Guide . Long Message This transaction has already been fully refunded Account is restricted You can not refund this type of transaction You can not do a partial refund on this transaction The account for the counterparty is locked or inactive You can not refund this type of transaction Transaction refused because of an invalid transaction id value Transaction class is not supported Correcting This Error. Internal Error Internal Error ButtonSource value truncated. See additional error messages for details. Check the number or attempt with another card. Account locked Transaction refused because of an invalid argument. See additional error messages for details.API Error Codes MassPay API Errors A MassPay API Errors MassPay API Errors Error Code 10001 10001 10001 10001 10001 Short Message Invalid account number. Transaction refused because of an invalid argument. Internal Error The transaction could not be loaded The transaction could not be loaded The masspay receiver_type is not a recognizable type 10002 10004 The user account is locked The number of input records is greater than maximum allowed 10004 The number of input records is less than or equal to zero 10004 The note string length exceeds the maximum limit of 4000 characters 10004 The amount is missing 10004 The currency is missing 10004 Currency is not supported Name-Value Pair API Developer Guide September 2010 219 . See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details. Long Message The transaction failed as a result of an invalid credit card number. See additional error messages for details. The user’s international account needs to have its sending limit removed in order to make a mass payment The user account is receive only and therefore cannot send payments out There is some configuration error The mass pay server is unavailable Unable to create payments for masspay 220 September 2010 Name-Value Pair API Developer Guide . See additional error messages for details. See additional error messages for details. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. See additional error messages for details.A API Error Codes MassPay API Errors Error Code 10004 Short Message Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. Permission denied User not allowed Restricted account Unconfirmed email Limit Exceeded Limit Exceeded Receive only account Masspay server configuration error Masspay server unavailable Unable to create payment Long Message The amount is not a valid number 10004 The amount exceeds the max limit of a single mass pay item ~1 10004 The amount is less than or equal to zero 10004 The unique id string length exceeds the maximum limit of 30 characters 10004 The unique id string contains a space as a character 10004 The transaction id is not valid 10007 10301 10303 10304 10305 10306 10307 10308 10309 10310 You do not have permissions to make this API call The user is not allowed to send money through Mass Pay Account is restricted The user account has unconfirmed email The user account needs to have its sending limit removed in order to make a mass payment. API Error Codes Recurring Payments Errors A Error Code 10311 10312 10313 10314 10317 10320 10321 10327 Short Message Unable to submit payment Masspay server error Masspay Invalid Data Masspay input parse error Masspay Invalid Email Internal Error Insufficient funds Masspay Invalid UserID Long Message Unable to submit payments for masspay The masspay server has reported errors The masspay input file includes invalid data The input to the masspay server is incorrect. Please make sure that you are using a correctly formatted input. The masspay input file includes invalid Email Internal Error The account does not have sufficient funds to do this masspay The masspay input file includes invalid UserID Recurring Payments Errors The following table lists errors for the following APIs that handle recurring payments profiles:      CreateRecurringPaymentsProfile GetRecurringPaymentsProfileDetails ManageRecurringPaymentsProfileStatus UpdateRecurringPaymentsProfile BillOutstandingAmount Name-Value Pair API Developer Guide September 2010 221 A API Error Codes SetCustomerBillingAgreement Errors SetCustomerBillingAgreement Errors SetCustomerBillingAgreement Errors Error Code 10004 Short Message Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Long Message Invalid argument; BillingType input field is set to None Additional Information 10404 ReturnURL is missing. ReturnURL tag has no content 10004 Invalid value for request billing address parameter. 10405 CancelURL is missing. CancelURL tag has no content 10407 Invalid buyer email address (BuyerEmail). Invalid BuyerEmail (badly formatted or violates SMTP protocol defined email address format) or BuyerEmail is passed as an empty tag. PageStyle tag is too long 10436 PageStyle value exceeds maximum allowable length. 10437 cpp-header-image value exceeds maximum allowable length. cpp_header_image tag is too long; maximum length is 127 10438 cpp-header-border-color value exceeds maximum allowable length. cpp-header-back-color value exceeds maximum allowable length. cpp_header_border_color tag is too long; maximum length is 6 10439 cpp_header_back_color tag is too long; maximum length is 6 222 September 2010 Name-Value Pair API Developer Guide API Error Codes SetCustomerBillingAgreement Errors A Error Code 10440 Short Message Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. Merchant not enabled for reference transactions Reference transactions temporarily unavailable. Request for billing address failed Request for billing address failed Long Message cpp-payflow-color value exceeds maximum allowable length. Additional Information cpp_payflow_color tag is too long; maximum length is 6 10471 ReturnURL is invalid. ReturnURL tag contains invalid URL 10472 CancelURL is invalid. CancelURL tag contains invalid URL 10476 10477 11452 Merchant not enabled for reference transactions Reference transaction feature not currently available; try again later Billing address request is not enabled for merchant Feature not yet available This merchant is not enabled for Mark reference transaction. Warning only Feature not enabled because system is running in standin mode. Warning only 11453 11601 11602 Name-Value Pair API Developer Guide September 2010 223 A API Error Codes GetBillingAgreementCustomerDetails Errors GetBillingAgreementCustomerDetails Errors GetBillingAgreementCustomerDetails Errors Error Code 10408 10409 Short Message Missing token You’re not authorized to access this info. Invalid token This Express Checkout session has expired. Long Message Token is missing Express Checkout token was issued for a merchant account other than yours. Invalid token This Express Checkout session has expired. Token value is no longer valid. Additional Information Token is missing Token belongs to a different merchant Token invalid Token expired 10410 10411 CreateBillingAgreement Errors CreateBillingAgreement Errors Error Code 10408 10409 Short Message Missing token You’re not authorized to access this info. Invalid token This Express Checkout session has expired. Buyer did not accept billing agreement A successful Billing Agreement has already been created for this token. Missing token You’re not authorized to access this info. Invalid token Long Message Token is missing Express Checkout token was issued for a merchant account other than yours. Invalid token This Express Checkout session has expired. Token value is no longer valid. Buyer did not accept billing agreement Transaction refused because of an invalid argument. See additional error messages for details. Token is missing Express Checkout token was issued for a merchant account other than yours. Invalid token Additional Information Token is missing Token belongs to a different merchant Token invalid Token expired 10410 10411 11455 11456 Buyer has not agreed to the billing agreement. Token has already been used to create a billing agreement Token is missing Token belongs to a different merchant Token invalid 10408 10409 10410 224 September 2010 Name-Value Pair API Developer Guide API Error Codes CreateBillingAgreement Errors A Error Code 10411 Short Message This Express Checkout session has expired. Long Message This Express Checkout session has expired. Token value is no longer valid. Additional Information Token expired Name-Value Pair API Developer Guide September 2010 225 description field or custom field is empty and the status is active Check the description and custom fields of the billing agreement.A API Error Codes UpdateBillingAgreement Errors UpdateBillingAgreement Errors UpdateBillingAgreement Errors Error Code 10001 10004 Short Message Internal Error Transaction refused because of an invalid argument. Reference id refers to an invalid transaction. Billing agreement has been cancelled Additional Information 10201 10204 10209 Billing Agreement was cancelled User’s account is closed or restricted Disabled Billing Agreement was cancelled User’s account is closed or restricted Preapproved Payments not enabled. Either the description or custom field is empty and the status is active or the contents of one of these fields exceeds the maximum field length. 10209 Disabled 10211 Invalid billing agreement ID Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Merchant not enabled for reference transactions 11451 11451 11452 ReferenceID field is empty. This merchant is not enabled for Mark reference transaction DoReferenceTransaction Errors All Reference Transactions-Related API Errors Error Code 10001 Short Message Internal Error Long Message Internal Error Additional Information 226 September 2010 Name-Value Pair API Developer Guide . Preapproved Payments not enabled. Long Message Internal Error Invalid argument. Invalid transaction or billing agreement ID. See additional error messages for details. could not find Billing Agreement in database Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Merchant not enabled for reference transactions Merchant pull is not enabled for the country or merchant is not enabled for merchant pull Account number mismatch for the API caller and the account the billing agreement belongs to. API Error Codes DoReferenceTransaction Errors A Error Code 10002 10004 Short Message Authentication/Authorizati on Failed Transaction refused because of an invalid argument. applies only to legacy PAP billing agreements Payee has no funding sources. See additional error messages for details. Merchant is locked/close/restricted Non-ASCII characters are used in InvoiceID field Billing agreement is not active Transaction would exceed the monthly limit Retry the transaction with an alternate funding source. Transaction refused Invalid Invoice Agreement canceled Exceed max Action required User’s account is closed or restricted Risk Duplicate Retry Disabled Long Message Additional Information Invalid payment type argument 10009 10010 10201 10202 10203 10204 10205 10206 10207 10209 The account for the counterparty is locked or inactive Non-ASCII invoice id is not supported Billing Agreement was cancelled Transaction would exceed user’s monthly maximum Transaction failed. action required by user User’s account is closed or restricted Transaction refused due to risk model Transaction was already processed Transaction failed but user has alternate funding source Preapproved Payments not enabled. Invalid MP ID A profile preference is set that automatically denies this kind of transaction 10210 10211 10212 No Funding Transaction failed because has no funding sources Invalid MP ID Profile preference setting A profile preference is set to automatically deny certain transactions The soft descriptor passed in contains invalid characters 10213 10214 10215 Invalid Soft Descriptor Soft descriptor format error. Merchants is not enabled for preapproved payments (PAP). Soft Descriptor truncated The soft descriptor was truncated Name-Value Pair API Developer Guide September 2010 227 . TotalOrder amount is invalid 10402 This merchant account is not permitted to set PaymentAction? to Authorization. The transaction cannot complete successfully. Currencies in the shopping cart must be the same 228 September 2010 Name-Value Pair API Developer Guide . Order total is missing. See additional error messages for details. Payment already made for the invoice Total of cart items does not match order total 10414 The amount exceeds the maximum amount for a single transaction. See additional error messages for details. Merchant account number is invalid 10412 10413 Payment has already been made for this InvoiceID?. Account not associated with a usable funding source 10417 Transaction cannot complete. Duplicate invoice Transaction refused because of an invalid argument. Please contact Customer Service. Credit card or Billing Agreement is required to complete payment 10418 Transaction refused because of an invalid argument.A API Error Codes DoReferenceTransaction Errors Error Code 10216 Short Message Long Message Additional Information Transaction refused because a confirmed address is not available 10400 Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. The currencies of the shopping cart amounts must be the same. The totals of the cart item amounts do not match order amounts. Instruct the customer to use an alternative payment method. See additional error messages for details. Transaction refused because of an invalid argument. TotalOrder amount is missing 10401 Order total is invalid. Merchant is not eligible for auth settlement 10406 Transaction refused because of an invalid argument. Transaction cannot complete. Instruct the customer to use an alternative payment method. The PayerID? value is invalid. Authorization only is not allowed for merchant. See additional error messages for details. See additional error messages for details. Amount exceeds the max amount for a single txn 10417 The transaction cannot complete successfully. See additional error messages for details. Transaction refused because of an invalid argument. See additional error messages for details. 10429 Item sales tax is invalid PaymentDetailsItem. HandlingTotal amount is invalid 10429 Tax total is invalid. 10433 Value of OrderDescription element has been truncated.API Error Codes DoReferenceTransaction Errors A Error Code 10420 Short Message Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Transaction refused because of an invalid argument. Warning only. Long Message PaymentAction? tag is missing.Tax field is invalid. Warning only. See additional error messages for details. API executes Name-Value Pair API Developer Guide September 2010 229 . Additional Information PaymentAction? tag is missing. Warning only. Warning only. See additional error messages for details. maximum length is 256 10430 Item amount is missing. API executes PaymentDetailsItem. See additional error messages for details.Amount field is missing. ItemTotal amount is invalid. TaxTotal amount is invalid. maximum length is 127. 10428 Handling total is invalid. Transaction refused because of an invalid argument. OrderDescription field is too long. Transaction refused because of an invalid argument. See additional error messages for details. 10427 Shipping total is invalid. See additional error messages for details. Transaction refused because of an invalid argument. 10432 Invoice ID value exceeds maximum allowable length. API executes InvoiceID field is too long. Transaction refused because of an invalid argument. 10426 Item total is invalid. API executes PaymentDetailsItem. See additional error messages for details. ShippingTotal amount is invalid.Amount field is invalid. See additional error messages for details. See additional error messages for details. 10431 Item amount is invalid. See additional error messages for details. Transaction refused because of an invalid argument. A Start Date or Issue Number is required. Please enter a valid Credit Card Verification Number. Long Message Value of Custom element has been truncated. maximum length is 32. The ButtonSource element value exceeds maximum allowable length. ButtonSource value truncated. API executes CVV2 field is invalid. maximum length for notify URL is 2048 ButtonSource field is too long. Additional Information Custom field is too long. None of Start date or issue number is specified (only applies to Switch and Solo credit cards) 10546 10560 10567 10600 10601 10621 Authorization voided Authorization expired. This transaction cannot be processed. Warning only. Payment declined by your Risk Controls settings: PayPal Risk Model. Gateway Decline Invalid Data Invalid Data Transaction declined by Risk Control settings: PayPal Risk model IP fraud models failed. Order has expired. Authorization has expired Order has expired. See additional error messages for details. Authorization voided. The transaction was refused because the country was prohibited as a result of your Country Monitor Risk Control Settings. 10441 The NotifyURL element value exceeds maximum allowable length. 230 September 2010 Name-Value Pair API Developer Guide . The transaction was refused because the maximum amount was excused as a result of your Maximum Amount Risk Control Settings. 10442 10504 10527 Invalid Data CreditCardNumber and/or CreditCardType is invalid Transaction refused due to country monitor risk control 10537 Risk Control Country Filter Failure 10538 Risk Control Max Amount Failure Transaction refused due to max amount risk control 10539 Payment declined by your Risk Controls settings: PayPal Risk Model. maximum length is 256. The issue number of the credit card is invalid. Please enter a valid credit card number and type. IssueNumber is invalid. API executes NotifyURL field is too long. This transaction cannot be processed. The cvv2 is invalid. This transaction cannot be processed. Warning only.A API Error Codes DoReferenceTransaction Errors Error Code 10434 Short Message Transaction refused because of an invalid argument. See additional error messages for details. There was an error in the Shipping Address Country field The field Shipping Address1 is required The field Shipping Address City is required The field Shipping Address State is required The field Shipping Address Postal Code is required The field Shipping Address Country is required A match of the Shipping Address City. state. Merchant is referencing own transaction. Invalid reference id Reference transaction is not associated with a billing agreement. State. 10748 Invalid Data CVV2 field is missing. Reference id either not found or could not be decrypted 11451 11451 Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid 11451 Name-Value Pair API Developer Guide September 2010 231 . Maximum number of authorization allowed for the order is reached. 11302 Cannot pay self Cannot pay self. The transaction was refused because you cannot send money to yourself. This transaction cannot be processed without a valid IP address. and Postal Code failed. Maximum number of authorization allowed for the order is reached. 10755 Unsupported Currency. IPAddress field is invalid.API Error Codes DoReferenceTransaction Errors A Error Code 10622 10623 Short Message Order is voided. This transaction cannot be processed without a Credit Card Verification number. This transaction cannot be processed due to an unsupported currency. Shipping Address Country Error Shipping Address1 Empty Shipping Address City Empty Shipping Address State Empty Shipping Address Postal Code Empty Shipping Address Country Empty Shipping Address Invalid City State Postal Code Invalid Data Long Message Order is voided. and postal code failed. Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Billing Agreement Id or transaction Id is not valid Additional Information 10725 10727 10728 10729 10730 10731 10736 10747 Shipping address error in country field Shipping address error in address1 field Shipping address error in city field Shipping address error in state field Shipping address error in postal code Country code is empty in shipping address Match of shipping address. city. Payment Pending your review in Fraud Management Filters Transaction blocked by your settings in FMF Could not process your request to accept/deny the transaction This transaction cannot be processed. 232 September 2010 Name-Value Pair API Developer Guide . Additional Information Reference id either not found or could not be decrypted This merchant is not enabled for Mark reference transaction Feature wired off Feature not supported in standin Failed to send email to buyer. Warning: Could not send email to the buyer Invalid Data Long Message Billing Agreement Id or transaction Id is not valid Merchant not enabled for reference transactions Reference transaction feature not currently available. This error is not fatal and generates a warning. try again later Warning: Could not send email to the buyer The shipping address must match the user’s address in the PayPal account. try again later Reference transaction feature not currently available.A API Error Codes DoReferenceTransaction Errors Error Code 11451 11452 11453 11453 11454 Short Message Billing Agreement Id or transaction Id is not valid Merchant not enabled for reference transactions Reference transactions temporarily unavailable. Reference transactions temporarily unavailable. The shipping address on file does not match the requested shipping address. 11459 11610 Payment Pending your review in Fraud Management Filters Transaction blocked by your settings in FMF Could not process your request to accept/deny the transaction Gateway Decline 11611 11612 18014 This transaction cannot be processed without a Credit Card Verification number. See additional error messages for details. Long Message Invalid email format 10004 Invalid street format 10004 Invalid zip format 10009 The Address API is currently disabled ManagePendingTransactionStatus API Errors ManagePendingTransactionStatus API Errors Error Code 11614 11614 Short Message Could not process your request to accept/deny the transaction The transaction has already been Accepted/Denied and the status cannot be changed Long Message Could not process your request to accept/deny the transaction The transaction has already been Accepted/Denied and the status cannot be changed Name-Value Pair API Developer Guide September 2010 233 . Transaction refused because of an invalid argument.API Error Codes AddressVerify API Errors A AddressVerify API Errors AddressVerify API Errors Error Code 10004 Short Message Transaction refused because of an invalid argument. See additional error messages for details. The API is disabled. See additional error messages for details. Transaction refused because of an invalid argument. A API Error Codes ManagePendingTransactionStatus API Errors 234 September 2010 Name-Value Pair API Developer Guide . Country or Region Country or Region Code AF AX AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM AMERICAN SAMOA ANDORRA ANGOLA ANGUILLA ANTARCTICA ANTIGUA AND BARBUDA ARGENTINA ARMENIA ARUBA AUSTRALIA AUSTRIA AZERBAIJAN BAHAMAS BAHRAIN BANGLADESH BARBADOS BELARUS BELGIUM BELIZE BENIN BERMUDA Name-Value Pair API Developer Guide September 2010 235 .B AFGHANISTAN ÅLAND ISLANDS ALBANIA ALGERIA Countries and Regions Supported by PayPal PayPal uses 2-character IS0-3166-1 codes for specifying countries and regions that are supported in fields and variables. B Countries and Regions Supported by PayPal Country or Region BHUTAN BOLIVIA BOSNIA AND HERZEGOVINA BOTSWANA BOUVET ISLAND BRAZIL BRITISH INDIAN OCEAN TERRITORY BRUNEI DARUSSALAM BULGARIA BURKINA FASO BURUNDI CAMBODIA CAMEROON CANADA CAPE VERDE CAYMAN ISLANDS CENTRAL AFRICAN REPUBLIC CHAD CHILE CHINA CHRISTMAS ISLAND COCOS (KEELING) ISLANDS COLOMBIA COMOROS CONGO CONGO. THE DEMOCRATIC REPUBLIC OF COOK ISLANDS COSTA RICA COTE D'IVOIRE CROATIA CUBA Country or Region Code BT BO BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU 236 September 2010 Name-Value Pair API Developer Guide . Countries and Regions Supported by PayPal B Country or Region CYPRUS CZECH REPUBLIC DENMARK DJIBOUTI DOMINICA DOMINICAN REPUBLIC ECUADOR EGYPT EL SALVADOR EQUATORIAL GUINEA ERITREA ESTONIA ETHIOPIA FALKLAND ISLANDS (MALVINAS) FAROE ISLANDS FIJI FINLAND FRANCE FRENCH GUIANA FRENCH POLYNESIA FRENCH SOUTHERN TERRITORIES GABON GAMBIA GEORGIA GERMANY GHANA GIBRALTAR GREECE GREENLAND GRENADA GUADELOUPE Country or Region Code CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP Name-Value Pair API Developer Guide September 2010 237 . B Countries and Regions Supported by PayPal Country or Region GUAM GUATEMALA GUINEA GUINEA-BISSAU GUYANA HAITI HEARD ISLAND AND MCDONALD ISLANDS HOLY SEE (VATICAN CITY STATE) HONDURAS HONG KONG HUNGARY ICELAND INDIA INDONESIA IRAN. ISLAMIC REPUBLIC OF IRAQ IRELAND ISLE OF MAN ISRAEL ITALY JAMAICA JAPAN JORDAN KAZAKHSTAN KENYA KIRIBATI KOREA. REPUBLIC OF KUWAIT KYRGYZSTAN LAO PEOPLE'S DEMOCRATIC REPUBLIC Country or Region Code GU GT GN GW GY HT HM VA HN HK HU IS IN ID IR IQ IE IM IL IT JM JP JO KZ KE KI KP KR KW KG LA 238 September 2010 Name-Value Pair API Developer Guide . DEMOCRATIC PEOPLE'S REPUBLIC OF KOREA. THE FORMER YUGOSLAV REPUBLIC OF MADAGASCAR MALAWI MALAYSIA MALDIVES MALI MALTA MARSHALL ISLANDS MARTINIQUE MAURITANIA MAURITIUS MAYOTTE MEXICO MICRONESIA.Countries and Regions Supported by PayPal B Country or Region LATVIA LEBANON LESOTHO LIBERIA LIBYAN ARAB JAMAHIRIYA LIECHTENSTEIN LITHUANIA LUXEMBOURG MACAO MACEDONIA. FEDERATED STATES OF MOLDOVA. REPUBLIC OF MONACO MONGOLIA MONTSERRAT MOROCCO MOZAMBIQUE MYANMAR NAMIBIA Country or Region Code LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN MS MA MZ MM NA Name-Value Pair API Developer Guide September 2010 239 . B Countries and Regions Supported by PayPal Country or Region NAURU NEPAL NETHERLANDS NETHERLANDS ANTILLES NEW CALEDONIA NEW ZEALAND NICARAGUA NIGER NIGERIA NIUE NORFOLK ISLAND NORTHERN MARIANA ISLANDS NORWAY OMAN PAKISTAN PALAU PALESTINIAN TERRITORY. OCCUPIED PANAMA PAPUA NEW GUINEA PARAGUAY PERU PHILIPPINES PITCAIRN POLAND PORTUGAL PUERTO RICO QATAR REUNION ROMANIA RUSSIAN FEDERATION RWANDA Country or Region Code NR NP NL AN NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW 240 September 2010 Name-Value Pair API Developer Guide . PROVINCE OF CHINA TAJIKISTAN Country or Region Code SH KN LC PM VC WS SM ST SA SN CS SC SL SG SK SI SB SO ZA GS ES LK SD SR SJ SZ SE CH SY TW TJ Name-Value Pair API Developer Guide September 2010 241 .Countries and Regions Supported by PayPal B Country or Region SAINT HELENA SAINT KITTS AND NEVIS SAINT LUCIA SAINT PIERRE AND MIQUELON SAINT VINCENT AND THE GRENADINES SAMOA SAN MARINO SAO TOME AND PRINCIPE SAUDI ARABIA SENEGAL SERBIA AND MONTENEGRO SEYCHELLES SIERRA LEONE SINGAPORE SLOVAKIA SLOVENIA SOLOMON ISLANDS SOMALIA SOUTH AFRICA SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS SPAIN SRI LANKA SUDAN SURINAME SVALBARD AND JAN MAYEN SWAZILAND SWEDEN SWITZERLAND SYRIAN ARAB REPUBLIC TAIWAN. U. WALLIS AND FUTUNA WESTERN SAHARA YEMEN ZAMBIA ZIMBABWE Country or Region Code TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW 242 September 2010 Name-Value Pair API Developer Guide . BRITISH VIRGIN ISLANDS.S. UNITED REPUBLIC OF THAILAND TIMOR-LESTE TOGO TOKELAU TONGA TRINIDAD AND TOBAGO TUNISIA TURKEY TURKMENISTAN TURKS AND CAICOS ISLANDS TUVALU UGANDA UKRAINE UNITED ARAB EMIRATES UNITED KINGDOM UNITED STATES UNITED STATES MINOR OUTLYING ISLANDS URUGUAY UZBEKISTAN VANUATU VENEZUELA VIET NAM VIRGIN ISLANDS.B Countries and Regions Supported by PayPal Country or Region TANZANIA. Countries and Regions Supported by PayPal Country Codes as an Unordered List for Adaptive Accounts B Country Codes as an Unordered List for Adaptive Accounts                Australia – AU Canada – CA Czech Republic – CZ France – FR Germany – DE Greece – GR Israel – IL Italy – IT Japan – JP Netherlands – NL Poland – PL Russian Federation – RU Spain – ES United Kingdom – GB United States – US Name-Value Pair API Developer Guide September 2010 243 . B Countries and Regions Supported by PayPal Country Codes as an Unordered List for Adaptive Accounts 244 September 2010 Name-Value Pair API Developer Guide . State Abbreviation AB BC MB NB NL NT NS NU ON PE QC SK YT AL AK AS AZ AR CA CO CT DE DC FM FL GA Newfoundland and Labrador Northwest Territories Nova Scotia Nunavut Ontario Prince Edward Island Quebec Saskatchewan Yukon Alabama Alaska American Samoa Arizona Arkansas California Colorado Connecticut Delaware District of Columbia Federated States of Micronesia Florida Georgia Name-Value Pair API Developer Guide September 2010 245 .C Alberta British Columbia Manitoba New Brunswick State and Province Codes Canadian Province or U.S. C State and Province Codes Canadian Province or U. State Guam Hawaii Idaho Illinois Indiana Iowa Kansas Kentucky Louisiana Maine Marshall Islands Maryland Massachusetts Michigan Minnesota Mississippi Missouri Montana Nebraska Nevada New Hampshire New Jersey New Mexico New York North Carolina North Dakota Northern Mariana Islands Ohio Oklahoma Oregon Palau Abbreviation GU HI ID IL IN IA KS KY LA ME MH MD MA MI MN MS MO MT NE NV NH NJ NM NY NC ND MP OH OK OR PW 246 September 2010 Name-Value Pair API Developer Guide .S. State and Province Codes C Canadian Province or U.S. State Pennsylvania Puerto Rico Rhode Island South Carolina South Dakota Tennessee Texas Utah Vermont Virgin Islands Virginia Washington West Virginia Wisconsin Wyoming Armed Forces Americas Armed Forces Armed Forces Pacific Abbreviation PA PR RI SC SD TN TX UT VT VI VA WA WV WI WY AA AE AP Name-Value Pair API Developer Guide September 2010 247 . C State and Province Codes 248 September 2010 Name-Value Pair API Developer Guide . D Currency Australian Dollar Brazilian Real N O TE : Currency Codes PayPal uses 3-character ISO-4217 codes for specifying currencies in fields and variables. MXN NOK NZD PHP PLN GBP SGD SEK CHF TWD Mexican Peso Norwegian Krone New Zealand Dollar Philippine Peso Polish Zloty Pound Sterling Singapore Dollar Swedish Krona Swiss Franc Taiwan New Dollar Name-Value Pair API Developer Guide September 2010 249 . CAD CZK DKK EUR HKD HUF ILS JPY MYR Canadian Dollar Czech Koruna Danish Krone Euro Hong Kong Dollar Hungarian Forint Israeli New Sheqel Japanese Yen Malaysian Ringgit N O TE : This currency is supported as a payment currency and a currency balance for in-country PayPal accounts only. Currencies and Currency Codes Supported by PayPal Currency Code AUD BRL This currency is supported as a payment currency and a currency balance for in-country PayPal accounts only. MasterCard Visa.S. MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard Canada Visa. MasterCard Visa. Maestro. Discover. MasterCard Visa. American Express Visa. Dollar Code AUD CAD CZK DKK EUR HUF JPY NOK NZD PLN GBP SGD SEK CHF USD Visa. MasterCard 250 September 2010 Name-Value Pair API Developer Guide . MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard. MasterCard United States Visa. MasterCard Visa.D Currency Codes Currency Thai Baht U. MasterCard Visa. Dollar Currency Code THB USD Currencies and Currency Codes Supported by DoDirectPayment Currency Australian Dollar Canadian Dollar Czech Koruna Danish Krone Euro Hungarian Forint Japanese Yen Norwegian Krone New Zealand Dollar Polish Zloty Pound Sterling Singapore Dollar Swedish Krona Swiss Franc U. MasterCard Visa. MasterCard. MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard Visa. Solo Visa. MasterCard Visa. MasterCard United Kingdom Visa. MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard Visa.S. MasterCard Visa. MasterCard Visa. MasterCard Visa. MasterCard Visa. and American Express” on page 251 “AVS Response Codes for Maestro and Solo” on page 252  AVS Response Codes for Visa. MasterCard. Discover. Discover.E    AVS and CVV2 Response Codes “AVS Response Codes” on page 251 “CVV2 Response Codes” on page 252 AVS Response Codes “AVS Response Codes for Visa. and American Express AVS Code A B C Meaning Address International “A” International “N” Matched Details Address only (no ZIP) Address only (no ZIP) None NOT E : The transaction is declined. D E International “X” Not allowed for MOTO (Internet/Phone) transactions UK-specific “X” Global Unavailable International Unavailable No Address and Postal Code Not applicable NOT E : The transaction is declined. MasterCard. P R S U Postal (International “Z”) Retry Service not Supported Unavailable Postal Code only (no Address) Not applicable Not applicable Not applicable Name-Value Pair API Developer Guide September 2010 251 . F G I N Address and Postal Code Not applicable Not applicable None NOT E : The transaction is declined. E AVS and CVV2 Response Codes CVV2 Response Codes AVS Code W X Y Z All others Meaning Whole ZIP Exact match Yes ZIP Error Matched Details Nine-digit ZIP code (no Address) Address and nine-digit ZIP code Address and five-digit ZIP Five-digit ZIP code (no Address) Not applicable AVS Response Codes for Maestro and Solo AVS Code 0 1 Meaning All the address information matched. 2 3 4 Null Partial Not applicable Not applicable Not applicable CVV2 Response Codes  “CVV2 Response Codes for Visa. or acquirer had no response. Discover. and American Express” on page 252 “CVV2 Response Codes for Maestro and Solo” on page 253  CVV2 Response Codes for Visa. Address not checked. The merchant did not provide AVS information. Not processed. Default value of field. Discover. No AVS response was obtained. Matched Details All information matched None N O TE : The transaction is declined. MasterCard. Service not available. MasterCard. Part of the address information matched. None of the address information matched. and American Express CVV2 Code M N Meaning Match No match Matched Details CVV2CSC None 252 September 2010 Name-Value Pair API Developer Guide . AVS and CVV2 Response Codes CVV2 Response Codes E CVV2 Code P S U X Meaning Not processed Service not supported Service not available No response Matched Details Not applicable Not applicable Not applicable Not applicable CVV2 Response Codes for Maestro and Solo CVV2 Code 0 1 2 3 4 All others Meaning Matched No match The merchant has not implemented CVV2 code handling Merchant has indicated that CVV2 is not present on card Service not available Error Matched Details CVV2 None Not applicable Not applicable Not applicable Not applicable Name-Value Pair API Developer Guide September 2010 253 . E AVS and CVV2 Response Codes CVV2 Response Codes 254 September 2010 Name-Value Pair API Developer Guide . 250 Authorization Type response fields 24. 34. 26. 49. 55. 155 Address response fields 107. 108. 94. 120. 129. 161 AMT response field 24. 136. 26. 132. 29 AUTHORIZATIONID response field 23. 157 API certificate security 18 API credentials 12 API parameters 17 API signature security 18 Auction Information response fields 112 AUCTIONITEMNUMBER reque st field 164 AUD 249. 139. 164 ACCT response field 131 ACK parameter values 17 ACTION request field 113. 250 Australian Dollar 249. 84 ALLOWEDPAYMENTMETHOD response field 74 ALLOWNOTE request field 50 ALLOWPUSHFUNDING request field 64 American Express AVS response codes 251 American Express CVV2 response codes 252 AMT request field 21. 154. 123. 138. 23. 81. 27 AUTHORIZATIONID request field 21. 143 BillOutstanding API operation 134 BillOutstandingAmount request message 134 BillOutstandingAmount response message 135 BRANDNAME request field 53 Brazilian Real 249 BRL 249 BUSINESS request field 123 Name-Value Pair API Developer Guide September 2010 255 .Index Numerics 3-D Secure request fields 37 3D Secure response fields 39 A ACCT request field 32. 132 ADDRESSSTATUS response field 70. 140. 137 Billing Period Details response fields 128 BILLINGAGREEMENTID response field 156 BILLINGAGREEMENTSTATUS request field 146 BILLINGAGREEMENTSTATUS response field 147 BILLINGFREQUENCY request field 119 BILLINGFREQUENCY response field 128 BILLINGPERIOD request field 119 BILLINGPERIOD response field 128 BILLINGTYPE request field 65. 145 AddressVerify API operation 19 AddressVerify request message 19 AddressVerify response message 20 ADDROVERRIDE request field 51 AGGREGATEAMOUNT response field 126 AGGREGATEOPTIONALAMOUNT response field 126 ALLOWEDPAYMENTMETHOD request field 58. 112. 42. 29 AUTHSTATUS3D request field 37 AUTOBILLAMT request field 119 AUTOBILLOUTAMT request field 136 AUTOBILLOUTAMT response field 126 AVS and CVV2 response codes 251 AVS response codes 251 AVSCODE response field 38. 156 B BA Update request fields 146 BA Update response fields 147 BANKTXNPENDINGURL request field 53 basic implentation steps 12 BAUpdate API operation 146 BAUpdate request message 146 BAUpdate response message 147 Bill Outstanding Amount request fields 134 Bill Outstanding Amount response fields 135 Billing Period Details request fields 119. 41. 107. 134. 133 Activation Details request fields 121 ADDITIONALBILLINGCYCLES request field 136 Address request fields 33. 132 Address Verify request fields 19 Address Verify response fields 20 ADDRESSOWNER response field 107. 26. 71. 43. 151. 124. 127. 38. 156 Czech Koruna 249. 122. 250 CITY request field 33. 152 Buyer Details request fields 64 BUYEREMAILOPTINENABLE request field 53 BUYERID request field 64 BUYERID response field 112 BUYERMARKETINGEMAIL request field 80 BUYERMARKETINGEMAIL response field 68 BUYERREGISTRATIONDATE request field 64 BUYERUSERNAME request field 64 C CAD 249. 55. 250 D Danish Krone 249. 250 CURRENCYCODE request field 21. 138. 115. 123. Adaptive accounts 243 COUNTRYCODE request field 33. 139. 157 CUSTOM request field 35. 140. 139. 250 deploying your application 13 account set up 13 API credentials. 141 CAVV request field 37 CHANNELTYPE request field 52 CHECKOUTSTATUS response field 67 CHF 249. 152 DESC response field 72. 111 CUSTOMERSERVICENUMBER request field 53 CVV2 request field 32. 154 CREDITCARDTYPE response field 131 currency codes 249. 43. 44. 164 CURRENCYCODE response field 44. 155 CLOSINGDATE response field 112 COMPLETETYPE request field 22 CONFIRMATIONCODE response field 20 country codes 235 country codes. 108. 139. 136. 42. 250 Do Authorization request fields 23 Do Authorization response fields 24 Do Capture request fields 21 Do Capture response fields 23 Do Direct Payment request field 31 Do Direct Payment response fields 38 Do ExpressCheckout Payment request fields 79 Do ExpressCheckout Payment response fields 92 Do NonReferenced Credit request fields 41 Do NonReferenced Credit response fields 44 Do Reauthorization request fields 26 Do Reauthorization response fields 26 Do Reference Transaction request fields 149 Do Reference Transaction response fields 156 Do Void request fields 29 Do Void response fields 29 DoAuthorization API operation 23 DoAuthorization request message 23 DoAuthorization response message 24 256 September 2010 Name-Value Pair API Developer Guide . 140. 130. 250 CANCELURL request field 50. 42. 42. 83. 155 COUNTRYCODE response field 20. 250 CZK 249. 68 Create Recurring Payments Profile request fields 118 Create Recurring Payments Profile response fields 125 CreateRecurringPaymentsProfile API operation 117 CreateRecurringPaymentsProfile request message 118 CreateRecurringPaymentsProfile response message 125 Credit Card Details request fields 32. 124. 57. 71. 118. 57. 23. 47. 42. 34. 152 CUSTOM response field 67. 154 CVV2 response codes 252 CVV2MATCH response field 38.Index BUSINESS response field 68 BUTTONSOURCE request field 35. 83. 73. 122. 151. 80. 120. 81. 124. 126 direct integration 11 Discover AVS response codes 251 Discover CVV2 response codes 252 DKK 249. 123. 154 Credit Card Details response fields 131 CREDITCARDTYPE request field 32. 250 Callback API operation 45 CALLBACK request field 50 Callback request fields 45 Callback request message 45 Callback response fields 47 Callback response message 47 CALLBACKTIMEOUT request field 50 CALLBACKVERSION request field 53 Canadian Dollar 249. 94. 26. 161. 45. set up 13 code modification 14 DESC request field 35. 140. 157 FEEREFUNDAMT response field 162 FINALPAYMENTDUEDATE response field 126 FIRSTNAME request field 33. 145. 132. 144. 155. 123. 147 EMAILSUBJECT request field 115 ENDDATE request field 163 error codes 167 error responses 17 EUR 249. 106.Index DoCapture API operation 21 DoCapture request message 21 DoCapture response message 23 DoDirectPayment API operation 31 DoDirectPayment request message 31 DoDirectPayment response message 38 DoExpressCheckoutPayment API operation 79 DoExpressCheckoutPayment request message 79 DoExpressCheckoutPayment response message 92 DoNonReferencedCredit API operation 41 DoNonReferencedCredit request message 41 DoNonReferencedCredit response message 44 DoReauthorization API operation 26 DoReauthorization request message 26 DoReauthorization response message 26 DoReferenceTransaction API operation 148 DoReferenceTransaction request message 149 DoReferenceTransaction response message 156 DoVoid API operation 29 DoVoid request message 29 DoVoid response message 29 F FAILEDINITAMTACTION request field 121 FAILEDPAYMENTCOUNT response field 131 FEEAMT response field 94. 155. 33. 123. 250 Get Balance request fields 101 Get Balance response fields 101 Get Billing Agreement Customer Details request fields 144 Get ExpressCheckout Details request fields 66 Get ExpressCheckout Details response fields 66 Get Pal Details request fields 103 Get Pal Details response fields 103 Get Recurring Payments Profile Details request fields 125 Get Recurring Payments Profile Details response fields 126 Get Transaction Details request fields 105 GetBalance API operation 101 GetBalance request message 101 GetBalance response message 101 GetBillingAgreementCustomerDetails API operation 144 GetBillingAgreementCustomerDetails request message 144 GetBillingAgreementCustomerDetails response message 144 GetExpressCheckoutDetails API operation 66 GetExpressCheckoutDetails request message 66 GetExpressCheckoutDetails response message 66 GetPalDetails API operation 103 GetPalDetails request message 103 GetPalDetails response message 103 GetRecurringPaymentsProfileDetails API operation 125 GetRecurringPaymentsProfileDetails request message 125 GetRecurringPaymentsProfileDetails response message 126 E Ebay Item Payment Details Item request fields 36. 63. 153 Ebay Item Payment Details Item response fields 77 EBAYITEMAUCTIONTXNID response field 97 EBAYITEMAUCTIONTXNIDn response field 77 EBAYITEMCARTIDn response field 77 EBAYITEMNUMBERn response field 77 EBAYITEMORDERIDn response field 77 ECI3DS request field 37 ECISUBMITTED3DS response field 40 EMAIL request field 19. 42. 165 FIRSTNAME response field 68. 43. 250 Euro 249. 148 Forint 249. 154 EXPDATE response field 131 Name-Value Pair API Developer Guide September 2010 257 . 43. 106. 139. 52. 250 Funding Source Details request fields 64 G GBP 249. 90. 108. 163 EMAIL response field 68. 158 EXPDATE request field 32. 132. 139. 109. 124. 250 EXCHANGERATE response field 94. 142 HKD 249 Hong Kong Dollar 249 HTTPS posting 18 HUF 249. 139. 250 Krone 249. 152 HANDLINGAMT response field 72 HDRBACKCOLOR request field 52. 146 L_BILLINGAGREEMENTDESCRIPTIONn response field 147 L_BILLINGAGREEMENTMAXn response field 147 L_BILLINGTYPEn response field 147 L_CURRENCYCODEn response field 101 L_DESCn request field 35. 142 HDRIMG request field 51. 46. 60. 81. 101. 111 IPADDRESS request field 31 Israeli Sheqel 249 ISSUENUMBER request field 32. 80 GIFTRECEIPTENABLE response field 67 GIFTWRAPAMOUNT request field 53. 250 K Koruna 249. 35. 80 GIFTWRAPAMOUNT response field 68 GIFTWRAPENABLE request field 53 GIFTWRAPNA ME response field 67 GIFTWRAPNAME request field 53. 80 GIROPAYCANCELURL request field 53 GIROPAYSUCCESSURL request field 53 GROSSREFUNDAMT response field 162 INVNUM request field 22. 111 L_EBAYITEMAUCTIONTXNIDn request field 36. 90 L_EBAYITEMNUMBERn request field 36. 250 Krona 249. 154 L_EMAILn response field 166 L_FEEAMTn response field 166 I ILS 249 implementation steps 12 create a web application 12 create and post request 12 get API credentials 12 interpret response 13 INITAMT request field 121 INSURANCEAMT request field 82 INSURANCEOPTIONOFFERED request field 56. 250 L L_AMT request field 36. 82. 155 ISSUENUMBER response field 131 ITE MAMT request field 34 ITEMAMT request field 56. 146 L_BILLINGAGREEMENTCUSTOMn response field 147 L_BILLINGAGREEMENTDESCRIPTIONn request field 65. 163 INVNUM response field 67. 112.Index GetTransactionDetails API operation 105 GetTransactionDetails request message 105 GetTransactionDetails response message 105 GIFTMESSAGE request field 80 GIFTMESSAGE response field 67 GIFTMESSAGEENABLE request field 53 GIFTRECEIPTENABLE request field 53. 87. 153 L_AMTn request field 46. 153 L_DESCn response field 74. 63. 60. 250 Hungarian Forint 249. 153 L_EBAYITEMORDERIDn request field 36. 63. 56. 143. 73. 123. 87 L_AMTn response field 75. 90. 99 integrating with NVP API 11 introduction 11 258 September 2010 Name-Value Pair API Developer Guide . 151 ITEMAMT response field 71 J Japanese Yen 249. 42. 154 L_EBAYITEMCARTIDn request field 64. 82 INSURANCEOPTIONOFFERED response field 72 INSURANCEOPTIONSELECTED request field 91 INSURANCEOPTIONSELECTED response field 77. 90. 161. 152. 250 JPY 249. 143. 142 HDRBORDERCOLOR request field 51. 57. 250 H HANDLINGAMT request field 34. 166 L_BILLINGAGREEMENTCUSTOMn request field 65. 63. 90. 46. 62. 89 L_ITEMWIDTHUNITn response field 76 L_ITEMWIDTHVALUEn request field 47. 89 L_ITEMHEIGHTVALUEn response field 76 L_ITEMLENGHTUNITn request field 61. 90 L_PAYMENTREQUEST_n_EBAYITEMAUCTIONT XNIDm response field 77 L_PAYMENTREQUEST_n_EBAYITEMCARTIDm response field 77 L_PAYMENTREQUEST_n_EBAYITEMNUMBERm request field 63. 92. 90 L_PAYMENTREQUEST_n_EBAYITEMORDERIDm response field 77 L_PAYMENTREQUEST_n_ITEMHEIGHTUNITm request field 62. 88 L_PAYMENTREQUEST_n_ITEMWIDTHUNITm request field 62. 89 L_PAYMENTREQUEST_n_ITEMHEIGHTUNITm response field 76 L_PAYMENTREQUEST_n_ITEMHEIGHTVALUEm request field 62. 89 L_PAYMENTREQUEST_n_ITEMWIDTHVALUEm response field 76 L_PAYMENTREQUEST_n_NAMEm request field 59. 61. 89 L_ITEMLENGTHUNITn request field 47 L_ITEMLENGTHUNITn response field 76 L_ITEMLENGTHVALUEn request field 47. 87 L_PAYMENTREQUEST_n_AMTm response field 75 L_PAYMENTREQUEST_n_DESCm request field 60. 62. 62. 61. 93. 89 L_PAYMENTREQUEST_n_ITEMLENGTHUNITm response field 76 L_PAYMENTREQUEST_n_ITEMLENGTHVALUEm request field 61. 89 L_ITEMHEIGHTUNITn response field 76 L_ITEMHEIGHTVALUEn request field 46. 156 L_FMFfilterNAM En response field 98 L_FMFfilterNAMEn response field 39. 88 L_PAYMENTREQUEST_n_ITEMWEIGHTUNITm response field 76 L_PAYMENTREQUEST_n_ITEMWEIGHTVALUEm request field 61. 89 L_PAYMENTREQUEST_n_ITEMWIDTHUNITm response field 76 L_PAYMENTREQUEST_n_ITEMWIDTHVALUEm request field 62. 61. 62. 88 L_ITEMWEIGHTVALUEn response field 76 L_ITEMWIDTHUNITn request field 47. 90 L_PAYMENTREQUEST_n_AMTm request field 60. 166 L_NETAMTn response field 166 L_NUMBER request field 36. 89 L_ITEMWEIGHTUNITn request field 46. 88 L_NUMBERn response field 75. 89 L_PAYMENTREQUEST_n_ITEMLENGTHVALUEm response field 76 L_PAYMENTREQUEST_n_ITEMURLm request field 62. 59. 87 L_PAYMENTREQUEST_n_NAMEm response field 74 L_PAYMENTREQUEST_n_NUMBERm request field 60. 87. 89 L_PAYMENTREQUEST_n_ITEMHEIGHTVALUEm response field 76 L_PAYMENTREQUEST_n_ITEMLENGTHUNITm request field 61. 89 L_ITEMLENGTHVALUEn response field 76 L_ITEMURLn request field 62. 156 L_INSURANCEAMOUNT response field 48 L_ITEMHEIGHTUNITn request field 46. 98. 153 L_NAMEn response field 74. 89 L_ITEMWIDTHVALUEn response field 76 L_NAMEn request field 35. 153 L_NUMBERn request field 46. 60. 112 L_OPTIONSNAMEn response field 112 L_OPTIONSVALUEn response field 112 L_PAYMENTINFO_n_FMFfilterIDm response field 98 L_PAYMENTINFO_n_FMFfilterNAMEm response field 98 L_PAYMENTRE QUEST_n_ITEMWEIGHTVALUEm response field 76 L_PAYMENTREQUESST_n_EBAYITEMAUCTIONT XNIDm request field 63. 88 L_ITEMWEIGHTUNITn response field 76 L_ITEMWEIGHTVALUEn request field 46.Index L_FMFfilterIDn response field 39. 88 L_PAYMENTREQUEST_n_NUMBERm response field 75 Name-Value Pair API Developer Guide September 2010 259 . 87 L_PAYMENTREQUEST_n_DESCm response field 74 L_PAYMENTREQUEST_n_EBAYCARTIDm request field 64. 89 L_PAYMENTREQUEST_n_ITEMWEIGHTUNITm request field 61. 90 L_PAYMENTREQUEST_n_EBAYITEMNUMBERm response field 77 L_PAYMENTREQUEST_n_EBAYITEMORDERIDm request field 63. 84. 103. 115. 250 NOSHIPPING request field 50 NOTE request field 22. 152 NOTIFYURL response field 73 NUMCYCLESREMAINING response field 130 NUMCYCYLESCOMPLETED response field 130 M Maestro AVS response codes 252 Maestro CVV2 response codes 253 Malaysian Ringgit 249 Manage Pending Transaction Status request fields 113 Manage Pending Transaction Status response fields 113 Manage Recurring Payments Profile Status request fields 133 Manage Recurring Payments Profile Status response fields 134 ManagePendingTransactionStatus API operation 113 ManagePendingTransactionStatus request message 113 260 September 2010 Name-Value Pair API Developer Guide . 75. 153 L_QTYn request field 46. 144. 143 L_QTY request field 36. 26. 135 NOTE response field 67. 88 L_QTYn response field 75. 118. 92. 250 NEXTBILLINGDATE response field 130 NO_SHIPPING_OPTION_DETAILS response field 48 NOK 249. 142 ManagePendingTransactionStatus response message 113 ManageRecurringPaymentsProfileStatus API operation 133 ManageRecurringPaymentsProfileStatus request message 133 ManageRecurringPaymentsProfileStatus response message 134 Mass Payment request fields 115 MassPay API operation 115 MassPay request message 115 MassPay response fields 115 MassPay response message 115 MasterCard AVS response codes 251 MasterCard CVV2 response codes 252 MAXAMT request field 49 MAXFAILEDPAYMENTS request field 119. 41. 43. 155. 133. 125. 60. 111 NOTETEXT request field 58. 165 LASTNAME response field 69. 148 MPIVENDOR3DS request field 37 MULTIITEM response field 112 MXN 249 MYR 249 N NETAMT request field 41 NETREFUNDAMT response field 162 New Zealand Dollar 249. 149. 23. 51. 49. 88 L_TIMESTAMPn response field 165 L_TIMEZONEn response field 165 L_TRANSACTIONIDn response field 166 L_TYPEn response field 165 LANDINGPAGE request field 52 LASTNAME request field 33. 112 L_SHIPPINGOPTIONAMOUNT response field 48 L_SHIPPINGOPTIONAMOUNTn request field 65 L_SHIPPINGOPTIONISDEFAULT response field 48 L_SHIPPINGOPTIONISDEFAULTn request field 64 L_SHIPPINGOPTIONLABEL response field 48 L_SHIPPINGOPTIONNAME response field 48 L_SHIPPINGOPTIONNAMEn request field 65 L_STATUSn response field 166 L_SURVEYCHOICEn request field 54 L_TAXAMT request fi eld 36 L_TAXAMT request field 153 L_TAXAMT response field 48 L_TAXAMTn request field 61. 21. 141. 113. 79. 161. 145. 165 MIDDLENAME response field 68. 124. 134. 88 L_PAYMENTTYPEn request field 65. 163 METHOD response field 47 Mexican Peso 249 MIDDLENAME request field 43. 140. 29. 132. 146. 143. 145. 105. 137 MAXFAILEDPAYMENTS response field 126 METHOD request field 19. 88 L_PAYMENTREQUEST_n_QTYm response field 75 L_PAYMENTREQUEST_n_TAXAMTm request field 61. 101. 31. 124. 58. 148 LASTPAYMENTAMT response field 131 LASTPAYMENTDATE response field 131 LOCALE response field 104 LOCALECODE request field 46. 106. 29. 66. 133.Index L_PAYMENTREQUEST_n_QTYm request field 60. 250 Norwegian Krone 249. 135. 45. 84 NOTETEXT response field 73 NOTIFYURL request field 35. 41. 107. 75. 144. 81. 59. 147 PAYFLOWCOLOR request field 52. 81 PAYMENTREQUEST_n_AMT response field 71 PAYMENTREQUEST_n_CURRENCYCODE request field 55. 108. 48 ORDERTIME response field 93. 153 Payment Details Item response fields 74 Payment Details request fields 34. 81 PAYMENTREQUEST_n_CURRENCYCODE response field 71 PAYMENTREQUEST_n_CUSTOM request field 57. 106. 94 PAYMENTINFO_n_TRANSACTIONTYPE response field 93 PaymentItemType response fields 111 PaymentPeriod. 144. 148 PAYERBUSINESS response field 106. 147 PAYERSTATUS request field 123 PAYERSTATUS response field 68. 142 PAL response field 103 PARENTTRANSACTIONID response field 108. 84 PAYMENTREQUEST_n_ALLOWEDPAYMENTMET HOD response field 74 PAYMENTREQUEST_n_AMT request field 55. 165 Payer Name response fields 68. 155 Payer Information response fields 68. 142 PAYMENREQUEST_n_INSURANCEOPTIONOFFE RED response field 72 Payment Details Item request fields 35. 106. 82 PAYMENTREQUEST_n_INVNUM request field 57. 85.Index NVP API overview 11 NVP format 14 NZD 249.Amount request field 121 PAYMENTREQUEST_n_ACK response field 79. 123. 145. 157 OUTSTANDINGAMT request field 136 OUTSTANDINGBALANCE response field 130 P PAGESTYLE request field 51. 132. 59. 139. 123 PAYERID response field 68. 99 PAYMENTREQUEST_n_HANDLINGAMT request field 56 PAYMENTREQUEST_n_HANDLINGAMT response field 72 PAYMENTREQUEST_n_INSURANCEAMT request field 82 PAYMENTREQUEST_n_INSURANCEOPTIONOFFE RED request field 56. 83 PAYMENTREQUEST_n_DESC response field 72 PAYMENTREQUEST_n_ERRORCODE response field 78. 145. 83 PAYMENTREQUEST_n_INVNUM response field 73 Name-Value Pair API Developer Guide September 2010 261 . 156 Payment Item Information response fields 111 Payment Request Info Type response fields 78 PAYMENTACTION reque st field 52 PAYMENTACTION request field 31. 157 Payer Information request fields 33. 144. 124. 55. 83 PAYMENTREQUEST_n_CUSTOM response field 73 PAYMENTREQUEST_n_DESC request field 57. 250 O OFFERINSURANCEOPTION response field 47. 79. 147 Payer Name request fields 43. 108. 43. 98 Payment Information response fields 93. 151 Payment Details response fields 71 Payment Error Type response fields 78. 99 PAYMENTREQUEST_n_ADDRESSSTATUS response field 70 PAYMENTREQUEST_n_ALLOWEDPAYMENTMET HOD request field 58. 106. 147 PAYERID request field 80. 87. 106. 149 PAYMENTINFO_n_AMT response field 94 PAYMENTINFO_n_CURRENCYCODE response field 94 PAYMENTINFO_n_EBAYITEMAUCTIONTXNID response field 97 PAYMENTINFO_n_EXCHANGERATE response field 94 PAYMENTINFO_n_FEEAMT response field 94 PAYMENTINFO_n_ORDERTIME response field 93 PAYMENTINFO_n_PAYMENTSTATUS response field 95 PAYMENTINFO_n_PAYMENTTYPE response field 93 PAYMENTINFO_n_PENDINGREASON response field 96 PAYMENTINFO_n_PROTECTIONELIGIBILITY response field 97 PAYMENTINFO_n_PROTECTIONELIGIBILITYTYP E response field 97 PAYMENTINFO_n_REASONCODE response field 97 PAYMENTINFO_n_TAXAMT response field 94 PAYMENTINFO_n_TRANSACTIONID response field 93. 109. 98 PAYMENTREQUEST_n_SELLERID request field 62. 99 PAYMENTREQUEST_n_NOTETEXT request field 58. 159 PENDINGREASON response field 25. 84 PAYMENTREQUEST_n_NOTIFYURL response field 73 PAYMENTREQUEST_n_PAYMENTACTION request field 59 PAYMENTREQUEST_n_PAYMENTREQUESTID request field 59. 99 PAYMENTREQUEST_n_SHIPDISCAMT request field 82 PAYMENTREQUEST_n_SHIPPINGAMT request field 56. 85 PAYMENTREQUESTID response fie ld 74 PAYMENTREQUESTID response field 98 PAYMENTREQUESTn_TRANSACTIONID request field 84 PAYMENTRREQUEST_n_HANDLINGAMT request field 82 PAYMENTRREQUEST_n_PAYMENTACTION request field 85 PAYMENTSTATUS response field 24. 86 PAYMENTREQUEST_n_SHIPTOSTATE response field 69 PAYMENTREQUEST_n_SHIPTOSTREET request field 54. 78 PAYMENTREQUESTID request field 59. 81 PAYMENTREQUEST_n_SHIPPINGAMT response field 71 PAYMENTREQUEST_n_SHIPTOCITY request field 54. 87 PAYMENTREQUEST_n_SHIPTOPHONENUM response field 70 PAYMENTREQUEST_n_SHIPTOSTATE request field 54. 27. 86 PAYMENTREQUEST_n_SHIPTOSTREET response field 69 PAYMENTREQUEST_n_SHIPTOSTREET2 request field 54. 108. 99 PAYMENTREQUEST_n_SELLERREGISTRATIOND ATE request field 91 PAYMENTREQUEST_n_SELLERUSERNAME request field 91 PAYMENTREQUEST_n_SEVERITYCODE response field 79. 91 PAYMENTREQUEST_n_SELLERPAYPALACCOUN TID request field 63 PAYMENTREQUEST_n_SELLERPAYPALACCOUN TID response field 78. 83 PAYMENTREQUEST_n_TAXAMT response field 72 PAYMENTREQUEST_n_TRANSACTIONID request field 58 PAYMENTREQUEST_n_TRANSACTIONID response field 74. 86 PAYMENTREQUEST_n_SHIPTOZIP response field 70 PAYMENTREQUEST_n_SHORTMESSAGE response field 78. 98 PAYMENTREQUEST_n_SOFTDESCRIPTOR request field 84 PAYMENTREQUEST_n_TAXAMT request field 57. 95. 81 PAYMENTREQUEST_n_ITEMAMT response field 71 PAYMENTREQUEST_n_LONGMESSAGE response field 78.Index PAYMENTREQUEST_n_ITEMAMT request field 56. 85 PAYMENTREQUEST_n_PAYMENTREQUESTID response field 74. 78. 86 PAYMENTREQUEST_n_SHIPTOSTREET2 response field 69 PAYMENTREQUEST_n_SHIPTOZIP request field 55. 86 PAYMENTREQUEST_n_SHIPTOCOUNTRY response field 70 PAYMENTREQUEST_n_SHIPTONAME request field 54. 93. 85 PAYMENTREQUEST_n_SHIPTONAME response field 69 PAYMENTREQUEST_n_SHIPTOPHONENUM request field 55. 86 PAYMENTREQUEST_n_SHIPTOCITY response field 69 PAYMENTREQUEST_n_SHIPTOCOUNTRY request field 55. 28. 96 PERIOD response field 112 Peso 249 Philippine Peso 249 PHONENUM response field 67 PHP 249 262 September 2010 Name-Value Pair API Developer Guide . 158 PAYMENTTYPE response field 92. 157 PAYPALADJUSTMENT response field 67 PENDIN GREASON response field 110. 84 PAYMENTREQUEST_n_NOTETEXT response field 73 PAYMENTREQUEST_n_NOTIFYURL request field 58. 250 PR OTECTIONELIGIBILITY response field 111. 159 RECEIPTID request field 163 RECEIPTID response field 108. 97 PROTECTIONELIGIBILITYTYPE response field 25. 145 Shipping Options request fields 64 SHIPPINGAMT reque st field 151 SHIPPINGAMT request field 34. 160 PROFILEID request field 125. 250 Polish Zloty 249. 140 ProfileID response field 134 PROFILEREFERENCE request field 118. 136 PROFILEREFERENCE response field 127 PROFILESTARTDATE request field 118. 99 R RE DIRECTREQUIRED response field 67 REASONCODE response field 97. 129 SHIPPINGCALCULATIONMODE response field 77. 28. 56. 41. 111. 109. 80. 126. 134. 145. 250 Sheqel 249 Ship To Address response fields 127. 165 SALUTATION response field 68. 148 Schedule Details request fields 118 SDK integration 12 security parameters 16 SEK 249. 133. 99 SHIPPINGDISCAMT request field 82 SHIPPINGOPTIONAMOUNT request field 91 SHIPPINGOPTIONAMOUNT response field 78. 135. 28. 160 REQCONFIRMSHIPPING request field 50 request format 15 Request-Response model 14 RET URNURL request field 49 RETURNALLCURRENCIES request field 101 RETURNFMFDETAILS request field 31. 124. 136. 135 PROFILEID response field 125. 138 SHIPPINGAMT response field 71. 157 SGD 249. 157 RECEIVER request field 163 RECEIVEREMAIL response field 106 RECEIVERID response field 106 RECEIVERTYPE request field 115 Recurring Payments Profile Details request fields 118 Recurring Payments Profile Details response fields 126 Recurring Payments Summary Details response fields 130 REDIRECTREQUIRED response field 92 REFERENCEID reques t field 146 REFERENCEID request field 149 Refund Transaction request fields 161 Refund Transaction response fields 162 RefundTransaction API operation 161 RefundTransaction request message 161 RefundTransaction response message 162 REFUNDTRANSACTIONID response field 162 REFUNDTYPE request field 161 REGULARAMT response field 129 REGULARBILLINGFREQUENCY response field 128 REGULARBILLINGPERIOD response field 128 REGULARCURRENCYCODE response field 130 REGULARSHIPPINGAMT response field 130 REGULARTAXAMT response field 130 REGULARTOTALBILLINGCYCLES response field 129 Name-Value Pair API Developer Guide September 2010 263 . 250 Seller Details request fields 62. 91 SELLERREGISTRATIONDATE re quest field 91 SELLERUSERNAME request field 91 servers API certificate security 18 API signature security 18 Set Customer Billing Agreement request fields 141 Set Customer Billing Agreement response fields 143 Set ExpressCheckout request fields 49 Set ExpressCheckout response fields 66 SetCustomerBillingAgreement API operation 141 SetCustomerBillingAgreement request message 141 SetCustomerBillingAgreement response message 143 SetExpressCheckout API operation 49 SetExpressCheckout request message 49 SetExpressCheckout response message 66 SETTLEAMT response field 94. 110. 149 RETURNURL request field 141 S SALESTAX response field 111 SALUTATION request field 43. 137 PROFILESTARTDATE response field 127 PROTECTIONELIGIBILITY response field 25. 250 Pound Sterling 249. 106. 81.Index PLN 249. 91 SELLERID request field 62. 86. 107. 137. 86. 132 SHIPTOSTREET request field 37. 158 technical details 14 Thai Baht 250 THB 250 TOKEN request field 45. 150 ShipTo Address response fields 69 SHIPTOCITY request field 37. 122. 66. 122. 137. 127. 38. 127. 145 SHIPTOZIP request field 37. 132. 41. 140. 43. 99 ShipTo Address request fields 37. 250 SOFTDESCRIPTOR request field 22. 130. 140. 140. 156 TransactionSearch API operation 163 TransactionSearch request message 163 TransactionSearch response message 165 TRANSACTIONTYPE response field 93. 85. 122. 126 STREET request field 19. 66. 163 TRANSACTIONID response field 24. 47. 47. 163. 144 TOKEN response field 20. 86. 122. 43. 155 STREET2 request field 33. 250 Swiss Franc 249. 109. 150 SHIPTOSTREET2 response field 69. 150 SHIPTOSTREET response f ield 127. 125. 132 SHIPTOSTATE request field 37. 54. 123. 137. 58. 86. 108. 107. 145 SHIPTOSTRE ET2 resp onse field 107. 127. 37. 127. 164 STARTDATE response field 131 state and proivince codes 245 STATE request field 33. 132. 146 Singapore Dollar 249. 122. 54. 138 TWD 249 264 September 2010 Name-Value Pair API Developer Guide . 122. 136. 151. 150 SHIPTOCITY response field 69. 43. 137. 155 SHIPTOPHONENUM response field 70. 150 Solo AVS response codes 252 Solo CVV2 response codes 253 SOLUTIONTYPE request field 52 STARTDATE request field 32. 54. 108. 139. 124. 87. 132 SHIPTOSTREET2 request field 37. 42. 154. 85. 132. 150 SHIPTONAME response field 69. 143 TOTALBILLINGCYCLES request field 119. 127.Index SHIPPINGOPTIONISDEFAULT request field 91 SHIPPINGOPTIONISDEFAULT response field 77. 44. 122. 86. 140. 161. 49. 151 SHIPTOCOUNTRY response field 70 SHIPTOCOUNTRYCODE response field 106. 54. 122. 155 STATUS request field 165 STATUS response field 114. 138. 152 TAXAMT response fie ld 94 TAXAMT response field 72. 165 SUFFIX response field 69. 55. 92. 138 TRIALBILLINGFREQUENCY request field 120 TRIALBILLINGPERIOD request field 120 TRIALTOTALBILLINGCYCLES request field 120. 137. 145 SHIPTOSTREET response field 69. 124. 93. 124. 150 SHIPTOSTATE response field 69. 107. 54. 47. 137. 137. 124. 83. 105. 146. 86. 79. 44. 84. 132. 54. 33. 250 T Taiwan New Dollar 249 TAXAMT request field 34. 113. 55. 47. 137. 107. 145. 127. 118. 148 SURVEYCHOICESELECTED request field 80 SURVEYCHOICESELECTED response field 68 SURVEYENABLE request field 54 SURVEYQUESTION request field 53. 80 SURVEYQUESTION response field 68 Swedish Krona 249. 122. 151 SHIPTOZIP response field 70. 74. 107. 107. 155 STREETMATCH response field 20 SUBSCRIBERNAME request field 118. 107. 147 SHIPTONAME request field 37. 99 SHIPPINGOPTIONNAME request field 91 SHIPPINGOPTIONNAME response field 78. 47. 55. 124. 137. 107. 137 TOTALBILLINGCYCLES response field 129 TOTALREFUNDEDAMT response field 162 Transaction Search request fields 163 Transaction Search response fields 165 TRANSACTIONCLASS request field 164 TRANSACTIONENTITY request field 23 TRANSACTIONID request field 23. 84. 113. 132. 57. 145 SHIPTOPHONENUM request field 33. 144. 145 SHIPTOCOUNTRY request field 37. 136 SUBSCRIBERNAME response field 126 Subscription Terms response fields 112 SUCCESSPAGEREDIRECTREQUESTED response field 92 SUFFIX request field 43. 47. 157 TRIALAMT request field 120. 250 Z ZIP request field 19. 140. 250 Name-Value Pair API Developer Guide September 2010 265 .S. 33. 99 V Visa AVS response codes 251 Visa CVV2 response codes 252 VPAS response field 39 X XID request field 38 Y Yen 249. 155 ZIPMATCH response field 20 Zloty 249.Index U U. 44. 124. Dollar 250 Update Recurring Payments Profile request fields 135 Update Recurring Payments Profile response fields 140 UpdateRecurringPaymentsProfile API operation 135 UpdateRecurringPaymentsProfile request message 135 UpdateRecurringPaymentsProfile response message 140 URL format 14 URL-encoding 14 USD 250 User Selected Options response fields 77. Index 266 September 2010 Name-Value Pair API Developer Guide .
Copyright © 2024 DOKUMEN.SITE Inc.