Home

PayPal Name-Value Pair API - 2012 Developer's Guide

1. 166 GetBillingAgreementCustomerDetails Response Message 166 BAUpdate API Operation 2 0000 pe ee 168 BAUpdate Request Message 0000 eee ee 168 BAUpdate Response Message 0 000 ee ee 168 DoReferenceTransaction API Operation 2 22004 171 DoReferenceTransaction Request Message 2 000002 ae 171 DoReferenceTransaction Response Message 0 e 50000 178 Chapter 13 RefundTransaction API Operation 185 RefundTransaction Request Message 0 e o uo 185 RefundTransaction Request Fields 0 00000 ee eee 185 Merchant Store Details Fields a 2 e 186 RefundTransaction Response Message o o eo 187 RefundTransaction Response Fields a 187 RefundinfoType Fields o o eo 188 Chapter 14 TransactionSearch API Operation 189 TransactionSearch Request Message o e o 189 TransactionSearch Request Fields o 189 Payer Name Fields 00000 eee ee 191 TransactionSearch Response Message 2 a ue 192 TransactionSearch Response Fields 2 0 00 eee ee ee eee 192 Appendix A API Error Codes 2 0 08 2 eee ee 193 General API Errors aoaaa a 193 Validation Errors
2. e 123 Payer Information Fields 00000 eee ee ee ee 123 Payer Name Fields 0 0002 eee ee 124 Name Value Pair API Developer Guide August 2012 5 all Contents Address Fields a 124 Payment Information Fields o o 125 Payment Item Information Fields o e o 129 Payment Item Fields o e eo 130 Auction Information Fields 0 o e 131 Subscription Terms Fields e 131 Chapter 10 ManagePendingTransactionStatus API Operation 133 ManagePendingTransactionStatus Request Message 2 0 133 ManagePendingTransactionStatus Request Fields 133 ManagePendingTransactionStatus Response Message 134 ManagePendingTransactionStatus Response Fields 134 Chapter 11 MassPay API Operation 135 MassPay Request Message 2 eee 135 MassPay Request Fields 0 0000 a 135 MassPay Response Message 2 135 MassPay Response Fields 0 000 a 135 Chapter 12 Recurring Payments and Reference Transactions API Operations137 CreateRecurringPaymentsProfile API Operation 2 2 02 137 CreateRecurringPaymentsProfile Request Message 137 CreateRecurringPaymentsProfile Response Message 145 GetRecurringPaymentsProfileDetails
3. Error Code Short Message Long Message Corrective Action 10759 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed Please enter a valid Contact PayPal for more information credit card number and type 10760 Invalid Configuration This transaction cannot be The merchant s country of residence processed The country listed for listed in their PayPal account is not your business address is not currently supported to allow Direct currently supported Payment transactions 10761 Gateway Decline This transaction cannot be The transaction was declined because processed Please check the PayPal is currently processing a status of your first transaction transaction by the same buyer for the before placing another order same amount Can occur when a buyer submits multiple identical transactions in quick succession 10762 Gateway Decline This transaction cannot be The CVV provide is invalid The CVV is processed between 3 4 digits long 10763 Invalid Data This transaction cannot be None this is a PayPal internal error processed 10764 This transaction cannotbe This transaction cannot be The transaction was declined by PayPal processed at this time processed at this time Please try Please try again later If the problem Please try again later again later persists please contact PayPal 11068 Seller restriction All sellers restricted 11610 Payment Pending your Payment Pending your review in
4. Field Description RECURRING Optional Flag to indicate a recurring transaction It is one of the following values e Any value other than Y This is not a recurring transaction default e Y This is a recurring transaction NOTE To pass Y in this field you must have established a billing agreement with the buyer specifying the amount frequency and duration of the recurring payment What s New in Version 74 0 New Behavior of DoExpressCheckoutPayment By default the DoExpressCheckout Payment API operation is idempotent for all API callers You can call DoExpressCheckout Payment up to a maximum of 10 times and it returns the same result The exceptions are when DoExpressCheckout Payment generates an error or the token expires This functionality only works with version 74 0 or greater There is no change to DoExpressCheckout Payment functionality if you are not updating to the latest version of the API If you update to version 74 0 or higher but want to opt out of this functionality contact PayPal New DoExpressCheckoutPayment Error Code Error Code Short Message Long Message Correcting This Error 13751 Could not retrieve the Transaction completed original successful successfully but could not response retrieve the original successful response Name Value Pair API Developer Guide August 2012 285 i What s New in Version 72 0 What s New in Version 72 0 New TaxldDetailsType Struct
5. 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 Amount of shipping charged on this transaction 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 If you specify a value for PAYMENTINFO n SHIPPINGAMT you must also specify a value for PAYMENTINFO n ITEMAMT SHIPPINGAMT is deprecated since version 63 0 Use PAYMENTINFO n SHIPPINGAMT instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO n SELLE RID PAYMENTINFO n SELLE RUSERNAME PAYMENTINFO n SELLE RREGISTRATIONDATE PAYMENTINFO n PAREN TTRANSACTIONID PARENTTRANSACTIONID deprecated PAYMENTINFO n RECEI PTID RECEIPTID deprecated PAYMENTINFO n EXPEC TEDECHECKCLEARDATE EXPECTEDECHECKCLEAR DATE deprecated PAYMENTINFO n SHIPP INGMETHOD SHIPPINGMETHOD deprecated PAYMENTINFO n INSTR UMENTCATEGORY PAYMENTINFO n OFFER CODE Unique non changing identifier for the merchant at the marketplace site Optional You can specify up to 10 payments where n
6. Name Value Pair API Developer Guide August 2012 209 210 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10004 Transaction refused because Invalid eBay buyer feedback overall of an invalid argument See positive count additional error messages for details 10004 Transaction refused because Invalid eBay buyer feedback overall of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay buyer feedback total of an invalid argument See positive count additional error messages for details 10004 Transaction refused because Invalid eBay buyer feedback total of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay buyer feedback recent of an invalid argument See positive count additional error messages for details 10004 Transaction refused because Invalid eBay buyer feedback recent of an invalid argument See negative count additional error messages for details 10004 Transaction refused because SellerRegistrationDate is invalid of an invalid argument See additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback overall of an invalid argument See positive count additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback ov
7. Address Fields Field Description STREET Required First street address Character length and limitations 100 single byte characters STREET2 Optional Second street address Character length and limitations 100 single byte characters CITY Required Name of city Character length and limitations 40 single byte characters STATE Required State or province Character length and limitations 40 single byte characters COUNTRYCODE Required Country code Character length and limitationst 2 single byte characters ZIP Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHIPTOPHONENUM Optional Phone number Character length and limitations 20 single byte characters Payment Details Fields Field Description AMT Required The total cost of the transaction to the buyer If shipping cost and tax charges are known include them in this value If not this value should be the current subtotal of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases This field must be set to a value greater than 0 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma
8. Name Value Pair API Developer Guide August 2012 247 248 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 11506 Invalid max failed Max failed payments if supplied payments must be gt 0 11507 Invalid trial amount Trial amount must be gt 0 11508 Invalid trial total billing Trial total billing cycles must be gt cycles 0 11509 Invalid trial billing period Trial billing period must be one of Day Week Month SemiMonth or Year 11510 Invalid trial amount Trial amount must be gt 0 11511 Invalid currency for trial This currency is currently not Currency must be USD amount supported for trial amount 11512 Invalid trial shipping Trial shipping amount must be gt Ifa trial shipping amount is amount supplied it must be gt 0 11513 Invalid currency for trial This currency is currently not Currency must be USD shipping amount supported for trial shipping amount 11514 Invalid profile status The profile status is invalid 11515 Invalid currency for trial tax This currency is currently not Currency must be USD amount supported for trial tax amount 11516 Invalid billing frequency Billing Frequency must be gt 0and The combination of billing be less than or equal to one year frequency and billing period cannot exceed one year 11517 Invalid total billing cycles Total billing cycles must be gt 0 0 means continuous 11518 Invalid billing period Billing period mus
9. Name Value Pair API Developer Guide August 2012 271 State and Province Codes 272 Canadian Province or U S State Abbreviation 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 GU HI KS El 5 E Ks a 5 OH OK OR PW August 2012 Name Value Pair API Developer Guide State and Province Codes Canadian Province or U S State Abbreviation Pennsylvania PA Puerto Rico PR Rhode Island RI South Carolina sc South Dakota SD Tennessee TN Texas TX Utah UT Vermont VT Virgin Islands VI Virginia VA Washington WA West Virginia WV Wisconsin WI Wyoming WY Armed Forces Americas AA Armed Forces AE Armed Forces Pacific AP Name Value Pair API Developer Guide August 2012 273 State and Province Codes 274 August 2012 Name Value Pair API Developer Guide Currency Codes PayPal uses 3 character ISO 4217 codes for specifying currencies in fields and variables Currencies and Currency Codes Supported by PayPal Currency Currency Code Australian Dollar AUD Brazilian Real BRL NOTE This currency is supported as a payment currency and a currency balance for in country PayPal acc
10. STATE Required State or province Character length and limitations 40 single byte characters COUNTRYCODE Required Country code Character length and limitationst 2 single byte characters ZIP Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHI PTOPHONENUM Optional Phone number Character length and limitations 20 single byte characters UpdateRecurringPaymentsProfile Response Message UpdateRecurringPaymentsProfile Response Fields Field Description PROFILEID Recurring payments profile ID returned in the CreateRecurringPayment sProfile response An error is returned if the profile specified in the BillOutstandingAmount request has a status of canceled or expired CreateBillingAgreement API Operation The CreateBillingAgreement API operation creates a billing agreement with a PayPal account holder CreateBillingAgreement is only valid for reference transactions CreateBillingAgreement Request Message CreateBillingAgreement Request Fields Field Description METHOD Required Must be CreateBillingAgreement TOKEN Required The time stamped token returned in the SetCustomerBillingAgreement response NOTE The token expires after 3 hours Character length and limitations 20 single byte characters Name Value Pair API Developer Guide August 2012 161 ae Recurring Payments and Reference Transactions API Operations Set
11. ee 194 DirectPayment API Errors es s ea s caa o wa ae e a a E E a 197 SetExpressCheckout API Errors aooaa a a a e 209 GetExpressCheckoutDetails API Errors a oaoa a a a a a 223 DoExpressCheckoutPayment API Errors 2 1 a 224 Authorization and Capture API Errors 2 2 2 233 Name Value Pair API Developer Guide August 2012 7 all Contents GetTransactionDetails API Errors o e o 237 TransactionSearch API Errors 2 2 ee 237 RefundTransaction API Errors 2 ee 239 MassPay APIT EMOS o eoc ea ata 424 bao 4 PR 4 e Re REE de a ee ewe 4 242 Recurring Payments Errors 244 SetCustomerBillingAgreement Errors oaoa eo 251 GetBillingAgreementCustomerDetails Errors 2 o e 253 CreateBillingAgreement Errors 2 0 ee a 253 UpdateBillingAgreement Errors 2 0 e 254 DoReferenceTransaction Errors 2 2 2 ee 255 AddressVerify API Errors aoaaa 262 ManagePendingTransactionStatus API Errors oaoa 262 Appendix B Countries and Regions Supported by PayPal 263 Appendix C State and Province Codes 271 Appendix D Currency Codes 2 562884 244 275 Appendix E AVS and CVV2 Response Codes 277 AVS Response Codes ee 277 AVS Response Codes for Visa MasterCard Discover and American Express 277 AVS Response Codes for Maestro 2 o e
12. 278 CVV2 Response Codes 0 00 279 CVV2 Response Codes for Visa MasterCard Discover and American Express 279 CVV2 Response Codes for Maestro 2 279 About Previous Versions of the API 281 Whats New in Version 92 0 000 ee ee 281 Whats New in Version 89 0 e 281 Whats New in Version 88 0 e 281 Whats New in Version 85 0 0 000 0 eee ee 281 Whats New in Version 84 0 0 eee ee 281 New Field in RefundTransaction Response 2 a e 282 New RefundInfoType in RefundTransaction Response 282 New Field in DoReferenceTransactionResponseDetailsType 282 New Field in DoDirectPaymentResponse 0 0000 ee eee 282 8 August 2012 Name Value Pair API Developer Guide Contents ional What s New in Version 82 0 2 aa 283 New Field in DoCapture Request 0 00000 pees 283 New MerchantStoreDetailsType in DoCapture Request 283 New Fields in RefundTransaction Request 2 e 2 283 New MerchantStoreDetailsType in RefundTransaction Request 284 What s New in Version 80 0 a 285 New Fields in PaymentDetailsType in DoReferenceTransaction Request 285 Whats New in Version 74 0 285 New Behavior of DoExpressCheckoutPaymMent 0 o 285 New DoExpressCheckoutPaymen
13. Status of the payment It is one of the following values e None No status e 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 e Completed The payment has been completed and the funds have been added successfully to your account balance e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element e Expired The authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from your buyer s bank account e In Progress The transaction has not terminated for example an authorization may be awaiting completion e Partially Refunded The payment has been partially refunded e Pending The payment is pending See the PendingReason field for more information e Refunded You refunded the payment e 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 e Processed A payment has been accepted e Voided An authorization for this transaction has been voided Name Value Pair API Developer Guide August 2012 181 ae Recurring Payments and Reference Transactions API Operations
14. Character length and limitations Date and time are in UTC GMT format for example 2011 06 24T05 38 48Z ORDERTIME is deprecated since version 63 0 Use PAYMENTINFO_0 ORDERTIME instead The final amount charged including any shipping and taxes from your Merchant Profile 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 Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma AMT is deprecated since version 63 0 Use PAYMENTINFO_0_AMT instead A 3 character currency code Default USD CURRENCYCODE is deprecated since version 63 0 Use PAYMENTINFO_0_CURRENCYCODE instead PayPal fee amount charged for the transaction PayPal fee amount charged for the transaction You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma FEEAMT is deprecated since version 63 0 Use PAYMENTINFO_0_FEEAMT instead Amount deposite
15. Country or Region Code BOTSWANA BOUVET ISLAND BRAZIL BRITISH INDIAN OCEAN TERRITORY BRUNEI DARUSSALAM BULGARIA BURKINA FASO CANADA CAPE VERDE CAYMAN ISLANDS CENTRAL AFRICAN REPUBLIC CHILE CHINA CHRISTMAS ISLAND COCOS KEELING ISLANDS COLOMBIA COOK ISLANDS COSTA RICA CYPRUS CZECH REPUBLIC DENMARK DJIBOUTI DOMINICA DOMINICAN REPUBLIC ECUADOR EGYPT EL SALVADOR ESTONIA FALKLAND ISLANDS MALVINAS FAROE ISLANDS FIJI BW BV BR Io BN BG 8 2 2 CF CL cx cc CO CK CR CY CZ DK DJ DM DO EC EG SV EE FK FO EJ August 2012 Name Value Pair API Developer Guide Countries and Regions Supported by PayPal Boo Country or Region Country or Region Code FINLAND FI FRANCE FR FRENCH GUIANA GF FRENCH POLYNESIA PF FRENCH SOUTHERN TERRITORIES TF GABON GA GAMBIA GM GEORGIA GE GERMANY DE GHANA GH GIBRALTAR GI GREECE GR GREENLAND GL GRENADA GD GUADELOUPE GP GUAM GU GUERNSEY cc GUYANA GY HEARD ISLAND AND MCDONALD ISLANDS HM HOLY SEE VATICAN CITY STATE VA HONDURAS HN HONG KONG HK HUNGARY HU ICELAND Is INDIA IN INDONESIA ID IRELAND IE ISLE OF MAN IM ISRAEL IL ITALY IT JAMAICA JM Name Value Pair API Developer Guide August 2012 265 ae Countries and Regions Supported by PayPal Country or Region Country or Region Code JAPAN JP JERSEY JE JORDAN JO KAZAKHSTAN KZ KIRIBATI KI KOREA REPUBLIC OF KR KUWAIT KW KYRGYZST
16. CouponID L_COUPONIDN CouponAmount L_COUPONAMOUNTN CouponAmount Currenc Y L_COUPONAMOUNTCURRE NCYn LoyaltyCardDiscount Amount L_LOYALTYCARDDISCOU NTAMOUNTN LoyaltyCardDiscount Currency L_LOYALTYCARDISCOUN TCURRENCYN L_AMTn xs string Optional The eBay auction transaction ID of the item that you use to identify items that the buyer purchased Character length and limitations 255 single byte characters Item name set by you or entered by the customer NOTE Character length and limitations 127 single byte alphanumeric characters These parameters must be ordered sequentially beginning with 0 for example L DESCO L_DESC1 Item number set by you If this was a shopping cart transaction PayPal appends the number of the item to the HTML item_number variable for example item number1 item_number2 and so forth Character length and limitations 127 single byte alphanumeric characters These parameters must be ordered sequentially beginning with 0 for example L_NUMBERO L_NUMBER1 Quantity set by you or entered by the buyer Character length and limitations no limit xs string Optional Coupon identification number xs string Optional Amount value of the coupon xs string Optional Currency of the coupon amount e g a 3 character currency code xs string Optional Amount of discount associated with this Loyalty Card incentive NOTE Use character string as shown xs string Optional Cu
17. DoReferenceTransaction API Operation Field Description PEND INGREASON The reason the payment is pending It is one of the following values none No pending reason address The payment is pending because your buyer 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 int1 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 payment review 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 veri
18. Field Description L_DESCn Item description from the Express Checkout API These parameters must be ordered sequentially beginning with 0 for example L DESCO L_DESC1 L_AMTn Item unit price from the Express Checkout API These parameters must be ordered sequentially beginning with 0 for example L_AMTO L_AMT1 L_OTYn Item unit quantity from the Express Checkout API L_ITEMWEIGHTVALUEN L_ITEMWEIGHTUNITN L_ITEMHEIGHTVALUEN L_ITEMHEIGHTUNITN L_ITEMWIDTHVALUEN L_ITEMWIDTHUNITN L_ITEMLENGTHVALUEN L_ITEMLENGTHUNITN SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRY These parameters must be ordered sequentially beginning with 0 for example L_QTYO L QTY1 The weight of the item You can pass this data to the shipping carrier as is without having to make an additional database query These parameters must be ordered sequentially beginning with 0 for example L _ITEMWEIGHTVALUEO L_ITEMWEIGHTVALUE1 The height of the item You can pass this data to the shipping carrier as is without having to make an additional database query These parameters must be ordered sequentially beginning with 0 for example L _ITEMHEIGHTVALUEO ITEMHEIGHTVALUE1 The width of the item You can pass this data to the shipping carrier as is without having to make an additional database query These parameters must be ordered sequentially beginning with 0 for example L _ITEMWIDTHVALUEO L _ ITEMWI
19. For digital goods this field is required and you must set it to 1 It is one of the following values e 0 PayPal displays the shipping address on the PayPal pages e 1 PayPal does not display shipping address fields whatsoever e 2 If you do not pass the shipping address PayPal obtains it from the buyer s account profile Character length and limitations 4 single byte numeric characters ALLOWNOTE Optional Enables the buyer to enter a note to the merchant on the PayPal page during checkout The note is returned in the GetExpressCheckoutDetails response and the DoExpressCheckout Payment response It is one of the following values e 0 The buyer is unable to enter a note to the merchant e 1 The buyer is able to enter a note to the merchant Character length and limitations 1 single byte numeric character This field is available since version 53 0 ADDROVERRIDE Optional Determines whether or not the PayPal pages should display the shipping address set by you in this SetExpressCheckout request not the shipping address on file with PayPal for this buyer Displaying the PayPal street address on file does not allow the buyer to edit that address It is one of the following values e 0 The PayPal pages should not display the shipping address e 1 The PayPal pages should display the shipping address Character length and limitations 1 single byte numeric character CALLBACKVERS ION Version of the callbac
20. REFUNDADVICE REFUNDITEMDETAILS MSGSUBID Optional Maximum time until you must retry the refund NOTE This field does not apply to point of sale transactions This field is available since version 82 0 Optional Type of PayPal funding source balance or eCheck that can be used for auto refund It is one of the following values e any The merchant does not have a preference Use any available funding source default Use the merchant s preferred funding source as configured in the merchant s profile e instant Use the merchant s balance as the funding source e eCheck The merchant prefers using the eCheck funding source If the merchant s PayPal balance can cover the refund amount use the PayPal balance NOTE This field does not apply to point of sale transactions This field is available since version 82 0 Optional Information about the merchant store This field is available since version 82 0 Optional Flag to indicate that the buyer was already given store credit for a given transaction It is one of the following values e true The buyer was already given store credit for a given transaction e false The buyer was not given store credit for a given transaction This field is available since version 85 0 Optional Details about the individual items to be returned Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the lat
21. SWEDEN SWITZERLAND TAIWAN PROVINCE OF CHINA TANZANIA UNITED REPUBLIC OF THAILAND TIMOR LESTE TOGO TOKELAU TONGA SH KN LC PM VC WS SM ST SA SN RS SC SG SK SI SB GS ES SR SJ SZ SE CH TZ TH TL TG TK TO August 2012 Name Value Pair API Developer Guide Countries and Regions Supported by PayPal Boo Country or Region Country or Region Code TRINIDAD AND TOBAGO TT TUNISIA TN TURKEY TR TURKMENISTAN TM TURKS AND CAICOS ISLANDS TC TUVALU TV UGANDA UG UKRAINE UA UNITED ARAB EMIRATES AE UNITED KINGDOM GB UNITED STATES US UNITED STATES MINOR OUTLYING ISLANDS UM URUGUAY UY UZBEKISTAN UZ VANUATU VU VENEZUELA VE VIET NAM VN VIRGIN ISLANDS BRITISH VG VIRGIN ISLANDS U S VI WALLIS AND FUTUNA WF WESTERN SAHARA EH ZAMBIA ZM Name Value Pair API Developer Guide August 2012 269 E Countries and Regions Supported by PayPal 270 August 2012 Name Value Pair API Developer Guide State and Province Codes Canadian Province or U S State Abbreviation Alberta AB British Columbia BC Manitoba MB New Brunswick NB Newfoundland and Labrador NL Northwest Territories NT Nova Scotia NS Nunavut NU Ontario ON Prince Edward Island PE Quebec Qc Saskatchewan SK Yukon YT Alabama AL Alaska AK American Samoa AS Arizona AZ Arkansas AR California CA Colorado co Connecticut CT Delaware DE District of Columbia DC Federated States of Micronesia FM Florida FL Georgia GA
22. e PaymentActionNot Initiated e PaymentActionFailed e PaymentActionInProgress e PaymentCompleted Gift message entered by the buyer on the PayPal checkout pages Character length and limitations 150 single byte characters Whether the buyer requested a gift receipt It is one of the following values e true The buyer requested a gift receipt e false The buyer did not request a gift receipt Returns the gift wrap name only if the buyer selects gift option on the PayPal pages Character length and limitations 25 single byte characters Returns the gift wrap amount only if the buyer selects the gift option on the PayPal pages Character length and 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 Buyer s email address if the buyer provided it on the PayPal pages Character length and limitations 127 single byte characters Survey question on the PayPal checkout pages Character length and limitations 50 single byte characters Survey response the buyer selects on the PayPal pages Character length and limitations 15 single byte characters Payer Information Fields Field Description EMAIL PAYERID PAYERSTATUS Email address of buyer Character length and limitations 127 single byte characters Unique PayPal Customer Account identification number Cha
23. is a digit between 0 and 9 inclusive Character length and limitations 13 single byte alphanumeric characters Current name of the merchant or business at the marketplace site This name may be shown to the buyer You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Date when the merchant registered with the marketplace You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Date and time are in UTC GMT format For example 2011 06 24T05 38 48Z Parent or related transaction identification number This field is populated for the following transaction types e Reversal e Capture of an authorized transaction e Reauthorization of a transaction Oo Capture of an order The value of ParentTransactionID is the original OrderID e Authorization of an order The value of ParentTransactionID is the original OrderTD e Capture of an order authorization e Void of an order The value of ParentTransactionID is the original OrderTD Character length and limits 19 single byte characters maximum PARENTTRANSACTIONID is deprecated since version 63 0 Use PAYMENTINFO n PARENTTRANSACTIONID instead Character length and limitations 16 digits in XXXX XXXX XXXX XXXX format RECEIPTID is deprecated since version 63 0 Use PAYMENTINFO_n RECEIPTID instead eCheck latest expected clear date EXPECTEDECHECKCLEARDATE is deprecated since ver
24. 256 single byte alphanumeric characters BAUpdate Response Message BAUpdate Response Fields Field Description L _BILLINGTYPEN L _BILLINGAGREEMENTD ESCRIPTIONN Type of billing agreement Description of goods or services associated with the billing agreement This field is required for each recurring payment billing agreement Character length and limitations 127 single byte alphanumeric characters August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations BAUpdate API Operation Field Description L BILLINGAGREEMENTC Custom annotation field for your own use USTOMN Character length and limitations 256 single byte alphanumeric characters BILLINGAGREEMENTSTA Optional Use to cancel a billing agreement To cancel a billing agreement pass the TUS value Canceled NOTE If you do not pass the value Canceled BAUpdate returns the buyer s latest billing address L_BILLINGAGREEMENTM Maximum amount for this billing agreement ARN NOTE This field only has a value if the buyer signed up for PayPal using Preapproved Payments it is included for backwards compatibility with legacy systems Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must
25. 40 single byte characters STATE Required State or province Character length and limitations 40 single byte characters COUNTRYCODE Required Country code Character length and limitationst 2 single byte characters ZIP Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHI PTOPHONENUM Optional Phone number Character length and limitations 20 single byte characters Payment Details Item Fields Field Description L PAYMENTREQUEST_n IT EMCATEGORYM L PAYMENTREQUEST n NA MEM L PAYMENTREQUEST _n DE scm Indicates whether the item is digital or physical For digital goods this field is required and must be set to Digital to get the best rates Is one of the following values These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_n ITEMCATEGORYO L PAYMENTREQUEST_n ITEMCATEGORY1 Is one of the following values e Digital e Physical This field is introduced in version 69 0 Item name This field is required when ItemCategory is passed Item name This field is required when L PAYMENTREQUEST_N ITEMCATEGORYM is passed These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST n NAMEO L PAYMENTREQUEST_N NAME1 Character length and limitations 127 single byte characters This field is introduced in version 69 0 Optional Item description These parameters must be ordered
26. 78 GetExpressCheckoutDetails API Operation a a e e o 78 GetExpressCheckoutDetails Request Message 0 78 GetExpressCheckoutDetails Response Message o a 79 DoExpressCheckoutPayment API Operation 0 eee 92 DoExpressCheckoutPayment Request Message 2 92 DoExpressCheckoutPayment Response Message 2 105 Chapter 7 GetBalance API Operation 117 GetBalance Request Message 2 e o a 117 GetBalance Request Fields e o 117 GetBalance Response Message e 117 GetBalance Response Fields e o 117 Chapter 8 GetPalDetails API Operation 119 GetPalDetails Request Message 2 2 2 ee 119 GetPalDetails Request Fields 2 2 a a a a ee 119 GetPalDetails Response Message 2 2 o 0 uo 119 GetPalDetails Response Fields 119 Chapter 9 GetTransactionDetails API Operation 121 GetTransactionDetails Request Message 0 e 121 GetTransactionDetails Request Fields 0 0 e 121 GetTransactionDetails Response Message e eee eee 121 GetTransactionDetails Response Fields 0 e e 121 Receiver Information Fields
27. August 2012 Credit Card Details request fields 42 52 142 159 177 Credit Card Details response fields 152 CREDITCARDTYPE request field 42 52 142 159 177 CREDITCARDTYPE response field 152 currency codes 275 276 CURRENCYCODE request field 27 33 36 43 52 55 58 67 94 135 140 159 173 185 188 190 CURRENCYCODE response field 54 83 109 126 151 180 CUSTOM request field 45 69 97 174 CUSTOM response field 79 85 129 CUSTOMERSERVICENUMBER request field 64 CVV2 request field 42 52 142 160 177 CVV2 response codes 279 CVV2MATCH response field 48 178 Czech Koruna 275 276 CZK 275 276 D Danish Krone 275 276 DESC request field 45 69 96 138 156 174 DESC response field 85 147 Discover AVS response codes 277 Discover CVV2 response codes 279 DKK 275 276 Do Authorization request fields 32 Do Authorization response fields 33 Do Capture request fields 27 Do Capture response fields 29 Do Direct Payment request field 41 Do Direct Payment response fields 48 Do ExpressCheckout Payment request fields 92 Do ExpressCheckout Payment response fields 105 Do NonReferenced Credit request fields 51 Do NonReferenced Credit response fields 54 Do Reauthorization request fields 36 Do Reauthorization response fields 37 Do Reference Transaction request fields 171 Do Reference Transaction response fields 178 Do Void request fields 39 Do Void response fields 39 DoAuthorization API operation 32
28. DoExpressCheckout has occurred TRANSACTIONID is deprecated since version 63 0 Use PAYMENTREQUEST 0 TRANSACTIONID instead 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 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST n PAYME A unique identifier of the specific payment request Required when NTREQUESTID implementing parallel payments You can specify up to 10 payments where n is PAYMENTREQUESTID a digit between 0 and 9 inclusive deprecated Character length and limitations Up to 127 single byte characters PAYMENTREQUESTID is deprecated since version 63 0 Use PAYMENTREQUEST 0 PAYMENTREQUESTID instead Payment Details ltem Type Fields Field Description L PAYMENTREQUEST nm NAME Item name You can specify up to 10 payments where n is a digit between 0 and m 9 inclusive and m specifies the list item within the payment except for digital L_NAMEN deprecated goods which only supports single payments These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_n NAMEO L PAYMENTREQUEST_n_NAME1 Character length and limitations 127 single byte characters L_NAMEn is
29. What s New in Version 88 0 Maintenance release updated for 88 0 What s New in Version 85 0 No new features added solely a maintenance release What s New in Version 84 0 Name Value Pair API Developer Guide August 2012 281 GA What s New in Version 84 0 New Field in RefundTransaction Response Field Description REFUNDINFO Contains refund payment status information This field is available since version 84 0 New RefundinfoType in RefundTransaction Response Field Description REFUNDSTATUS Status of the refund It is one of the following values e instant e delayed This field is available since version 84 0 PENDINGREASON Reason that the payment is delayed It is one of the following values e none The refund is instant e echeck The refund is delayed This field is available since version 84 0 New Field in DoReferenceTransactionResponseDetailsType Field Description PAYMENTADVICECODE Response code from the processor when a recurring transaction is declined For details on the meanings of the codes see https merchant paypal com us cgi bin amp cmd _render content amp content ID merchant cc_ compliance error codes This field is available since version 84 0 New Field in DoDirectPaymentResponse Field Description PAYMENTADVICECODE Response code from the processor when a recurring transaction is declined For details on the meanings of the codes s
30. details 10004 Invalid transaction type You can not get the details for this type of transaction 10004 Transaction refused because The transaction could not be loaded of an invalid argument See additional error messages for details 10004 Transaction refused because The transaction id is not valid of an invalid argument See additional error messages for details 10007 Permission denied You do not have permission to make this API call 10007 Permission denied You do not have permission to get the details of this transaction Name Value Pair API Developer Guide August 2012 223 224 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10007 Permission denied You do not have permission to make this API call 10408 Express Checkout token is Express Checkout token is missing missing 10409 You re not authorized to Express Checkout token was issued for access this info a merchant account other than yours 10410 Invalid token Invalid token 10411 This Express Checkout This Express Checkout session has session has expired expired Token value is no longer valid 13112 Cannot Pay Seller The Buyer will not be able to Pay the seller for this transaction 13116 Transaction refused because The transaction is in progress for this of an invalid argument See additional error messages for details token DoExpressCheckoutPayment API Errors DoExpressCheck
31. feature unavailable DoCapture Service DoReauthorization DoVoid 10608 Funding source The funding source is DoAuthorization Contact the buyer missing missing DoCapture DoReauthorization 10609 Invalid Transaction id is invalid DoAuthorization Check the validity of the transactionID DoCapture authorization ID and DoReauthorization reattempt the request DoVoid 10610 Amount limit Amount specified DoAuthorization Reattempt the request exceeded exceeds allowable limit DoCapture with a lower amount DoReauthorization 10611 Not enabled Authorization amp Capture DoAuthorization Contact PayPal Customer feature is not enabled for DoCapture Service the merchant Contact DoReauthorization customer service 10612 No more Maxmimum number of DoCapture Close the order settlement allowable settlements has been reached No more settlement for the authorization 10613 Currency Currency of capture must DoCapture Ensure that the currencies mismatch be the same as currency are the same and retry of authorization the request 10614 Cannot void You can void only the DoVoid Void the authorization reauth original authorization not a reauthorization August 2012 Name Value Pair API Developer Guide Authorization and Capture API Errors API Error Codes Error Short Returned By API Correcting This Code Message Long Message Call Error 10615 Cannot reauth You can reauthorize only DoReauthorization Capture the re
32. functionality to obtain the latest billing address and to skip billing agreement creation Added ReverseTransaction API Name Value Pair API Developer Guide August 2012 295 296 August 2012 Name Value Pair API Developer Guide Name Value Pair API Developer Guide Index Numerics 3 D Secure request fields 47 3D Secure response fields 50 A ACCT request field 42 52 142 160 177 190 ACCT response field 152 ACTION request field 133 154 Activation Details request fields 141 ADDITIONALBILLINGCYCLES request field 156 Address request fields 43 53 143 160 178 Address response fields 124 153 Address Verify request fields 25 Address Verify response fields 26 ADDRESSOWNER response field 124 153 ADDRESSSTATUS response field 82 124 148 153 167 AddressVerify API operation 25 AddressVerify request message 25 AddressVerify response message 26 ADDROVERRIDE request field 61 AGGREGATEAMOUNT response field 147 AGGREGATEOPTIONALAMOUNT response field 147 ALLOWEDPAYMENTMETHOD request field 70 98 ALLOWEDPAYMENTMETHOD respo nse field 86 ALLOWNOTE request field 61 ALLOWPUSHFUNDING request field 76 American Express AVS response codes 277 American Express CVV2 response codes 279 AMT request field 27 32 36 43 51 59 67 94 139 155 156 158 173 185 AMT response field 33 48 83 109 126 131 150 180 AUCTI ONITEMNUMBER reque st field 190 Auction Information response fields 131 AUD 275 276 Austral
33. if the billing cycle is Month the maximum value for billing frequency is 12 Similarly if the billing cycle is Week the maximum value for billing frequency is 52 NOTE If the billing period is SemiMonth the billing frequency must be 1 Optional Number of billing cycles for trial payment period Billing amount for each billing cycle during this payment period required if you specify an optional trial period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Required Currency code default is USD Character length and limitations 3 single byte characters Optional Shipping amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Taxamount for each billing cycle during this payment period NOTE All amounts in the
34. message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid Name Value Pair API Developer Guide August 2012 203 204 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10717 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error postal code in the billing address message tells you which field is invalid 10718 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error city and state in the billing message tells you which field is invalid address 10719 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error shipping address message tells you which field is invalid 10720 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error addressl in the shipping address message tells you which field is invalid 10721 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error address2 in the shipping address message tells you
35. 153 SHIPTOSTATE request field 47 57 66 99 141 158 173 SHIPTOSTATE response field 82 124 148 153 167 SHIPTOSTRE ET2 resp onse field 124 153 SHIPTOSTREET request field 47 57 66 99 141 157 173 SHIPTOSTREET response field 148 167 SHIPTOSTREET response field 81 124 153 SHIPTOSTREET2 request field 47 57 66 99 141 158 173 SHIPTOSTREET2 response field 81 148 167 SHIPTOZIP request field 47 57 66 99 142 158 173 SHIPTOZIP response field 82 124 148 153 167 Singapore Dollar 275 276 SOFTDESCRIPTOR request field 28 97 172 SOLUTIONTYPE request field 63 STARTDATE request field 42 52 142 160 177 189 190 STARTDATE response field 152 state and proivince codes 271 STATE request field 43 53 144 161 178 STATUS request field 191 STATUS response field 134 146 Storeld 113 129 183 STOREID request field 29 186 283 284 Name Value Pair API Developer Guide STREET request field 25 43 53 143 160 178 STREET2 request field 43 53 143 160 178 STREETMATCH response field 26 SUBSCRIBERNAME request field 138 156 SUBSCRIBERNAME response field 147 Subscription Terms response fields 131 SUCCESSPAGEREDIRECTREQUESTED response field 106 SUFFIX request field 53 143 191 SUFFIX response field 81 124 167 170 SURVEYCHOICESELECTED request field 93 SURVEYCHOICESELECTED response field 80 123 SURVEYENABLE request field 65 SURVEY QUESTION request field 65 93 SURVEYQUESTION respons
36. 3 character currency code default is USD ITEMAMT Optional Sum of cost of all items in this order NOTE ITEMAMT is required if you specify L_AMTn Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Name Value Pair API Developer Guide August 2012 173 174 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description SHIPPINGAMT HANDLINGAMT TAXAMT DESC CUSTOM INVNUM BUTTONSOURCE Optional Total shipping costs for this order NOTE If you specify a value for SHIPPINGAMT you must also specify a value for ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Total handling costs for this order NOTE If you specify a value for HANDLINGAMT you must also specify a value for ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a peri
37. 84 INSURANCEOPTIONSELECTED request field 104 I SURANCEOPTIONSELECTED response field 90 115 122 INVNUM request field 28 45 70 174 185 189 ZZZZZ August 2012 INVNUM response field 79 86 129 IPADDRESS request field 41 171 Israeli Sheqel 275 ISSUENUMBER request field 42 52 142 160 177 ISSUENUMBER response field 152 ITE MAMT request field 44 ITEMAMT request field 67 95 173 289 ITEMAMT response field 83 J Japanese Yen 275 276 JPY 275 276 K Koruna 275 276 Krona 275 276 Krone 275 276 L L_AMT request field 46 175 288 L_AMTn request field 57 72 100 290 L_AMTn response field 87 117 130 192 L_BILLINGAGREEMENTCUSTOMnh request field 77 165 168 L_BILLINGAGREEMENTCUSTOMn response field 169 L_BILLINGAGREEMENTDESCRIPTIONn request field 77 165 168 L_BILLINGAGREEMENTDESCRIPTIONn response field 168 L_BILLINGAGREEMENTMAXn response field 169 L_BILLINGTYPEn request field 77 164 L_BILLINGTYPEn response field 168 L_COUPONAMOUNTCurrencyn response field 130 L_COUPONAMOUNTnh response field 130 L_COUPONIDn response field 130 L_CURRENCYCODEn response field 117 192 L_DESCn request field 46 57 72 100 175 290 L_DESCn response field 87 130 L_EBAYITEMAUCTIONTXNIDn request field 46 75 103 176 L_EBAYITEMCARTIDn request field 75 104 L_EBAYITEMNUMBERn request field 46 75 103 176 Name Value Pair API Developer Guide Name Value Pair API Developer Guide L
38. API Operation Field Description LOCALECODE Optional Locale of pages displayed by PayPal during checkout PayPal supports the following 2 character country codes e AU Australia AT Austria BE Belgium BR Brazil CA Canada CH Switzerland CN China DE Germany ES Spain GB United Kingdom FR France IT Italy NL Netherlands PL Poland PT Portugal RU Russia US United States The following 5 character codes are also supported for languages in specific countries da_DK Danish for Denmark only he IL Hebrew all id ID Indonesian for Indonesia only jp _JP Japanese for Japan only no_NO Norwegian for Norway only pt_BR Brazilian Portuguese for Portugal and Brazil only ru RU Russian for Lithuania Latvia and Ukraine only sv_SE Swedish for Sweden only th_TH Thai for Thailand only tr_TR Turkish for Turkey only zh_CN Simplified Chinese for China only zh HK Traditional Chinese for Hong Kong only zh TW Traditional Chinese for Taiwan only Any other value defaults to US Character length and limitations 2 single byte characters PAGESTYLE Optional Sets the Custom Payment Page Style for payment pages associated with this button link This value corresponds to the HTML variable page style for customizing payment pages The value is the same as the Page Style Name you chose when adding or editing the page style in your PayPal accou
39. 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 You must set the currencyID attribute to one of the 3 character currency codes for any of the supported PayPal currencies Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Search by 3 character ISO 4217 currency code August 2012 Name Value Pair API Developer Guide TransactionSearch API Operation TransactionSearch Request Message Field Description STATUS Optional Search by transaction status It is one of the following values e Pending The payment is pending The specific reason the payment is pending is returned by the Get Transact ionDetails API PendingReason field e Processing The payment is being processed Success The payment has been completed and the funds have been added successfully to you
40. CURRENCYCODE Optional A 3 character currency code default is USD Name Value Pair API Developer Guide August 2012 43 4 DoDirectPayment API Operation DoDirectPayment Request Message Field Description ITEMAMT SHIPPINGAMT INSURANCEAMT SHIPDISCAMT HANDLINGAMT TAXAMT Optional Sum of cost of all items in this order NOTE ITEMAMT is required if you specify L_AMTn Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Total shipping costs for this order NOTE If you specify a value for SHIPPINGAMT you must also specify a value for ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Total shipping insurance costs for this order The value must be a non negative currency amount or null if you offer insurance options Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the op
41. Cart da CORRELATIONID 63cdacob de e VERSION 52 2e000000 rver BUILD 1 2e0006 Response specific fields Related information PayPal API Client Server Architecture August 2012 Name Value Pair API Developer Guide PayPal Name Value Pair API Basics Responding to an NVP Response Common Response Fields The PayPal API always returns common fields in addition to fields that are specific to the requested PayPal API operation A PayPal API response includes the following fields Field Description ACK Acknowledgement status which is one of the following values e Success indicates a successful operation e SuccessWithWarning indicates a successful operation however there are messages returned in the response that you should examine e Failure indicates the operation failed the response also contains one or more error messages explaining the failure e FailureWithWarning indicates that the operation failed and that there are messages returned in the response that you should examine CORRELATIONID Correlation ID which uniquely identifies the transaction to PayPal TIMESTAMP The date and time that the requested API operation was performed VERSION The version of the API BUILD The sub version of the API Error Responses If the ACK value is not Success API response fields may not be returned An error response has the following general format Format of an Error Response Response Fieldson ACK notSuccess a
42. DoAuthorization request message 32 DoAuthorization response message 33 DoCapture API operation 27 Name Value Pair API Developer Guide DoCapture request message 27 DoCapture response message 29 DoDirectPayment API operation 41 DoDirectPayment request message 41 DoDirectPayment response message 48 DoExpressCheckoutPayment API operation 92 DoExpressCheckoutPayment request message 92 DoExpressCheckoutPayment response message 105 DoNonReferencedCredit API operation 51 DoNonReferencedCredit request message 51 DoNonReferencedCredit response message 54 DoReauthorization API operation 36 DoReauthorization request message 36 DoReauthorization response message 37 DoReferenceTransaction API operation 171 DoReferenceTransaction request message 171 DoReferenceTransaction response message 178 DoVoid API operation 39 DoVoid request message 39 DoVoid response message 39 E Ebay Item Payment Details Item request fields 46 75 103 176 Ebay Item Payment Details Item response fields 89 EBAYITEMAUCTIONTXNID response field 113 EBAYITEMAUCTIONTXNIDn response field 90 EBAYITEMCARTIDn response field 90 EBAYITEMNUMBERRn response field 89 EBAYITEMORDERIDn response field 90 EbayltemTxnld response field 130 ECI3DS request field 48 ECISUBMITTED3DS response field 50 EMAIL request field 25 42 53 63 143 160 177 189 EMAIL response field 80 123 152 166 169 EMAILSUBJECT request field 135 ENDDATE request field 189 error codes 193 error respo
43. DoCaptue API only the authorization ID transaction ID transaction type payment date gross amount and payment status are guaranteed to be returned If you need the values of other fields and they are not returned you can obtain their values later by calling Get TransactionDetails or by using the reporting mechanism Not applicable to point of sale transactions DoCapture Response Fields Field Description AUTHORIZATIONID Authorization identification number you specified in the request Character length and limits 19 single byte characters maximum MSGSUBID Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 Payment Information Fields Field Description TRANSACTIONID Unique transaction ID of the payment Character length and limitations 17 single byte characters Name Value Pair API Developer Guide August 2012 29 Authorization and Capture API Operation Reference DoCapture API Operation Field Description PARENTTRANSACTIONID Parent or related transaction identification number This field is populated for the following transaction types e Reversal Capture of a
44. Error Codes Error Code Short Message Long Message Correcting This Error 10416 Transaction refused You have exceeded the because of an invalid maximum number of payment argument See additional attempts for this token error messages for details 10417 Transaction cannot The transaction cannot Instruct the buyer that PayPal is unable complete complete successfully Instruct to process the payment and redisplay the customer to use an alternative payment methods with alternative payment method which the buyer can pay 10418 Transaction refused The currencies of the shopping because of an invalid cart amounts must be the same argument See additional error messages for details 10419 Express Checkout Express Checkout PayerlD is PayerID is missing missing 10420 Transaction refused Express Checkout because of an invalid PaymentAction is missing argument See additional error messages for details 10421 This Express Checkout This Express Checkout session Verify that your programs are properly session belongs to a belongs to a different customer associating the Tokens and PayerTDs different customer Token value mismatch 10422 Customer must choose The customer must return to new funding sources PayPal to select new funding sources 10424 Transaction refused Shipping address is invalid If you receive this error message because of an invalid PayPal recommends that you return argument See additional your buyer to PayPal to
45. If the transaction includes one or more one time purchases this field is ignored For recurring payments you should pass the expected average transaction amount default 25 00 PayPal uses this value to validate the buyer s funding source Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma NOTE This field is required when implementing the Instant Update API callback PayPal recommends that the maximum total amount be slightly greater than the sum of the line item order details tax and the shipping options of greatest value Required URL to which the buyer s browser is returned after choosing to pay with PayPal For digital goods you must add JavaScript to this page to close the in context experience NOTE PayPal recommends that the value be the final review page on which the buyer confirms the order and payment or billing agreement Character length and limitations 2048 single byte characters Required URL to which the buyer is returned if the buyer does not approve the use of PayPal to pay you For digital goods you must add JavaScript to this page to close the in context experience NOTE PayPal recommends that the value be the original page on which the buyer chose to pay with PayPal or establish a b
46. Inc reserves the right to make changes to any information herein without further notice Contents What s New 11 Whats New in Version 93 0 0 0 000 ee ee 11 Preface 13 About This Guide 13 Intended Audience 002 ee 13 Where to Go for More Information 0 002 eee ee ee 13 Documentation Feedback 0000 eee ee 13 Chapter 1 PayPal Name Value Pair API Basics 15 PayPal API Client Server Architecture 0 0 220000 ee eee 15 PayPal Name Value Pair API Requests and Responses 16 UTF 8 Character Encoding s e os sa e s aiee o 16 Multiple API Operations o aoaaa a 16 NVP Format a s oa u ie a u ew aa a ta A a ee we Ee le ae 17 Creating an NVP Request a 18 Specifying the PayPal API Operation oaoa aa e o 18 Specifying an API Credential Using Signatures o a oaa a 19 URC EMCOGING e aa e E G E ee GE Gadde ae E a EE E eae 20 List Syntax for Name Value Pairs oaa aaa a 21 Executing NVP API Operations aoaaa a 21 Specifying a PayPal Server 0000202 ee eee ee eee 21 Logging API Operations oaoa a a 22 Responding to an NVP Response a 22 Common Response Fields a o a a a a a a e 23 Error Responses 23 URL Decoding z e an ia a a ee ee a a 24 Chapter 2 AddressVerify API Operation 25 AddressVerify Request Message o mo 25 Address
47. Information 10400 10401 10402 10406 10412 10413 10414 10417 10417 10418 10420 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 Authorization only is not allowed for merchant Transaction refused because of an invalid argument See additional error messages for details Duplicate invoice 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 cannot complete Transaction cannot complete 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 Order total is missing Order total is invalid This merchant account is not permitted to set PaymentAction to Authorization Please contact Customer Service The PayerID value is invalid Payment has already been made for this InvoiceID The totals of the cart item amounts do not match order amounts The amount exceeds the maximum amount for a single transaction The transaction cannot complete successfully Instruct the customer to use an alternative payment method The transaction cannot comp
48. It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SETTLEAMT Amount deposited in your PayPal account after a currency conversion Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TAXAMT Tax charged on the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma EXCHANGERATE Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the buyer chooses to pay with a currency other than the non primary currency the conversion occurs in the buyer s account Character length and limitations Decimal value that does not exceed 17 characters including decimal point 126 August 2012 Name Value Pair API Developer Guide GetTransactionDetails API Operation Sa GetTransactionDetails Response Message Field Description PAYMENTSTATUS Status of the payment It is one of the following values e None No status e Canceled Reversal A reversal has be
49. Pair API Developer Guide Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation Reference Credit Card Details Fields Field Description CREDITCARDTYPE Optional Type of credit card Is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note For UK only Maestro MasterCard Discover and Visa are allowable For Canada only MasterCard and Visa are allowable Interac debit cards are not supported NOTE If the credit card type is Maestro you must set CURRENCYCODE to GBP In addition you must specify either STARTDATE or ISSUENUMBER Character length and limitations Up to 10 single byte alphabetic characters ACCT Optional Credit card number Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card type EXPDATE Credit card expiration date This field is required if you are using recurring payments with direct payments Character length and limitations 6 single byte alphanumeric characters including leading zero in the format MMYYYY CVV2 Optional Card Verification Value version 2 To comply with credit card processing regulations you must not store this value after a transaction has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the va
50. Refund Transaction response fields 187 REFUNDADVICE request field 186 REFUNDINFO request field 188 REFUNDITEMDETAILS request field 186 REFUNDSOURCE request field 186 REFUNDSTATUS request field 188 RefundTransaction API operation 185 RefundTransaction request message 185 RefundTransaction response message 187 REFUNDTRANSACTIONID response field 187 REFUNDTYPE request field 185 284 REGULARAMT response field 150 August 2012 305 Index REGULARBILLINGFREQUENCY response field 149 REGULARBILLINGPERIOD response field 149 REGULARCURRENCYCODE response field 151 REGULARSHIPPINGAMT response field 150 REGULARTAXAMT response field 151 REGULARTOTALBILLINGCYCLES response field 149 REQCONFIRMSHIPPING request field 60 171 RET URNURL request field 60 RETRYUNTIL request field 186 RETURNALLCURRENCIES request field 117 RETURNFMFDETAILS request field 41 93 171 RETURNURL request field 162 S SALESTAX response field 129 SALUTATION request field 53 143 191 SALUTATION response field 81 124 167 169 Schedule Details request fields 138 SEK 275 276 Seller Details request fields 104 SELLERID request field 104 SELLERREGISTRATIONDATE re quest field 105 SELLERUSERNAME request field 105 Set Customer Billing Agreement request fields 162 Set Customer Billing Agreement response fields 165 Set ExpressCheckout request fields 59 Set ExpressCheckout response fields 78 SetCustomerBillingA greement API operation 162 SetCustomerBillingA greement reque
51. These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST nN EBAYITEMORDERIDO L_PAYMENTREQUEST_n_EBAYITEMORDERID1 Character length 64 single byte characters L_EBAYITEMORDERIDn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 EBAYITEMORDERID instead Name Value Pair API Developer Guide August 2012 103 104 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description L_PAYMENTREQUEST_n_EB AYCARTIDM L_EBAYTTEMCARTIDN deprecated 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 inclusive and m specifies the list item within the payment These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST N EBAYITTEMCARTIDO L PAYMENTREQUEST N EBAYITEMCARTID1 Character length 255 single byte characters L_EBAYITEMCARTIDn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 EBAYITEMCARTIDM instead UserSelectedOptions Fields Field Description INSURANCEOPTIONSELEC Optional The option that the buyer chose for insurance It is one of the following TED values e Yes The buyer opted for insurance e No The buyer did not opt for insurance SHIPPINGOPTIONISDEFA Optional Whether the buyer chose the default shipping option It is one of the ULT following values e true The buyer chose the de
52. Value Pair API Developer Guide August 2012 105 106 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description SUCCESSPAGEREDIRECT Flag to indicate whether you would like to redirect the buyer to sign up for REQUESTED PayPal after completing the transaction If set to true you can redirect users to the following URL with the token value appended https www paypal com cgi bin webscr cmd _express checkout success amp token token BILLINGAGREEMENTID The ID of the billing agreement associated with the Express Checkout transaction L_FMFfilterIDn deprecated L_FMFfilterNAMEN deprecated PAYMENTINFO n SHIPP INGAMT SHIPPINGAMT deprecated Filter ID including the filter type PENDING REPORT or DENY the filter ID and the entry number n starting from 0 Filter ID is one of the following values e 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 0 Use L_PAYMENTINFO_0_FMFfilterIDn instead
53. 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 int1 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 NOTE PendingReason is returned in the resp
54. a transaction Please enter a city in particular field in the address the billing address The long error message tells you which field is invalid 10711 Invalid Data There s an error with this There was a problem with a transaction Please enter your state particular field in the address in the billing address The long error message tells you which field is invalid 10712 Invalid Data There s an error with this There was a problem with a transaction Please enter your five digit postal code in the billing address particular field in the address The long error message tells you which field is invalid August 2012 Name Value Pair API Developer Guide API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10713 10744 10748 10751 10752 10760 11089 11501 11502 11503 11504 11505 Invalid Data Invalid Data Invalid Data Invalid Data Gateway Decline Invalid Configuration Transaction Refused Invalid merchant country The token is missing or is invalid Missing subscription details Missing schedule details Start date should be greater than current date There s an error with this transaction Please enter a country in the billing address This transaction cannot be processed Please enter a valid country code in the billing address This transaction cannot be processed without a Credit Card V
55. and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description TRIALAMT Billing amount for each billing cycle during this payment period required if you specify an optional trial period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma CURRENCY CODE Required Currency code default is USD Character length and limitations 3 single byte characters SHIPPINGAMT Optional Shipping amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TAXAMT Optional Tax amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itinclu
56. 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 buyer s account Character length and limitations A decimal that does not exceed 17 characters including decimal point Status of the payment It is one of the following values NOTE Inasuccessful DoCapture response for a point of sale authorization the only value value is Completed e None No status e Canceled Reversal This means a reversal has been canceled For example you won a dispute with the customer and the funds for the transaction that was reversed have been returned to you e Completed The payment has been completed and the funds have been added successfully to your account balance This is the only value status for point of sale transactions e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element e Expired The authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from your customer s bank account e Pending The payment is pending See the PendingReason field for more information e Refunded You refunded the payment e Reversed A payment was reversed due to a chargeback or other type of reversal The funds have been removed from your account balance and
57. associated with this billing address Character length and limitations 32 single byte characters STREET First billing street address Character length and limitations 100 single byte characters STREET2 Second billing street address Character length and limitations 100 single byte characters CITY Name of billing city Character length and limitations 40 single byte characters STATE Billing state or province Required for U S addresses only Character length and limitations 40 single byte characters ZIP U S billing ZIP code or other country specific postal code Character length and limitations 20 single byte characters COUNTRYCODE Billing country code Character length and limitations 2 single byte characters 170 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation DoReferenceTransaction API Operation The DoReferenceTransaction API operation processes a payment from a buyer s account which is identified by a previous transaction DoReferenceTransaction Request Message DoReferenceTransaction Request Fields Field Description METHOD Required Must be DoReferenceTransaction REFERENCEID Required A transaction ID from a previous purchase such as a credit card charge using the DoDirectPayment API or a billing agreement ID PAYMENTACTION Optional How you want to obtain payment It is one of the followi
58. authorization to void or to void an order the order ID IMPORTANT If you are voiding a transaction that has been reauthorized use the ID from the original authorization and not the reauthorization Character length and limitations 19 single byte characters NOTE Optional Informational note about this void that is displayed to the buyer in email and in their transaction history Character length and limitations 255 single byte characters DoVoid Response Message DoVoid Response Fields Field Description AUTHORIZATIONID Authorization identification number you specified in the request Character length and limitations 19 single byte characters Name Value Pair API Developer Guide August 2012 39 Authorization and Capture API Operation Reference DoVoid API Operation 40 August 2012 Name Value Pair API Developer Guide DoDirectPayment API Operation The DoDirect Payment API Operation enables you to process a credit card payment DoDirectPayment Request Message DoDirectPayment Request Fields Field Description METHOD Required Must be DoDirectPayment PAYMENTACTION Optional How you want to obtain payment It is one of the following values e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Sale This is a final sale for which you are requesting payment default NOTE Order is not allowed for Direct Payment Character l
59. available since version 53 0 Shipping amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Shipping amount for each billing cycle during this regular payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is available since version 53 0 Tax amount for each billing cycle during this payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma 150 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation
60. be a comma Payer Information Fields Field Description EMAIL Email address of buyer Character length and limitations 127 single byte characters PAYERID Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters PAYERSTATUS Status of buyer It is one of the following values e verified e unverified Character length and limitations 10 single byte alphabetic characters COUNTRYCODE Buyer s country of residence in the form of ISO standard 3166 2 character country codes Character length and limitations 2 single byte characters PAYERBUSINESS Buyer s business name Character length and limitations 127 single byte characters Payer Name Fields Field Description SALUTATION Buyer s salutation Character length and limitations 20 single byte characters FIRSTNAME Buyer s first name Character length and limitations 25 single byte characters Name Value Pair API Developer Guide August 2012 169 ae Recurring Payments and Reference Transactions API Operations BAUpdate API Operation Field Description MIDDLENAME Buyer s middle name Character length and limitations 25 single byte characters LASTNAME Buyer s last name Character length and limitations 25 single byte characters SUFFIX Buyer s suffix Character length and limitations 12 single byte characters Bill To Address Fields Field Description BILLINGNAME Billing name
61. 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 NM QTYO L_PAYMENTREQUEST n QTY1 Character length and limitations Any positive integer L QTYn is deprecated since version 63 0 Use L_PAYMENTREQUEST_0 QTYM instead 290 August 2012 Name Value Pair API Developer Guide What s New in Version 66 az Changes to PaymentDetailsltemType in GetExpressCheckoutDetails Response Field Description L PAYMENTREQUEST_N_ITEMC New field ATEGORYM Inicates whethe item is digital or physical goods For digital goods this field is required and you must set it to Digital It is one of the following values e Digital e Physical This field is available since version 65 1 Name Value Pair API Developer Guide August 2012 291 a What s New in Version 66 292 August 2012 Name Value Pair API Developer Guide Revision History Date Description 10 August 2012 Maintenance release Added CVV2 response codes E and I for Visa Mastercard Discover and American Express 7 August 2012 Maintenance release New 10486 error code added for redirects when the process declines the transaction The transaction couldn t be completed Please redirect your customer to PayPal 10 July 2012 Updated for 92 0 Added new MsgSubID field for the following APIs for both requests and responsees RefundTransaction DoReferenceTransa
62. by PayPal processed Contact PayPal for more information 10540 Invalid Data The transaction cannot be The transaction was declined by PayPal processed due to an invalid because of an invalid address address 10541 Gateway Decline This transaction cannot be The credit card entered is currently processed Please enter a valid restricted by PayPal Contact PayPal for credit card number and type more information 10542 Invalid Data This transaction cannot be The email address provided by the buyer processed Please enter a valid is in an invalid format email address 10544 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed Contact PayPal for more information 10545 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed because of possible fraudulent activity Contact PayPal for more information 10546 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed because of possible fraudulent activity on the IP address Contact PayPal for more information 10547 Internal Error This transaction cannot be None This is a PayPal internal error processed August 2012 Name Value Pair API Developer Guide API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10548 Invalid Configuration 10549 Invalid Configuration 10550 Invalid Configuration 10552 Invalid C
63. by third party applications to identify transactions Character length and limitations 32 single byte alphanumeric characters August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation Field Description NOTIFYURL 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 IMPORTANT The notify URL applies only to DoExpressCheckout Payment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and limitations 2 048 single byte alphanumeric characters RECURRING ns RecurringFlagType Optional Flag to indicate a recurring transaction It is one of the following values e Any value other than Y This is not a recurring transaction default e Y This is a recurring transaction NOTE To pass Y in this field you must have established a billing agreement with the buyer specifying the amount frequency and duration of the recurring payment Payment Details Item Fields Field Description L_ITEMCATEGORYN Indicates whether the item is digital or physical For digital goods this field is required and you must set it to Digital to get the best rates These parameters must be ordered sequentially beginning with 0 for example L_
64. deprecated Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the buyer chooses to pay with a currency other than the non primary currency the conversion occurs in the buyer s account You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Decimal value that does not exceed 17 characters including decimal point EXCHANGERATE is deprecated since version 63 0 Use PAYMENTINFO 0 EXCHANGERATE instead PAYMENTINFO n PAYME The status of the payment It is one of the following values NTSTATUS The status of the payment You can specify up to 10 payments where n is a digit PAYMENTSTATUS between 0 and 9 inclusive It is one of the following values deprecated e 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 e Expired the authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from your buyer s bank account In Progress The transaction has not ter
65. deprecated in version 63 0 Use L_ PAYMENTREQUEST_O NAMEM instead L PAYMENTREQUEST_n DESC Item description You can specify up to 10 payments where n is a digit between m 0 and 9 inclusive and m specifies the list item within the payment except for L_DESCn deprecated digital goods which only supports single payments Character length and limitations 127 single byte characters This field is available since version 53 0 L_DESCn is deprecated in version 63 0 Use L_PAYMENTREQUEST_0 DESCm instead L PAYMENTREQUEST_n AMT Cost of item You can specify up to 10 payments where n is a digit between 0 m and 9 inclusive and m specifies the list item within the payment except for L_AMTN deprecated digital goods which only supports single payments These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST_n_AMTO L_PAYMENTREQUEST_n AMT1 NOTE If you specify a value for L_PAYMENTREQUEST_n AMTm you must specify a value for PAYMENTREQUEST_n_ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma L_AMTn is deprecated in version 63 0 Use L_PAYMENTREQUEST_0_AMTm instead Name Value Pair API Developer Guide August 2012 87 88 ExpressCheckout API Operations GetExpressChe
66. error messages for details The API is disabled Invalid email format Invalid street format Invalid zip format The Address API is currently disabled ManagePendingTransactionStatus API Errors ManagePendingTransactionStatus API Errors Error Code Short Message Long Message 11614 11614 Could not process your request to accept deny the transaction The transaction has already been Accepted Denied and the status cannot be changed Could not process your request to accept deny the transaction The transaction has already been Accepted Denied and the status cannot be changed August 2012 Name Value Pair API Developer Guide Countries and Regions Supported by PayPal PayPal uses 2 character 1S0 3166 1 codes for specifying countries and regions that are supported in fields and variables Countries marked with an asterisk are not supported for PayPal Payments Pro and Virtual Terminal Country or Region Country or Region Code ALAND ISLANDS AX ALBANIA AL ALGERIA DZ AMERICAN SAMOA AS ANDORRA AD ANGUILLA AI ANTARCTICA AQ ANTIGUA AND BARBUDA AG ARGENTINA AR ARMENIA AM ARUBA AW AUSTRALIA AU AUSTRIA AT AZERBAIJAN AZ BAHAMAS BS BAHRAIN BH BANGLADESH BD BARBADOS BB BELGIUM BE BELIZE BZ BENIN BJ BERMUDA BM BHUTAN BT BOSNIA HERZEGOVINA BA Name Value Pair API Developer Guide August 2012 263 ae Countries and Regions Supported by PayPal 264 Country or Region
67. exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma L_TAXAMTn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 TAXAMTHM instead Optional 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 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 ITEMWEIGHTVALUEO L_PAYMENTREQUEST_n_ITEMWEIGHTVALUE1 Character length and limitations Any positive integer L_ITEMWEIGHTTVALUEN and L_ITEMWEIGHTUNITH are deprecated since version 63 0 Use L_PAYMENTREQUEST_ 0 ITEMWEIGHTVALUEM and L_PAYMENTREQUEST 0 ITEMWEIGHTUNITM instead Optional Item length corresponds to the length of the item 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 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 ITEMLENGTHVALUEO L PAYMENTREQUEST _n_ITEMLENGTHVALUE1 Character length and limitations Any positive inte
68. for example L PAYMENTREQUEST nN NUMBERO L_PAYMENTREQUEST N NUMBER1 Name Value Pair API Developer Guide August 2012 287 ai What s New in Version 69 Field Description L PAYMENTREQUEST_n QT New field Ym Item quantity This field is required when you pass a value for ItemCategory These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST nN OTYO L PAYMENTREQUEST n QTY1 Character length and limitations Any positive integer L PAYMENTREQUEST_n TA New field XAMTM Optional Item sales tax These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST nN TAXAMTO L_PAYMENTREQUEST n_TAXAMT1 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 Changes to PaymentDetailsltemType in DoReferenceTransaction Request PaymentDetailsltemType Fields Field Description L_ITEMCATEGORYN New field Indicates whether the item is digital or physical goods For digital goods this field is required and you must set it to Digital to get the best rates It is one of the following values e Digital e Physical These parameters must be ordered sequentially beginning with 0 for example L ITEMCATEGORYO L_ITEMCATEGORY1 L NAMEN Item name This field is r
69. for the buyer and is also reflected in the default total Optional New tax amount based on this shipping option and the shipping address NOTE 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 58 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE SetExpressCheckout API Operation Field Description L INSURANCEAMOUNTN Optional New insurance amount based on this shipping option and the shipping address NOTE 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 OFFERINSURANCEOPTIO Optional Indicates whether or not PayPal should display insurance in a drop down N list on the Review page When the value is true PayPal displays the drop down with the associated amount and the string Yes NO SHIPPING OPTION Optional If you do not ship to the buyer s shipping address set this field to 1 The DETAILS value of CALLBACKVERSION in SetExpressCheckout request must be 61 0 or greater similar to the following CALLBACKVERSION lt 61 0 or greater gt Charact
70. limitations 20 single byte characters SHIPTOPHONENUM Optional Phone number Character length and limit 20 single byte characters DoReferenceTransaction Response Message DoReferenceTransaction Response Fields for Express Checkout Field Description AVSCODE Address Verification System response code Character limit 1 single byte alphanumeric character CVV2MATCH Result of the CVV2 check by PayPal BILLINGAGREEMENTID Billing agreement identifier returned if the value of ReferencelD in the request is a billing agreement identification number 178 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation Field Description L_FMFfilterIDn Filter ID including the filter type PENDING REPORT or DENY the filter JD and 7 the entry number n starting from 0 Filter JD is one of the following values e 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 L_FMFfilterNAMEN
71. must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST n_ AMTO L PAYMENTREQUEST_n AMT1 NOTE If you specify a value for L_PAYMENTREQUEST_n AMTm you must specify a value for PAYMENTREQUEST_n_ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is introduced in version 53 0 L_AMTn is deprecated since version 63 0 Use L_PAYMENTREQUEST_0 AMT instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE DoExpressCheckoutPayment API Operation Field Description L PAYMENTREQUEST nN NU Optional Item number You can specify up to 10 payments where n is a digit MBERM between 0 and 9 inclusive and m specifies the list item within the payment These L_NUMBERN deprecated parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST Nn NUMBERO L_PAYMENTREQUEST N NUMBER1 Character length and limitations 127 single byte characters This field is introduced in version 53 0 L_NUMBERN is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 NUMBER instead L PAYMENTREQUEST n QT Item quantity This field is required when Ym L PAYMENTREQUEST n_ITEMCATEGORYM is passed For digital goods L_QTYn deprecated L_PAYMENTREQ
72. 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 You can specify up to 10 payments where n is a digit between 0 and 9 inclusive NOTE This field is only returned after a successful transaction for DoExpressCheckout has occurred TRANSACTIONID is deprecated since version 63 0 Use PAYMENTREQUEST 0 TRANSACTIONID instead Optional The payment method type Specify the value Instant PaymentOnly 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 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE SetExpressCheckout API Operation Field Description PAYMENTREQUEST n PAY How you want to obtain payment When implementing parallel payments this field MENTACTION is required and must be set to Order When implementing digital goods this field PAYMENTACTION is required and must be set to Sale You can specify up to 10 payments where n is deprecated a digit between 0 and 9 inclusive except for digital goods which supports single payments only If the transaction does not include a one time purchase this field is ignored It is one of the followin
73. nN SHIPTOZIP SHIPTOZIP deprecated PAYMENTREQUEST N SHIPTOCOU NTRYCODE SHIPTOCOUNTRY deprecated Person s name associated with this shipping address It is required if using a shipping address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 32 single byte characters SHIPTONAME is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTONAME instead First street address It is required if using a shipping address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 100 single byte characters SHIPTOSTREET is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOSTREET instead Optional Second street address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 100 single byte characters SHIPTOSTREETZ2 is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOSTREET2 instead Name of city It is required if using a shipping address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 40 single byte characters SHIPTOCITY is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOCITY instead State or province It is required if using a shipping address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limit
74. number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma 180 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation Field Description SETTLEAMT TAXAMT EXCHANGERATE PAYMENTSTATUS Amount deposited in your PayPal account after a currency conversion Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Tax charged on the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the buyer chooses to pay with a currency other than the non primary currency the conversion occurs in the buyer s account Character length and limitations Decimal value that does not exceed 17 characters including decimal point
75. of an invalid argument See additional error messages for details 10473 Error occurred in Multiple Order IDs are not supported communicating to eBay August 2012 Name Value Pair API Developer Guide API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10474 Invalid Data This transaction cannot be processed The country code in the shipping address must match the buyer s country of residence 10475 Transaction refused because This transaction cannot be completed of an invalid argument See with PaymentAction of Sale additional error messages for details 10476 Invalid Data Maximum number of billing agreements exceeded 10477 Invalid Data More than one billing agreement specified for reference transaction 10478 Invalid Data Recurring payments profile description must be provided if the billing agreement type is recurring payments 10479 Invalid Data Billing agreement types cannot be mixed in the same request 10480 Invalid Data Invalid billing agreement type 10485 Payment not authorized Payment has not been authorized by the user 10537 Risk Control Country Filter The transaction was refused because Failure the country was prohibited as a result of your Country Monitor Risk Control Settings 10538 Risk Control Max Amount The transaction was refused because Failure the maximum amount was excceeded as a result of your Maximum Amount Risk Control Settings 10539 Payment declin
76. or more PayPal account holders MassPay Request Message MassPay Request Fields Field Description METHOD Required Must be MassPay EMAILSUBJECT Optional The subject line of the email that PayPal sends when the transaction completes The subject line is the same for all recipients Character length and limitations 255 single byte alphanumeric characters CURRENCYCODE Currency code Character length and limitations 3 single byte characters RECEIVERTYPE Optional How you identify the recipients of payments in this call to MassPay It is one of the following values e EmailAddress e UserID e PhoneNumber MassPay Response Message MassPay Response Fields The fields in the response are the standard response header fields Name Value Pair API Developer Guide August 2012 135 m MassPay API Operation MassPay Response Message 136 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations The PayPal API includes the following API operations supporting recurring payments and reference transactions CreateRecurringPaymentsProfile API Operation The CreateRecurringPayment sProfile API operation creates a recurring payments profile You must invoke the CreateRecurringPayment sProfile API operation for each profile you want to create The API operation creates a profile and an associated billing agreement NOTE There is a one to one correspondence betw
77. ordered sequentially beginning with 0 for example L_PAYMENTREQUEST N ITEMHEIGHTVALUEO L PAYMENTREQUEST Nn ITEMHEIGHTVALUE1 Character length and limitations Any positive integer L_ITEMHEIGHTVALUEN and L_ITEMHEIGHTUNITM are deprecated since version 63 0 Use L_PAYMENTREQUEST 0 ITEMHEIGHTVALUEM and L PAYMENTREQUEST 0 ITEMHEIGHTUNITN instead Optional URL for the 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 ITEMURLO L_PAYMENTREQUEST n_ITEMURL1 L_ITEMURLN is deprecated since version 63 0 Use L PAYMENTREQUEST_0_ITEMURLM instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description L PAYMENTREQUEST_n IT EMCATEGORYM Indicates whether an item is digital or physical For digital goods this field is required and must be set to Digital 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 except for digital goods which only supports single payments These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST N ITEMCATEGORYO L PAYMENTREQUEST N ITEMCATEGORY1 It is one of the following values e Digital e Physical This field is available
78. parameter missing 81119 Missing Parameter ItemAmt Required parameter missing 81120 Missing Parameter ShippingAmt Required parameter missing 81121 Missing Parameter HandlingAmt Required parameter missing 81122 Missing Parameter TaxAmt Required parameter missing 81123 Missing Parameter IPAddress Required parameter missing 81124 Missing Parameter ShipToName Required parameter missing 81125 Missing Parameter L_Amt Required parameter missing 81126 Missing Parameter Amt Required parameter missing 81127 Missing Parameter L_TaxAmt Required parameter missing 81128 Missing Parameter AuthorizationID Required parameter missing 81129 Missing Parameter CompleteType Required parameter missing 81130 Missing Parameter CurrencyCode Required parameter missing 81131 Missing Parameter TransactionID Required parameter missing 81132 Missing Parameter TransactionEntity Required parameter missing 81133 Missing Parameter Acct Required parameter missing 81134 Missing Parameter ExpDate Required parameter missing 81135 Missing Parameter FirstName Required parameter missing 81136 Missing Parameter LastName Required parameter missing 81137 Missing Parameter Street Required parameter missing 81138 Missing Parameter Street2 Required parameter missing 81139 Missing Parameter City Required parameter missing 81140 Missing Parameter State Required parameter missing 81141 Missing Parameter Zip Required parameter missing 81142 Missing
79. returned to the buyer The reason for the reversal is specified in the ReasonCode element e Processed A payment has been accepted e Voided An authorization for this transaction has been voided Name Value Pair API Developer Guide August 2012 31 32 Authorization and Capture API Operation Reference DoAuthorization API Operation Field Description PENDINGREASON NOTE PendingReason is returned in the response only if Payment Status is Pending This field does not apply to capturing point of sale authorizations which do not create pending payments Reason the payment is pending It is one of the following values 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 echeck The payment is pending because it was made by an eCheck that has not yet cleared int1 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 pa
80. review and error messages for details approve new valid funding sources Although this error is rare you should consider trapping the error to display a message to the buyer describing what happened along with a button or hyperlink to return to PayPal 10426 Transaction refused Item total is invalid because of an invalid argument See additional error messages for details 10427 Transaction refused Shipping total is invalid because of an invalid argument See additional error messages for details Name Value Pair API Developer Guide August 2012 227 228 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10428 Transaction refused Handling total is invalid because of an invalid argument See additional error messages for details 10429 Transaction refused Tax total is invalid because of an invalid argument See additional error messages for details 10431 Item amount is invalid Item amount is invalid 10432 Transaction refused Invoice ID value exceeds because of an invalid maximum allowable length argument See additional error messages for details 10433 Transaction refused Value of OrderDescription because of an invalid element has been truncated argument See additional error messages for details 10434 Transaction refused Value of Custom element has because of an invalid been truncated argument See additional error message
81. sequentially beginning with 0 for example L_PAYMENTREQUEST_n_ DESCO L PAYMENTREQUEST Nn DESCI1 Character length and limitations 127 single byte characters This field is introduced in version 69 0 144 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description L_PAYMENTREQUEST _n AM Cost of item This field is required when ItemCategory is passed Tm Cost of item This field is required when L_PAYMENTREQUEST_n ITEMCATEGORY M is passed These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_n AMTO L_PAYMENTREQUEST_N_AMT1 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is introduced in version 69 0 L_PAYMENTREQUEST nN NU Optional Item number These parameters must be ordered sequentially beginning MBERM with 0 for example L_PAYMENTREQUEST n_NUMBERO L PAYMENTREQUEST n NUMBER1 Character length and limitations 127 single byte characters This field is introduced in version 69 0 L PAYMENTREQUEST n QT Item quantity This field is required when ItemCategory is passed Ym Item quantity This field is required when L_PAYMENTREQUEST
82. since version 65 1 EbayltemPaymentDetailsltemType Fields Field Description L_PAYMENTREQUEST_n_EB AYITEMNUMBERM L_EBAYTTEMNUMBERN deprecated L PAYMENTREQUESST n E BAYITEMAUCTIONTXNIDM L EBAYITEMAUCTIONTXNI Dn deprecated L PAYMENTREQUEST N EB AYTTEMORDERIDM L EBAYTTEMORDERIDnN deprecated Optional Auction item number 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 nN EBAYTTEMNUMBERO L_PAYMENTREQUEST_n_EBAYITEMNUMBER1 Character length 765 single byte characters L_EBAYITEMNUMBERN is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 EBAYITEMNUMBERM instead Optional Auction transaction identification number 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 EBAYITEMAUCTIONTXNIDO L_PAYMENTREQUEST nN EBAYITEMAUCTIONTXNID1 Character length 255 single byte characters L_EBAYAUCTIONTXNIDn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 EBAYAUCTIONTXNIDM instead Optional Auction order identification number 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
83. single byte alphanumeric characters DESC is deprecated since version 63 0 Use PAYMENTREQUEST_ 0 DESC instead PAYMENTREQUEST nN CUSTO Optional A free form field for your own use You can specify up to 10 M payments where n is a digit between 0 and 9 inclusive CUSTOM deprecated NOTE The value you specify is available only 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 256 single byte alphanumeric characters CUSTOM is deprecated since version 63 0 Use PAYMENTREQUEST 0 CUSTOM instead Name Value Pair API Developer Guide August 2012 85 86 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST N INVNU M INVNUM deprecated PAYMENTREQUEST N NOTIF YURL NOTIFYURL deprecated PAYMENTREQUEST N NOTET EXT NOTETEXT deprecated PAYMENTREQUEST N TRANS ACTIONID TRANSACTIONID deprecated PAYMENTREQUEST n ALLOW EDPAYMENTMETHOD ALLOWEDPAYMENTMETHOD deprecated Optional Your own invoice or tracking number You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only NOTE The value you specify is available only if the transaction includes a purchase This field is ignored if you set up a billing agreement for a recurring payme
84. single byte characters L_NAMEn is deprecated since version 63 0 Use L PAYMENTREQUEST 0 NAME instead Item description For digital goods this field is required 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_ DESCO L PAYMENTREQUEST n_ DESC1 Character length and limitations 127 single byte characters L_DESCH is deprecated since version 63 0 Use L PAYMENTREQUEST 0 DESCm instead Cost of item For digital goods this field is required 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 nm AMTO L_PAYMENTREQUEST 1 AMT1 NOTE If you specify a value for L_PAYMENTREQUEST_n_AMTm you must specify a value for PAYMENTREQUEST _n_ITEMAMT 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 L_AMTnis deprecated since version 63 0 Use L_PAYMENTREQUEST 0 AMTMm instead Item quantity For digital goods this field is required You can specify up to 10 payments where n is a digit
85. specifies the list item within the payment except for digital goods which supports single payments only These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST N_AMTO L_ PAYMENTREQUEST 1 AMT1 NOTE Ifyou specify a value for L_ PAYMENTREQUEST_n AMTm you must specify a value for PAYMENTREQUEST_n_ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is introduced in version 53 0 L_ AMTn is deprecated since version 63 0 Use L_PAYMENTREQUEST_0_ AMT instead Optional Item number 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 NUMBERO L_PAYMENTREQUEST NM NUMBER1 Character length and limitations 127 single byte characters This field is introduced in version 53 0 L_NUMBERN is deprecated since version 63 0 Use L_PAYMENTREQUEST_0_NUMBERM instead Item quantity This field is required when L PAYMENTREQUEST n_ITEMCATEGORYM is passed For digital goods L _PAYMENTREQUEST n ITEMCATEGORYmM Digital this field is required You can specify up to 10 payments where n is a digit between 0
86. the recurring payments profile e PendingProfile The system is in the process of creating the recurring payment profile Please check your IPN messages for an update GetRecurringPaymentsProfileDetails API Operation The GetRecurringPaymentsProfileDetails API operation obtains information about a recurring payments profile GetRecurringPaymentsProfileDetails Request Message GetRecurringPaymentsProfileDetails Request Fields Field Description METHOD Required Must be GetRecurringPaymentsProfileDetails PROF ILEID Required Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response 19 character profile IDs are supported for compatibility with previous versions of the PayPal API Character length and limitations 14 single byte alphanumeric characters GetRecurringPaymentsProfileDetails Response Message GetRecurringPaymentsProfileDetails Response Fields Field Description PROF ILEID Recurring payments profile ID returned in the CreateRecurringPayment sProfile response STATUS Status of the recurring payment profile It is one of the following values e Active Pending Cancelled Suspended Expired 146 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description DESC Description of the recurring payment Character length and limitations 127 s
87. the maximum value for billing frequency is 52 NOTE If the billing period is SemiMonth the billing frequency must be 1 REGULARBILLINGFREQU Number of billing periods that make up one regular billing cycle ENCY The combination of billing frequency and billing period must be less than or equal to one year For example if the billing cycle is Month the maximum value for billing frequency is 12 Similarly if the billing cycle is Week the maximum value for billing frequency is 52 NOTE If the billing period is SemiMonth the billing frequency must be 1 This field is available since version 53 0 TOTALBILLINGCYCLES Number of billing cycles for payment period either the regular payment period or the trial period e For the trial period the value must be greater than 0 e For the regular payment period if no value is specified or the value is 0 the regular payment period continues until the profile is canceled or deactivated e For the regular payment period if the value is greater than 0 the regular payment period will expire after the trial period is finished and continue at the billing frequency for TotalBillingCycles cycles REGULARTOTALBILLING Number of billing cycles for the regular payment period CYCLES e For the regular payment period if no value is specified or the value is 0 the regular payment period continues until the profile is canceled or deactivated e For the regular payment period if the value is greater tha
88. the return URL to which PayPal redirects your buyer s browser after the buyer finishes on PayPal Other setup actions also can be performed by this API operation 2 Invoke additional API operations after receiving the buyer s permission on PayPal for example GetExpressCheckoutDetails or DoExpressCheckout Payment The following diagram shows the execution flow between your site and PayPal en PE Checkout _ Request I sae A Response ms API Server Bi aaa IA La Redirect to PayPal i gt denia a i y a 1 PayPal Redirects ME Continue T eo Receipt es ROC 1 0S PayPal Token Usage Typically the API operation that sets up a redirection to PayPal returns a token This token is passed as a parameter in the redirect to PayPal The token also might be required in related API operations NVP Format NVP is a way of specifying names and values in a string NVP is the informal name for the query in the URI specification The NVP string is appended to the URL An NVP string conforms to the following guidelines e The name is separated from the value by an equal sign For example FIRSTNAME Robert Name Value Pair API Developer Guide August 2012 17 E PayPal Name Value Pair API Basics Creating an NVP Request e Name value pairs are separated by an ampersand amp For example FIRSTNAME Robert amp MIDDLENAME Herbert LASTNAME Moore e The values for each value in an NVP string are URL encod
89. 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 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 240 August 2012 Name Value Pair API Developer Guide API Error Codes RefundTransaction API Errors Error Code Short Message Long Message Correcting This Error 10009 Transaction refused The account for the counterparty is locked or inactive 10009 Transaction refused This transaction already has a chargeback filed 10009 Transaction refused You have not filled out the Direct Debit Instruction 10011 Invalid transaction id value Transaction refused because of an invalid transaction id value 10755 Unsupported currency Currency is not supported 11603 Conflict with prior request One or more critical fields in the with same Message request conflict with prior message Submission ID with the same Message Submission ID specified in MSGSUBID parameter 11604 Request for Message Request for the specified Message Retry the request at a later Submission ID already in Submission ID specified in time progress MSGSUBID parameter cannot be started until the previous request finishes 11607 Duplicate request for The specified Message Submission ID Retry the request at a later
90. voided Authorization has expired Order has expired Order is voided Maximum number of authorization allowed for the order is reached NotifyURL field is too long maximum length for notify URL is 2048 ButtonSource field is too long maximum length is 32 Warning only API executes CVV field is invalid CreditCardNumber and or CreditCardType is invalid Transaction refused due to country monitor risk control Transaction refused due to max amount risk control Transaction declined by Risk Control settings PayPal Risk model IP fraud models failed IssueNumber is invalid None of Start date or issue number is specified only applies to Switch credit cards Name Value Pair API Developer Guide August 2012 259 260 API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10725 Shipping Address Country There was an error in the Shipping Shipping address error in Error Address Country field country field 10727 Shipping Address Empty The field Shipping Addressl is Shipping address error in required address1 field 10728 Shipping Address City The field Shipping Address City is Shipping address error in city Empty required field 10729 Shipping Address State The field Shipping Address Stateis Shipping address error in state Empty required field 10730 Shipping Address Postal The field Shipping Address Postal Shipping address error in po
91. which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma HANDLINGAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 HANDLINGAMT instead PAYMENTREQUEST Nn TAXAM Optional Sum of tax for all items in this order You can specify up to 10 T payments where n is a digit between 0 and 9 inclusive except for digital goods TAXAMT deprecated which supports single payments only NOTE PAYMENTREQUEST_n TAXAMT is required if you specify L_PAYMENTREQUEST _n_TAXAMTm Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TAXAMT is deprecated since version 63 0 Use PAYMENTREQUEST_0 TAXAMT instead PAYMENTREQUEST nN DESC Optional Description of items the buyer is purchasing You can specify up to DESC deprecated 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only NOTE The value you specify is available only 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
92. with this transaction Please enter your five digit postal code in the shipping address There s an error with this transaction Please enter your five digit postal code in the shipping address There s an error with this transaction Please enter a valid city and state in the shipping address field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which f
93. within the payment except for digital goods which supports single payments only These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_n NAMEO L_PAYMENTREQUEST n_NAME1 Character length and limitations 127 single byte characters This field is introduced in version 53 0 L_NAMEn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 NAME instead Name Value Pair API Developer Guide August 2012 71 72 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description L PAYMENTREQUEST N DE scm L_DESCn deprecated L PAYMENTREQUEST_n_AM Tm L_AMTN deprecated L PAYMENTREQUEST n NU MBERM L_NUMBERN deprecated L PAYMENTREQUEST n QT Ym L_QTYn deprecated 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 except for digital goods which supports single payments only These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_n_DESCO L PAYMENTREQUEST_n_DESC1 Character length and limitations 127 single byte characters This field is introduced in version 53 0 L_DESCn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 DESCm instead Cost of item This field is required when L_PAYMENTREQUEST_n_ITEMCATEGORY is passed You can specify up to 10 payments where n is a digit between 0 and 9 inclusive and m
94. 002 eee ee ee 46 Ebay Item Payment Details Item Fields 2 2 20 4 46 Ship To Address Fields 2 a a a a a 47 3D Secure Request Fields U K Merchants Only 47 DoDirectPayment Response Message 0 00 ee 48 DoDirectPayment Response Fields 2 00000225 ee 48 ThreeDSecure Response Fields 50 Chapter 5 DoNonReferencedCredit API Operation 51 DoNonReferencedCredit Request Message 0 51 DoNonReferencedCredit Request Fields 2 2 0 4 51 Credit Card Details Type Fields 2 222 000220004 52 Payer Name Type Fields 2 0000 eee eee eee 53 Payer Information Fields 0000 eee ee ee 53 Address Fields 20 cr pee pa ee Gg Bea ea ae Re 53 4 August 2012 Name Value Pair API Developer Guide Contents ional DoNonReferencedCredit Response Message 0 eee eee 54 DoNonReferencedCredit Response Fields 0000 eee 54 Chapter 6 ExpressCheckout API Operations 55 Callback API Operation 0022 eee ee 55 Callback API Request Message aoaaa aa 0 55 Callback Response Message 2 00 eee ee 58 SetExpressCheckout API Operation e 59 SetExpressCheckout Request Message 22 005 59 SetExpressCheckout Response Message e
95. 15002 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed Contact PayPal for more information 15003 Invalid Configuration This transaction cannot be The transaction was declined because processed the merchant does not have a valid commercial entity agreement on file with PayPal Contact PayPal for more information 15004 Gateway Decline This transaction cannot be The transaction was declined because processed Please enter a valid the CVV entered does not match the Credit Card Verification Number credit card 15005 Processor Decline This transaction cannot be The transaction was declined by the processed issuing bank not PayPal The merchant should attempt another card 15006 Processor Decline This transaction cannot be The transaction was declined by the processed Please enter a valid issuing bank not PayPal The merchant credit card number and type should attempt another card 15007 Processor Decline This transaction cannot be The transaction was declined by the processed Please use a valid issuing bank because of an expired credit card credit card The merchant should attempt another card 15008 Invalid Data This transaction has been completed but the total of items in the cart did not match the total of all items 15011 Gateway Decline This credit card was issued from an unsupported country 208 August 2012 Name Value Pair API Developer Guide API Error Codes SetExpres
96. 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TAXAMT Optional Tax amount for each billing cycle during the regular payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma OUTSTANDINGAMT Optional The current past due or outstanding amount for this profile You can only decrease the outstanding amount It cannot be increased Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma AUTOBILLOUTAMT Optional This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle It is one of the following values e NoAutoBill PayPal does not automatically bill the outstanding balance e AddToNextBilling PayPal automatically bills the outstanding balance MAXFAILEDPAYMENTS Optional The number of failed payments allowed before the profile is automatically suspended The specified value cannot be less th
97. 298 Index BUYERID request field 75 BUYERID response field 131 BUYERMARKETINGEMAIL request field 93 BUYERMARKETINGEMAIL response field 80 122 BUYERREGISTRATIONDATE request field 76 BUYERUSERNAME request field 76 C CAD 275 276 Callback API operation 55 CALLBACK request field 60 Callback request fields 55 Callback request message 55 Callback response fields 58 Callback response message 58 CALLBACKTIMEOUT request field 60 CALLBACKVERSION request field 61 Canadian Dollar 275 276 CANCELURL request field 60 162 CAVV request field 48 CHANNELTYPE request field 64 character encoding 16 CHECKOUTSTATUS response field 80 CHF 275 276 CITY request field 43 53 144 160 178 CLOSINGDATE response field 131 COMPLETETYPE request field 27 CONFIRMATIONCODE response field 26 COUNTRYCODE 123 166 169 COUNTRYCODE request field 43 54 143 144 161 178 COUNTRYCODE response field 26 81 CouponAmount response field 130 CouponAmountCurrency 130 CouponID 130 Create Billing Agreement request fields 161 Create Billing Agreement response fields 162 Create Recurring Payments Profile request fields 137 Create Recurring Payments Profile response fields 145 CreateBillingAgreement API operation 161 CreateBillingAgreement request message 161 CreateBillingAgreement response message 162 CreateRecurringPaymentsProfile API operation 137 CreateRecurringPaymentsProfile request message 137 CreateRecurringPaymentsProfile response message 145
98. 66 Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation GetBillingAgreementCustomerDetails API Operation The GetBillingAgreementCustomerDetails API operation obtains information about a billing agreement s PayPal account holder GetBillingAgreementCustomerDetails Request Message GetBillingAgreementCustomerDetails Request Fields Field Description METHOD Required Must be GetBillingAgreementCustomerDetails TOKEN Required The time stamped token returned in the SetCustomerBillingAgreement response NOTE The token expires after 3 hours Character length and limitations 20 single byte characters GetBillingAgreementCustomerDetails Response Message Payer Information Fields Field Description EMAIL Email address of buyer Character length and limitations 127 single byte characters PAYERID Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters PAYERSTATUS Status of buyer It is one of the following values e verified e unverified Character length and limitations 10 single byte alphabetic characters COUNTRYCODE Buyer s country of residence in the form of ISO standard 3166 2 character country codes Character length and limitations 2 single byte characters PAYERBUSINESS Buyer s business name Character length and limitations 127 single byte characters August 2012 Name Val
99. A value returned by the Cardinal Centinel If the cmpi_ lookup request returns Y for Enrolled set this field to the PAResStatus value returned by cmpi_authenticate Otherwise set this field to blank MPIVENDOR3DS Optional A value returned by the Cardinal Centinel Set this field to the Enrolled value returned by cmpi_ lookup Name Value Pair API Developer Guide August 2012 47 48 DoDirectPayment API Operation DoDirectPayment Response Message Field Description ECI3DS XID Optional A value returned by the Cardinal Centinel If the cmpi_ lookup request returns Y for Enrolled set this field to the Cavv value returned by cmpi_authenticate Otherwise set this field to blank Optional A value returned by the Cardinal Centinel If the cmpi_ lookup request returns Y for Enrolled set this field to the EciFlag value returned by cmpi_authenticate Otherwise set this field to the EciFlag value returned by cmpi_ lookup Optional A value returned by the Cardinal Centinel If the cmpi_ lookup request returns Y for Enrolled set this field to the Xid value returned by cmpi authenticate Otherwise set this field to blank DoDirectPayment Response Message DoDirectPayment Response Fields Field Description TRANSACTIONID Unique transaction ID of the payment NOTE If the PaymentAction of the request was Authorization the value of TransactionID is your AuthorizationID for use with the Authorization and Captu
100. AN KG LATVIA LV LESOTHO LS LIECHTENSTEIN LI LITHUANIA LT LUXEMBOURG LU MACAO MO MACEDONIA MK MADAGASCAR MG MALAWI MALAYSIA MY MALTA MT MARSHALL ISLANDS MH MARTINIQUE MQ MAURITANIA MR MAURITIUS MU MAYOTTE YT MEXICO MX MICRONESIA FEDERATED STATES OF FM MOLDOVA REPUBLIC OF MD MONACO MC MONGOLIA MN MONTENEGRO ME MONTSERRAT MS 266 August 2012 Name Value Pair API Developer Guide Countries and Regions Supported by PayPal Boo Country or Region Country or Region Code MOROCCO MA MOZAMBIQUE MZ NAMIBIA NA NAURU NR NEPAL NP NETHERLANDS NL NETHERLANDS ANTILLES AN NEW CALEDONIA NC NEW ZEALAND NZ NICARAGUA NI NIGER NE NIUE NU NORFOLK ISLAND NF NORTHERN MARIANA ISLANDS MP NORWAY NO OMAN OM PALAU PW PALESTINE PS PANAMA PA PARAGUAY PY PERU PE PHILIPPINES PH PITCAIRN PN POLAND PL PORTUGAL PT PUERTO RICO PR QATAR QA REUNION RE ROMANIA RO RUSSIAN FEDERATION RU RWANDA RW Name Value Pair API Developer Guide August 2012 267 ae Countries and Regions Supported by PayPal 268 Country or Region Country or Region Code 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 SEYCHELLES SINGAPORE SLOVAKIA SLOVENIA SOLOMON ISLANDS SOUTH AFRICA SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS SPAIN SURINAME SVALBARD AND JAN MAYEN SWAZILAND
101. API Operation 146 GetRecurringPaymentsProfileDetails Request Message 146 GetRecurringPaymentsProfileDetails Response Message 146 ManageRecurringPaymentsProfileStatus API Operation 154 ManageRecurringPaymentsProfileStatus Request Message 154 ManageRecurringPaymentsProfileStatus Response Message 154 BillOutstandingAmount API Operation aoaaa a e e 155 BillOutstandingAmount Request Message 2 e 155 BillOutstandingAmount Response Message o 2 2 155 UpdateRecurringPaymentsProfile API Operation o o 156 UpdateRecurringPaymentsProfile Request Message 156 UpdateRecurringPaymentsProfile Response Message 161 CreateBillingAgreement API Operation o e 00022222 ee 161 CreateBillingAgreement Request Message 0 2 161 6 August 2012 Name Value Pair API Developer Guide Contents ional CreateBillingAgreement API Response Message 2 2 162 SetCustomerBillingAgreement API Operation 24 162 SetCustomerBillingAgreement Request Message 162 SetCustomerBillingAgreement Response Message o 165 GetBillingAgreementCustomerDetails API Operation 0 166 GetBillingAgreementCustomerDetails Request Message
102. AYMENTREQUEST_n AM Tm L_AMTN deprecated Item name This field is required when L PAYMENTREQUEST_N ITEMCATEGORYMis passed 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 except for digital goods which supports single payments only These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST N_NAMEO L PAYMENTREQUEST n NAME1 Character length and limitations 127 single byte characters This field is introduced in version 53 0 L_NAMEn is deprecated since version 63 0 Use L_PAYMENTREQUEST_0 NAME instead 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 except for digital goods which supports single payments only These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_n DESCO L PAYMENTREQUEST_n_DESC1 Character length and limitations 127 single byte characters This field is introduced in version 53 0 L_DESCn is deprecated since version 63 0 Use L_PAYMENTREQUEST_ 0 DESCm instead Cost of item This field is required when L PAYMENTREQUEST_N ITEMCATEGORY is passed 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 except for digital goods which supports single payments only These parameters
103. Additional Information 10441 10442 10504 10527 10537 10538 10539 10546 10560 10567 10600 10601 10621 10622 10623 Transaction refused because of an invalid argument See additional error messages for details ButtonSource value truncated The cvv2 is invalid Invalid Data Risk Control Country Filter Failure Risk Control Max Amount Failure Payment declined by your Risk Controls settings PayPal Risk Model Gateway Decline Invalid Data Invalid Data Authorization voided Authorization expired Order has expired Order is voided Maximum number of authorization allowed for the order is reached The NotifyURL element value exceeds maximum allowable length The ButtonSource element value exceeds maximum allowable length This transaction cannot be processed Please enter a valid Credit Card Verification Number This transaction cannot be processed Please enter a valid credit card number and type The transaction was refused because the country was prohibited as aresult of your Country Monitor Risk Control Settings The transaction was refused because the maximum amount was excused as a result of your Maximum Amount Risk Control Settings Payment declined by your Risk Controls settings PayPal Risk Model This transaction cannot be processed The issue number of the credit card is invalid A Start Date or Issue Number is required Authorization
104. CustomerBillingAgreement API Operation CreateBillingAgreement API Response Message CreateBillingAgreement Response Fields Field Description BILLINGAGREEMENTID Identification number of the billing agreement SetCustomerBillingAgreement API Operation The SetCustomerBillingAgreement API operation initiates the creation of a billing agreement NOTE If you are using Express Checkout with version 54 0 or later of the API do not use the SetCustomerBillingAgreement API operation to set up a billing agreement Use the SetExpressCheckout API operation instead SetCustomerBillingAgreement Request Message SetCustomerBillingAgreement Request Fields Field Description METHOD Required Must be SetCustomerBillingAgreement RETURNURL Required URL to which the buyer s browser is returned after choosing to pay with PayPal NOTE PayPal recommends that the value be the final review page on which the buyer confirms the billing agreement 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 NOTE PayPal recommends that the value be the original page on which the customer chose to pay with PayPal or establish a billing agreement Character length and limitations no limit 162 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement
105. D is missing from the the request request 11552 Invalid profile ID The profile ID is invalid 11553 Invalid action value Invalid action value provided provided 11554 Note is missing from the Note is missing from the request request 11555 11556 Invalid profile status for Invalid profile status for suspend cancel action profile action profile should be active should be active or suspended 11557 Invalid profile status for Invalid profile status for reactivate suspend action profile action profile should be suspended should be active 11558 Invalid profile status for The activation type is invalid reactivate action profile should be suspended 11560 Invalid activation type The activation type is invalid 11561 Invalid initial amount The initial amount is invalid 11562 Invalid auto bill type The auto bill type is invalid Name Value Pair API Developer Guide August 2012 249 250 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 11564 The number of failed The number of failed payments payments should be greater should be greater than the current than the current number of number of failed payments failed payments 11567 The time of the update is The time of the update is too close too close to the billing date to the billing date 11568 Invalid currency for Invalid currency for delinquent delinquent amount amount 11569 Cannot increase delinquent Cannot increase delinquent amou
106. DTHVALUE1 The length of the item You can pass this data to the shipping carrier as is without having to make an additional database query These parameters must be ordered sequentially beginning with 0 for example ITEMLENGTHVALUEO ITEMLENGTHVALUE1 First street address Required if using a shipping address Character length and limitations 300 single byte characters Second street address Character length and limitations 300 single byte characters Name of city Required if using a shipping address Character length and limitations 40 single byte characters State or province Required if using a shipping address Character length and limitations 40 single byte characters U S ZIP code or other country specific postal code Required if using a U S shipping address may be required for other countries Character length and limitations 20 single byte characters Country code Required if using a shipping address Character limit 2 single byte characters Name Value Pair API Developer Guide August 2012 57 6 ExpressCheckout API Operations Callback API Operation Callback Response Message Callback Response Fields Field Description METHOD Required The method sent to the PayPal server The value is always CallbackResponse CURRENCYCODE Required The three character currency code for the transaction from the Express Checkout API OFFERINSURANCEOPTIO Optional Indicates whether or not PayPal shou
107. DoNonReferencedCredit API issues a credit to a card not referenced by the original transaction DoNonReferencedCredit Request Message DoNonReferencedCredit Request Fields Field Description METHOD Required Must be DoNonReferencedCredit AMT Required Total of order including shipping handling and tax Amount NetAmount ShippingAmount TaxAmount Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma NETAMT Optional Total amount of all items in this transaction NOTE The only valid currencies are AUD CAD EUR GBP JPY and USD Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma TAXAMT Optional Sum of tax for all items in this order NOTE The only valid currencies are AUD CAD EUR GBP JPY and USD Character length and limitations The value must be zero or greater and cannot exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGAMT Optional Total shipping costs in this transaction NOTE The only valid currencies are AUD CAD EUR GB
108. Duplicate invoice Payment has already been made for PayPal checks that this InvoicelD InvoicelD values are unique for any particular merchant If you send an InvoicelD value already associated with another transaction in the PayPal system PayPal returns error code 10412 You might not be able to correct this error during an actual checkout If you receive this error research why it might occur and modify your implementation of Express Checkout to ensure that you generate unique invoice identification numbers 10413 Transaction refused because The totals of the cart item amounts If you receive this error be of an invalid argument See do not match order amounts sure the total of the payment additional error messages for detail item parameters such as details ItemTotal HandlingTotal TaxTotal and so forth add up to the order total Name Value Pair API Developer Guide August 2012 213 214 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10415 Transaction refused because of an invalid argument See additional error messages for details 10418 Transaction refused because of an invalid argument See additional error messages for details 10425 Express Checkout has been disabled for this merchant 10426 Transaction refused because of an invalid argument See additional error messages for details 10427 Transaction refused because o
109. E Optional Return the gift wrap name only if the buyer selected the gift option on the PayPal pages Character length and limitations 25 single byte characters GIFTWRAPAMOUNT Optional Amount only if the buyer selected the gift option on the PayPal pages Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma BUYERMARKETINGEMAIL Optional The buyer email address opted in by the buyer on the PayPal pages Character length and limitations 127 single byte characters SURVEYQUESTION Optional Survey question on the PayPal pages Limitations 50 single byte characters SURVEYCHOICESELECTE Optional Survey response that the buyer selected on the PayPal pages D Character length and limitations 15 single byte characters Name Value Pair API Developer Guide August 2012 93 94 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description BUTTONSOURCE Optional Identification code for use by third party applications to identify transactions Character length and limitations 32 single byte alphanumeric characters Payment Details Type Fields When implementing parallel payments you can create up to 10 sets of payment details type parameter fields each representing one payment you ar
110. ENTREQUEST 0 SHIPTOCITY instead State or province You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 40 single byte characters SHIPTOSTATE is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOSTATE instead U S ZIP code or other country specific postal code You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 20 single byte characters SHIPTOZTP is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOZIP instead Country code You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 2 single byte characters SHIPTOCOUNTRY is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOCOUNTRYCODE instead Phone number You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 20 single byte characters SHIPTOPHONENUM is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOPHONENUM instead Status of street address on file with PayPal You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e none e Confirmed e Unconfirmed ADDRESSSTATUS is deprecated since version 63 0 Use PAYMENTREQUEST 0 ADDRESSSTATUS instead Payment Details Type Fields When implementing parallel payments you can create up to 10 sets
111. Field Description REGULARTAXAMT Tax amount for each billing cycle during this regular payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is available since version 53 0 CURRENCY CODE Required Currency code default is USD Character length and limitations 3 single byte characters REGULARCURRENCYCODE Required Currency code default is USD This field is available since version 53 0 Recurring Payments Summary Details Fields Field Description NEXTBILLINGDATE The next scheduled billing date in YY YY MM DD format NUMCYCYLESCOMPLETED The number of billing cycles completed in the current active subscription period A billing cycle is considered completed when payment is collected or after retry attempts to collect payment for the current billing cycle have failed NUMCYCLESREMAINING The number of billing cycles remaining in the current active subscription period OUTSTANDINGBALANCE The current past due or outstanding balance for this 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 opti
112. Filter name including the filter type PENDING REPORT or DENY the filter NAME and the entry number n starting from 0 PAYMENTADVICECODE Response code from the processor when a recurring transaction is declined For details on the meanings of the codes see https merchant paypal com us cgi bin amp cmd _render content amp content_ID merchant cc_compliance_error_codes This field is available since version 84 0 MSGSUBID Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 Payment Information Fields Field Description TRANSACTIONID Unique transaction ID of the payment Character length and limitations 17 single byte characters Name Value Pair API Developer Guide August 2012 179 ae Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description PARENTTRANSACTIONID Parent or related transaction identification number This value in this field is for the RECEIPTID TRANSACTIONTYPE PAYMENTTYPE ORDERTIME CURRENCYCODE FEEAMT following transaction types e Reversal Capture of an authorized trans
113. GDISCAMT deprecated PAYMENREQUEST n INSURA NCEOPTIONOFFERED INSURANCEOPTIONOFFERED deprecated Optional Total shipping costs for this order You can specify up to 10 payments where n is a digit between 0 and 9 inclusive NOTE If you specify a value for PAYMENTREQUEST n SHIPPINGAMT you must also specify a value for PAYMENTREQUEST_n ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPPINGAMT instead Optional Total shipping insurance costs for this order The value must be a non negative currency amount or null if insurance options are offered You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma INSURANCEAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 INSURANCEAMT instead Optional Shipping discount for this order specified as a negative number You can specify up to 10 payments where n is a digit between 0 and 9 i
114. GREASON response field 35 38 111 PERIOD response field 131 Peso 275 Philippine Peso 275 PHONENUM response field 79 PHP 275 PLN 275 276 Polish Zloty 275 276 Pound Sterling 275 276 PR OTECTIONELIGIBILITY response field 129 183 previous versions 281 Name Value Pair API Developer Guide PROFILEID request field 146 154 155 156 ProfileID request field 191 PROFILEID response field 145 146 155 161 ProfileID response field 154 PROFILEREFERENCE request field 138 156 PROFILEREFERENCE response field 147 PROFILESTARTDATE request field 138 157 PROFILESTARTDATE response field 147 PROTECTIONELIGIBILITY response field 35 38 112 PROTECTIONELIGIBILITYTYPE response field 36 39 129 183 R RE DIRECTREQUIRED response field 79 REASONCODE response field 112 128 182 RECEIPTID request field 189 RECEIPTID response field 125 180 Receiver Information response fields 123 RECEIVER request field 189 RECEIVERBUSINESS response field 123 RECEIVEREMAIL response field 123 RECEIVERID response field 123 RECEIVERTYPE request field 135 Recurring Payments API Operations 137 Recurring Payments Profile Details request fields 138 Recurring Payments Profile Details response fields 147 Recurring Payments Summary Details response fields 151 RECURRING request field 45 175 285 REDIRECTREQUIRED response field 105 Reference Transactions API Operations 137 REFERENCEID request field 168 171 Refund Transaction request fields 185
115. INFO N EBAYI TEMAUCTIONTXNID EBAY ITEMAUCTIONTXNI D deprecated PAYMENTREQUEST nN PA YMENTREQUESTID PAYMENTREQUESTID deprecated Since version 64 4 the kind of seller protection in force for the transaction It is one of the following values Since version 64 4 the kind of seller protection in force for the transaction You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNotReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is available since version 64 4 Storeld as entered in the transaction Terminalld as entered in the transaction eBay transaction identification number 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 Unique identifier of the specific payment request The value should match the one you passed in the DoExpressCheckout request Un
116. ITEMCATEGORYO L_ITEMCATEGORY1 It is one of the following values e Digital e Physical This field is introduced in version 69 0 L NAMEN Item name This field is required when you pass a value for L PAYMENTREQUEST_N_ITEMCATEGORYM These parameters must be ordered sequentially beginning with 0 for example L_NAMEO L_NAME1 Character length and limitations 127 single byte characters L_DESCn Optional Item description This field is available since version 53 0 Character length and limitations 127 single byte characters L_AMTN Cost of item This field is required when you pass a value for L_PAYMENTREQUEST_n_ITEMCATEGORYm These parameters must be ordered sequentially beginning with 0 for example L_AMTO L_AMT1 NOTE If you specify a value for L_AMTn you must specify a value for ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Name Value Pair API Developer Guide August 2012 175 ae Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description L_NUMBERN Optional Item number These parameters must be ordered sequentially beginning with 0 for example L_NUMBERO L_NUMBER1 Character length and limitations 127 single byte chara
117. ITEMLENGTHVALUEO L PAYMENTREQUEST Nn ITEMLENGTHVALUE1 Character length and limitations Any positive integer L ITEMLENGTHVALUEN and L_ITEMLENGTHUNITHN are deprecated in version 63 0 Use L_PAYMENTREQUEST 0 ITEMLENGTHVALUEM and L PAYMENTREQUEST 0 ITEMLENGTHUNITM instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE GetExpressCheckoutDetails API Operation Field Description L PAYMENTREQUEST nN ITEM Width of the item You can pass this data to the shipping carrier as is without WIDTHVALUEM having to make an additional database query You can specify up to 10 L_PAYMENTREQUEST n ITEM payments where n is a digit between 0 and 9 inclusive and m specifies the list WIDTHUNITM item within the payment These parameters must be ordered sequentially L ITEMWIDTHVALUEN and beginning with 0 for example L_PAYMENTREQUEST_n ITEMWIDTHVALUEO LI TEMWIDTHUNITN L PAYMENTREQUEST_n_ITEMWIDTHVALUE1 deprecated Character length and limitations Any positive integer L_ITEMWIDTHVALUEN and L_ITEMWIDTHUNITN are deprecated in version 63 0 Use L_ PAYMENTREQUEST_n_ITEMWIDTHVALUEM and L PAYMENTREQUEST_N ITEMWIDTHUNITM instead L_PAYMENTREQUEST _n ITEM Height of the item You can pass this data to the shipping carrier as is without HEIGHTVALUEM having to make an additional database query You can specify up to 10 L PAYMENTREQUEST n ITEM payments where n is a digit between 0 and 9 inclusive and m specifies the
118. K CHF USD Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Discover American Express Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Maestro Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard Visa MasterCard August 2012 Name Value Pair API Developer Guide AVS and CVV2 Response Codes AVS Response Codes Related information DoDirectPayment Response Fields AVS Response Codes for Visa MasterCard Discover and American Express AVS Code Meaning Matched Details A Address Address only no ZIP code B International A Address only no ZIP code C International N None NOTE The transaction is declined D International X Address and Postal Code E Not allowed for MOTO Not applicable Internet Phone transactions NOTE The transaction is declined F UK specific X Address and Postal Code G Global Unavailable Not applicable I Interna
119. LLERUSERNAME instead PAYMENTREQUEST N SELL Optional Date when the merchant registered with the marketplace You can ERREGISTRATIONDATE specify up to 10 payments where n is a digit between 0 and 9 inclusive SELLERREGISTRATIONDAT Character length and limitations Date and time are in UTC GMTformat for E deprecated example 2011 06 24T05 38 48Z SELLERREGISTRATIONDATE is deprecated since version 63 0 Use PAYMENTREQUEST 0 SELLERREGISTRATIONDATE instead DoExpressCheckoutPayment Response Message DoExpressCheckoutPayment Response Fields Field Description TOKEN The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request Character length and limitations 20 single byte characters PAYMENTTY PE Information about the payment NOTE The text entered by the buyer on the PayPal website if you set the ALLOWNOTE field to 1 in SetExpressCheckout This field is available since version 53 0 Character length and limitations 255 single byte characters REDIRECTREQUIRED Flag to indicate whether you need to redirect the buyer back to PayPal after successfully completing the transaction If set to true you can redirect users to the following URL with the token value appended https www paypal com cgi bin webscr cmd _complete express checkout amp token token NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany Name
120. OFFERED instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE SetExpressCheckout API Operation Field Description PAYMENTREQUEST n HAN Optional Total handling costs for this order You can specify up to 10 payments DLINGAMT where n is a digit between 0 and 9 inclusive HANDLINGAMT deprecated wore If you specify a value for PAYMENTREQUEST n HANDLINGAMT you must also specify a value for PAYMENTREQUEST_n ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma HANDLINGAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 HANDLINGAMT instead PAYMENTREQUEST n TAX Optional Sum of tax for all items in this order You can specify up to 10 AMT payments where n is a digit between 0 and 9 inclusive except for digital goods TAXAMT deprecated which supports single payments only NOTE PAYMENTREQUEST_n TAXAMT is required if you specify L PAYMENTREQUEST Nn TAXAMTm Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TAXAMT is deprecated s
121. ONAME is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTONAME instead PAYMENTREQUEST nN SHIPTOSTR First street address You can specify up to 10 payments where n is a digit EET between 0 and 9 inclusive SHIPTOSTREET deprecated Character length and limitations 100 single byte characters SHIPTOSTREET is deprecated since version 63 0 Use PAYMENTREQUEST O SHIPTOSTREET instead PAYMENTREQUEST nN SHIPTOSTR Second street address You can specify up to 10 payments where n is a digit EET2 between 0 and 9 inclusive SHIPTOSTREET2 deprecated Character length and limitations 100 single byte characters SHIPTOSTREET2 is deprecated since version 63 0 Use PAYMENTREQUEST O SHIPTOSTREET2 instead Name Value Pair API Developer Guide August 2012 81 82 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST N SHIPTOCIT Y SHIPTOCITY deprecated PAYMENTREQUEST N SHIPTOSTA TE SHIPTOSTATE deprecated PAYMENTREQUEST N SHIPTOZIP SHIPTOZIP deprecated PAYMENTREQUEST nm SHIPTOCOU NTRYCODE SHIPTOCOUNTRY deprecated PAYMENTREQUEST nN SHIPTOPHO NENUM SHI PTOPHONENUM deprecated PAYMENTREQUEST nN ADDRESSST ATUS ADDRESSSTATUS deprecated Name of city You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 40 single byte characters SHIPTOCITY is deprecated since version 63 0 Use PAYM
122. P JPY and USD Character length and limitations Value must be zero or greater and cannot exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma The only valid currencies are AUD CAD EUR GBP JPY and USD Name Value Pair API Developer Guide August 2012 51 52 DoNonReferencedCredit API Operation DoNonReferencedCredit Request Message Field Description NOTE Optional Field used by merchant to record why this credit was issued to a buyer It is similar to a memo field freeform text or string field CURRENCY CODE Required Currency code default is USD NOTE The only valid currencies are AUD CAD EUR GBP JPY and USD Credit Card Details Type Fields Field Description CREDITCARDTYPE ACCT EXPDATE CVV2 STARTDATE ISSUENUMBER Optional Type of credit card For UK only Maestro MasterCard Discover and Visa are allowable For Canada only MasterCard and Visa are allowable and Interac debit cards are not supported It is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set CURRENCYCODE to GBP In addition you must specify either STARTDATE or ISSUENUMBER Character length and limitations Up to 10 single byte alphabetic characters Required Credit card num
123. PTOSTREET2 Second street address Character length and limitations 100 single byte characters SHIPTOCITY Name of city Character length and limitations 40 single byte characters SHIPTOSTATE State or province Required for U S addresses only Character length and limitations 40 single byte characters SHIPTOZIP U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHIPTOCOUNTRYCODE Country code Character length and limitations 2 single byte characters SHIPTOPHONENUM Phone number Character length and limitations 20 single byte characters Name Value Pair API Developer Guide August 2012 153 ae Recurring Payments and Reference Transactions API Operations ManageRecurringPaymentsProfile Status API Operation ManageRecurringPaymentsProfileStatus API Operation The ManageRecurringPaymentsProfileStatus API operation cancels suspends or reactivates a recurring payments profile ManageRecurringPaymentsProfileStatus Request Message ManageRecurringPaymentsProfileStatus Request Fields Field Description METHOD Required Must be ManageRecurringPaymentsProfileStatus PROFILEID Required Recurring payments profile ID returned in the CreateRecurringPayment sProfile response Character length and limitations 14 single byte alphanumeric characters 19 character profile IDs are supported for compatibility with previous versions of the PayPal API ACTION Required The
124. Parameter CountryCode Required parameter missing 81143 Missing Parameter RefundType Required parameter missing 81144 Missing Parameter StartDate Required parameter missing Name Value Pair API Developer Guide August 2012 195 196 API Error Codes Validation Errors Error Code Short Message Long Message 81145 Missing Parameter EndDate Required parameter missing 81146 Missing Parameter MPID Required parameter missing 81147 Missing Parameter CreditCardType Required parameter missing 81148 Missing Parameter User Required parameter missing 81149 Missing Parameter Pwd Required parameter missing 81150 Missing Parameter Version Required parameter missing 81200 Missing Parameter Amt Invalid parameter 81201 Invalid Parameter MaxAmt Invalid parameter 81203 Invalid Parameter NotifyURL Invalid parameter 81205 Invalid Parameter ShipToStreet Invalid parameter 81206 Invalid Parameter ShipToStreet2 Invalid parameter 81207 Invalid Parameter ShipToCity Invalid parameter 81208 Invalid Parameter ShipToState Invalid parameter 81209 Invalid Parameter ShipToZip Invalid parameter 81210 Invalid Parameter Country Invalid parameter 81211 Invalid Parameter ReqConfirmShipping Invalid parameter 81212 Invalid Parameter Noshipping Invalid parameter 81213 Invalid Parameter AddrOverride Invalid parameter 81214 Invalid Parameter LocaleCode Invalid parameter 81215 Invalid Parameter PaymentAction Invalid parame
125. PayPal Name Value Pair API Developer Guide Name Value Pair API Developer Guide Document Number 100018 en_US 201208 2012 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 L 2449 Luxembourg R C S Luxembourg B 118 349 Consumer advisory The PayPal payment service is regarded as a stored value facility under Singapore law As such it does not require the approval of the Monetary Authority of Singapore You are advised to read the terms and conditions carefully Notice of non liability PayPal Inc is providing the information in this document to you AS IS with all faults PayPal Inc makes no warranties of any kind whether express implied or statutory with respect to the information contained herein PayPal Inc assumes no liability for damages whether direct or indirect caused by errors or omissions or resulting from the use of this document or the information contained in this document or resulting from the application or use of the product or service described herein PayPal
126. Recurring Payments Profile Details Fields Field Description SUBSCRIBERNAME Full name of the person receiving the product or service paid for by the recurring payment If not present the name in the buyer s PayPal account is used Character length and limitations 32 single byte characters PROFILESTARTDATE The date when billing for this profile begins Must be a valid date in UTC GMT format NOTE The profile may take up to 24 hours for activation PROF ILEREFERENCE The merchant s own unique reference or invoice number Character length and limitations 127 single byte alphanumeric characters Name Value Pair API Developer Guide August 2012 147 ae Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Ship To AddressType Fields Field Description ADDRESSSTATUS Status of street address on file with PayPal It is one of the following values e none e Confirmed e Unconfirmed SHI PTONAME Person s name associated with this address Character length and limitations 32 single byte characters SHIPTOSTREET First street address Character length and limitations 100 single byte characters SHIPTOSTREET2 Second street address Character length and limitations 100 single byte characters SHIPTOCITY Name of city Character length and limitations 40 single byte characters SHIPTOSTATE State or province Required for U S addresses only Character length a
127. SOFTDESCRIPTOR PAYMENTREQUEST n PA YMENTREASON MSGSUBID Optional Per transaction description of the payment that is passed to the consumer s credit card statement If the API request provides a value for the soft descriptor field the full descriptor displayed on the buyer s statement has the following format lt PP PAYPAL gt lt Merchant descriptor as set in the Payment Receiving Preferences gt lt 1 space gt lt soft descriptor gt The soft descriptor can contain only the following characters e Alphanumeric characters e dash e asterisk e period e space If you use any other characters such as PayPal returns an error code The soft descriptor does not include the phone number which can be toggled between the merchant s customer service number and PayPal s customer service number The maximum length of the total soft descriptor is 22 characters Of this the PayPal prefix uses either 4 or 8 characters shown in the data format Thus the maximum length of the soft descriptor passed in the API request is 22 len lt PP PAYPAL gt len lt Descriptor set in Payment Receiving Preferences gt 1 For example assume the following conditions e The PayPal prefix toggle is set to PAYPAL in PayPal s administration tools e The merchant descriptor set in the Payment Receiving Preferences is set to EBAY e The soft descriptor is passed in as JanesFlowerGifts LLC The resulting descripto
128. ST N_AMTm ITEMAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 ITEMAMT instead PAYMENTREQUEST n PAYMENT How you want to obtain payment When implementing digital goods this field ACTION is required and you must set it to Sale PAYMENTACTION deprecated PAYMENTACTION is deprecated since version 63 0 Use PAYMENTREQUEST 0 PAYMENTACTION instead Changes to PaymentDetailsltemTypein SetExpressCheckout and DoExpressCheckoutPayment Requests PaymentDetailsltemType Fields Field Description L PAYMENTREQUEST Nn ITEMC New field ATEGORYM Indicates whether the item is digital or physical goods This field is available since version 65 1 For digital goods this field is required and you must set it to Digital It is one of the following values e Digital e Physical Name Value Pair API Developer Guide August 2012 289 a What s New in Version 66 Field Description L PAYMENTREQUEST NM NAME m L_NAMEN deprecated L PAYMENTREQUEST_n DESC m L_DESCn deprecated L_PAYMENTREQUEST_n AMTm L_AMTn deprecated L PAYMENTREQUEST n QTYm L_QTYn deprecated Item name For digital goods this field is required 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 NAMEO L_PAYMENTREQUEST n_NAME1 Character length and limitations 127
129. T NOTETEXT deprecated PAYMENTREQUEST nN TRA NSACTIONID TRANSACTIONID deprecated PAYMENTREQUEST n ALL OWEDPAYMENTMETHOD ALLOWEDPAYMENTMETHOD deprecated Optional Your own invoice or tracking number You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only NOTE The value you specify is available only 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 256 single byte alphanumeric characters INVNUM is deprecated since version 63 0 Use PAYMENTREQUEST_0 INVNUM instead 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 You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only IMPORTANT The notify URL applies only to DoOExpressCheckout Payment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and limitations 2 048 single byte alphanumeric characters NOTIFYURL is deprecated since version 63 0 Use PAYMENTREQUEST 0 NOTIFYURL instead Optional Note to the merchant You can specify up to 10 payments where
130. TECTIONELIGIBILITY Prior to version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy 38 August 2012 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference baw DoVoid API Operation Field Description PROTECTIONELIGIBILITY Since version 64 4 the kind of seller protection in force for the transaction It is TYPE one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNotReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is available since version 64 4 DoVoid API Operation Void an order or an authorization DoVoid Request Message DoVoid Request Fields Field Description METHOD Required Must be DoVoid AUTHORIZATIONID Required Original authorization ID specifying the
131. TREQUEST N TRANSAC TIONID TRANSACTIONID deprecated PAYMENTREQUEST N ALLOWED PAYMENTMETHOD ALLOWEDPAYMENTMETHOD deprecated PAYMENTREQUEST nN PAYMENT ACTION PAYMENTACTION deprecated PAYMENTREQUEST N PAYMENT REQUESTID PAYMENTREQUESTID deprecated Optional Transaction identification number of the transaction that was created You can specify up to 10 payments where n is a digit between 0 and 9 inclusive NOTE This field is only returned after a successful transaction for DoExpressCheckout has occurred 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 How you want to obtain payment When implementing parallel payments this field is required and must be set to Order When implementing digital goods this field is required and must be set to Sale You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only If the transaction does not include a one time purchase this field is ignored It is one of the following values e Sale This isa final sale for which you are requesting payment default e Authorization This payment is a ba
132. The string must conform with modulo and length required by each credit card type Credit card expiration date This field is required if you are using recurring payments with direct payments Character length and limitations 6 single byte alphanumeric characters including leading zero in the format MMYYYY Card Verification Value version 2 Your Merchant Account settings determine whether this field is required To comply with credit card processing regulations you must not store this value after a transaction has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the value is exactly 4 digits Optional Month and year that Maestro card was issued Character length and limitations Must be 6 digits including leading zero in the format MMYYYY Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum Payer Information Fields Field Description EMAIL Optional Email address of buyer Character length and limitations 127 single byte characters FIRSTNAME Required Buyer s first name Character length and limitations 25 single byte characters August 2012 Name Value Pair API Developer Guide DoDirectPayment API Operation ES DoDirectPayment Request Message Field Description LASTNAME Required Buyer s last name Character length and limitations 25 single byte characters
133. These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST n TAXAMTO L PAYMENTREQUEST N TAXAMT1 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma L_TAXAMTn is deprecated in version 63 0 Use L PAYMENTREQUEST 0 TAXAMTm instead Weight of the item 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 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_ITEMWEIGHTVALUEO L PAYMENTREQUEST N ITEMWEIGHTVALUE1 Character length and limitations Any positive integer L_ITEMWEIGTHTVALUEN and L_ITEMWEIGHTUNITN are deprecated in version 63 0 Use L_PAYMENTREQUEST_0 ITEMWEIGTHTVALUEM and L_PAYMENTREQUEST 0 ITEMWEIGHTUNITminstead Length of the item 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 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
134. UEST_N ITEMCATEGORYmM Digital this field is required 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 except for digital goods which only supports single payments These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_N QTYO L PAYMENTREQUEST n QTY1 Character length and limitations Any positive integer This field is introduced in version 53 0 L_OTYn is deprecated since version 63 0 Use L _PAYMENTREQUEST_0_QTYM instead L PAYMENTREQUEST n TA Optional Item sales tax You can specify up to 10 payments where n is a digit XAMTM between 0 and 9 inclusive and m specifies the list item within the payment L_TAXAMTn deprecated except for digital goods which only supports single payments These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST nN TAXAMTO L_PAYMENTREQUEST n_TAXAMT1 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma L_TAXAMTn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 _TAXAMTM instead L_PAYMENTREQUEST nN IT Optional Item weight corresponds to the weight of the item You can pass this EMWEIGHTVALUEM data to the shipping carrier as i
135. Verify Request Fields o e 25 AddressVerify Response Message ee 26 Name Value Pair API Developer Guide August 2012 all Contents Address Verify Response Fields 0 e eee ee eee 26 Chapter 3 Authorization and Capture API Operation Reference 27 DoCapture API Operation 02000 0 ee ee 27 DoCapture Request Message 0 02020 27 DoCapture Response Message aoaaa aaa e 29 DoAuthorization API Operation 00000 eee ee 32 DoAuthorization Request Message aoaaa aa e 32 DoAuthorization Response Message 1 2 e eee ee es 33 DoReauthorization API Operation 0 2 220002 eee 36 DoReauthorization Request Message 2 2 e 4 36 DoReauthorization Response Message 2 0 0 e e 37 DoVoid API Operation ee 39 DoVoid Request Message aoaaa a a 39 DoVoid Response Message e 39 Chapter 4 DoDirectPayment API Operation 41 DoDirectPayment Request Message 2 a eo 41 DoDirectPayment Request Fields 0 00000522 2s 41 Credit Card Details Fields o eo 42 Payer Information Fields 0000 eee ee ee 42 Address Fields 4 4 4 ia e de Bde ae a a a we ed Gees 43 Payment Details Fields 0 00002 eee ee 43 Payment Details Item Fields 0 00 0
136. WEIGHTUNITm request field 73 101 L PAYMENTREQUEST_n ITEMWEIGHTUNITm response field 88 L PAYMENTREQUEST_n ITEMWEIGHTVALUEm request field 73 101 August 2012 301 Index L _PAYMENTREQUEST_n ITEMWIDTHUNITm request field 73 102 L _PAYMENTREQUEST_n ITEMWIDTHUNITm response field 89 L PAYMENTREQUEST_n ITEMWIDTHVALUEm request field 73 102 L PAYMENTREQUEST_n ITEMWIDTHVALUEm response field 89 L _ PAYMENTREQUEST_n_NAMEm request field 71 100 144 287 290 L_PAYMENTREQUEST_n NAMEnm response field 87 L_PAYMENTREQUEST_n NU MBERm response field 88 L_PAYMENTREQUEST_n NUMBERm request field 72 101 145 287 L PAYMENTREQUEST_n QTYm request field 72 101 145 288 290 L_PAYMENTREQUEST n QTYm response field 88 L_PAYMENTREQUEST_n TAXAMTm request field 73 88 101 145 288 L_PAYMENTTYPEn request field 77 165 L_QTY request field 46 176 289 L_QTYn request field 57 72 101 290 L_QTYn response field 88 130 L_SHIPPINGOPTIONAMOUNT response field 58 L_SHIPPINGOPTIONAMOUNTn request field 76 L_SHIPPINGOPTIONAMOUNTn response field 122 L_SHIPPINGOPTIONISDEFAULT response field 58 L_SHIPPINGOPTIONISDEFAULTn request field 76 L_SHIPPINGOPTIONISDEFAULTn response field 122 L_SHIPPINGOPTIONLABEL response field 58 L_SHIPPINGOPTIONNAME response field 58 L_SHIPPINGOPTIONNAMEn request field 76 L_SHIPPINGOPTIONNAMEn response field 122 L_STATUSn response field 192 L_SURVEYCHOICEn request field 65 L_TAXAMT re
137. YPALACCOUNTID Unique identifier for the merchant For parallel payments this field is required and must contain the Payer Id or the email address of the merchant 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 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE SetExpressCheckout API Operation Ebay Item Payment Details Item Type Fields Field Description L PAYMENTREQUEST N EB AYITEMNUMBERM L_EBAYTTEMNUMBERN deprecated L PAYMENTREQUESST n E BAYITEMAUCTIONTXNIDM L_EBAYTITEMAUCTIONTXNI Dn deprecated L_PAYMENTREQUEST_n_EB AYTTEMORDERIDM L_EBAYTTEMORDERIDN deprecated L_PAYMENTREQUEST_n_EB AYCARTIDM L_EBAYTTEMCARTIDN deprecated Optional Auction item number 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 nN EBAYTTEMNUMBERO L_PAYMENTREQUEST_n_EBAYITEMNUMBER1 Character length 765 single byte characters L_EBAYITEMNUMBERN is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 EBAYITEMNUMBER instead Optional Auction transaction identification number 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 T
138. _EBAYITEMORDERIDn request field 47 75 103 176 L_EBAYITEMTXNID response field 130 L_EMAILn response field 192 L_FEEAMTn response field 192 L_FMFfilterIDn response field 49 106 114 179 L_FMFfilterNAM E n response field 114 L_FMFfilterNAMEn response field 49 106 179 L_INSURANCEAMOUNT response field 59 L_ITEMCATEGORYn 175 288 L_ITEMHEIGHTUNITn request field 57 74 102 L_ITEMHEIGHTUNITn response field 89 L_ITEMHEIGHTVALUEn request field 57 74 102 L_ITEMHEIGHTVALUEn response field 89 L_ITEMLENGHTUNITn request field 73 102 L_ITEMLENGTHUNITn request field 57 L_ITEMLENGTHUNITn response field 88 L_ITEMLENGTHVALUEn request field 57 73 102 L_ITEMLENGTHVALUEn response field 88 L_ITEMURLn request field 74 102 L_ITEMWEIGHTUNITn request field 57 73 101 L_ITEMWEIGHTUNITn response field 88 L_ITEMWEIGHTVALUEn request field 57 73 101 L_ITEMWEIGHTVALUEn response field 88 L_ITEMWIDTHUNITn request field 57 73 102 L_ITEMWIDTHUNITn response field 89 L_ITEMWIDTHVALUEn request field 57 73 102 L_ITEMWIDTHVALUEn response field 89 L LOYALTYCARDDISCOUNTAMOUNTn response field 130 L LOYALTYCARDDISCOUNTCURRENCYn response field 130 L_NAMEn request field 46 56 71 100 175 288 290 L_NAMEn response field 87 192 L_NETAMTn response field 192 L_NUMBER request field 46 176 L_NUMBERn request field 56 72 101 L_NUMBER response field 88 130 L_OPTIONSNAMEn response field 131 L_OPTIONSVALUEn response field 131 L PAYMENTINFO_n FMFfilterlDm re
139. _n ITEMCATEGORYM is passed These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST_n QTYO L_PAYMENTREQUEST 1 QTY1 Character length and limitations Any positive integer This field is introduced in version 69 0 L PAYMENTREQUEST_n TA Optional Item sales tax These parameters must be ordered sequentially XAMTM beginning with 0 for example L_PAYMENTREQUEST_n TAXAMTO L PAYMENTREQUEST n TAXAMT1 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is introduced in version 69 0 CreateRecurringPaymentsProfile Response Message CreateRecurringPaymentsProfile Response Fields Field Description PROFILEID A unique identifier for future reference to the details of this recurring payment Character length and limitations Up to 14 single byte alphanumeric characters Name Value Pair API Developer Guide August 2012 145 ae Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description PROFILESTATUS Status of the recurring payment profile e ActiveProfile The recurring payment profile has been successfully created and activated for scheduled payments according the billing instructions from
140. a digit between 0 and 9 inclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma INSURANCEAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 INSURANCEAMT instead Optional Shipping discount for this order specified as a negative number You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGDISCAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPPINGDISCAMT instead Optional Indicates whether insurance is available as an option the buyer can choose on the PayPal Review page You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Is one of the following values e true The Insurance option displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number e false The Insurance option displays No INSURANCEOPTIONOFFERED is deprecated since version 63 0 Use PAYMENTREQUEST 0 INSURANCEOPTION
141. action e Reversal Reauthorization of a transaction e Capture of an order The value of ParentTransactionID is the original OrderID e Authorization of an order The value of ParentTransactionID is the original OrderID e Capture of an order authorization e Void of an order The value of ParentTransactionID is the original OrderID Character length and limitations 16 digits Receipt identification number Character length and limitations 16 digits in xxxx xxxX XXXX Xxxx format The type of transaction It is one of the following values e cart e express checkout Character length and limitations 15 single byte characters Indicates whether the payment is instant or delayed It is one of the following values e none e echeck e instant Character length and limitations 7 single byte characters Time date stamp of payment Character length and limitations Date and time are in UTC GMTformat for example 2011 06 24T05 38 48Z The final amount charged including any shipping and taxes from your Merchant Profile Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma A 3 character currency code PayPal fee amount charged for the transaction Character length and limitations Value is a positive
142. action to be performed to the recurring payments profile Must be one of the following e Cancel Only profiles in Active or Suspended state can be canceled e Suspend Only profiles in Active state can be suspended e React ivate Only profiles in a suspended state can be reactivated NOTE Optional The reason for the change in status For profiles created using Express Checkout this message is 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 ManageRecurringPaymentsProfileStatus Response Message ManageRecurringPaymentsProfileStatus Response Fields Field Description PROF ILEID Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response For each action an error is returned if the recurring payments profile has a status that is not compatible with the action Errors are returned in the following cases e Cancel Profile status is not Active or Suspended e Suspend Profile status is not Active e Reactivate Profile status is not Suspended 154 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API Operation BillOutstandingAmount API Operation The BillOutstandingAmount API operation bills the buyer for the outstanding balance associated with a recur
143. actionID is the original OrderID Character length and limitations 16 digits RECEIPTID Receipt identification number Character length and limitations 16 digits in xxxx xxxX XXXX Xxxx format TRANSACTIONTYPE The type of transaction It is one of the following values e cart e express checkout Character length and limitations 15 single byte characters PAYMENTTYPE Indicates whether the payment is instant or delayed It is one of the following values e none e echeck e instant Character length and limitations 7 single byte characters ORDERTIME Time date stamp of payment Character length and limitations Date and time are in UTC GMT format for example 2011 06 24T05 38 48Z Name Value Pair API Developer Guide August 2012 125 a GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description AMT The final amount charged including any shipping and taxes from your Merchant Profile Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma CURRENCY CODE A 3 character currency code FEEAMT PayPal fee amount charged for the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol
144. ages Character length and limitations 127 single byte alphanumeric characters CUSTOMERSERVICENUMB Optional Merchant Customer Service number displayed on the PayPal pages ER Character length and limitations 16 single byte characters GIFTMESSAGEENABLE Optional Enables the gift message widget on the PayPal pages It is one of the following values e 0 Do not enable gift message widget e 1 Enable gift message widget GIFTRECEI PTENABLE Optional Enable gift receipt widget on the PayPal pages It is one of the following values e 0 Do not enable gift receipt widget e 1 Enable gift receipt widget GIFTWRAPENABLE Optional Enable gift wrap widget on the PayPal pages It is one of the following values e 0 Do not enable gift wrap widget e 1 Enable gift wrap widget NOTE If you pass the value 1 in this field values for the gift wrap amount and gift wrap name are not passed the gift wrap name is not displayed and the gift wrap amount displays as 0 00 GIFTWRAPNAME Optional Label for the gift wrap option such as Box with ribbon Character length and limitations 25 single byte characters August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE SetExpressCheckout API Operation Field Description GIFTWRAPAMOUNT Optional Amount to be charged to the buyer for gift wrapping Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any cu
145. ages 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 ButtonSource value truncated Transaction refused because of an invalid argument See additional error messages for details Invoice ID value exceeds maximum allowable length Value of Order Description has been truncated Value of Custom element has been truncated PageStyle value exceeds maximum allowable length cpp header image value exceeds maximum allowable length cpp header image value exceeds maximum allowable length cpp header image value exceeds maximum allowable length cpp header image value exceeds maximum allowable length The NotifyURL element value exceeds maximum allowable length The ButtonSource elem
146. alid parameter Username Invalid parameter Password Invalid parameter Version Invalid parameter Internal Service Error Transaction refused because of an Currency is not supported invalid argument See additional error messages for details DirectPayment API Errors DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10102 10401 PaymentAction of Order Temporarily Unavailable Transaction refused because of an invalid argument See additional error messages for details PaymentAction of Order is temporarily unavailable Please try later or use other PaymentAction Order total is missing Name Value Pair API Developer Guide August 2012 197 198 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10418 Transaction refused The currencies of the shopping because of an invalid cart amounts must be the same argument See additional error messages for details 10426 Transaction refused Item total is invalid because of an invalid argument See additional error messages for details 10427 Transaction refused Shipping total is invalid because of an invalid argument See additional error messages for details 10428 Transaction refused Handling total is invalid because of an invalid argument See additional error messages for details 10429 Transaction refused Tax total is invalid because of an invalid
147. alphanumeric characters Payment Request Info Type Fields Field Description PAYMENTREQUEST nN TRAN Transaction ID for up to 10 parallel payment requests You can specify up to 10 SACTIONID payments where n is a digit between 0 and 9 inclusive This field is available since version 64 0 PAYMENTREQUEST n PAYM Payment request ID You can specify up to 10 payments where n is a digit between ENTREQUESTID 0 and 9 inclusive This field is available since version 64 0 Payment Error Type Fields Field Description PAYMENTREQUEST N SH xs string ORTMESSAGE Payment error short message You can specify up to 10 payments where n is a digit between 0 and 9 inclusive PAYMENTREQUEST n LO xs string NGMESSAGE Payment error long message You can specify up to 10 payments where n is a digit between 0 and 9 inclusive PAYMENTREQUEST N ER xs string RORCODE Payment error code You can specify up to 10 payments where n is a digit between 0 and 9 inclusive PAYMENTREQUEST nN SE xs string VERITYCODE Payment error severity code You can specify up to 10 payments where n is a digit between 0 and 9 inclusive PAYMENTREQUEST n AC xs string K Application specific error values indicating more about the error condition You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Name Value Pair API Developer Guide August 2012 91 6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operat
148. an NVP Request Specifying an API Credential Using Signatures You must specify API credentials in each request to execute a PayPal API operation You can use either a signature or a certificate but not both When you execute a PayPal API operation you use credentials such as a signature to authenticate that you are requesting the API operation The following diagram shows the API credentials part of an NVP request Your Site _ _ NVP Request Checkout API operation sosrocar MM USER sdk three_apit sdk com PayPal PWD QFZCWN5HZM8VBG7Q API Server _ lt i i SIGNATURE A IzJhZZjhg29 Request specific fields The eater casier may te pay IMPORTANT You must protect the values for USER PWD and SIGNATURE in your implementation 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 To enable PayPal to authenticate your request 1 Specify the API username associated with your account USER API_usemame 2 Specify the password associated with the API user name PWD API_password 3 If you are using an API signature and not an API certificate specify the API signature associated with the API username SIGNATURE API_signature 4 Optionally you can specify the email address on file with PayPal of the third party merchant on whose behalf you are call
149. an the current number of failed payments for this profile Character length and limitations Number string representing an integer PROF ILESTARTDATE Optional The date when billing for this profile begins NOTE The profile may take up to 24 hours for activation Character length and limitations Must be a valid date in UTC GMT format Ship To Address Fields Field Description SHI PTONAME Person s name associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters SHIPTOSTREET First street address It is required if using a shipping address Character length and limitations 100 single byte characters Name Value Pair API Developer Guide August 2012 157 ae Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRY SHIPTOPHONENUM Optional Second street address Character length and limitations 100 single byte characters Name of city It is required if using a shipping address Character length and limitations 40 single byte characters State or province It is required if using a shipping address Character length and limitations 40 single byte characters U S ZIP code or other country specific postal code It is required if using a U S shipping address may be required for othe
150. anceled Reversal A reversal has been canceled For example when you win a dispute PayPal returns the funds for the reversal to you Completed The payment has been completed and the funds have been added successfully to your account balance e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element e Expired The authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from the buyer s bank account e In Progress The transaction has not terminated For example an authorization may be awaiting completion e 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 PayPal removes the funds from your account balance and returns them to the buyer The ReasonCode element specifies the reason for the reversal e Processed A payment has been accepted e Voided An authorization for this transaction has been voided 34 August 2012 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference baw DoAuthorization API Operation Field Description PEND INGREASON Reason the payment is pending It is one of t
151. and 9 inclusive and m specifies the list item within the payment except for digital goods which only supports single payments These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_N QTYO L PAYMENTREQUEST n QTY1 Character length and limitations Any positive integer This field is introduced in version 53 0 L_OTYn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 QTY instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations SetExpressCheckout API Operation Field Description L PAYMENTREQUEST n TA XAMTM L_TAXAMTN deprecated L_PAYMENTREQUEST_n_IT EMWEIGHTVALUEM L_PAYMENTREQUEST_n_IT EMWEIGHTUNITM L_ITEMWEIGHTVALUEn and L_ITEMWEIGHTUNITnN deprecated L_PAYMENTREQUEST_n_IT EMLENGTHVALUEM L PAYMENTREQUEST Nn IT EMLENGTHUNITM L_ITEMLENGTHVALUEN and L_ITEMLENGHTUNITN deprecated L_PAYMENTREQUEST_n_IT EMWIDTHVALUEM L_PAYMENTREQUEST_n_IT EMWIDTHUNITM L_ITEMWIDTHVALUEN and L_ITEMWIDTHUNITN deprecated Optional Item sales tax 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 except for digital goods which only supports single payments These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST nN TAXAMTO L_PAYMENTREQUEST n_TAXAMT1 Character length and limitations Value is a positive number which cannot
152. aracter country code The following two character country codes are supported by PayPal e AU Australia AT Austria BE Belgium BR Brazil CA Canada CH Switzerland CN China DE Germany ES Spain GB United Kingdom FR France IT Italy NL Netherlands PL Poland PT Portugal RU Russia US United States The following 5 character codes are also supported for languages in specific countries da_DK Danish for Denmark only he_IL Hebrew all id ID Indonesian for Indonesia only jp JP Japanese for Japan only no_NO Norwegian for Norway only pt_BR Brazilian Portuguese for Portugal and Brazil only ru RU Russian for Lithuania Latvia and Ukraine only sv_SE Swedish for Sweden only th_TH Thai for Thailand only tr_TR Turkish for Turkey only zh_CN Simplified Chinese for China only zh HK Traditional Chinese for Hong Kong only zh TW Traditional Chinese for Taiwan only Any other value will default to US L_NAMEN Item name from the Express Checkout API These parameters must be ordered sequentially beginning with 0 for example L_NAMEO L_NAME1 L_NUMBERN Item number from the Express Checkout API These parameters must be ordered sequentially beginning with 0 for example L_NUMBERO L_NUMBER1 56 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations Callback API Operation
153. aracters Name Value Pair API Developer Guide August 2012 141 142 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description SHIPTOZIP SHIPTOCOUNTRY SHIPTOPHONENUM U S ZIP code or other country specific postal code It is required if using a U S shipping address may be required for other countries Character length and limitations 20 single byte characters Country code It is required if using a shipping address Character length and limitations 2 single byte characters Optional Phone number Character length and limitations 20 single byte characters Credit Card Details Fields Field Description CREDITCARDTYPE ACCT EXPDATE CVV2 STARTDATE ISSUENUMBER Optional Type of credit card For UK only Maestro MasterCard Discover and Visa are allowable For Canada only MasterCard and Visa are allowable and Interac debit cards are not supported It is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set CURRENCYCODE to GBP In addition you must specify either STARTDATE or ISSUENUMBER Character length and limitations Up to 10 single byte alphabetic characters Required Credit card number Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modu
154. are returned in a response only if PayPal has recorded data that corresponds to the field GetTransactionDetails Response Fields Field Description SHIPPINGCALCULATION Describes how the options that were presented to the buyer were determined MODE It is one of the following values e Callback Shipping option rates are based on the buyer s location e FlatRate Shipping options are flat rates Name Value Pair API Developer Guide August 2012 121 122 GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description INSURANCEOPTIONSELE Whether the buyer selected the insurance option It is one of the following values CTED e true The buyer selected Yes for the insurance option L_SHIPPINGOPTIONISD EFAULTn L_SHIPPINGOPTIONNAM En L_SHIPPINGOPTIONAMO UNTn GIFTMESSAGE GIFTRECEI PTENABLE GIFTWRAPNAME GIFTWRAPAMOUNT BUYERMARKETINGEMATL SURVEYQUESTION e false The buyer did not select the insurance option The option is No The value true is returned if the buyer selected the option Otherwise false is returned Default shipping option displayed on the PayPal pages This field is required if you specify the Callback URL It is one of the following values e true This is the default flat rate shipping option PayPal displays this option by default e false This flat rate shipping option is not displayed as the default NOTE There must be ONE and ONLY ONE defaul
155. argument See additional error messages for details 10004 Transaction refused because Transaction class is not supported of an invalid argument See additional error messages for details Name Value Pair API Developer Guide August 2012 237 API Error Codes TransactionSearch API Errors Error Code Short Message Long Message 10004 10004 10004 10004 10004 10004 10004 10007 10007 11002 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 Permission denied Permission denied Search warning Receipt id is not valid Payer email is invalid Auction item id is not valid Receiver email is invalid You can not search for a transaction id and a receipt id Receiver can only be specified for payments you ve received The transaction id is not valid You do not hav
156. argument See additional error messages for details 10432 Invalid argument Invoice ID value exceeds maximum allowable length 10485 Payment not authorized Payment has not been authorized by the user 10500 Invalid Configuration This transaction cannot be Occurs when you have not agreed to the processed due to an invalid billing agreement merchant configuration 10501 Invalid Configuration This transaction cannot be Occurs when the billing agreement is processed due to an invalid disabled or inactive merchant configuration 10502 Invalid Data This transaction cannot be The credit card used is expired processed Please use a valid credit card 10504 Invalid Data This transaction cannot be The CVV provided is invalid The CVV processed Please enter a valid is between 3 4 digits long Credit Card Verification Number 10505 Gateway Decline This transaction cannot be The transaction was refused because the processed AVS response returned the value of N and the merchant account is not able to accept such transactions August 2012 Name Value Pair API Developer Guide API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10507 Invalid Configuration This transaction cannot be Your PayPal account is restricted processed Please contact PayPal Contact PayPal for more information Customer Service 10508 Invalid Data This transaction cannot be The expiration date must be a two digit
157. ations 40 single byte characters SHIPTOSTATE is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOSTATE instead U S ZIP code or other country specific postal code It is required if using a U S shipping address and may be required for other countries You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 20 single byte characters SHIPTOZIP is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOZIP instead Country code It is required if using a shipping address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 2 single byte characters SHIPTOCOUNTRY is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOCOUNTRYCODE instead Name Value Pair API Developer Guide August 2012 99 100 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST N SHIPTOPHO Optional Phone number You can specify up to 10 payments where n is a NENUM digit between 0 and 9 inclusive SHIPTOPHONENUM deprecated Character length and limitations 20 single byte characters SHIPTOPHONENUM is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOPHONENUM instead Payment Details Item Type Fields Field Description L PAYMENTREQUEST n NA MEM L NAMEN deprecated L PAYMENTREQUEST _n DE scm L_DESCn deprecated L P
158. auth the original authorization reauthorization not a reauthorization 10616 Maximum Maximum number of DoReauthorization Capture or close the number of reauthorization allowed authorization reauthorization for the auth is reached allowed for the auth is reached 10617 Reauthorization Reauthorization is not DoReauthorization Capture the authorization not allowed allowed inside honor or reauthorize outside of period honor period 10618 Transaction Transaction has already DoAuthorization Close the order or already voided been voided or expired DoCapture authorization or expired DoReauthorization DoVoid 10619 InvoiceID value Invoice ID value exceeds DoCapture Check the length of the exceeds maximum allowable invoice ID and reattempt maximum length the request allowable length 10620 Order has Order has already been DoAuthorization Close this order already been voided expired or DoCapture voided expired completed DoVoid or completed 10621 Order has Order has expired DoAuthorization Close this order expired DoCapture DoVoid 10622 Order is voided Order is voided DoAuthorization Close this order DoCapture DoVoid 10623 Maximum Maximum number of DoAuthorization Capture this order number of authorization allowed for DoCapture ne the order is reached DoReauthorization allowed for the order is reached Devore 10624 Duplicate Payment has already DoAuthorization Review the invoice ID invoice been made for this and
159. ay server is unavailable Unable to create payments for masspay Name Value Pair API Developer Guide August 2012 243 244 API Error Codes Recurring Payments Errors Error Code Short Message Long Message 10311 Unable to submit payment Unable to submit payments for masspay 10312 Masspay server error The masspay server has reported errors 10313 Masspay Invalid Data The masspay input file includes invalid data 10314 Masspay input parse error The input to the masspay server is incorrect Please make sure that you are using a correctly formatted input 10317 Masspay Invalid Email The masspay input file includes invalid Email 10320 Internal Error Internal Error 10321 Insufficient funds The account does not have sufficient funds to do this masspay 10327 Masspay Invalid UserID The masspay input file includes invalid UserID Recurring Payments Errors The following table lists errors for the following APIs that handle recurring payments profiles e CreateRecurringPaymentsProfile e GetRecurringPaymentsProfileDetails e ManageRecurringPaymentsProfileStatus e UpdateRecurringPaymentsProfile e BillOutstandingAmount Recurring Payments Errors Error Code Short Message Long Message Additional Information 10001 Invalid account number The transaction failed as a result of invalid credit card number Check the number or attempt with another credit card 10003 Missing argument Item name amount and quantity S
160. ayments 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 ITEMLENGTHVALUEO L_PAYMENTREQUEST_n_ITEMLENGTHVALUE1 Character length and limitations Any positive integer L_ITEMLENGTHVALUEN and L_ITEMLENGTHUNITM are deprecated since version 63 0 Use L_PAYMENTREQUEST 0 ITEMLENGTHVALUEM and L PAYMENTREQUEST 0 ITEMLENGTHUNITN instead Optional Item width corresponds to the width of the item 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 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 ITEMWIDTHVALUEO L_PAYMENTREQUEST_n_ITEMWIDTHVALUE1 Character length and limitations Any positive integer L_ITEMWIDTHVALUEN and L_ITEMWIDTHUNITM are deprecated since version 63 0 Use L_ PAYMENTREQUEST_0 ITEMWIDTHVALUEM and L_PAYMENTREQUEST 0 ITEMWIDTHUNITH instead Optional 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 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
161. ber Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card type Credit card expiration date This field is required if you are using recurring payments with direct payments Character length and limitations 6 single byte alphanumeric characters including leading zero in the format MMYYYY Card Verification Value version 2 Your Merchant Account settings determine whether this field is required To comply with credit card processing regulations you must not store this value after a transaction has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the value is exactly 4 digits Optional Month and year that Maestro card was issued Character length and limitations Must be 6 digits including leading zero in the format MMYYYY Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum August 2012 Name Value Pair API Developer Guide DoNonReferencedCredit API Operation ba DoNonReferencedCredit Request Message Payer Name Type Fields Field Description SALUTATION Optional Buyer s salutation Character length and limitations 20 single byte characters FIRSTNAME Optional Buyer s first name Character length and limitations 25 single byte characters MIDDLENAME Optiona
162. can be returned from a TransactionSearch API call is 100 TransactionSearch Request Message TransactionSearch Request Fields Field Description METHOD Required Must be Transact ionSearch STARTDATE Required The earliest transaction date at which to start the search Character length and limitations No wildcards are allowed The value must be in UTC GMT ENDDATE Optional The latest transaction date to be included in the search Character length and limitations No wildcards are allowed The value must be in UTC GMT EMAIL Optional Search by the buyer s email address Character length and limitations 127 single byte alphanumeric characters RECEIVER Optional Search by the receiver s email address If the merchant account has only one email address this is the primary email It can also be a non primary email address RECEIPTID Optional Search by the PayPal Account Optional receipt ID This field is not applicable to point of sale transactions TRANSACTIONID Optional Search by the transaction ID The returned results are from the merchant s transaction records Character length and limitations 19 single byte characters maximum INVNUM Optional Search by invoice identification key as set by you for the original transaction This field searches the records for items the merchant sells Character length and limitations 127 single byte characters maximum with no wildcards allowed Name Value Pair API D
163. cenario Merchant passes item are required if item category is category as either Digital or provided Physical but does not also pass one of the following parameters name amount or quantity 10004 Transaction refused You are not signed up to accept Scenario Merchant is not signed because of an invalid payment for digitally delivered up for digital goods but passes argument See additional goods item category as Digital error messages for details August 2012 Name Value Pair API Developer Guide API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10004 10004 10478 10501 10502 10504 10505 10507 10508 10509 10510 Cart item calculation mismatch Tax calculation mismatch Invalid Data Invalid Configuration Invalid Data Invalid Data Gateway Decline Invalid Configuration Invalid Data Invalid Data Invalid Data Cart item calculation mismatch The regular non trial billing period amount is different than the sum of the amounts for each item in the cart Tax calculation mismatch The tax amount for the regular non trial billing period is different than the sum of the tax for each item in the cart Recurring payments profile description must be provided if the billing agreement type is recurring payments This transaction cannot be processed due to an invalid merchant configuration This transacti
164. characters Text for the survey question on the PayPal pages If the survey question is present at least 2 survey answer options need to be present Limitations 50 single byte characters August 2012 Name Value Pair API Developer Guide GetTransactionDetails API Operation Sa GetTransactionDetails Response Message Field Description SURVEYCHOICESELECTE Survey response the buyer selected on the PayPal pages D Limitations 15 single byte characters Receiver Information Fields Field Description RECEIVERBUSINESS Details about a single transaction This field is not application for point of sale transactions RECEIVEREMAIL Primary email address of the payment recipient the merchant If you are the recipient of the payment and the payment is sent to your non primary email address the value of Receiver is still your primary email address Character length and limitations 127 single byte alphanumeric characters RECEIVERID Unique account ID of the payment recipient the merchant This value is the same as the value of the recipient s referral ID Payer Information Fields Field Description EMAIL Email address of buyer Character length and limitations 127 single byte characters PAYERID Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters PAYERSTATUS Status of buyer It is one of the following values e verified e unverifi
165. chnical Not allowed diffculties the Multi Payments for Sale is not avaliable now please try again later 13111 Mixed Payment actionnot The Payment Action passed supported should be unique mixed Payment Action not supported 13113 Buyer Cannot Pay The Buyer cannot pay with PayPal for this transaction 13115 Seller ID Missing Seller ID is mandatory for parallel payments 13116 Transaction refused The transaction is in progress because of an invalid for this token argument See additional error messages for details 13751 Could not retrieve the Transaction completed original successful response successfully but could not retrieve the original successful response August 2012 Name Value Pair API Developer Guide API Error Codes Authorization and Capture API Errors Authorization and Capture API Errors Authorization and Capture API Error Messages Error Short Returned By API Correcting This Code Message Long Message Call Error 10001 Internal Error Internal Error 10001 Internal Error Transaction failed due to internal error 10004 Internal Error Invalid argument 10007 Permission You do not have denied permissions to make this API call 10009 Transaction Account is locked or Retry the request at a refused inactive later time or close order 10010 Transaction Invalid argument refused because of an invalid argument See additional error messages for details 10202 Exceed max Transaction would DoAuthorizat
166. ckoutDetails API Operation Field Description L PAYMENTREQUEST_N NUMB ERM L NUMBERN deprecated L PAYMENTREQUEST_n QTY m L_QTYn deprecated L PAYMENTREQUEST_n TAXA MTM L_TAXAMTN deprecated L_PAYMENTREQUEST_n_ITEM WEIGHTVALUEM L_PAYMENTREQUEST_n_ITEM WEIGHTUNITM L_ITEMWEIGHTVALUEN and L_ITEMWEIGHTUNITN deprecated L_PAYMENTREQUEST_n_ITEM LENGTHVALUEM L_PAYMENTREQUEST_n_ITEM LENGTHUNITM L_ITEMLENGTHVALUEN and L_ITEMLENGTHUNITN deprecated Item number 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 NUMBERO L_PAYMENTREQUEST N NUMBER1 Character length and limitations 127 single byte characters L_NUMBERN is deprecated in version 63 0 Use L_PAYMENTREQUEST 0 NUMBERM instead 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 QTYO L_PAYMENTREQUEST 1 QTY1 Character length and limitations Any positive integer L _QTYn is deprecated in version 63 0 Use L_PAYMENTREQUEST_0_QTYM instead Item sales tax 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
167. country code Optional Name of the Custom Payment Page Style for payment pages associated with this button or link It corresponds to the HTML variable page style for customizing payment pages It is the same name as the Page Style Name you chose to add or edit the page style in your PayPal Account profile Character length and limitations 30 single byte alphabetic characters August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE SetExpressCheckout API Operation Field Description HDRIMG Optional URL for the image you want to appear at the top left ofthe payment page The image has a maximum size of 750 pixels wide by 90 pixels high PayPal recommends that you provide an image that is stored on a secure https server If you do not specify an image the business name displays Character length and limitations 127 single byte alphanumeric characters HDRBORDERCOLOR Optional Sets the border color around the header of the payment page The border is a 2 pixel perimeter around the header space which is 750 pixels wide by 90 pixels high By default the color is black Character length and limitations 6 character HTML hexadecimal ASCII color code HDRBACKCOLOR Optional Sets the background color for the header of the payment page By default the color is white Character length and limitations 6 character HTML hexadecimal ASCII color code PAYFLOWCOLOR Optional Sets the background color for
168. cters L_OTYN Item quantity This field is required when you pass a value for L PAYMENTREQUEST Nn ITEMCATEGORYM These parameters must be ordered sequentially beginning with 0 for example L_QTYO L_QTY1 Character length and limitations Any positive integer L_TAXAMTN Optional Item sales tax These parameters must be ordered sequentially beginning with 0 for example L_TAXAMTO L_TAXAMT1 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Ebay Item Payment Details Item Fields Field Description L_EBAYITEMNUMBERN Optional Auction item number These parameters must be ordered sequentially beginning with 0 for example L_EBAYITEMNUMBERO L_EBAYITEMNUMBER1 Character length 765 single byte characters L EBAYITEMAUCTIONTX Optional Auction transaction identification number These parameters must be NIDn ordered sequentially beginning with 0 for example L_EBAYITEMAUCTIONTXNIDO L EBAYITEMAUCTIONTXNID1 Character length 255 single byte characters L EBAYITEMORDERIDn Optional Auction order identification number These parameters must be ordered sequentially beginning with 0 for example L_EBAYITEMORDERIDO L EBAYITEMORDERID1 Character length 64 single byte characters 176 August 2012 Name Value
169. ction DoAuthorization and DoCapture 12 June 2012 Maintenance release 22 May 2012 Maintenance release 2 May 2012 Updated for 89 0 Added new field to SetExpressCheckout and DoReferenceTransaction Request APIs Added new error to DoReferenceTransaction Request API 3 April 2012 Updated references to Website Payments Standard and Website Payments Pro to PayPal Payments Standard and PayPal Payments Pro respectively 14 February 2012 Maintenance release 24 January 2012 Maintenance release updated for 85 0 1November 2011 Updated for 84 0 Added new field and a new type to RefundTransaction API 1 September 2011 5 April 2011 8 March 2011 26 January 2011 15 September 2010 request Added new field to DoDirectPayment API and DoReferenceTransaction API responses Edits to improve accuracy General edits to improve consistency Updated for 71 0 Added new fields to the DoExpressCheckout API response to return information about funds that are being held and the seller s encrypted account number Updated for 69 0 Added more digital goods support to the CreateRecurringPaymentsProfile and DoReferenceTransaction APIs to enable the merchant to obtain the best rates for digital goods Updated for 66 0 Describes changes to the ExpressCheckout API for implementing Digital Goods Updated for 64 4 including addition of ProtectionEligibilityType field Name Value Pair API Developer Guide August 2012 293 294 Date De
170. d 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 Invalid item URL SellerRegistrationDate is invalid Invalid eBay seller feedback overall positive count Invalid eBay seller feedback overall negative count Invalid eBay seller feedback total positive count Invalid eBay seller feedback total negative count Invalid eBay seller feedback recent positive count Invalid eBay seller feedback recent negative count Invalid eBay item transaction date Invalid eBay item buyer protection type Name Value Pair API Developer Guide August 2012 225 226 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10004 Transaction refused Invalid eBay item payment because of an invalid hold risk argument See additional error messages for details 10004 Transaction refused Multiple eBay order IDs not because of an invalid allowed argument Se
171. d in your PayPal account after a currency conversion 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 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma 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 Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TAXAMT is deprecated since version 63 0 Use PAYMENTINFO_0_TAXAMT instead Name Value Pair API Developer Guide August 2012 109 6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO Nn EXCHA Exchange rate if a currency conversion occurred Relevant only if your are billing in NGERATE their non primary currency If the buyer chooses to pay with a currency other than the EXCHANGERATE non primary currency the conversion occurs in the buyer s account
172. d with buyer Use this value unless you need per transaction billing agreements You must specify version 58 0 or higher to use this option BILLINGTYPE Type of billing agreement for reference transactions You must have permission from PayPal to use this field For reference transactions this field must be set to one of the following values e MerchantInitiatedBilling PayPal creates a billing agreement for each transaction associated with buyer You must specify version 54 0 or higher to use this option e Merchant InitiatedBillingSingleAgreement PayPal creates a single billing agreement for all transactions associated with buyer Use this value unless you need per transaction billing agreements You must specify version 58 0 or higher to use this option Other defined values are not valid L_BILLINGAGREEMENTD Description of goods or services associated with the billing agreement This field is ESCRIPTIONN required for each recurring payment billing agreement PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions For example buyer is billed at 9 99 per month for 2 years Character length and limitations 127 single byte alphanumeric characters L_PAYMENTTYPEnN Optional Type of PayPal payment you require for the billing agreement It is one of the following values e Any e InstantOnly NOTE For recurring payments this field is ignored L_BILLINGAGREEMENTC Optional Cu
173. dditional error messages for details 10429 Transaction refused Item sales tax is invalid PaymentDetailsItem Tax field is because of an invalid invalid Warning only API argument See additional executes error messages for details 10430 Transaction refused Item amount is missing PaymentDetailsItem Amount because of an invalid field is missing Warning only argument See additional API executes error messages for details 10431 Transaction refused Item amount is invalid PaymentDetailsItem Amount because of an invalid field is invalid Warning only argument See additional API executes error messages for details 10432 Transaction refused Invoice ID value exceeds InvoicelD field is too long because of an invalid maximum allowable length maximum length is 256 argument See additional error messages for details 10433 Transaction refused Value of OrderDescription element OrderDescription field is too because of an invalid has been truncated long maximum length is 127 argument See additional Warning only API executes error messages for details 10434 Transaction refused Value of Custom element has been Custom field is too long because of an invalid argument See additional error messages for details truncated maximum length is 256 Warning only API executes August 2012 Name Value Pair API Developer Guide API Error Codes DoReference Transaction Errors Error Code Short Message Long Message
174. de August 2012 89 90 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description L_PAYMENTREQUEST_n_EB AYTTEMAUCTIONTXNIDM EBAYITEMAUCTIONTXNIDN deprecated L_PAYMENTREQUEST_n_EB AYTTEMORDERIDM EBAYTTEMORDERIDnN deprecated L PAYMENTREQUEST N EB AYTTEMCARTIDM EBAYITEMCARTIDN deprecated Auction transaction identification number 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 Character length 255 single byte characters EBAYITEMAUCTIONTXNIDn is deprecated since 63 0 Use L_PAYMENTREQUEST 0 EBAYAUCTIONTXNIDM instead Auction order identification number 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 Character length 64 single byte characters EBAYITEMORDERIDn is deprecated since 63 0 Use L_PAYMENTREQUEST_ 0 EBAYITEMORDERIDM instead 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 inclusive and m specifies the list item within the payment Character length 255 single byte characters EBAYITEMCARTIDn is deprecated since 63 0 Use L PAYMENTREQUEST 0 EBAYITEMCARTIDm instead User Selected Options Type Fields Field Description SHIPPINGCALCULATIONM Describes how the options that were presented to the buyer we
175. des no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Credit Card Details Fields Field Description CREDITCARDTYPE Optional Type of credit card For UK only Maestro MasterCard Discover and Visa are allowable For Canada only MasterCard and Visa are allowable and Interac debit cards are not supported It is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set CURRENCYCODE to GBP In addition you must specify either STARTDATE or ISSUENUMBER Character length and limitations Up to 10 single byte alphabetic characters Name Value Pair API Developer Guide August 2012 159 160 Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description ACCT Required Credit card number Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card type EXPDATE Credit card expiration date This field is required if you are using recurring payments with direct payments Character length and limitations 6 single byte alphanumeric characters including leading zero in the format MMYYYY CVV2 Card Verification Value version 2 Your Merchant Account s
176. e mixed Payment Action not supported 13114 Buyer Didn t Complete The Buyer returned without completing the payment 13115 Seller ID Missing Seller ID is mandatory for parallel payments 13116 Transaction refused because The transaction is in progress for this of an invalid argument See additional error messages for details token August 2012 Name Value Pair API Developer Guide API Error Codes GetExpressCheckoutDetails API Errors GetExpressCheckoutDetails API Errors GetExpressCheckoutDetails API Errors Error Code Short Message Long Message Correcting This Error 10001 Internal Error Internal Error 10001 Internal Error Transaction failed due to internal error 10001 ButtonSource value The transaction could not be loaded truncated 10001 ButtonSource value The transaction could not be loaded truncated 10003 Missing argument OtherPaymentMethodID is missing 10003 Missing argument OtherPaymentMethodLabel is missing 10003 Missing argument OtherPaymentMethodType is missing 10003 Missing argument One or more of these giropay URLs is missing giropaySuccessURL giropayCancelURL BanktxnPendingURL 10004 Transaction refused because Transaction refused because of an of an invalid argument See invalid argument See additional error additional error messages for messages for details details 10004 Transaction refused because The transaction id is not valid of an invalid argument See additional error messages for
177. e recurring payment If not present the name in the buyer s PayPal account is used Character length and limitations 32 single byte characters PROFILEREFERENCE Optional The merchant s own unique reference or invoice number Character length and limitations 127 single byte alphanumeric characters ADDITIONALBILLINGCY Optional The number of additional billing cycles to add to this profile CLES AMT Optional Billing amount for each cycle in the subscription period not including shipping and tax amounts NOTE For recurring payments with Express Checkout the payment amount can be increased by no more than 20 every 180 days starting when the profile is created Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma 156 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation Field Description SHIPPINGAMT Optional Shipping amount for each billing cycle during the regular payment period NOTE All amounts in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have
178. e additional error messages for details 10007 Permission denied You do not have permissions to make this API call 10406 Transaction refused The PayerID value is invalid because of an invalid argument See additional error messages for details 10408 Express Checkout tokenis Express Checkout token is missing missing 10409 You re not authorized to Express Checkout token was access this info issued for a merchant account other than yours 10410 Invalid token Invalid token 10411 This Express Checkout This Express Checkout session session has expired has expired Token value is no longer valid 10412 Duplicate invoice Payment has already been made for this InvoiceID 10413 Transaction refused The totals of the cart item If you receive this error be sure the because of an invalid amounts do not match order total of the payment detail item argument See additional amounts parameters such as ItemTotal error messages for details HandlingTotal TaxTotal and so forth add up to the order total 10414 Transaction refused The amount exceeds the because of an invalid maximum amount for a single argument See additional transaction error messages for details 10415 Transaction refused A successful transaction has because of an invalid argument See additional error messages for details already been completed for this token August 2012 Name Value Pair API Developer Guide DoExpressCheckoutPayment API Errors API
179. e byte characters SHIPTOCOUNTRYCODE Country code Character length and limitations 2 single byte characters Name Value Pair API Developer Guide August 2012 167 168 Recurring Payments and Reference Transactions API Operations BAUpdate API Operation BAUpdate API Operation The BAUpdate API operation updates or deletes a billing agreement BAUpdate Request Message BAUpdate Request Fields Field Description METHOD Required Must be BillAgreementUpdate REFERENCEID Required An ID such as a billing agreement ID or a reference transaction ID that is associated with a billing agreement BILLINGAGREEMENTSTA Optional Use to cancel a billing agreement To cancel a billing agreement pass the TUS value Canceled L _BILLINGAGREEMENTD ESCRIPTIONn L_BILLINGAGREEMENTC USTOMn NOTE If you do not pass the value Canceled BAUpdate returns the buyer s latest billing address Optional Description of goods or services associated with the billing agreement This field is required for each recurring payment billing agreement PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions For example buyer will be billed at 9 99 per month for 2 years Character length and limitations 127 single byte alphanumeric characters Optional Custom annotation field for your own use NOTE For recurring payments this field is ignored Character length and limitations
180. e field 80 122 Swedish Krona 275 276 Swiss Franc 275 276 Y Taiwan New Dollar 275 TAXAMT request field 44 51 69 96 157 159 174 TAXAMT response fie ld 109 TAXAMT response field 85 126 150 181 TAXIDDETAILS request field 78 TAXIDDETAILS response field 92 TaxIdDetailsType request fields 78 TaxIdDetailsType response fields 92 TAXIDTYPE request field 78 TAXIDTYPE response field 92 Terminalld 113 129 183 TERMINALID response field 29 187 283 284 Thai Baht 276 THB 276 TOKEN request field 55 79 92 137 161 166 TOKEN response field 26 78 79 105 165 TOTALBILLINGCYCLES request field 139 158 TOTALBILLINGCYCLES response field 149 TOTALREFUNDEDAMT response field 187 TOTALTYPE request field 65 Transaction Search request fields 189 Transaction Search response fields 192 TRANSACTIONCLASS request field 190 TRANSACTIONENTITY request field 33 TRANSACTIONID request field 32 70 98 121 133 185 189 Name Value Pair API Developer Guide TRANSACTIONID response field 33 48 54 86 108 125 134 179 TransactionSearch API operation 189 TransactionSearch request message 189 TransactionSearch response message 192 TRANSACTIONTYPE response field 108 125 180 TRIALAMT request field 140 159 TRIALBILLINGFREQUENCY request field 140 TRIALBILLINGPERIOD request field 139 TRIALTOTALBILLINGCYCLES request field 140 158 TRY 276 Turkish Lira 276 TWD 275 E S Dollar 276 pdate Recurring Payments Profile reques
181. e hosting on your marketplace Field Description PAYMENTREQUEST n_ AMT AMT deprecated PAYMENTREQUEST nm CURRENC YCODE CURRENCYCODE deprecated The total cost of the transaction to the buyer If shipping cost not applicable to digital goods and tax charges are known include them in this value If not this value should be the current sub total of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases Set this field to 0 if the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged When the field is set to 0 purchase specific fields are ignored You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only For digital goods the following must be true e total cost gt 0 e total cost lt total cost passed in the call to SetExpressCheckout Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma AMT is deprecated since version 63 0 Use PAYMENTREQUEST_0 AMT instead Optional A 3 character currency code Default USD You can specify up to 10 payments where
182. e permission to search for this transaction You do not have permission to make this API call The number of results were truncated Please change your search parameters if you wish to see all your results 238 August 2012 Name Value Pair API Developer Guide API Error Codes RefundTransaction API Errors RefundTransaction API Errors RefundTransaction API Errors Error Code Short Message Long Message Correcting This Error 10001 10001 10001 10002 10004 10004 10004 10004 10007 10007 Internal Error Internal Error Internal Error Restricted account 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 Permission denied Permission denied Internal Error Warning an internal error has occurred The transaction id may not be correct The transaction could not be loaded Account is restricted The partial refund amount must be a positive amount You can not specify a partial amount with a full refund A transaction id is required The transaction id is not valid You do not have permission to refund this transaction You do not hav
183. e permissions to make this API call Name Value Pair API Developer Guide August 2012 239 API Error Codes RefundTransaction API Errors Error Code Short Message Long Message Correcting This Error 10009 10009 10009 10009 10009 10009 10009 10009 10009 10009 10009 10009 10009 Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused Transaction refused 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 of the following e Not having yet verified the bank account associated with your PayPal account e Not having any bank account associated with your PayPal account Be sure that you have sufficient funds in your PayPal balance and that you have verified the associated bank account 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 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
184. ecause 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 The transaction failed as a result of an invalid credit card number Check the number or attempt with another card Internal Error The transaction could not be loaded The transaction could not be loaded The masspay receiver_type is not a recognizable type The user account is locked The number of input records is greater than maximum allowed The number of input records is less than or equal to zero The note string length exceeds the maximum limit of 4000 characters The amount is missing The currency is missing Currency is not supported 242 August 2012 Name Value Pair API Developer Guide API Error Codes MassPay API Errors Error Code Short Message Long Message 10004 10004 10004 10004 10004 10004 10007 10301 10303 10304 10305 10306 10307 10308 10309 10310 Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argumen
185. ecified is not Supported 81003 Unspecified Method No Method Specified 81004 Unspecified Method No Request Received 81100 Missing Parameter OrderTotal Amt Required parameter missing 81101 Missing Parameter MaxAmt Required parameter missing 81102 Missing Parameter ReturnURL Required parameter missing 81103 Missing Parameter NotifyURL Required parameter missing 81104 Missing Parameter CancelURL Required parameter missing 81105 Missing Parameter ShipToStreet Required parameter missing 81106 Missing Parameter ShipToStreet2 Required parameter missing 81107 Missing Parameter ShipToCity Required parameter missing 81108 Missing Parameter ShipToState Required parameter missing 81109 Missing Parameter ShipToZip Required parameter missing 81110 Missing Parameter Country Required parameter missing 81111 Missing Parameter ReqConfirmShipping Required parameter missing 81112 Missing Parameter NoShipping Required parameter missing 81113 Missing Parameter AddrOverride Required parameter missing August 2012 Name Value Pair API Developer Guide API Error Codes Validation Errors Error Code Short Message Long Message 81114 Missing Parameter LocaleCode Required parameter missing 81115 Missing Parameter PaymentAction Required parameter missing 81116 Missing Parameter Email Required parameter missing 81117 Missing Parameter Token Required parameter missing 81118 Missing Parameter PayerID Required
186. ed Creating an NVP Request The Name Value Pair request format specifies the API operation to perform credentials that authorize PayPal to access your account and fields containing additional information to be used in the request Related information PayPal API Client Server Architecture Specifying the PayPal API Operation For the NVP version of the PayPal API you must specify the name of the PayPal API operation to execute in each request along with the version of the API operation The following diagram shows the API operation part of an NVP request Your Site NVP Request 1 Chechens METHOD SetExpressCheckout sstacat E gt VERSION XX 0 ES PayPal API credentials API Server Request specific fields Tha sata aama way la aip A method specifies the PayPal operation you want to execute and each method is associated with a version Together the method and version define the exact behavior of the API operation Typically the behavior of an API operation does not change between versions however you should carefully retest your code whenever you change a version To specify a method and version number 1 Choose the PayPal API operation you want to use METHOD operation 2 Choose the appropriate version In most cases you should use the latest version of the API operation VERS ION version_number 18 August 2012 Name Value Pair API Developer Guide PayPal Name Value Pair API Basics Creating
187. ed Character length and limitations 10 single byte alphabetic characters COUNTRYCODE Buyer s country of residence in the form of ISO standard 3166 2 character country codes Character length and limitations 2 single byte characters PAYERBUSINESS Buyer s business name Character length and limitations 127 single byte characters Name Value Pair API Developer Guide August 2012 123 124 GetTransactionDetails API Operation GetTransactionDetails Response Message Payer Name Fields Field Description SALUTATION Buyer s salutation Character length and limitations 20 single byte characters FIRSTNAME Buyer s first name Character length and limitations 25 single byte characters MIDDLENAME Buyer s middle name Character length and limitations 25 single byte characters LASTNAME Buyer s last name Character length and limitations 25 single byte characters SUFFIX Buyer s suffix Character length and limitations 12 single byte characters Address Fields Field Description ADDRESSOWNER eBay company that maintains this address It is one of the following values e eBay e PayPal ADDRESSSTATUS Status of street address on file with PayPal It is one of the following values e none e Confirmed e Unconfirmed SHIPTONAME Person s name associated with this address Character length and limitations 32 single byte characters SHIPTOSTREET First street address Character length and limitations 100 sing
188. ed Details Express CVV2 Code Meaning E Error Unrecognized or Unknown response I Invalid or Null M Match N No match P Not processed S Service not supported U Service not available No response Not applicable Not applicable CVV2CSC None Not applicable Not applicable Not applicable Not applicable CVV2 Response Codes for Maestro CVV2 Code Meaning Matched Details 0 Matched CVV2 1 No match None 2 The merchant has not implemented Not applicable CVV2 code handling 3 Merchant has indicated that CVV2 is Not applicable not present on card 4 Service not available Not applicable All others Error Not applicable Name Value Pair API Developer Guide August 2012 279 PE AVS and CVV2 Response Codes CVV2 Response Codes 280 August 2012 Name Value Pair API Developer Guide About Previous Versions of the API Previous versions of the API can still be used however PayPal recommends using the latest version whenever possible Unless specifically specified API operations default to the latest version What s New in Version 92 0 Updated for 92 0 Added new MsgSubID field for the following APIs for both requests and responsees RefundTransaction DoReferenceTransaction DoAuthorization and DoCapture What s New in Version 89 0 Updated for 89 0 Added new field to SetExpressCheckout and DoReferenceTransaction Request APIs Added new error to DoReferenceTransaction Request API
189. ed by your Payment declined by your Risk Risk Controls settings Controls settings PayPal Risk PayPal Risk Model Model 10725 Shipping Address Country There was an error in the Shipping Error Address Country field 10727 Shipping Addressl Empty The field Shipping Address 1 is required 10728 Shipping Address City The field Shipping Address City is Empty required Name Value Pair API Developer Guide August 2012 217 218 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10729 Shipping Address State The field Shipping Address State is Empty required 10730 Shipping Address Postal The field Shipping Address Postal Code Empty Code is required 10731 Shipping Address Country The field Shipping Address Country Empty is required 10736 Shipping Address Invalid A match of the Shipping Address City State Postal Code City State and Postal Code failed 10800 Invalid Data Your request is too long Check URLs and other long strings 11001 Exceeds maximum length Value of NoteText element is truncated 11001 Exceeds maximum length OtherPaymentMethodID exceeds maximum length 11001 Exceeds maximum length OtherPaymentMethodLabel exceeds maximum length 11001 Exceeds maximum length OtherPaymentMethodLabelDescripti on exceeds maximum length 11001 Exceeds maximum length OtherPaymentMethodLongDescripti on exceeds maximum length 11001 Exceeds maximum length OtherPaymentMet
190. ee https merchant paypal com us cgi bin 8 cmd _render content content ID merchant cc compliance error_codes This field is available since version 84 0 282 August 2012 Name Value Pair API Developer Guide What s New in Version 82 0 al What s New in Version 82 0 New Field in DoCapture Request Field Description MERCHANTSTOREDETAILS Optional Information about the merchant store This field is available since version 82 0 New MerchantStoreDetailsType in DoCapture Request Field Description STOREID ID of the merchant store This field is required for point of sale transactions Character length and limitations 50 single byte characters This field is available since version 84 0 TERMINALID Optional 1D of the terminal Character length and limitations 50 single byte characters This field is available since version 82 0 New Fields in RefundTransaction Request Field Description MERCHANTSTOREDETAILS Optional Information about the merchant store This field is available since version 82 0 RETRYUNTIL Optional Maximum time until you must retry the refund NOTE This field does not apply to point of sale transactions This field is available since version 82 0 Name Value Pair API Developer Guide August 2012 283 i What s New in Version 82 0 Field Description REFUNDSOURCE Optional Type of PayPal funding source balance or eCheck that can be used for auto refu
191. een billing agreements and recurring payments profiles To associate a recurring payments profile with its billing agreement you must ensure that the description in the recurring payments profile matches the description of a billing agreement For version 54 0 and later use SetExpressCheckout to initiate creation of a billing agreement CreateRecurringPaymentsProfile Request Message CreateRecurringPaymentsProfile Request Fields Field Description METHOD Required Must be CreateRecurringPaymentsProfile TOKEN A timestamped token 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 Either this token or a credit card number is required If you include both token and credit card number the token is used and credit card number is ignored Call CreateRecurringPaymentsProfile once for each billing agreement included in SetExpressCheckout request and use the same token for each call Each CreateRecurringPaymentsProfile request creates a single recurring payments profile NOTE Tokens expire after approximately 3 hours Name Value Pair API Developer Guide August 2012 137 ae Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Recurring Payments Profile Details Fields Field Description SUBSCRIBERNAME Optional Full name of the person receiving the product
192. en canceled for example when you win a dispute and the funds for the reversal have been returned to you e Completed The payment has been completed and the funds have been added successfully to your account balance e Denied You denied the payment This happens only if the payment was previously pending because of possible reasons described for the PendingReason element e Expired The authorization period for this payment has been reached e Failed The payment has failed This happens only if the payment was made from your buyer s bank account e In Progress The transaction has not terminated for example an authorization may be awaiting completion e Partially Refunded The payment has been partially refunded e Pending The payment is pending See the PendingReason field for more information e Refunded You refunded the payment e 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 e Processed A payment has been accepted e Voided An authorization for this transaction has been voided Name Value Pair API Developer Guide August 2012 127 a GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description PENDINGREASON The reason the payment is pending It is one of the following values e no
193. ength and limit Up to 13 single byte alphabetic characters IPADDRESS Required IP address of the buyer s browser NOTE PayPal records this IP addresses as a means to detect possible fraud Character length and limitations 15 single byte characters including periods for example 255 255 255 255 RETURNFMFDETAILS Optional Flag to indicate whether you want the results returned by Fraud Management Filters By default you do not receive this information It is one of the following values e 0 Do not receive FMF details default e 1 Receive FMF details Name Value Pair API Developer Guide August 2012 41 42 DoDirectPayment API Operation DoDirectPayment Request Message Credit Card Details Fields Field Description CREDITCARDTYPE ACCT EXPDATE CVV2 STARTDATE ISSUENUMBER Optional Type of credit card For UK only Maestro MasterCard Discover and Visa are allowable For Canada only MasterCard and Visa are allowable and Interac debit cards are not supported It is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set CURRENCYCODE to GBP In addition you must specify either STARTDATE or ISSUENUMBER Character length and limitations Up to 10 single byte alphabetic characters Required Credit card number Character length and limitations Numeric characters only with no spaces or punctutation
194. ent value exceeds maximum allowable length Sale is only allowed PaymentAction Name Value Pair API Developer Guide August 2012 215 216 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10457 Error occurred in eBay API creation error communicating to eBay 10458 Error occurred in eBay API unknown failure communicating to eBay 10459 Error occurred in eBay API failure communicating to eBay 10460 Error occurred in Parsing error communicating to eBay 10461 Error occurred in Item number invalid removed or communicating to eBay unavailable 10462 Error occurred in Order not found communicating to eBay 10463 Error occurred in eBay user password incorrect communicating to eBay 10464 Error occurred in Item ID and Transaction ID communicating to eBay mismatch 10465 Error occurred in eBay user invalid communicating to eBay 10467 Error occurred in Duplicate Item ID communicating to eBay 10468 Transaction refused because Duplicate Order ID of an invalid argument See additional error messages for details 10469 PaymentAction of Order Express Auctions is unavailable Temporarily Unavailable 10470 Wowo flag is off for Solution Type passed as Sole while ExpressO feature ExpressO feature is turned off 10471 Transaction refused because ReturnURL is missing of an invalid argument See additional error messages for details 10472 Transaction refused because CancelURL is missing
195. entially beginning with 0 for example L_NUMBERO L_NUMBER1 Character length and limitations 127 single byte characters L_oTYn Optional Item quantity These parameters must be ordered sequentially beginning with 0 for example L_OTYO L_QTY1 Character length and limitations Any positive integer L_TAXAMTN Optional Item sales tax These parameters must be ordered sequentially beginning with 0 for example L_TAXAMTO L_TAXAMT1 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Ebay Item Payment Details Item Fields Field Description L_EBAYTTEMNUMBERN L_EBAYTTEMAUCTIONTX NIDN Optional Auction item number These parameters must be ordered sequentially beginning with 0 for example L_EBAYITEMNUMBERO L EBAYITEMNUMBER1 Character length 765 single byte characters Optional Auction transaction identification number These parameters must be ordered sequentially beginning with 0 for example L_EBAYITEMAUCTIONTXNIDO L EBAYITEMAUCTIONTXNID1 Character length 255 single byte characters August 2012 Name Value Pair API Developer Guide DoDirectPayment API Operation ES DoDirectPayment Request Message Field Description L EBAYITEMORDERIDn Optional Auction order identification
196. entials gt gt Request specific fields Ad To Cart AAA ar a NVP Response patil Saat PayPal a status scone A siete as Response specific fields rn o os The request identifies e The name of the API operation specified by METHOD name to be performed and its version NOTE After the METHOD parameter you can specify the parameters in any order e Credentials that identify the PayPal account making the request e Request specific information that controls the API operation to be performed A PayPal API server performs the operation and returns a response The response contains e An acknowledgement status that indicates whether the operation was a success or failure and whether any warning messages were returned e Information that can be used by PayPal to track execution of the API operation e Response specific information required to fulfill the request UTF 8 Character Encoding The PayPal API assumes that all data in requests is in Unicode specifically the Unicode or UCS Transformation Format 8 bit encoding form UTF 8 In responses the API always returns data in UTF 8 Multiple API Operations Some of the features such as Express Checkout require you to call multiple API operations Typically these features require you to 16 August 2012 Name Value Pair API Developer Guide PayPal Name Value Pair API Basics NVP Format 1 Invoke an API operation such as SetExpressCheckout that sets up
197. eprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPPINGDISCAMT instead Name Value Pair API Developer Guide August 2012 95 96 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST N INSURAN CEOPTIONOFFERED INSURANCEOPTIONOFFERED deprecated PAYMENTREQUEST_N HANDLIN GAMT HANDLINGAMT deprecated PAYMENTREQUEST_N TAXAMT TAXAMT deprecated PAYMENTREQUEST N DESC DESC deprecated Optional Indicates whether insurance is available as an option the buyer can choose on the PayPal Review page You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Is one of the following values e true The Insurance option displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number e false The Insurance option displays No INSURANCEOPTIONOFFERED is deprecated since version 63 0 Use PAYMENTREQUEST O INSURANCEOPTIONOFFERED instead Optional Total handling costs for this order You can specify up to 10 payments where n is a digit between 0 and 9 inclusive NOTE If you specify a value for PAYMENTREQUEST n HANDLINGAMT you must also specify a value for PAYMENTREQUEST_n ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal
198. equired when you pass a value for ItemCategory These parameters must be ordered sequentially beginning with 0 for example L_NAMEO L_NAME1 Character length and limitations 127 single byte characters L_AMTN Cost of item This field is required when you pass a value for ItemCategory These parameters must be ordered sequentially beginning with 0 for example L_AMTO L_AMT1 NOTE If you specify a value for L_AMTn you must specify a value for ITEMAMT 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 288 August 2012 Name Value Pair API Developer Guide What s New in Version 66 fia Field Description L_QTYnN Item quantity This field is required when you pass a value for ItemCategory These parameters must be ordered sequentially beginning with 0 for example L QTYO L QTY1 Character length and limitations Any positive integer What s New in Version 66 Changes to PaymentDetailsType in SetExpressCheckout and DoExpressCheckoutPayment Requests PaymentDetailsType Fields Field Description PAYMENTREQUEST_n_ITEMAMT Sum of cost of all items in this order For digital goods this field is required ITEMAMT deprecated NOTE PAYMENTREQUEST NM ITEMAMT is required if you specify L PAYMENTREQUE
199. er Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy PROTECTIONELIGIBILI Since version 64 4 the kind of seller protection in force for the transaction It is one TYTYPE of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNotReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is introduced in API version 64 4 STOREID xs string Storeld as entered in the transaction TERMINALID xs string Terminalld as entered in the transaction Name Value Pair API Developer Guide August 2012 183 ee Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation 184 August 2012 Name Value Pair API Developer Guide 1 3 RefundTransaction API Operation The RefundTransaction API operation issues a refund to the PayPal account holder associated with a transaction RefundTransaction Request Message RefundTransaction Request Fields Field Description METHOD Required Must be RefundTransaction TRANSACTIONID Required Unique identifier of the transaction to be refu
200. er length and limitations string SetExpressCheckout API Operation The SetExpressCheckout API operation initiates an Express Checkout transaction SetExpressCheckout Request Message SetExpressCheckout Request Fields Field Description METHOD Required Must be SetExpressCheckout AMT deprecated Required The total cost of the transaction to the buyer If shipping cost and tax charges are known include them in this value If not this value should be the current subtotal of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases If the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment set this field to 0 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma AMT is deprecated since version 63 0 Use PAYMENTREQUEST_0 AMT instead Name Value Pair API Developer Guide August 2012 59 6 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description MAXAMT RETURNURL CANCELURL CALLBACK CALLBACKTIMEOUT REQCONFIRMSHIPPING Optional The expected maximum total amount of the complete order including shipping cost and tax charges
201. erall of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback total of an invalid argument See additional error messages for details positive count August 2012 Name Value Pair API Developer Guide API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10004 Transaction refused because Invalid eBay seller feedback total of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback recent of an invalid argument See positive count additional error messages for details 10004 Transaction refused because Invalid eBay seller feedback recent of an invalid argument See negative count additional error messages for details 10004 Transaction refused because Invalid eBay item transaction date of an invalid argument See additional error messages for details 10004 Transaction refused because Invalid eBay item buyer protection of an invalid argument See type additional error messages for details 10004 Transaction refused because Invalid eBay item payment hold risk of an invalid argument See additional error messages for details 10004 Transaction refused because Multiple eBay order IDs not allowed of an invalid argument See additional error messages for details 10004 Transactio
202. erchant The transaction was declined because of a merchant risk filter for AVS Specifically the merchant has set to decline transaction when the AVS returned a no match AVS N The transaction was declined because of a merchant risk filter for AVS Specifically the merchant has set the filter to decline transactions when the AVS returns a partial match The transaction was declined because of a merchant risk filter for AVS Specifically the merchant has set the filter to decline transactions when the AVS is unsupported Name Value Pair API Developer Guide August 2012 201 202 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10564 Gateway Decline This transaction cannot be There was a problem processing this processed transaction 10565 Merchant country The merchant country is not unsupported supported 10566 Credit card type The credit card type is not unsupported supported 10567 Invalid Data This transaction cannot be processed Please enter a valid credit card number and type 10571 Transaction approved but This transaction was approved If you want to require valid CVV values with invalid Card although the Card Security Code change the risk control settings in your Security Code CSC CSC had too few too many or account profile format invalid characters Based on your account profile settings the invalid CSC was not given to the card
203. erification Number There s an error with this transaction Please enter a valid state in the billing address This transaction cannot be processed This transaction cannot be processed The country listed for your business address is not currently supported Account is locked or inactive The merchant s country is currently not supported The token is missing or is invalid Missing subscription details Missing schedule details Subscription start date should be greater than current date There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message will tells you which field is invalid The merchant s configuration requires a CVV to be entered but no CVV was provided with this transaction Contact PayPal if you wish to change this setting The merchant provided an address either in the United States or Canada but the state provided is not a valid state in either country The transaction was declined by the issuing bank not PayPal The merchant should attempt another card The merchant s country of residence listed in their PayPal account is not currently supported to allow Direct Payment transactions Missing token One or more subscription detail fields are missing from the request One or more schedule detail fields are missing from the request
204. erification Number provided with this transaction Contact PayPal if you wish to change this setting 10750 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error state in the shipping address message tells you which field is invalid 10751 Invalid Data There s an error with this The merchant provided an address either transaction Please enter a valid in the United States or Canada but the state in the billing address state provided is not a valid state in either country 10752 Gateway Decline This transaction cannot be The transaction was declined by the processed issuing bank not PayPal The merchant should attempt another card 10754 Gateway Decline This transaction cannot be The transaction was declined by PayPal processed Contact PayPal for more information 10755 Invalid Data This transaction cannot be The currency code entered by the processed due to an unsupported merchant is not supported currency 10756 Gateway Decline The transaction cannot be None This is a PayPal internal error processed The country and billing address associated with this credit card do not match 10758 Invalid Configuration There s been an error due to The API username or password is invalid API username and or password incorrect for this merchant August 2012 Name Value Pair API Developer Guide API Error Codes DirectPayment API Errors
205. erified e unverified Character length and limitations 10 single byte alphabetic characters COUNTRYCODE Optional Buyer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations 2 single byte characters BUSINESS Optional Buyer s business name Character length and limitations 127 single byte characters Payer Name Fields Field Description SALUTATION Optional Buyer s salutation Character length and limitations 20 single byte characters FIRSTNAME Optional Buyer s first name Character length and limitations 25 single byte characters MIDDLENAME Optional Buyer s middle name Character length and limitations 25 single byte characters LASTNAME Optional Buyer s last name Character length and limitations 25 single byte characters SUFFIX Optional Buyer s suffix Character length and limitations 12 single byte characters Address Fields Field Description STREET Required First street address Character length and limitations 100 single byte characters STREET2 Optional Second street address Character length and limitations 100 single byte characters Name Value Pair API Developer Guide August 2012 143 ae Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description CITY Required Name of city Character length and limitations
206. eriod is finished and continue at the billing frequency for TotalBillingCycles cycles AMT Required Billing amount for each billing cycle during this payment period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TRIALBILLINGPERIOD Unit for billing during this subscription period required if you specify an optional trial period It is one of the following values e Day e Week e SemiMonth e Month e Year For SemiMonth billing is done on the 1st and 15th of each month NOTE The combination of BillingPeriod and BillingFrequency cannot exceed one year Name Value Pair API Developer Guide August 2012 139 ae Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Field Description TRIALBILLINGFREQUEN CY TRIALTOTALBILLINGCY CLES TRIALAMT CURRENCYCODE SHIPPINGAMT TAXAMT Number of billing periods that make up one billing cycle required if you specify an optional trial period The combination of billing frequency and billing period must be less than or equal to one year For example
207. est message 78 GetExpressCheckoutDetails response message 79 GetPalDetails API operation 119 GetPalDetails request message 119 GetPalDetails response message 119 GetRecurringPaymentsProfileDetails API operation 146 August 2012 299 300 Index GetRecurringPaymentsProfileDetails request message 146 GetRecurringPaymentsProfileDetails response message 146 GetTransactionDetails API operation 121 GetTransactionDetails request message 121 GetTransactionDetails response message 121 GIFTMESSAGE request field 93 GIFTMESSAGE response field 80 122 GIFTMESSAGEENABLE request field 64 GIFTRECEIPTENABLE request field 64 93 GIFTRECEIPTENABLE response field 80 122 GIFTWRAPAMOUNT request field 65 93 GIFTWRAPAMOUNT response field 80 122 GIFTWRAPENABLE request field 64 GIFTWRAPNAME request field 64 93 GIFTWRAPNAME response field 80 122 GIROPAYCANCELURL request field 64 GIROPAYSUCCESSURL request field 64 GROSSREFUNDAMT response field 187 H HANDLINGAMT reque st field 174 HANDLINGAMT request field 44 69 96 HANDLINGAMT response field 85 HDRBACKCOLOR request field 63 164 HDRBORDERCOLOR request field 63 164 HDRIMG request field 63 164 HKD 275 Hong Kong Dollar 275 HUF 275 276 Hungarian Forint 275 276 ILS 275 INITAMT request field 141 InstrumentDetails response field 114 INSURANCEAMT request field 44 68 95 INSURANCEAMT response field 84 INSURANCEOPTIONOFFERED request field 68 96 INSURANCEOPTIONOFFERED response field
208. est results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 Merchant Store Details Fields Field Description STOREID Identifier of the merchant store at which the refund is given This field is required for point of sale transactions Character length and limitations 50 single byte characters This field is available since version 82 0 August 2012 Name Value Pair API Developer Guide RefundTransaction API Operation RefundTransaction Response Message Field Description TERMINALID Optional 1D of the terminal Character length and limitations 50 single byte characters This field is available since version 82 0 RefundTransaction Response Message RefundTransaction Response Fields Field Description REFUNDTRANSACTIONID Unique transaction ID of the refund Character length and limitations 17 single byte characters FEEREFUNDAMT Transaction fee refunded to original recipient of payment Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma GROSSREFUNDAMT Amo
209. ettings determine whether this field is required To comply with credit card processing regulations you must not store this value after a transaction has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the value is exactly 4 digits STARTDATE Optional Month and year that Maestro card was issued Character length and limitations Must be 6 digits including leading zero in the format MMYYYY ISSUENUMBER Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum Payer Information Fields Field Description EMAIL Optional Email address of buyer Character length and limitations 127 single byte characters FIRSTNAME Required Buyer s first name Character length and limitations 25 single byte characters LASTNAME Required Buyer s last name Character length and limitations 25 single byte characters Address Fields Field Description STREET Required First street address Character length and limitations 100 single byte characters STREET2 Optional Second street address Character length and limitations 100 single byte characters CITY Required Name of city Character length and limitations 40 single byte characters August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations Bay CreateBillingAgreement API Operation Field Description
210. eveloper Guide August 2012 189 190 TransactionSearch API Operation TransactionSearch Request Message Field Description ACCT AUCTIONITEMNUMBER TRANSACTIONCLASS CURRENCYCODE Optional Search by credit card number as set by you for the original transaction This field searches the records for items the merchant sells The field is not applicable to point of sale NOTE No wildcards are allowed Character length and limitations Must be at least 11 and no more than 25 single byte numeric characters maximum Special punctuation such as dashes or spaces is ignored Optional Search by auction item number of the purchased goods This field is not applicable to point of sale Optional Search by classification of transaction Some kinds of possible classes of transactions are not searchable with this field You cannot search for bank transfer withdrawals for example It is one of the following values 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
211. example L_DESCO is the first line of a description L_DESC1 is the second line and so on NOTE Not all lists follow the L_ prefix convention however all lists start with 0 as the first element Executing NVP API Operations You execute a PayPal NVP API operation by submitting an HTTPS POST request to a PayPal API server or by using cURL or another mechanism to provide secure access between the buyer s browser and the PayPal API server For example you might implement a system in which the buyer s browser remains a client of your server and your server becomes a client of the PayPal API server Specifying a PayPal Server You execute a PayPal API operation by submitting the request to a PayPal API server To execute a PayPal NVP API operation submit the request to one of the following end points Server end point Description https api Sandbox server for use with API signatures use for testing your 3t sandbox paypal com nvp API Name Value Pair API Developer Guide August 2012 21 22 PayPal Name Value Pair API Basics Responding to an NVP Response Server end point Description https api 3t paypal com nvp PayPal live production server for use with API signatures https api sandbox paypal com nvp Sandbox server for use with API certificates use for testing your API https api paypal com nvp PayPal live production server for use with API certificates NOTE You must use differe
212. f an invalid argument See additional error messages for details 10428 Transaction refused because of an invalid argument See additional error messages for details 10429 Transaction refused because of an invalid argument See additional error messages for details 10430 Transaction refused because of an invalid argument See additional error messages for details 10431 Transaction refused because of an invalid argument See additional error messages for details A successful transaction has already been completed for this token PayPal allows a token only once for a successful transaction If you determine that your buyers are clicking your Place Order button twice PayPal recommends that you disable the button after your buyer has clicked it The currencies of the shopping cart amounts must be the same Express Checkout has been disabled for this merchant Please contact Customer Service Item total is invalid Shipping total is invalid Handling total is invalid Tax total is invalid Item amount is missing Item amount is invalid August 2012 Name Value Pair API Developer Guide API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10432 10433 10434 10436 10437 10438 10439 10440 10441 10442 10446 Transaction refused because of an invalid argument See additional error mess
213. fault It is not OK to have no default Internal name of the shipping option such as Air Ground Expedited and so forth This field is required if you specify the Callback URL Character length and limitations 50 character string Amount of the flat rate shipping option This field is required if you specify the Callback URL Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE SetExpressCheckout API Operation Billing Agreement Details Type Fields Field Description L_BILLINGTYPEN Required Type of billing agreement For recurring payments this field must be set to RecurringPayments In this case you can specify up to ten billing agreements Other defined values are not valid Type of billing agreement for reference transactions You must have permission from PayPal to use this field This field must be set to one of the following values e MerchantInitiatedBilling PayPal creates a billing agreement for each transaction associated with buyer You must specify version 54 0 or higher to use this option e Merchant InitiatedBillingSingleAgreement PayPal creates a single billing agreement for all transactions associate
214. fault shipping option e false The buyer did not choose the default shipping option SHIPPINGOPTIONAMOUNT Optional The shipping amount that the buyer chose Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGOPTIONNAME Optional The name of the shipping option such as air or ground Seller Details Type Fields Field Description PAYMENTREQUEST N SELL ERID SELLERID deprecated Optional Unique non changing identifier for the merchant at the marketplace site This ID is not displayed You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 13 single byte alphanumeric characters SELLERID is deprecated since version 63 0 Use PAYMENTREQUEST 0 SELLERID instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST n SELL xs string ERUSERNAME Optional Current name of the merchant or business at the marketplace site This SELLERUSERNAME name may be shown to the buyer You can specify up to 10 payments where n is a deprecated digit between 0 and 9 inclusive SELLERUSERNAME is deprecated since version 63 0 Use PAYMENTREQUEST 0 SE
215. fied 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 NOTE PendingReason is returned in the response only if Payment Status is Pending REASONCODE The reason for a reversal if the transaction type is reversal It is one of the following values e none No reason code e chargeback A reversal has occurred on this transaction due to a chargeback by your buyer e guarantee A reversal has occurred on this transaction due to your buyer triggering a money back guarantee e buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your buyer e refund A reversal has occurred on this transaction because you have given the buyer a refund e other A reversal has occurred on this transaction due to a reason not listed above 182 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation Field Description PROTECTIONELIGIBILI Prior to version 64 4 the kind of seller protection in force for the transaction It is one TY of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payments and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Sell
216. for details 10408 Missing token Token is missing Token is missing 10409 You re not authorized to Express Checkout token was Token belongs to a different access this info issued for a merchant account merchant other than yours 10410 Invalid token Invalid token Token is invalid 10411 This Express Checkout This Express Checkout session has Token expired session has expired expired Token value is no longer valid UpdateBillingAgreement Errors UpdateBillingAgreement Errors Error Code Short Message Long Message Additional Information 10001 Internal Error Internal Error 10004 Transaction refused Invalid argument description field Check the description and because of an invalid or custom field is empty and the custom fields of the billing argument See additional status is active agreement Either the description error messages for details or custom field is empty and the status 1s active or the contents of one of these fields exceeds the maximum field length 10201 Billing Agreement was Billing Agreement was cancelled Billing agreement has been cancelled cancelled 10204 User s account is closed or User s account is closed or restricted restricted 10209 Disabled Preapproved Payments not Merchant pull is not enabled for enabled the country or merchant is not enabled for merchant pull 10209 Disabled Preapproved Payments not Account number mismatch enabled exists for the API caller and the account the billi
217. g values e Sale This is a final sale for which you are requesting payment default e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Order This payment is an order authorization subject to settlement with PayPal Authorization and Capture NOTE You cannot set this field to Sale in SetExpressCheckout request and then change the value to Authorization or Order in the DoExpressCheckout Payment request If you set the field to Authorization or Order in SetExpressCheckout you may set the field to Sale Character length and limitations Up to 13 single byte alphabetic characters PAYMENTACTION is deprecated since version 63 0 Use PAYMENTREQUEST 0 PAYMENTACTION instead PAYMENTREQUEST n PAY A unique identifier of the specific payment request which is required for parallel MENTREQUESTID payments You can specify up to 10 payments where n is a digit between 0 and 9 PAYMENTREQUESTID inclusive deprecated Character length and limitations Up to 127 single byte characters PAYMENTREQUESTID is deprecated since version 63 0 Use PAYMENTREQUEST 0 PAYMENTREQUESTID instead Payment Details Item Type Fields Field Description L_PAYMENTREQUEST_n_NA Item name This field is required when MEM L PAYMENTREQUEST_N ITEMCATEGORYMis passed You can specify up to 10 L NAMEN deprecated payments where n is a digit between 0 and 9 inclusive and m specifies the list item
218. ger L ITEMLENGTHVALUEN and L_ITEMLENGTHUNITM are deprecated since version 63 0 Use L_PAYMENTREQUEST 0 ITEMLENGTHVALUEM and L PAYMENTREQUEST 0 ITEMLENGTHUNITH instead Optional Item width corresponds to the width of the item 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 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 ITEMWIDTHVALUEO L_PAYMENTREQUEST_n_ITEMWIDTHVALUE1 Character length and limitations Any positive integer L_ITEMWIDTHVALUEN and L_ITEMWIDTHUNITM are deprecated since version 63 0 Use L_ PAYMENTREQUEST 0 ITEMWIDTHVALUEm and L_PAYMENTREQUEST QO ITEMWIDTHUNITH instead Name Value Pair API Developer Guide August 2012 73 74 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description L_PAYMENTREQUEST_n_IT EMHETGHTVALUEM L_PAYMENTREQUEST_n_IT EMHEIGHTUNITM L_ITEMHEIGHTVALUEN and L_ITEMHEIGHTUNITnN deprecated L_PAYMENTREQUEST_n_IT EMURLM L_ITEMURLN deprecated L PAYMENTREQUEST_n IT EMCATEGORYM Optional 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 You can specify up to 10 payments where n is a digit between 0 and 9 incl
219. gle byte characters SHI PTOPHONENUM Optional Phone number Character length and limitations 20 single byte characters DoNonReferencedCredit Response Message DoNonReferencedCredit Response Fields Field Description TRANSACTIONID Unique identifier of a transaction Character length and limitations 17 single byte alphanumeric characters CURRENCY CODE Currency code NOTE The only valid currencies are AUD CAD EUR GBP JPY and USD 54 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations Express Checkout API operations include SetExpressCheckout GetExpressCheckoutDetails and DoExpressCheckout Payment Callback API Operation Updates the PayPal Review page with shipping options insurance and tax information Callback API Request Message Callback Request Fields Field Description METHOD Required Must be Callback TOKEN Optional A timestamped token the value of which was returned by SetExpressCheckout response Character length and limitations 20 single byte characters CURRENCYCODE Required The three character currency code for the transaction from the Express Checkout API Default USD Name Value Pair API Developer Guide August 2012 55 6 ExpressCheckout API Operations Callback API Operation Field Description LOCALECODE Optional Locale of pages displayed by PayPal during Express Checkout Character length and limitations Any two ch
220. gth and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPPINGAMT instead PAYMENTREQUEST_n INSURAN Optional Total shipping insurance costs for this order The value must be a CEAMT non negative currency amount or null if insurance options are offered You INSURANCEAMT deprecated can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma INSURANCEAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 INSURANCEAMT instead PAYMENTREQUEST N SHIPDIS Optional Shipping discount for this order specified as a negative number CAMT You can specify up to 10 payments where n is a digit between 0 and 9 SHIPPINGDISCAMT inclusive deprecated Character length and limitations Value is a negative number It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGDISCAMT is d
221. gust 2012 Name Value Pair API Developer Guide ManagePendingTransactionStatus API Operation The ManagePendingTransactionStatus API operation accepts or denys a pending transaction held by Fraud Management Filters ManagePendingTransactionStatus Request Message ManagePendingTransactionStatus Request Fields Field Description METHOD Required Must be ManagePendingTransactionStatus TRANSACTIONID Required The transaction ID of the payment transaction ACTION Required The operation you want to perform on the transaction It is one of the following values e Accept Accepts the payment e Deny Rejects the payment Name Value Pair API Developer Guide August 2012 133 10 ManagePendingTransactionStatus API Operation ManagePending TransactionStatus Response Message ManagePendingTransactionStatus Response Message ManagePendingTransactionStatus Response Fields Field Description TRANSACTIONID The transaction ID of the transaction whose payment has been denied or accepted STATUS Displays in the following message The Status of the transaction after running your action accept deny is TransactionStatus TransactionStatus is one of the following values e Pending Processing Completed Denied Reversed Display Only Partially Refunded Created Refunded 134 August 2012 Name Value Pair API Developer Guide MassPay API Operation The MassPay API operation makes a payment to one
222. haracter codes are also supported for languages in specific countries da_DK Danish for Denmark only he IL Hebrew all id_ID Indonesian for Indonesia only jp_JP Japanese for Japan only no_NO Norwegian for Norway only pt_BR Brazilian Portuguese for Portugal and Brazil only ru RU Russian for Lithuania Latvia and Ukraine only sv_SE Swedish for Sweden only th TH Thai for Thailand only tr_TR Turkish for Turkey only zh_CN Simplified Chinese for China only zh HK Traditional Chinese for Hong Kong only zh_TW Traditional Chinese for Taiwan only Character length and limitations 2 single byte characters August 2012 Name Value Pair API Developer Guide GetTransactionDetails API Operation The Get Transact ionDetails API operation obtains information about a specific transaction GetTransactionDetails Request Message GetTransactionDetails Request Fields Field Description METHOD Must be Get TransactionDetails TRANSACTIONID Required Unique identifier of a transaction NOTE The details for some kinds of transactions cannot be retrieved with GetTransactionDetails You cannot obtain details of bank transfer withdrawals for example Character length and limitations 17 single byte alphanumeric characters GetTransactionDetails Response Message NOTE All fields defined in the formal structure of Get Transact ionDetailsResponse are not necessarily returned Data
223. he Express Checkout Integration Guide Added Fraud Management Filters information Changed recurring payments information Added that ther VERSION parameter must be 50 0 in the API call to use recurring payments e Added billing agreement fields to SetExpressCheckout for recurring payments Updated CreateRecurringPaymentsProfile for new recurring payments features e Added new recurring payments APIs e Added DoNonReferencedCredit API e Update eBay auctions for Express Checkout section e Added fields for the giropay payment method to Express Checkout APIs e Added Direct Payment error 10571 Added recurring payments concepts modified SetExpressCheckout DoExpressCheckout Payment DoReferenceTransaction and added additional DoReferenceTransaction error codes August 2012 Name Value Pair API Developer Guide Date Description April 2007 Added Recurring Payments APIs SetCustomerBillingAgreement GetBillingAgreementCustomerDetails and CreateRecurringPaymentsProfile February 2007 Bug fixes including updating Line Item Details for Direct Payment and Express Checkout APIs changing some parameters to optional in DoDirect Payment adding SHIPTOCOUNTRYCODE and adding Switch Solo codes for AVS and CVV2 December 2006 Updates for bug fixes October 2006 First public release 11 May 2010 Added new NVP API fields to use in version 63 0 Express Checkout integrations Deprecated old fields Updated billing agreement API with
224. he following values e none No pending reason e 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 e authorization The payment is pending because it has been authorized but not settled You must capture the funds first e echeck The payment is pending because it was made by an eCheck that has not yet cleared e 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 e 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 e order The payment is pending because it is part of an order that has been authorized but not settled e paymentreview The payment is pending while it is being reviewed by PayPal for risk e unilateral The payment is pending because it was made to an email address that is not yet registered or confirmed e verify The payment is pending because you are not yet verified You must verify your account before you can accept this payment e other The payment is pending for a rea
225. hese parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_n EBAYITEMAUCTIONTXNIDO L PAYMENTREQUEST Nn EBAYITEMAUCTIONTXNID1 Character length 255 single byte characters L EBAYAUCTIONTXNIDN is deprecated since version 63 0 Use L PAYMENTREQUEST 0 EBAYAUCTIONTXNIDM instead Optional Auction order identification number 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 EBAYITEMORDERIDO L PAYMENTREQUEST Nn EBAYITEMORDERID1 Character length 64 single byte characters L_EBAYITEMORDERIDn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 EBAYITEMORDERIDmM instead 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 inclusive and m specifies the list item within the payment These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST nN EBAYTTEMCARTIDO L PAYMENTREQUEST Nn EBAYITEMCARTID1 Character length 255 single byte characters L_EBAYITEMCARTIDn is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 EBAYITEMCARTIDM instead Buyer Details Fields Field Description BUYERID Optional The unique identifier provided by eBay for this buyer The value may or may no
226. hodLongDescripti onTitle exceeds maximum length 11001 Exceeds maximum length OtherPaymentMethodIcon exceeds maximum length 11068 Seller restriction All sellers restricted 11547 Recurring payments Recurring payments temporarily temporarily unavailable try unavailable again later 11547 Permission denied Permission Denied You are not authorized to do this kind of transaction 11601 Request for billing address Billing address request is not enabled failed for merchant 11602 Request for billing address Feature not yet available failed 11801 Invalid Data You cannot pass both new and deprecated parameter address fields August 2012 Name Value Pair API Developer Guide API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 11802 Invalid Data You cannot pass both the new and deprecated Custom parameter 11803 Invalid Data You cannot pass both the new and deprecated Invoice ID parameter 11804 Invalid Data You cannot pass both the new and deprecated order description 11805 Invalid Data You cannot pass both the new and deprecated order total or amount parameters 11806 Invalid Data You cannot pass both the new and deprecated ProfileAddressChangeDate parameter 11807 Invalid Data You cannot pass both the new and deprecated ShippingMethod parameter 11810 Transaction refused because Invalid Insurance Amount of an invalid argument See additional error messages f
227. horization Request Message DoReauthorization Request Fields Field Description METHOD Required Must be DoReauthorization AUTHORIZATIONID Required Value of a previously authorized transaction identification number returned by PayPal Character length and limitations 19 single byte characters AMT Required Amount to reauthorize Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma CURRENCY CODE Optional 3 character ISO 4217 currency code Default value is USD Character length and limitations 3 single byte characters August 2012 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference baa DoReauthorization API Operation DoReauthorization Response Message DoReauthorization Response Fields Field Description AUTHORIZATIONID New authorization identification number Character length and limits 19 single byte characters Authorization Information Fields Field Description PAYMENTSTATUS Status of the payment It is one of the following values e None No status e Canceled Reversal A reversal has been canceled For example when you win a dispute PayPal returns the funds for the reversal to you Completed The payment has been comple
228. ian Dollar 275 276 Authorization and Capture API Operation Reference 27 Authorization Type response fields 34 37 AUTHORIZATIONID request field 27 36 39 AUTHORIZATIONID response field 29 37 39 AUTHSTATUS3DS request field 47 AUTOBILLAMT request field 138 AUTOBILLOUTAMT request field 157 AUTOBILLOUTAMT response field 147 AVS and CVV2 response codes 277 AVS response codes 277 AVSCODE response field 48 178 B BA Update request fields 168 BA Update response fields 168 BANKTXNPENDINGURL request field 64 BAUpdate API operation 168 BAUpdate request message 168 BAUpdate response message 168 Bill Outstanding Amount request fields 155 Bill Outstanding Amount response fields 155 Billing Period Details request fields 139 158 Billing Period Details response fields 148 BILLINGAGREEMENTID response field 106 162 178 BILLINGAGREEMENTSTATUS request field 168 BILLINGAGREEMENTSTATUS response fie ld 169 BILLINGFREQUENCY request field 139 BILLINGFREQUENCY response field 149 BILLINGPERIOD request field 139 BILLINGPERIOD response field 148 BILLINGTYPE request field 77 165 BillOutstanding API operation 155 BillOutstandingAmount request message 155 BillOutstandingAmount response message 155 BRANDNAME request field 64 Brazilian Real 275 BRL 275 BUSINESS request field 143 BUSINESS response field 81 BUTTONSOURCE request field 45 94 174 Buyer Details request fields 75 BUYEREMAILOPTINENABLE request field 65 August 2012 297
229. ield is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid Name Value Pair API Developer Guide August 2012 205 206 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10744 Invalid Data This transaction cannot be There was a problem with a particular processed Please enter a valid field in the address The long error country code in the billing message tells you which field is invalid address 10745 Invalid Data This transaction cannot be There was a problem with a particular processed Please enter a valid field in the address The long error country code in the shipping message tells you which field is invalid address 10746 Invalid Data This transaction cannot be There was a problem with a particular processed Please use a valid field in the address The long error country on the billing address message tells you which field is invalid 10747 Invalid Data This transaction cannot be The merchant entered an IP address that processed was in an invalid format The IP address must be in a format such as 123 456 123 456 10748 Invalid Data This transaction cannot be The merchant s configuration requires a processed without a Credit Card CVV to be entered but no CVV was V
230. ield to 0 if the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged When the field is set to 0 purchase specific fields are ignored You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma AMT is deprecated since version 63 0 Use PAYMENTREQUEST_0 AMT instead Optional A 3 character currency code default is USD You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only CURRENCYCODE is deprecated since version 63 0 Use PAYMENTREQUEST 0 CURRENCYCODE instead Sum of cost of all items in this order For digital goods this field is required You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only NOTE PAYMENTREQUEST_n_ITEMAMT is required if you specify L_PAYMENTREQUEST_n AMTm Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symb
231. ields are present they should contain null values Cart ID is required for Immediate Payment item Name Value Pair API Developer Guide August 2012 221 222 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 12208 eBay item amount does not eBay item amount must match match Express Checkout Express Checkout API item amount API item amount 13100 Parallel payments Parallel payments functionality is not functionality is not available available 13101 Invalid Data Payment action of Order is only supported for parallel payments 13102 Payment Request ID is Payment Request ID is mandatory missing for parallel payments 13103 Duplicate Payment Request Payment Request ID must be unique ID passed for parallel payments 13104 Transaction refused because Number of payment requests exceeds of an invalid argument See maximum number of supported Additional error messages requests for details 13105 Invalid Data Billing Agreement is not supported for parallel payments 13106 Invalid Data You cannot pass both the new and deprecated PaymentAction parameter 13108 Merchant is not eligible Merchant is not eligible for parallel payments 13110 Multi Payments Sale is Not Due to some technical diffculties the allowed Multi Payments for Sale is not avaliable now please try again later 13111 Mixed Payment action not The Payment Action passed should supported be uniqu
232. illing agreement Character length and limitations 2048 single byte characters Optional URL to which the callback request from PayPal is sent It must start with HTTPS for production integration It can start with HTTPS or HTTP for sandbox testing Character length and limitations 1024 single byte characters This field is available since version 53 0 Optional An override for you to request more or less time to be able to process the callback request and respond The acceptable range for the override is 1 to 6 seconds If you specify a value greater than 6 PayPal uses the default value of 3 seconds Character length and limitations An integer between 1 and 6 Indicates whetheror not you require the buyer s shipping address on file with PayPal be a confirmed address For digital goods this field is required and you must set it to 0 It is one of the following values e 0 You do not require the buyer s shipping address be a confirmed address e 1 You require the buyer s shipping address be a confirmed address NOTE Setting this field overrides the setting you specified in your Merchant Account Profile Character length and limitations single byte numeric character 60 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE SetExpressCheckout API Operation Field Description NOSHIPPING Determines where or not PayPal displays shipping address fields on the PayPal pages
233. illingAgreementDetails Fields Field Description L_BILLINGTYPEn Required Type of billing agreement For recurring payments this field must be set to RecurringPayments In this case you can specify up to ten billing agreements Other defined values are not valid Type of billing agreement for reference transactions You must have permission from PayPal to use this field This field must be set to one of the following values e MerchantInitiatedBilling PayPal creates a billing agreement for each transaction associated with buyer You must specify version 54 0 or higher to use this option e Merchant InitiatedBillingSingleAgreement PayPal creates a single billing agreement for all transactions associated with buyer Use this value unless you need per transaction billing agreements You must specify version 58 0 or higher to use this option 164 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description BILLINGTYPE Type of billing agreement for reference transactions You must have permission from PayPal to use this field For reference transactions this field must be set to one of the following values e MerchantInitiatedBilling PayPal creates a billing agreement for each transaction associated with buyer You must specify version 54 0 or higher to use this option e Merchant InitiatedBillingSingleAgreemen
234. ince version 63 0 Use PAYMENTREQUEST_ 0 TAXAMT instead PAYMENTREQUEST _ DES Optional Description of items the buyer is purchasing You can specify up to 10 C payments where n is a digit between 0 and 9 inclusive except for digital goods DESC deprecated which supports single payments only NOTE The value you specify is available only 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 alphanumeric characters DESC is deprecated since version 63 0 Use PAYMENTREQUEST_0_DESC instead PAYMENTREQUEST n CUS Optional A free form field for your own use You can specify up to 10 payments TOM where n is a digit between 0 and 9 inclusive CUSTOM deprecated NOTE The value you specify is available only 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 256 single byte alphanumeric characters CUSTOM is deprecated since version 63 0 Use PAYMENTREQUEST_0 CUSTOM instead Name Value Pair API Developer Guide August 2012 69 70 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description PAYMENTREQUEST n INV NUM INVNUM deprecated PAYMENTREQUEST n NOT IFYURL NOTIFYURL deprecated PAYMENTREQUEST_n NOT ETEX
235. ing options Invalid shipping options you must specify a name and amount for each shipping option type 11826 Invalid shipping total Invalid shipping total it should equal the shipping amount of the selected shipping option August 2012 Name Value Pair API Developer Guide API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 12125 PP incentive no longer There s a problem with the available redemption code s you entered and can t be used at this time Your payment has not been processed Please go back to PayPal so that the code s can be removed your order total can be updated and then you ll be able to complete checkout 12126 Payment could not be We re having problems processed at this time processing redemption codes at Incentive temporarily this time Your payment has unavailable not been processed You can try to check out again at a later time or complete your payment without the discount applied 12201 Immediate Payment item The item specified is either not Please check that the item is a valid was not found valid or is not currently Immediate Payment item available for purchase as an Immediate Payment item 12203 Payment rolled back Payment was not created because of pending item because it would have been in a pending state which is unacceptable for Immediate Payment items 12204 Transaction reversed Error occurred causing transaction reve
236. ing the API operation SUBJECT merchantEmailAddress NOTE Typically a merchant grants third party permissions to a shopping cart The merchant previously must have given you permission to execute the API operation Specifying Credentials Using cURL The following example shows one way to specify a signature using cURL Name Value Pair API Developer Guide August 2012 19 20 PayPal Name Value Pair API Basics Creating an NVP Request curl insecure https api 3t sandbox paypal com nvp d METHOD name amp VERSION XX 0 amp USER API_usermame amp PWD API_password amp SIGNATURE API_signature amp NOTE This example does not establish a secure connection and should not be used live on paypal com URL Encoding All requests to execute PayPal API operations sent using HTTP must be URL encoded The encoding ensures that you can transmit special characters characters that are not allowed in a URL and characters that have special meaning in a URL such as the equal sign and ampersand The PayPal NVP API uses the HTTP protocol to send requests and receive responses from a PayPal API server You must encode all data sent using the HTTP protocol because data that is not encoded could be misinterpreted as part of the HTTP protocol instead of part of the request Most programming languages provide a way to encode strings in this way You should consistently URL encode the complete API request otherwise you may find that unan
237. ing values deprecated e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Order This payment is an order authorization subject to settlement with PayPal Authorization and Capture e Sale This is a final sale for which you are requesting payment NOTE You cannot set this value to Sale in the SetExpressCheckout request and then change this value to Authorization in the DoExpressCheckout Payment request Character length and limitations Up to 13 single byte alphabetic characters This field is deprecated Use PAYMENTREQUEST Mm PAYMENTACTION instead PAYERID Required Unique PayPal buyer account identification number as returned in the GetExpressCheckoutDetails response Character length and limitations 13 single byte alphanumeric characters RETURNFMFDETAILS Optional Flag to indicate whether you want the results returned by Fraud Management Filters By default you do not receive this information It is one of the following values e 0 Do not receive FMF details default e 1 Receive FMF details GIFTMESSAGE Optional The gift message the buyer entered on the PayPal pages Character length and limitations 150 single byte characters GIFTRECEIPTENABLE Optional Whether the buyer selected a gift receipt on the PayPal pages It is one of the following vaues e true The buyer selected a gift message e false The buyer did not select a gift message GIFTWRAPNAM
238. ingle byte alphanumeric characters AUTOBILLOUTAMT Indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid It is one of the following values e NoAutoBill PayPal does not automatically bill the outstanding balance amount e AddToNextBilling PayPal automatically bills the outstanding balance amount MAXFAILEDPAYMENTS Number of scheduled payments that can fail before the profile is automatically suspended Character length and limitations Number string representing an integer AGGREGATEAMOUNT Total amount collected thus far for scheduled payments Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma AGGREGATEOPTIONALAM Total amount collected thus far for optional payments OUNT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma FINALPAYMENTDUEDATE Final scheduled payment due date before the profile expires
239. instead PAYMENTREQUEST NM CURRE A 3 character currency code Default USD NCYCODE You can specify up to 10 payments where n is a digit between 0 and 9 CURRENCYCODE deprecated inclusive CURRENCYCODE is deprecated since version 63 0 Use PAYMENTREQUEST nN CURRENCYCODE instead PAYMENTREQUEST N ITEMA Sum of cost of all items in this order For digital goods this field is required MT PayPal recommends that you pass the same value in the call to ITEMAMT deprecated DoExpressCheckout Payment that you passed in the call to SetExpressCheckout You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only NOTE PAYMENTREQUEST n_ITEMAMT is required if you specify L PAYMENTREQUEST n_AMTm Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the 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 Name Value Pair API Developer Guide August 2012 83 6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST N SHIPP INGAMT SHIPPINGAMT deprecated PAYMENTREQUEST NM INSUR ANCEAMT INSURANCEAMT deprecated PAYMENTREQUEST N SHIPD ISCAMT SHIPPIN
240. ion Tax Id Details Type Fields Field Description TAXIDTYPE Buyer s tax ID type This field is required for Brazil and used for Brazil only For Brazil use only The tax ID type is BR_CPF for individuals and BR_CNPJ for businesses This field is introduced in API version 72 0 TAXIDDETAILS Buyer s tax ID This field is required for Brazil and used for Brazil only For Brazil use only The tax ID is 11 single byte characters for individuals and 14 single byte characters for businesses This field is introduced in API version 72 0 DoExpressCheckoutPayment API Operation The DoExpressCheckout Payment API operation completes an Express Checkout transaction If you set up a billing agreement in your SetExpressCheckout API call the billing agreement is created when you call the DoExpressCheckout Payment API operation DoExpressCheckoutPayment Request Message DoExpressCheckoutPayment Request Fields Field Description METHOD Required Must be DoExpressCheckout Payment TOKEN Required The timestamped token value that was returned in the SetExpressCheckout response and passed in the GetExpressCheckoutDetails request Character length and limitations 20 single byte characters 92 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE DoExpressCheckoutPayment API Operation Field Description PAYMENTACTION Required How you want to obtain payment It is one of the follow
241. ion exceed user s monthly DoCapture maximum 10600 Authorization Authorization is voided DoAuthorization Close the order or voided DoCapture authorization DoReauthorization DoVoid 10601 Authorization Authorization has DoAuthorization Close the order or expired expired DoCapture authorization DoReauthorization DoVoid 10602 Authorization Authorization has already DoAuthorization Close the order or completed been completed DoCapture authorization DoReauthorization DoVoid 10603 The buyer is The buyer account is DoAuthorization Contact the buyer restricted restricted DoCapture DoReauthorization DoVoid Name Value Pair API Developer Guide August 2012 233 234 API Error Codes Authorization and Capture API Errors Error Short Returned By API Correcting This Code Message Long Message Call Error 10604 Authorization Authorization transaction DoAuthorization Review the order to must include cannot be unilateral It ensure customer and both buyer and must include both buyer seller are both PayPal seller and seller to make an members auth 10605 Unsupported Currency is not DoAuthorization Retry the request with a currency supported DoCapture PayPal supported currency 10606 Buyer cannot Transaction rejected DoAuthorization Contact the buyer pay please contact the buyer DoCapture DoReauthorization 10607 Auth amp Capture Authorization amp Capture DoAuthorization Contact PayPal Customer unavailable
242. ionID for use with the Authorization amp Capture APIs Character length and limitations 19 single byte characters TRANSACTIONID is deprecated since version 63 0 Use PAYMENTINFO_n TRANSACTIONID instead Type of transaction It is one of the following values Type of transaction You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e cart e express checkout Character length and limitations 15 single byte characters TRANSACTIONTYPE is deprecated since version 63 0 Use PAYMENTINFO 0 TRANSACTIONTYPE instead Indicates whether the payment is instant or delayed It is one of the following values You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e none e echeck e instant Character length and limitations 7 single byte characters PAYMENTTYPE is deprecated since version 63 0 Use PAYMENTINFO_ 0 PAYMENTTYPE instead 108 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO N ORDER TIME ORDERTIME deprecated PAYMENTINFO N AMT AMT deprecated PAYMENTINFO N CURRE NCYCODE CURRENCYCODE deprecated PAYMENTINFO n FEEAM T FEEAMT deprecated PAYMENTINFO n SETTL EAMT SETTLEAMT deprecated PAYMENTINFO n TAXAM T TAXAMT deprecated Time date stamp of payment
243. ipping amount of the default shipping option Invalid shipping options Invalid shipping options you must specify a name and amount for each shipping option 11821 Invalid shipping options Invalid shipping options you must specify a name and amount for each shipping option type 11822 Multiple default shipping More than one shipping option type options specified is marked as the default you can only specify one default shipping option at a time 11823 No default shipping option You must specify one shipping specified option type as the default 11824 Invalid callback timeout The callback timeout is zero you must specify a longer timeout value 11825 Flat rate shipping options Flat rate shipping options are are missing missing you must specify flat rate shipping options when you specify a callback URL 11826 Invalid shipping total Invalid shipping total it should equal the shipping amount of the selected shipping option 11827 Line items missing Line items missing line items are required when you specify a callback URL for flat rate shipping options August 2012 Name Value Pair API Developer Guide API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 11828 11829 11830 11831 11832 12109 12124 12200 12201 12202 12205 12207 Maximum amount of order not specified Shipping total is missing Insurance amount is missing Callback URL i
244. ipping option such as air or ground Name Value Pair API Developer Guide August 2012 115 6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Seller Details Type Fields Field Description PAYMENTREQUEST n SELLER Unique identifier for the merchant For parallel payments this field contains PAYPALACCOUNTID either the Payer Id or the email address of the merchant 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 PAYMENTREQUEST_Nn SECURE Unique PayPal customer account number of the merchant This field is MERCHANTACCOUNTID returned in the response It is ignored if passed in the request 116 August 2012 Name Value Pair API Developer Guide GetBalance API Operation The GetBalance API Operation obtains the available balance for a PayPal account GetBalance Request Message GetBalance Request Fields Field Description METHOD Required Must be GetBalance RETURNALLCURRENCIES Optional Indicates whether to return all currencies It is one of the following values e 0 Return only the balance for the primary currency holding e 1 Return the balance for each currency holding NOTE This field is availalble since version 51 Prior versions return only the balance for the primary currency holding GetBalance Response Message GetBalance Response Fields Field Descri
245. ique identifier of the specific payment request The value should match the one you passed in the DoExpressCheckout request You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Up to 127 single byte characters PAYMENTREQUESTID is deprecated since version 63 0 Use PAYMENTINFO 0 PAYMENTREQUESTID instead Name Value Pair API Developer Guide August 2012 113 6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description L PAYMENTINFO_n FMF filterIDm L_FMFfilterIDn deprecated L PAYMENTINFO_n FMF filterNAMEM L_FMFfilterNAMEN deprecated InstrumentDetails OfferDetails Filter ID including the fi ter type PENDING REPORT or DENY the filter ID and the entry number m starting from 0 Filter JD is one of the following values e 1 AVS No Match e 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 where n is a digit between 0 and 9 inclu
246. ir API Developer Guide describes the PayPal Name Value Pair API Intended Audience This guide is written for developers who are implementing solutions using the Name Value Pair API Where to Go for More Information e Express Checkout Integration Guide e Express Checkout Advanced Features Guide e Merchant Setup and Administration Guide Documentation Feedback Help us improve this guide by sending feedback to documentat ionfeedback paypal com Name Value Pair API Developer Guide August 2012 13 al Documentation Feedback 14 August 2012 Name Value Pair API Developer Guide PayPal Name Value Pair API Basics The Name Value Pair NVP API provides parameter based association between request and response fields of a message and their values The request message is sent from your website by the API and a response message is returned by PayPal using a client server model in which your site is a client of the PayPal server NOTE The PayFlow API also uses name value pairs to provide parameter based association between request and response fields of a message and their values however the PayFlow API is not the same as the NVP API for more information about the PayFlow API see Gateway Developer Guide and Reference PayPal API Client Server Architecture The PayPal API uses a client server model in which your website is a client of the PayPal server A page on your website initiates an action o
247. is recurring payment profile When you specify Cont inueOnFailure a success code is returned to you in the CreateRecurringPaymentsProfile response and the recurring payments profile is activated for scheduled billing immediately You should check your IPN messages or PayPal account for updates of the payment status CancelOnFailure If this field is not set or you set it to CancelOnFailure PayPal creates the recurring payment profile but places it into a pending status until the initial payment completes If the initial payment clears PayPal notifies you by IPN that the pending profile has been activated If the payment fails PayPal notifies you by IPN that the pending profile has been canceled Ship To Add ress Fields Field Description SHIPTONAME SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE Person s name associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters First street address It is required if using a shipping address Character length and limitations 100 single byte characters Optional Second street address Character length and limitations 100 single byte characters Name of city It is required if using a shipping address Character length and limitations 40 single byte characters State or province It is required if using a shipping address Character length and limitations 40 single byte ch
248. issuer for its approval process 10701 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error billing address message tells you which field is invalid 10702 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error address in the billing address message tells you which field is invalid 10703 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error address2 in the billing address message tells you which field is invalid 10704 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error city in the billing address message tells you which field is invalid 10705 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error state in the billing address message tells you which field is invalid 10706 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error postal code in the billing address message tells you which field is invalid 10707 Invalid Data There s an error with this There was a problem with a particu
249. itations 2 048 single byte alphanumeric characters RECURRING ns RecurringFlagType Optional Flag to indicate a recurring transaction It is one of the following values e Any value other than Y This is not a recurring transaction default e Y This is a recurring transaction NOTE To pass Y in this field you must have established a billing agreement with the buyer specifying the amount frequency and duration of the recurring payment Name Value Pair API Developer Guide August 2012 45 46 DoDirectPayment API Operation DoDirectPayment Request Message Payment Details Item Fields Field Description L NAMEN Optional Item name These parameters must be ordered sequentially beginning with 0 for example L_NAMEO L_NAME1 Character length and limitations 127 single byte characters L_DESCn Optional Item description Character length and limitations 127 single byte characters L_AMTn Optional Cost of item These parameters must be ordered sequentially beginning with 0 for example L_AMTO L_AMT1 NOTE If you specify a value for L_AMTn you must specify a value for ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma L_NUMBERN Optional Item number These parameters must be ordered sequ
250. ity in the billing address There s an error with this transaction Please enter your state in the billing address There s an error with this transaction Please enter your five digit postal code in the billing address There s an error with this transaction Please enter a country in the billing address There s an error with this transaction Please enter a country in the billing address There s an error with this transaction Please enter a valid billing address There s an error with this transaction Please enter a valid state in the billing address There s an error with this transaction Please enter your five digit postal code in the billing address field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error message tells you which field is invalid There was a problem with a particular field in the address The long error
251. k API This field is required when implementing the Instant Update Callback API It must be set to 61 0 or a later version This field is available since version 61 0 Name Value Pair API Developer Guide August 2012 61 62 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description LOCALECODE PAGESTYLE Optional Locale of pages displayed by PayPal during Express Checkout It is one of the following country code values supported by PayPal default is US e AU Australia AT Austria BE Belgium BR Brazil CA Canada CH Switzerland CN China DE Germany ES Spain GB United Kingdom FR France IT Italy NL Netherlands PL Poland PT Portugal RU Russia US United States The following 5 character codes are also supported for languages in specific countries da_DK Danish for Denmark only he IL Hebrew all id_ID Indonesian for Indonesia only jp _JP Japanese for Japan only no_NO Norwegian for Norway only pt_BR Brazilian Portuguese for Portugal and Brazil only ru RU Russian for Lithuania Latvia and Ukraine only sv_SE Swedish for Sweden only th_TH Thai for Thailand only tr_TR Turkish for Turkey only zh CN Simplified Chinese for China only zh HK Traditional Chinese for Hong Kong only zh_TW Traditional Chinese for Taiwan only Character length and limitations 2 character
252. l PayPal does not automatically bill the outstanding balance e AddToNextBilling PayPal automatically bills the outstanding balance 138 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Billing Period Details Fields Field Description BILLINGPERIOD Required Unit for billing during this subscription period It is one of the following values e Day e Week e SemiMonth e Month e Year For SemiMonth billing is done on the 1st and 15th of each month NOTE The combination of BillingPeriod and BillingFrequency cannot exceed one year BILLINGFREQUENCY Required Number of billing periods that make up one billing cycle The combination of billing frequency and billing period must be less than or equal to one year For example if the billing cycle is Month the maximum value for billing frequency is 12 Similarly if the billing cycle is Week the maximum value for billing frequency is 52 NOTE If the billing period is SemiMonth the billing frequency must be 1 TOTALBILLINGCYCLES Optional Number of billing cycles for payment period e For the regular payment period if no value is specified or the value is 0 the regular payment period continues until the profile is canceled or deactivated e For the regular payment period if the value is greater than 0 the regular payment period will expire after the trial p
253. l Buyer s middle name Character length and limitations 25 single byte characters LASTNAME Optional Buyer s last name Character length and limitations 25 single byte characters SUFFIX Optional Buyer s suffix Character length and limitations 12 single byte characters Payer Information Fields Field Description EMAIL Optional Email address of buyer Character length and limitations 127 single byte characters FIRSTNAME Required Buyer s first name Character length and limitations 25 single byte characters LASTNAME Required Buyer s last name Character length and limitations 25 single byte characters Address Fields Field Description STREET Required First street address Character length and limitations 100 single byte characters STREET2 Optional Second street address Character length and limitations 100 single byte characters CITY Required Name of city Character length and limitations 40 single byte characters STATE Required State or province Character length and limitations 40 single byte characters Name Value Pair API Developer Guide August 2012 53 a DoNonReferencedCredit API Operation DoNonReferencedCredit Response Message Field Description COUNTRYCODE Required Country code Character length and limitationst 2 single byte characters ZIP Required U S ZIP code or other country specific postal code Character length and limitations 20 sin
254. lar transaction Please enter a valid country in the billing address field in the address The long error message tells you which field is invalid August 2012 Name Value Pair API Developer Guide API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10708 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a field in the address The long error complete billing address message tells you which field is invalid 10709 Invalid Data There s an error with this There was a problem with a particular transaction Please enter an field in the address The long error address1l in the billing address message tells you which field is invalid 10709 Invalid Data There s an error with this There was a problem with a particular transaction Please enter an field in the address The long error address1 in the billing address message tells you which field is invalid 10710 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a city in field in the address The long error the billing address message tells you which field is invalid 10710 Invalid Data There s an error with this There was a problem with a particular 10711 Invalid Data 10712 Invalid Data 10713 Invalid Data 10713 Invalid Data 10714 Invalid Data 10715 Invalid Data 10716 Invalid Data transaction Please enter a c
255. ld display insurance in a drop down N list on the Review page When the value is true PayPal displays the drop down L SHIPPINGOPTIONNAM En L SHIPPINGOPTIONLAB ELN L SHIPPINGOPTIONAMO UNTN L_SHIPPINGOPTIONISD EFAULT L_TAXAMTN with the associated amount and the string Yes Required Is the internal system name of a shipping option such as Air Ground or Expedited These parameters must be ordered sequentially beginning with 0 for example L SHIPPINGOPTIONNAMEO L SHIPPINGOPTIONNAME1 Character length and limitations 50 characters Required The label for the shipping option as displayed to the buyer Examples Air Next Day Expedited 3 5 days Ground 5 7 days These labels can be localized based on the buyer s locale which is a part of the callback request These parameters must be ordered sequentially beginning with 0 for example L SHIPPINGALABELO L _SHIPPINGLABEL1 Character length and limitations 50 characters Required Is the amount for this shipping option These parameters must be ordered sequentially beginning with 0 for example L SHIPPINGAMOUNTO L_SHIPPINGAMOUNT1 NOTE 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 Required The option that is selected by default
256. le byte characters SHIPTOSTREET2 Second street address Character length and limitations 100 single byte characters SHIPTOCITY Name of city Character length and limitations 40 single byte characters SHIPTOSTATE State or province Required for U S addresses only Character length and limitations 40 single byte characters SHIPTOZIP U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters August 2012 Name Value Pair API Developer Guide GetTransactionDetails API Operation em GetTransactionDetails Response Message Field Description SHIPTOCOUNTRYCODE Country code Character length and limitations 2 single byte characters SHIPTOPHONENUM Phone number Character length and limitations 20 single byte characters Payment Information Fields Field Description TRANSACTIONID Unique transaction ID of the payment Character length and limitations 17 single byte characters PARENTTRANSACTIONID Parent or related transaction identification number This value in this field is for the following transaction types e Reversal Capture of an authorized transaction e Reversal Reauthorization of a transaction e Capture of an order The value of ParentTransactionID is the original OrderID e Authorization of an order The value of ParentTransactionID is the original OrderID e Capture of an order authorization e Void of an order The value of ParentTrans
257. len lt Descriptor set in Payment Receiving Preferences gt 1 For example assume the following conditions e The PayPal prefix toggle is set to PAYPAL in PayPal s administration tools e The merchant descriptor set in the Payment Receiving Preferences is set to EBAY e The soft descriptor is passed in as JanesFlowerGifts LLC The resulting descriptor string on the credit card is PAYPAL EBAY JanesFlow Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 August 2012 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference baa DoCapture API Operation Merchant Store Details Fields Field Description STOREID Identifier of the merchant store at which the refund is given This field is required for point of sale transactions Character length and limitations 50 single byte characters This field is available since version 82 0 TERMINALID Optional 1D of the terminal Character length and limitations 50 single byte characters This field is available since version 82 0 DoCapture Response Message NOTE If you use version 56 0 or later of the
258. lete successfully Instruct the customer to use an alternative payment method The currencies of the shopping cart amounts must be the same PaymentAction tag is missing TotalOrder amount is missing TotalOrder amount is invalid Merchant is not eligible for auth settlement Merchant account number is invalid Payment already made for the invoice Total of cart items does not match order total Amount exceeds the max amount for a single txn Account not associated with a usable funding source Credit card or Billing Agreement is required to complete payment Currencies in the shopping cart must be the same PaymentAction tag is missing Name Value Pair API Developer Guide August 2012 257 258 API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10426 Transaction refused Item total is invalid ItemTotal amount is invalid because of an invalid argument See additional error messages for details 10427 Transaction refused Shipping total is invalid ShippingTotal amount is invalid because of an invalid argument See additional error messages for details 10428 Transaction refused Handling total is invalid HandlingTotal amount is invalid because of an invalid argument See additional error messages for details 10429 Transaction refused Tax total is invalid TaxTotal amount is invalid because of an invalid argument See a
259. lid because of an invalid URL argument See additional error messages for details 10472 Transaction refused CancelURL is invalid CancelURL tag contains invalid because of an invalid URL argument See additional error messages for details 10476 Transaction refused because of an invalid argument See additional error messages for details 10477 Transaction refused because of an invalid argument See additional error messages for details 10485 Payment not authorized Payment has not been authorized by the user 11452 Merchant not enabled for Merchant not enabled forreference This merchant is not enabled for reference transactions transactions Mark reference transaction Warning only August 2012 Name Value Pair API Developer Guide GetBillingAgreementCustomerDetails Errors API Error Codes Error Code Short Message Long Message Additional Information 11453 Reference transactions Reference transaction feature not Feature not enabled because temporarily unavailable currently available try again later system is running in standin mode Warning only 11601 Request for billing address Billing address request is not failed enabled for merchant 11602 Request for billing address Feature not yet available failed GetBillingAgreementCustomerDetails Errors GetBillingAgreementCustomerDetails Errors Error Code Short Message Long Message Additional Information 10408 Missing token Token is missing Toke
260. limitations 16 single byte characters maximum Whitespace and case of input value are ignored Name Value Pair API Developer Guide August 2012 25 a AddressVerify API Operation AddressVerify Response Message AddressVerify Response Message Address Verify Response Fields Field Description CONFIRMATIONCODE STREETMATCH ZIPMATCH COUNTRYCODE TOKEN Indicates whether the address is a confirmed address on file at PayPal It is one of the following values e None The request value of the Email element does not match any email address on file at PayPal e Confirmed If the response value of the StreetMatch element is Matched the entire postal address is confirmed e Unconfirmed PayPal responds that the postal address is unconfirmed NOTE The values Confirmed and Unconfirmed both indicate that the member email address passed verification Indicates whether the street address matches address information on file at PayPal It is one of the following values e None The request value of the Email element does not match any email address on file at PayPal No comparison of other request values was made Matched The request value of the Street element matches the first 3 single byte characters of a postal address on file for the PayPal member Unmatched The request value of the Street element does not match any postal address on file for the PayPal member Indicates whether the zip address matches addre
261. list HEIGHTUNITM item within the payment These parameters must be ordered sequentially L ITEMHEIGHTVALUEN and beginning with 0 for example L_PAYMENTREQUEST_n_ITEMHEIGHTVALUEO L 1 TEMHEIGCHTUNITN L PAYMENTREQUEST N ITEMHEIGHTVALUE1 deprecated Character length and limitations Any positive integer L_ITEMHEIGHTVALUEN and L_ITEMHEIGHTUNITN are deprecated in version 63 0 Use L_PAYMENTREQUEST _N ITEMHEIGHTVALUEM and L_ITEMHEIGHTUNITM instead L PAYMENTREQUEST nm ITEM Indicates whether the item is digital or physical For digital goods CATEGORYM L_PAYMENTREQUEST_n_ITEMCATEGORYM Digital this field is required 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 ITEMCATEGORYO L PAYMENTREQUEST Nn ITEMCATEGORY1 It is one of the following values e Digital e Physical This field is available since version 65 1 EbayltemPaymentDetailsltemType Fields Field Description L PAYMENTREQUEST nN EB Auction item number You can specify up to 10 payments where n is a digit AYITEMNUMBERM between 0 and 9 inclusive and m specifies the list item within the payment EBAY ITEMNUMBERN Character length 765 single byte characters deprecated EBAYITEMNUMBERN is deprecated since 63 0 Use L PAYMENTREQUEST 0 EBAYAUCTIONTXNIDM instead Name Value Pair API Developer Gui
262. lo and length required by each credit card type Credit card expiration date This field is required if you are using recurring payments with direct payments Character length and limitations 6 single byte alphanumeric characters including leading zero in the format MMYYYY Card Verification Value version 2 Your Merchant Account settings determine whether this field is required To comply with credit card processing regulations you must not store this value after a transaction has been completed Character length and limitations For Visa MasterCard and Discover the value is exactly 3 digits For American Express the value is exactly 4 digits Optional Month and year that Maestro card was issued Character length and limitations Must be 6 digits including leading zero in the format MMYYYY Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Payer Information Fields Field Description EMAIL Required Email address of buyer Character length and limitations 127 single byte characters PAYERID Optional Unique PayPal Customer Account identification number Character length and limitations 13 single byte alphanumeric characters PAYERSTATUS Optional Status of buyer It is one of the following values e v
263. lue is exactly 4 digits STARTDATE Optional Month and year that Maestro card was issued Character length and limitations Must be 6 digits including leading zero in the format MMYYYY ISSUENUMBER Optional Issue number of Maestro card Character length and limitations 2 numeric digits maximum Payer Information Fields Field Description EMATL Optional Email address of buyer Character length and limitations 127 single byte characters FIRSTNAME Required Buyer s first name Character length and limitations 25 single byte characters Name Value Pair API Developer Guide August 2012 177 ae Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description LASTNAME Required Buyer s last name Character length and limitations 25 single byte characters Address Fields Field Description STREET Optional First street address Character length and limitations 100 single byte characters STREET2 Optional Second street address Character length and limitations 100 single byte characters CITY Optional Name of city Character length and limitations 40 single byte characters STATE Optional State or province Character length and limitations 40 single byte characters COUNTRY CODE Optional Country code Character limit 2 single byte characters ZIP Optional U S ZIP code or other country specific postal code Character length and
264. me 10527 Invalid Data This transaction cannot be The credit card entered is invalid processed Please enter a valid credit card number and type 10534 Gateway Decline This transaction cannot be The credit card entered is currently processed Please enter a valid credit card number and type restricted by PayPal Contact PayPal for more information Name Value Pair API Developer Guide August 2012 199 200 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10535 Gateway Decline This transaction cannot be The credit card entered is invalid processed Please enter a valid credit card number and type 10536 Invalid Data This transaction cannot be The merchant entered an invoice ID that processed is already associated with a transaction by the same merchant By default the invoice ID must be unique for all transactions To change this setting log into PayPal or contact customer service 10537 Filter Decline This transaction cannot be The transaction was declined by the processed country filter managed by the merchant To accept this transaction change your risk settings on PayPal 10538 Filter Decline This transaction cannot be The transaction was declined by the processed maximum amount filter managed by the merchant To accept this transaction change your risk settings on PayPal 10539 Filter Decline This transaction cannot be The transaction was declined
265. ment is being held You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e newsellerpaymenthold This is a new merchant e paymenthold A hold is placed on the merchant s transaction for a reason not listed This field is available since version 71 0 and is returned only if Payment Status is Completed Funds Held This field is available since version 71 0 and is returned only if PAYMENTINFO_n PAYMENTSTATUS is Completed Funds Held Prior to version 64 4 the kind of seller protection in force for the transaction It is one of the following values Prior to version 64 4 the kind of seller protection in force for the transaction You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payments and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy PROTECTIONELIGIBILITY is deprecated since version 63 0 Use PAYMENTINFO 0 PROTECTIONELIGIBILITY instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO n PROTE CTIONELIGIBILITYTYP E STOREID TERMINALID PAYMENT
266. minated e g an authorization may be awaiting completion e Partially Refunded The payment has been partially refunded e Pending The payment is pending See the PendingReason field for more information e 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 e Processed A payment has been accepted e Voided An authorization for this transaction has been voided e Completed Funds Held The payment has been completed and the funds have been added successfully to your pending balance See the PAYMENTINFO_n HOLDDECISION field for more information See the HoldDeci sion field for more information PAYMENTSTATUS is deprecated since version 63 0 Use PAYMENTINFO 0 PAYMENTSTATUS instead 110 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO N PENDI Reason the payment is pending It is one of the following values NGREASON Reason the payment is pending You can specify up to 10 payments where n is a digit PENDINGREASON between 0 and 9 inclusive It is one of the following values deprecated e none No pending reason address The payment is pending because your buyer did not include
267. mp TIMESTAMP date timeOfResponse amp Multiple errors can be Error CORRELATIONID debuggingToken amp VERSION VersionNo amp returned Each set of BUILD buildNumber amp L_ERRORCODE0 errorCode amp errors has a different numeric suffix starting with 0 and incremented by one for each error L_SHORTMESSAGE0 shortMessage amp lL LONGMESSAGE0 ongMessage amp L_SEVERITYCODE0 severityCode Additional pass through information may appear in the L ERRORPARAMIDn and L_ ERRORPARAMVALUEDn fields Consider the following error response TIMESTAMP 2011 2d11 2d15T20 3a27 3a02Z amp CORRELATIONID 5be53331d9700 amp ACK Fail ure amp VERSION 78 2e0 amp BUILD 000000 amp L_ ERRORCODEO 15005 L SHORTMESSAGE0O Processo r 20Decline amp L_ LONGMESSAGEO This 20transaction 20cannot 20be 20processed 2e amp L SEVERITYCODEO ErrorsL ERRORPARAMIDO ProcessorResponsesL ERRORPARAMVALUEO 0051SAMT 10 2e4 0 CURRENCYCODE USD amp AVSCODE X amp CVV2MATCH M Name Value Pair API Developer Guide August 2012 23 a PayPal Name Value Pair API Basics Responding to an NVP Response In this case the parameter ID is ProcessorResponse which indicates an error response by a credit or debit card processor The value contains the processor specific error These values are not set by PayPal rather they are passed through from the source NOTE PayPal only passes selected values in the L_ERRORPARAMIDn and L_ERRORPARAMVALUEn fields URL Decoding All responses to HTTP POST operation
268. n 0 the regular payment period will expire after the trial period is finished and continue at the billing frequency for RegularTotalBillingCycles cycles This field is available since version 53 0 Name Value Pair API Developer Guide August 2012 149 ae Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Field Description REGULARAMT SHIPPINGAMT REGULARSHIPPINGAMT TAXAMT Billing amount for each billing cycle during this payment period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Billing amount for each billing cycle during this regular payment period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is
269. n Authoriza tion Failed Username Password is incorrect 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 API access is disabled for this account This error can be caused by an incorrect API username an incorrect API password or an invalid API signature Make sure that all three of these values are correct For your security PayPal does not report exactly which of these three values might be in error Your PayPal merchant account has been restricted Contact your PayPal account manager for resolution Name Value Pair API Developer Guide August 2012 193 194 API Error Codes Validation Errors Error Code Short Message Long Message Correcting This Error 10002 Authentication Authoriza tion Failed 10006 Version error 10008 Security error 10101 This API Temporarily Unavailable Client certificate is disabled Version is not supported Security header is not valid This API is temporarily unavailable Please try later Validation Errors Validation Errors Error Code Short Message Long Message 81000 Missing Parameter Required Parameter Missing Unable to identify parameter 81001 Invalid Parameter A Parameter is Invalid Unable to identify parameter 81002 Unspecified Method Method Sp
270. n a PayPal API server by sending a request to the server The PayPal server responds with a confirmation that the requested action was taken or indicates that an error occurred The response might also contain additional information related to the request The following diagram shows the basic request response mechanism Your Site 7 Request T a PayPal Add To Cart i Response API Server For example you might want to obtain the buyer s shipping address from PayPal You can initiate a request specifying an API operation to obtain buyer details The response from the PayPal API server contains information about whether the request was successful If the operation succeeds the response contains the requested information In this case the response contains the buyer s shipping address If the operation fails the response contains one or more error messages Related information Creating an NVP Request Responding to an NVP Response Name Value Pair API Developer Guide August 2012 15 EN PayPal Name Value Pair API Basics PayPal API Client Server Architecture PayPal Name Value Pair API Requests and Responses To perform a PayPal NVP API operation you send an NVP formatted request to a PayPal NVP server and interpret the response In the following diagram your website generates a request The request is executed on a PayPal server and the response is returned to your site Your Site pave Request API operation m m ep i API cred
271. n authorized transaction e Reversal Reauthorization of a transaction e Capture of an order The value of ParentTransactionID is the original OrderID e Authorization of an order The value of ParentTransactionID is the original OrderID e Capture of an order authorization e Void of an order The value of ParentTransactionID is the original OrderID Character length and limitations 16 digits Only authorization of an order and capture of an order authorization apply to point of sale transactions RECEIPTID Receipt identification number Character length and limitations 16 digits Empty for point of sale transactions TRANSACTIONTYPE The type of transaction It is one of the following values e cart e express checkout Character length and limitations 15 single byte characters PAYMENTTYPE Indicates whether the payment is instant or delayed It is one of the following values e none e echeck e instant Character length and limitations 7 single byte characters ORDERTIME Time date stamp of payment For example 2006 08 15T17 23 15Z AMT The final amount charged including any shipping and taxes from your Merchant Profile Shipping and taxes do not apply to point of sale transactions Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separa
272. n is a digit between 0 and 9 inclusive CURRENCYCODE is deprecated since version 63 0 Use PAYMENTREQUEST 0 CURRENCYCODE instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST nN ITEMAMT Sum of cost of all items in this order For digital goods this field is required ITEMAMT deprecated PayPal recommends that you pass the same value in the call to DoExpressCheckout Payment that you passed in the call to SetExpressCheckout You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only NOTE PAYMENTREQUEST_n_ITEMAMT is required if you specify L_PAYMENTREQUEST_n AMTm Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the 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 SHIPPIN Optional Total shipping costs for this order You can specify up to 10 GAMT payments where n is a digit between 0 and 9 inclusive SHIPPINGAMT deprecated NOTE If you specify a value for PAYMENTREQUEST n SHIPPINGAMT you must also specify a value for PAYMENTREQUEST_n ITEMAMT Character len
273. n is missing 10409 You re not authorized to Express Checkout token was Token belongs to a different access this info issued for a merchant account merchant other than yours 10410 Invalid token Invalid token Token is invalid 10411 This Express Checkout This Express Checkout sessionhas Token expired session has expired expired Token value is no longer valid CreateBillingAgreement CreateBillingAgreement Errors Errors Error Code Short Message Long Message Additional Information 10408 Missing token Token is missing Token is missing 10409 You re not authorized to Express Checkout token was Token belongs to a different access this info issued for a merchant account merchant other than yours 10410 Invalid token Invalid token Token is invalid 10411 This Express Checkout This Express Checkout sessionhas Token expired session has expired expired Token value is no longer valid Name Value Pair API Developer Guide August 2012 253 254 API Error Codes UpdateBillingAgreement Errors Error Code Short Message Long Message Additional Information 11455 Buyer did not accept billing Buyer did not accept billing Buyer has not agreed to the agreement agreement billing agreement 11456 A successful Billing Transaction refused because of an Token has already been used to Agreement has already invalid argument See additional create a billing agreement been created for this token error messages
274. n refused because AllowPushFunding value specified is of an invalid argument See invalid It must be 0 or 1 or an empty additional error messages for string details 10005 Option not supported Merchant not enabled to use enhanced checkout data 10005 Option not supported Merchant not enabled to use OtherPaymentMethodDetails 10005 Option not supported Transaction ID is not supported 10007 Permission denied You do not have permission to make this API call Name Value Pair API Developer Guide August 2012 211 212 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10010 Invalid Invoice Non ASCII invoice id is not supported 10101 Option not supported Express Checkout temporarily unavailable Please try later 10102 PaymentAction of Order PaymentAction of Order is Temporarily Unavailable temporarily unavailable Please try later or use other PaymentAction 10103 Please use another Solution Your Solution Type is temporarily Type unavailable If possible please use another Solution Type 10400 Transaction refused because OrderTotal is missing of an invalid argument See additional error messages for details 10401 Transaction refused because Order total is invalid of an invalid argument See additional error messages for details 10402 Authorization only is not This merchant account is not allowed for merchant permitted to set PaymentAction to Authorization Plea
275. nclusive Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGDISCAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPPINGDISCAMT instead Optional Indicates whether insurance is available as an option the buyer can choose on the PayPal pages You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Is one of the following values e true The Insurance option displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number e false The Insurance option displays No INSURANCEOPTIONOFFERED is deprecated since version 63 0 Use PAYMENTREQUEST O INSURANCEOPTIONOFFERED instead 84 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations cae GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST nN HANDL Optional Total handling costs for this order You can specify up to 10 INGAMT payments where n is a digit between 0 and 9 inclusive HANDLINGAMT deprecated _ wore If you specify a value for PAYMENTREQUEST n HANDLINGAMT you must also specify a value for PAYMENTREQUEST_n ITEMAMT Character length and limitations Value is a positive number
276. nd It is one of the following values e any The merchant does not have a preference Use any available funding source e default Use the merchant s preferred funding source as configured in the merchant s profile e instant Use the merchant s balance as the funding source e eCheck The merchant prefers using the eCheck funding source If the merchant s PayPal balance can cover the refund amount use the PayPal balance NOTE This field does not apply to point of sale transactions This field is available since version 82 0 REFUNDTYPE Type of refund you are making It is one of the following values e Full Full refund default Partial Partial refund Oo e ExternalDispute External dispute Value available since version 82 0 e Other Other type of refund Value available since version 82 0 New MerchantStoreDetailsType in RefundTransaction Request Field Description STOREID ID of the merchant store This field is required for point of sale transactions Character length and limitations 50 single byte characters This field is available since version 84 0 TERMINALID Optional 1D of the terminal Character length and limitations 50 single byte characters This field is available since version 82 0 284 August 2012 Name Value Pair API Developer Guide What s New in Version 80 0 BEN What s New in Version 80 0 New Fields in PaymentDetailsType in DoReferenceTransaction Request
277. nd limitations 40 single byte characters SHIPTOZIP U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHI PTOCOUNTRYCODE Country code Character length and limitations 2 single byte characters Billing Period Details Fields Field Description BILLINGPERIOD Unit for billing during this subscription period It is one of the following values Day Week SemiMonth Month Year For SemiMonth billing is done on the Ist and 15th of each month NOTE The combination of BillingPeriod and BillingFrequency cannot exceed one year 148 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations e GetRecurringPaymentsProfileDetails API Operation Field Description REGULARBILLINGPERIO Unit for billing during this regular subscription period It is one of the following D values e Day e Week e SemiMonth e Month e Year For SemiMonth billing is done on the 1st and 15th of each month NOTE The combination of RegularBillingPeriod and RegularBillingFrequency cannot exceed one year This field is available since version 53 0 BILLINGFREQUENCY Number of billing periods that make up one billing cycle The combination of billing frequency and billing period must be less than or equal to one year For example if the billing cycle is Month the maximum value for billing frequency is 12 Similarly if the billing cycle is Week
278. nded Character length and limitations 17 single byte alphanumeric characters INVOICEID Optional Your own invoice or tracking number Character length and limitations 127 single byte alphanumeric characters REFUNDTYPE Type of refund you are making It is one of the following values e Full Full refund default e Partial Partial refund e ExternalDispute External dispute Value available since version 82 0 e Other Other type of refund Value available since version 82 0 AMT Optional Refund amount The amount is required if RefundType is Partial NOTE If RefundType is Full do not set the amount Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma CURRENCYCODE ISO 4217 3 letter currency code USD for US Dollars This field is required for partial refunds and is also required for refunds greater than 100 Character length and limitations 3 single byte characters NOTE Optional Custom memo about the refund Character length and limitations 255 single byte alphanumeric characters Name Value Pair API Developer Guide August 2012 185 186 RefundTransaction API Operation RefundTransaction Request Message Field Description RETRYUNTIL REFUNDSOURCE MERCHANTSTOREDETAIL S
279. ne No pending reason address The payment is pending because your buyer 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 int1 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 i
280. nformation contact PayPal Customer Service NOTE PendingReason is returned in the response only if Payment Status is Pending REASONCODE The reason for a reversal if the transaction type is reversal It is one of the following values none No reason code chargeback A reversal has occurred on this transaction due to a chargeback by your buyer guarantee A reversal has occurred on this transaction due to your buyer triggering a money back guarantee buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your buyer refund A reversal has occurred on this transaction because you have given the buyer a refund other A reversal has occurred on this transaction due to a reason not listed above 128 August 2012 Name Value Pair API Developer Guide GetTransactionDetails API Operation em GetTransactionDetails Response Message Field Description PROTECTIONELIGIBILI Prior to version 64 4 the kind of seller protection in force for the transaction It is one TY of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payments and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy PROTECTIONELIGIBILI Since version 64 4 the kind of seller protec
281. ng 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 e authorization The payment is pending because it has been authorized but not settled You must capture the funds first e echeck The payment is pending because it was made by an eCheck that has not yet cleared e 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 e 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 e order The payment is pending because it is part of an order that has been authorized but not settled e paymentreview The payment is pending while it is being reviewed by PayPal for risk e unilateral The payment is pending because it was made to an email address that is not yet registered or confirmed e verify The payment is pending because you are not yet verified You must verify your account before you can accept this payment e other The payment is pending for a reason other than those listed above For more information contact PayPal Customer Service NOTE PendingReason is returned in the response only if Payment Status is Pending PRO
282. ng agreement belongs to August 2012 Name Value Pair API Developer Guide API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10211 11451 11451 11452 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 Invalid transaction or billing agreement ID 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 ReferencelD field is empty Reference id refers to an invalid transaction This merchant is not enabled for Mark reference transaction DoReferenceTransaction Errors All Reference Transactions Related API Errors Error Code Short Message Long Message Additional Information 10001 10002 10003 10004 10004 10004 Internal Error Authentication Authorizati on Failed Missing argument Transaction refused because of an invalid argument See additional error messages for details Cart item calculation mismatch Tax calculation mismatch Internal Error Item name amount and quantity are required if item category is provided You are not signed up to accept payment for digitally delivered goods Cart i
283. ng values e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Sale This is a final sale for which you are requesting payment IPADDRESS Optional IP address of the buyer s browser NOTE PayPal records this IP addresses as a means to detect possible fraud Character length and limitations 15 single byte characters including periods for example 255 255 255 255 REQCONFIRMSHIPPING Whether you require that the buyer s shipping address on file with PayPal be a confirmed address You must have permission from PayPal to not require a confirmed address It is one of the following values e 0 You do not require that the buyer s shipping address be a confirmed address e 1 You require that the buyer s shipping address be a confirmed address NOTE Setting this field overrides the setting you have specified in your Merchant Account Profile Character length and limitations 1 single byte numeric character RETURNFMFDETAILS Optional Flag to indicate whether you want the results returned by Fraud Management Filters By default you do not receive this information It is one of the following values e 0 Do not receive FMF details default e 1 Receive FMF details Name Value Pair API Developer Guide August 2012 171 172 Recurring Payments and Reference Transactions API Operations DoReferenceTransaction API Operation Field Description
284. nse field 82 PAYMENTREQUEST_n SHIPTOCOUNTRY request field 66 99 PAYMENTREQUEST_n SHIPTOCOUNTRY response field 82 PAYMENTREQUEST_n SHIPTONAME request field 66 99 PAYMENTREQUEST_n SHIPTONAME response field 81 PAYMENTREQUEST_n SHIPTOPHONENUM request field 67 100 PAYMENTREQUEST_n SHIPTOPHONENUM response field 82 Name Value Pair API Developer Guide PAYMENTREQUEST n SHIPTOSTATE request field 66 99 PAYMENTREQUEST n SHIPTOSTATE response field 82 PAYMENTREQUEST n SHIPTOSTREET request field 66 99 PAYMENTREQUEST n SHIPTOSTREET response field 81 PAYMENTREQUEST_n SHIPTOSTREET 2 request field 66 99 PAYMENTREQUEST _n SHIPTOSTREET 2 response field 81 PAYMENTREQUEST n SHIPTOZIP request field 66 99 PAYMENTREQUEST _n SHIPTOZIP response field 82 PAYMENTREQUEST n SHORTMESSAGE response field 91 115 PAYMENTREQUEST n SOFTDESCRIPTOR request field 97 PAYMENTREQUEST_n TAXAMT request field 69 96 PAYMENTREQUEST_n TAXAMT response field 85 PAYMENTREQUEST n TRANSACTIONID request field 70 PAYMENTREQUEST n TRANSACTIONID response field 86 91 PAYMENTREQUESTID request field 71 98 PAYMENTREQUESTID response fie ld 87 PAYMENTREQUESTID response field 113 PAYMENTREQUESTn TRANSACTIONID request field 98 PAYMENTSTATUS response field 34 37 110 127 181 PAYMENTTYPE response field 105 108 125 180 PAYPALADJUSTMENT response field 79 PENDIN GREASON response field 128 182 PENDINGREASON request field 188 PENDIN
285. nses 23 EUR 275 276 Euro 275 276 EXCHANGERATE response field 110 126 181 EXPDATE request field 42 52 142 160 177 EXPDATE response field 152 ExpressCheckout API Operatons 55 Name Value Pair API Developer Guide F FAILEDINITAMTACTION request field 141 FAILEDPAYMENTCOUNT response field 151 FEEAMT response field 109 126 180 FEEREFUNDAMT response field 187 FINALPAYMENTDUEDATE response field 147 FIRSTNAME request field 42 53 143 160 177 191 FIRSTNAME respo n se field 152 FIRSTNAME response field 81 124 167 169 Forint 275 276 Funding Source Details request fields 76 G GBP 275 276 Get Balance request fields 117 Get Balance response fields 117 Get Billing Agreement Customer Details request fields 166 Get ExpressCheckout Details request fields 78 Get ExpressCheckout Details response fields 79 Get Pal Details request fields 119 Get Pal Details response fields 119 Get Recurring Payments Profile Details request fields 146 Get Recurring Payments Profile Details response fields 146 Get Transaction Details request fields 121 Get Transaction Details response fields 121 GetBalance API operation 117 GetBalance request message 117 GetBalance response message 117 GetBillingA greementCustomerDetails API operation 166 GetBillingA greementCustomerDetails request message 166 GetBillingAgreementCustomerDetails response message 166 GetExpressCheckoutDetails API operation 78 GetExpressCheckoutDetails requ
286. nt Character length and limitations 30 single byte alphabetic characters Name Value Pair API Developer Guide August 2012 163 ae Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Operation Field Description HDRIMG Optional A URL for the image you want to appear at the top left of the payment page The image has a maximum size of 750 pixels wide by 90 pixels high PayPal recommends that you provide an image that is stored on a secure https server Character length and limitations 127 single byte alphanumeric characters HDRBORDERCOLOR Optional Sets the border color around the header of the payment page The border is a 2 pixel perimeter around the header space which is 750 pixels wide by 90 pixels high Character length and limitations 6 character HTML hexadecimal color code in ASCII HDRBACKCOLOR Optional Sets the background color for the header of the payment page By default the color is white Character length and limitation 6 character HTML hexadecimal color code in ASCII PAYFLOWCOLOR Optional Sets the background color for the payment page Character length and limitation 6 character HTML hexadecimal color code in ASCII EMAIL Optional Email address of the buyer as entered during checkout PayPal uses this value to pre fill the PayPal membership sign up portion of the PayPal login page Character length and limit 127 single byte alphanumeric characters B
287. nt amount 11570 The maximum number of The maximum number of failed failed payments should be payments should be greater than greater than the current the current number of failed number of failed payments payments 11571 The total amount cannot The total amount cannot exceed exceed 120 increment per 120 increment per 180 days 180 days 11576 Bill amount is greater than Bill amount is greater than outstanding balance outstanding balance 11577 Another outstanding Another outstanding payment is payment is scheduled scheduled 11578 Bill outstanding amount not Recurring payment scheduled processed because of within 24 hours so we are not scheduled payment processing the bill outstanding amount 11579 Payment is failing Payment is failing 11581 Invalid Data Profile description is invalid 11582 No payment in queue No scheduled payment has been found 11583 DPRP feature is unavailable DPRP feature is unavailable 11584 Inactive profile Profile is not active 11585 Missing Token or buyer Missing token or payment source credit card 11586 DPRP is disabled DPRP is disabled for this merchant 11587 Billing Address is Partial Billing Address is Partial August 2012 Name Value Pair API Developer Guide API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message Additional Information 11590 11592 13122 13701 15004 Profile update is not required Subscription profiles are not supported for
288. nt API credentials for each server end point Typically you obtain API credentials when you test in the Sandbox and then obtain another set of credentials for the production server You must change each API request to use the new credentials when you go live Logging API Operations You should log basic information from the request and response messages of each PayPal API operation you execute You must log the Correlation ID from the response message which identifies the API operation to PayPal and which must be provided to Merchant Technical Support if you need their assistance with a specific transaction All responses to PayPal API operations contain information that may be useful for debugging purposes In addition to logging the Correlation ID from the response message you can log other information such as the transaction ID and timestamp to enable you to review a transaction on the PayPal website or through the API You could implement a scheme that logs the entire request and response in a verbose mode however you should never log the password from a request Responding to an NVP Response The Name Value Pair response consists of the answer to the request as well as common fields that identify the API operation and how it was executed The following diagram shows fields in the response to a PayPal NVP API operation Your Site i NVP Response A A X a ACK Success La m TIMESTAMP 2008 2d04 2 PayPal Add To
289. nt Optional e Mark Buyer must have a PayPal account to check out NOTE You can pass Mark to selectively override the PayPal Account Optional setting if PayPal Account Optional is turned on in your merchant account Passing Sole has no effect if PayPal Account Optional is turned off in your account Name Value Pair API Developer Guide August 2012 63 64 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description LANDINGPAGE Optional Type of PayPal page to display It is one of the following values e Billing Non PayPal account e Login PayPal account login CHANNELTYPE Optional Type of channel It is one of the following values e Merchant Non auction seller e eBaylItem eBay auction GIROPAYSUCCESSURL Optional The URL on the merchant site to redirect to after a successful giropay payment NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany GIROPAYCANCELURL Optional The URL on the merchant site to redirect to after a successful giropay payment NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany BANKTXNPENDINGURL Optional The URL on the merchant site to transfer to after a bank transfer payment NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany BRANDNAME Optional A label that overrides the business name in the PayPal account on the PayPal hosted checkout p
290. nt error code You can specify up to 10 payments where n is a digit between 0 and 9 inclusive xs string Payment error severity code You can specify up to 10 payments where n is a digit between 0 and 9 inclusive xs string K Application specific error values indicating more about the error condition You can specify up to 10 payments where n is a digit between 0 and 9 inclusive UserSelectedOptions Fields Field Description SHIPPINGCALCULATIONM Describes how the options that were presented to the buyer were determined It is ODE one of the following values e API Callback e API Flatrate INSURANCEOPTIONSELEC The option that the buyer chose for insurance It is one of the following values TED e Yes The buyer opted for insurance e No The buyer did not opt for insurance SHIPPINGOPTIONISDEFA Indicates whether the buyer chose the default shipping option It is one of the ULT following values e true The buyer chose the default shipping option e false The buyer did not choose the default shipping option Character length and limitations true or false SHIPPINGOPTIONAMOUNT The shipping amount that the buyer chose Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGOPTIONNAME The name of the sh
291. nt that is not immediately charged Character length and limitations 256 single byte alphanumeric characters INVNUM is deprecated since version 63 0 Use PAYMENTREQUEST_0_INVNUM instead 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 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 You can specify up to 10 payments where n is a digit between 0 and 9 inclusive IMPORTANT The notify URL applies only to DoExpressCheckout Payment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and limitations 2 048 single byte alphanumeric characters NOTIFYURL is deprecated since version 63 0 Use PAYMENTREQUEST 0 NOTIFYURL instead 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 Transaction identification number of the transaction that was created You can specify up to 10 payments where n is a digit between 0 and 9 inclusive NOTE This field is only returned after a successful transaction for
292. number These parameters must be ordered sequentially beginning with 0 for example L_EBAYITEMORDERIDO L EBAYITEMORDERID1 Character length 64 single byte characters Ship To Address Fields Field Description SHIPTONAME Person s name associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters SHIPTOSTREET First street address It is required if using a shipping address Character length and limitations 100 single byte characters SHIPTOSTREET2 Optional Second street address Character length and limitations 100 single byte characters SHIPTOCITY Name of city It is required if using a shipping address Character length and limitations 40 single byte characters SHIPTOSTATE State or province It is required if using a shipping address Character length and limitations 40 single byte characters SHIPTOZIP U S ZIP code or other country specific postal code It is required if using a U S shipping address may be required for other countries Character length and limitations 20 single byte characters SHIPTOCOUNTRY Country code It is required if using a shipping address Character length and limitations 2 single byte characters SHIPTOPHONENUM Optional Phone number Character length and limitations 20 single byte characters 3D Secure Request Fields U K Merchants Only Field Description AUTHSTATUS3DS Optional
293. nvalid BuyerEmail badly formatted or violates SMTP protocol defined email address format or BuyerEmail is passed as an empty tag Name Value Pair API Developer Guide August 2012 251 252 API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message Additional Information 10436 Transaction refused PageStyle value exceeds maximum PageStyle tag is too long because of an invalid allowable length argument See additional error messages for details 10437 Transaction refused cpp header image value exceeds cpp_header_image tag is too because of an invalid maximum allowable length long maximum length is 127 argument See additional error messages for details 10438 Transaction refused cpp header border color value cpp_header_border_color tag is because of an invalid exceeds maximum allowable too long maximum length is 6 argument See additional length error messages for details 10439 Transaction refused cpp header back color value cpp_header_back_ color tag is because of an invalid exceeds maximum allowable too long maximum length is 6 argument See additional length error messages for details 10440 Transaction refused cpp payflow color value exceeds cpp payflow_color tag is too because of an invalid maximum allowable length long maximum length is 6 argument See additional error messages for details 10471 Transaction refused ReturnURL is invalid ReturnURL tag contains inva
294. o tell buyers about items in the cart such as your return policy or that the total excludes shipping and handling Character length and limitations 127 single byte characters This field is available with API Version 64 0 or later PAYMENTREQUEST n PA Indicates the type of transaction It is one of the following values YMENTREASON e None Transaction is not identified as a particular type e Refund Identifies the transaction as a refund Name Value Pair API Developer Guide August 2012 65 66 ExpressCheckout API Operations SetExpressCheckout API Operation AddressType Fields Field Description PAYMENTREQUEST N SHIPTONAM E SHIPTONAME deprecated PAYMENTREQUEST N SHIPTOSTR EET SHIPTOSTREET deprecated PAYMENTREQUEST N SHIPTOSTR EET2 SHIPTOSTREET2 deprecated PAYMENTREQUEST N SHIPTOCIT Y SHIPTOCITY deprecated PAYMENTREQUEST nN SHIPTOSTA TE SHIPTOSTATE deprecated PAYMENTREQUEST nN SHIPTOZIP SHIPTOZIP deprecated PAYMENTREQUEST N SHIPTOCOU NTRYCODE SHIPTOCOUNTRY deprecated Person s name associated with this shipping address It is required if using a shipping address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 32 single byte characters SHIPTONAME is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTONAME instead First street address It is required if using a shipping address You can specify u
295. od and the optional thousands separator must be a comma Optional Sum of tax for all items in this order NOTE TAXAMT is required if you specify L_TAXAMTN Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Description of items the buyer is purchasing NOTE The value you specify is available only 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 alphanumeric characters Optional A free form field for your own use NOTE The value you specify is available only 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 256 single byte alphanumeric characters Optional Your own invoice or tracking number NOTE The value you specify is available only 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 256 single byte alphanumeric characters Optional An identification code for use
296. odes 279 MAXAMT request field 60 MAXFAILEDPAYMENTS request field 138 157 MAXFAILEDPAYMENTS response field 147 MERCHANTSTOREDETAILS request field 186 METHOD req uest field 121 METHOD request field 25 27 32 36 39 41 51 55 59 78 92 117 119 133 135 137 146 154 155 156 161 162 164 166 168 171 185 189 METHOD response field 58 Mexican Peso 275 MIDDLENAME request field 53 143 191 MIDDLENAME response field 81 124 167 170 MPIVENDOR3DS request field 47 Name Value Pair API Developer Guide MSGSUBID request field 28 29 33 172 179 186 188 MULTIITEM response field 131 MXN 275 MYR 275 N NETAMT request field 51 NETREFUNDAMT response field 187 New Zealand Dollar 275 276 NEXTBILLINGDATE response field 151 NO_ SHIPPING OPTION DETAILS response field 59 NOK 275 276 Norwegian Krone 275 276 NOSHIPPING request field 61 NOTE request field 28 39 52 154 155 156 NOTE response field 79 105 129 NOTETEXT request field 70 97 NOTETEXT response field 86 NOTETOBUYER request field 65 NOTIFY URL request field 97 NOTIFYURL request field 45 70 175 NOTIFYURL response field 86 NUMCYCLESREMAINING response field 151 NUMCYCYLESCOMPLETED response field 151 NVP format 17 NZD 275 276 O OfferDetails response field 114 OFFERINSURANCEOPTION response field 58 59 ORDERTIME response field 109 125 180 OUTSTANDINGAMT request field 157 OUTSTANDINGBALANCE response field 151 P PAGESTYLE reques
297. of payment details type parameter fields each representing one payment you are hosting on your marketplace August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CAE GetExpressCheckoutDetails API Operation Field Description PAYMENTREQUEST_n AMT The total cost of the transaction to the buyer If shipping cost not applicable to AMT deprecated digital goods and tax charges are known include them in this value If not this value should be the current sub total of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases Set this field to 0 if the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged Purchase specific fields are ignored You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only For digital goods the following must be true e total cost gt 0 e total cost lt total cost passed in the call to SetExpressCheckout Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma AMT is deprecated since version 63 0 Use PAYMENTREQUEST_0_AMT
298. ofile ID returned in the CreateRecurringPayment sProfile response An error is returned if the profile specified in the BillOutstandingAmount request has a status of canceled or expired Name Value Pair API Developer Guide August 2012 155 ae Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Operation UpdateRecurringPaymentsProfile API Operation The UpdateRecurringPaymentsProfile API operation updates a recurring payments profile UpdateRecurringPaymentsProfile Request Message UpdateRecurringPaymentsProfile Request Fields Field Description METHOD Required Must be UpdateRecurringPaymentsProfile PROF ILEID Required Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response Character length and limitations 14 single byte alphanumeric characters 19 character profile IDs are supported for compatibility with previous versions of the PayPal API NOTE Optional The reason for the update to the recurring payments profile This message is 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 DESC Optional Description of the recurring payment Character length and limitations 127 single byte alphanumeric characters SUBSCRIBERNAME Optional Full name of the person receiving the product or service paid for by th
299. ol It must have 2 decimal places the 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 Name Value Pair API Developer Guide August 2012 67 68 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description PAYMENTREQUEST N SHI PPINGAMT SHIPPINGAMT deprecated PAYMENTREQUEST n_ INS URANCEAMT INSURANCEAMT deprecated PAYMENTREQUEST N SHI PDISCAMT SHIPPINGDISCAMT deprecated PAYMENTREQUEST n_ INS URANCEOPTIONOFFERED INSURANCEOPTIONOFFER ED deprecated Optional Total shipping costs for this order You can specify up to 10 payments where n is a digit between 0 and 9 inclusive NOTE If you specify a value for PAYMENTREQUEST _Nn SHIPPINGAMT you must also specify a value for PAYMENTREQUEST_N ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPPINGAMT instead Optional Total shipping insurance costs for this order The value must be a non negative currency amount or null if insurance options are offered You can specify up to 10 payments where n is
300. on Id is not valid transaction Id is not valid August 2012 Name Value Pair API Developer Guide API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 11451 11451 11451 11452 11453 11453 11454 11459 11610 11611 11612 13122 13701 18014 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 Merchant not enabled for reference transactions Reference transactions temporarily unavailable Reference transactions temporarily unavailable Warning Could not send email to the buyer Invalid Data 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 Transaction refused Invalid Data Gateway Decline 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 Merchant not enabled for reference transactions Reference transaction feature not currently available try again later Reference transaction feature not currently available try again later Warning Could not send email to the buyer The shipping address must match the user s address in the PayPal account Payment Pending
301. on cannot be processed Please use a valid credit card This transaction cannot be processed Please enter a valid Credit Card Verification Number This transaction cannot be processed This transaction cannot be processed Please contact PayPal Customer Service This transaction cannot be processed Please enter a valid credit card expiration date This transaction cannot be processed The credit card type is not supported Try another card type Scenario When the regular non trial billing period amount is different than the sum of the amounts for each item in the cart Scenario When the tax for the regular non trial billing period is different than the sum of the tax for each item in the cart Occurs when the billing agreement is disabled or inactive The credit card used is expired The CVV provided is invalid The CVV is between 3 4 digits long The transaction was refused because the AVS response returned the value of N and the merchant account is not able to accept such transactions Your PayPal account is restricted Contact PayPal for more information The expiration date must be a two digit month and four digit year You must submit an IP address of the buyer with each API call The credit card type entered is not currently supported by PayPal Name Value Pair API Developer Guide August 2012 245 246 API Error Codes Recurring Payments Errors Error Code Sh
302. onal numbers PAYPALADJUSTMENT A discount or gift certificate offered by PayPal to the buyer This amount is represented by a negative amount If the buyer has a negative PayPal account balance PayPal adds the negative balance to the transaction amount which is represented as a positive value Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Must have 2 decimal places decimal separator must be a period and the optional thousands separator must be a comma NOTE Text entered by the buyer on the PayPal website if you set the ALLOWNOTE field to 1 in SetExpressCheckout Character length and limitations 255 single byte characters This field is deprecated REDIRECTREQUIRED Flag to indicate whether you need to redirect the buyer back to PayPal after successfully completing the transaction NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany Name Value Pair API Developer Guide August 2012 79 6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Field Description CHECKOUTSTATUS GIFTMESSAGE GIFTRECEIPTENABLE GIFTWRAPNAME GIFTWRAPAMOUNT BUYERMARKETINGEMAIL SURVEYQUESTION SURVEY CHOICESELECTE D ebl Checkout StatusType Status of the checkout session If payment is completed the transaction identification number of the resulting transaction is returned It is one of the following values
303. onal thousands separator is a comma Equivalent to nine characters maximum for USD FAILEDPAYMENTCOUNT The total number of failed billing cycles for this profile LASTPAYMENTDATE The date of the last successful payment received for this profile in YY YY MM DD format LASTPAYMENTAMT The amount of the last successful payment received for this 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 Name Value Pair API Developer Guide August 2012 151 ae Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Credit Card Details Fields Field Description CREDITCARDTYPE Type of credit card Is one of the following values e Visa e MasterCard e Discover e Amex e Maestro See note NOTE If the credit card type is Maestro you must set the currencyId to GBP In addition you must specify either StartMonth and Start Year or IssueNumber Character length and limitations Up to 10 single byte alphabetic characters ACCT Credit card number Only the last 4 digits of the credit card number are returned Character length and limitations Numeric characters only with no spaces or punctutation The string must conform with modulo and length required by each credit card
304. onfiguration 10553 Gateway Decline 10554 Filter Decline 10555 Filter Decline 10556 Filter Decline 10561 Invalid Data 10562 Invalid Data 10563 Invalid Data This transaction cannot be processed The merchant s account is not able to process transactions This transaction cannot be processed The merchan s account is not able to process transactions This transaction cannot be processed This transaction cannot be processed This transaction cannot be processed This transaction cannot be processed This transaction cannot be processed This transaction cannot be processed There s an error with this transaction Please enter complete billing address This transaction cannot be processed Please enter a valid credit card expiration year This transaction cannot be processed Please enter a valid credit card expiration month The merchant account attempting the transaction is not a business account at PayPal Check your account settings The merchant account attempting the transaction is not able to process Direct Payment transactions Contact PayPal for more information Access to Direct Payment was disabled for your account Contact PayPal for more information The merchant account attempting the transaction does not have a confirmed email address with PayPal Check your account settings The merchant attempted a transaction where the amount exceeded the upper limit for that m
305. onse only if Payment Status is Pending PENDINGREASON is deprecated since version 63 0 Use PAYMENTINFO 0 PENDINGREASON instead Name Value Pair API Developer Guide August 2012 111 112 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO_n_REASO NCODE REASONCODE deprecated PAYMENTINFO_n HOLDD ECISION PAYMENTINFO n PROTE CTIONELIGIBILITY PROTECTIONELIGIBILI TY deprecated Reason for a reversal if TransactionType is reversal It is one of the following values Reason for a reversal if TransactionType is reversal You can specify up to 10 payments where n is a digit between 0 and 9 inclusive It is one of the following values e none No reason code e chargeback A reversal has occurred on this transaction due to a chargeback by your buyer e guarantee A reversal has occurred on this transaction due to your buyer triggering a money back guarantee e buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your buyer e refund A reversal has occurred on this transaction because you have given the buyer a refund e other A reversal has occurred on this transaction due to a reason not listed above REASONCODE is deprecated since version 63 0 Use PAYMENTINFO_0 REASONCODE instead xs string Reason that this payment is being held It is one of the following values Reason that this pay
306. or details 11811 Transaction refused because Invalid Shipping Discount of an invalid argument See additional error messages for details 11812 Invalid Data The value of Description parameter has been truncated 11813 Transaction refused because Invalid callback URL of an invalid argument See additional error messages for details Callback URL is wrong type Callback URL is wrong type you Ensure that your callback URL must use the HTTPS starts with https 11814 Invalid data Invalid value for AllowNote 11815 Transaction refused because Item sales tax is invalid of an invalid argument See additional error messages for details Callback options missing You must specify callback options when you specify a callback URL Name Value Pair API Developer Guide August 2012 219 220 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error Invalid callback timeout The callback timeout is is zero you must specify a longer timeout Line items missing Line items are required when specify a callback URL for flate rate shipping options Callback URL is too long The callback URL must not exceed 1 024 characters Multiple default shipping You can only specify one default options specified shipping option at a time No default shipping option You must specify a default shipping specified option Invalid shipping total Invalid shipping total it should equal the sh
307. or service paid for by the recurring payment If not present the name in the buyer s PayPal account is used Character length and limitations 32 single byte characters PROF ILESTARTDATE Required The date when billing for this profile begins NOTE The profile may take up to 24 hours for activation Character length and limitations Must be a valid date in UTC GMT format PROFILEREFERENCE Optional The merchant s own unique reference or invoice number Character length and limitations 127 single byte alphanumeric characters Schedule Details Fields Field Description DESC Required Description of the recurring payment NOTE You must ensure that this field matches the corresponding billing agreement description included in the SetExpressCheckout request Character length and limitations 127 single byte alphanumeric characters MAXFAILEDPAYMENTS Optional Number of scheduled payments that can fail before the profile is automatically suspended An IPN message is sent to the merchant when the specified number of failed payments is reached Character length and limitations Number string representing an integer AUTOBILLOUTAMT Optional Indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle The outstanding balance is the total amount of any previously failed scheduled payments that have yet to be successfully paid It is one of the following values e NoAutoBil
308. orization you are capturing is an Express Checkout order authorization NOTE This value on DoCapture overwrites a value previously set on DoAuthorization Character length and limitations 127 single byte alphanumeric characters Optional An informational note about this settlement that is displayed to the buyer in email and in their transaction history Character length and limitations 255 single byte characters Optional Per transaction description of the payment that is passed to the buyer s credit card statement If you provide a value in this field the full descriptor displayed on the buyer s statement has the following format lt PP PAYPAL gt lt Merchant descriptor as set in the Payment Receiving Preferences gt lt 1 space gt lt soft descriptor gt Character length and limitations The soft descriptor can contain only the following characters e Alphanumeric characters e dash e asterisk e period e space If you pass any other characters such as PayPal returns an error code The soft descriptor does not include the phone number which can be toggled between your customer service number and PayPal s Customer Service number The maximum length of the soft descriptor is 22 characters Of this the PayPal prefix uses either 4 or 8 characters of the data format Thus the maximum length of the soft descriptor information that you can pass in this field is 22 len lt PP PAYPAL gt
309. ort Message Long Message Additional Information 10511 Invalid Data This transaction cannot be The merchant selected an value processed for the PaymentAction field that is not supported 10512 Invalid Data This transaction cannot be The first name of the buyer is processed Please enter a first required for this merchant name 10513 Invalid Data This transaction cannot be The last name of the buyer is processed Please enter a last required for this merchant name 10535 Gateway decline This transaction cannot be processed Please enter a valid credit card number and type 10548 Invalid Configuration This transaction cannot be The merchant account processed The merchant s account attempting the transaction is not is not able to process transactions a business account at PayPal Check your account settings 10550 Invalid Configuration This transaction cannot be Access to Direct Payment was processed disabled for your account Contact PayPal for more information 10561 Invalid Data There s an error with this transaction Please enter complete billing address 10565 Merchant country The merchant country is not unsupported supported 10709 Invalid Data There s an error with this There was a problem with a transaction Please enter an particular field in the address address1 in the billing address The long error message tells you which field is invalid 10710 Invalid Data There s an error with this There was a problem with
310. ounts only Canadian Dollar CAD Czech Koruna CZK Danish Krone DKK Euro EUR Hong Kong Dollar HKD Hungarian Forint HUF Israeli New Sheqel ILS Japanese Yen JPY Malaysian Ringgit MYR NOTE This currency is supported as a payment currency and a currency balance for in country PayPal accounts only Mexican Peso MXN Norwegian Krone NOK New Zealand Dollar NZD Philippine Peso PHP Polish Zloty PLN Pound Sterling GBP Singapore Dollar SGD Swedish Krona SEK Swiss Franc CHF Taiwan New Dollar TWD Name Value Pair API Developer Guide August 2012 275 Dl Currency Codes 276 Currency Currency Code Thai Baht THB Turkish Lira TRY NOTE This currency is supported as a payment currency and a currency balance for in country PayPal accounts only U S Dollar USD Currencies and Currency Codes Supported by Express Checkout and Direct Payment Express Checkout Currency Cur rency Code Direct Payment Currency for Specified Card in United States Direct Payment Currency for Specified Card in United Kingdom Direct Payment Currency for Specified Card in Canada Australian Dollar Canadian Dollar Czech Koruna Danish Krone Euro Hong Kong Dollar Hungarian Forint Japanese Yen Norwegian Krone New Zealand Dollar Polish Zloty Pound Sterling Singapore Dollar Swedish Krona Swiss Franc U S Dollar AUD CZK DKK EUR HKD JPY NOK NZD PLN GBP SGD SE
311. outPayment API Errors Error Code 10001 10001 10001 10001 10004 10004 Short Message Internal Error Internal Error ButtonSource value truncated Internal Error 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 Correcting This Error Transaction failed due to internal error Warning an internal error has occurred 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 The transaction id is not valid August 2012 Name Value Pair API Developer Guide API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10004 10004 10004 10004 10004 10004 10004 10004 10004 10004 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 invali
312. p to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 100 single byte characters SHIPTOSTREET is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOSTREET instead Optional Second street address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 100 single byte characters SHIPTOSTREETZ2 is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOSTREET2 instead Name of city It is required if using a shipping address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 40 single byte characters SHIPTOCITY is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOCITY instead State or province It is required if using a shipping address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 40 single byte characters SHIPTOSTATE is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOSTATE instead U S ZIP code or other country specific postal code It is required if using a U S shipping address and may be required for other countries You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 20 single byte characters SHIPTOZIP is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOZIP instead Country code It is req
313. pe of the transaction It is one of the following values e Currency Conversion credit Currency Conversion debit Payment Recurring Payment Temporary Hold Transfer Donation L EMAILN Email address of either the buyer or the payment recipient the payee If the payment amount is positive this field is the recipient of the funds If the payment is negative this field is the paying buyer L_NAMEn Display name of the buyer L_TRANSACTIONIDn Merchant s transaction ID L_STATUSn The status of the transaction L_AMTn The total gross amount charged including any profile shipping cost and taxes L_CURRENCYCODEN 3 character ISO 4217 currency code L_FEEAMTn The fee that PayPal charged for the transaction L_NETAMIn The net amount of the transaction 192 August 2012 Name Value Pair API Developer Guide API Error Codes The PayPal API can return multiple errors for any operation General API Errors General API Errors Error Code Short Message Long Message Correcting This Error 10002 10002 10002 10002 10002 10002 10002 10002 10002 10002 Authentication Authoriza tion Failed 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 Authenticatio
314. processed Please enter a valid month and four digit year credit card expiration date 10509 Invalid Data This transaction cannot be You must submit an IP address of the processed buyer with each API call 10510 Invalid Data The credit card type is not The credit card type entered is not supported Try another card type currently supported by PayPal 10511 Invalid Data This transaction cannot be The merchant selected a value for the processed PaymentAction field that is not supported 10512 Invalid Data This transaction cannot be The first name of the buyer is required processed Please enter a first for this merchant name 10513 Invalid Data This transaction cannot be The last name of the buyer is required processed Please enter a last for this merchant name 10519 Invalid Data Please enter a credit card The credit card field was blank 10520 Invalid Data This transaction cannot be The total amount and item amounts do processed not match 10521 Invalid Data This transaction cannot be The credit card entered is invalid processed Please enter a valid credit card 10523 Internal Error This transaction cannot be None This is a PayPal internal error processed 10525 Invalid Data This transaction cannot be The merchant entered an amount of zero processed The amount to be charged is zero 10526 Invalid Data This transaction cannot be The currency code entered is not processed The currency is not supported supported at this ti
315. ption L_AMIn Available balance and associated currency code for the primary currency holding L_CURRENCYCODEn Currency code such as USD associated with the holding Name Value Pair API Developer Guide August 2012 117 GetBalance API Operation GetBalance Response Message 118 August 2012 Name Value Pair API Developer Guide GetPalDetails API Operation The Get PalDetails API operation obtains your Pal ID which is the PayPal assigned merchant account number and other information about your account You need the account number when working with dynamic versions of PayPal buttons and logos GetPalDetails Request Message GetPalDetails Request Fields Field Description METHOD Required Must be Get PalDetails GetPalDetails Response Message GetPalDetails Response Fields Field Description PAL PayPal assigned merchant account number Name Value Pair API Developer Guide August 2012 119 120 GetPalDetails API Operation GetPalDetails Response Message Field Description LOCALE Country code representing the merchant s default locale It is one of the following locales e AU Australia AT Austria BE Belgium BR Brazil CA Canada CH Switzerland CN China DE Germany ES Spain GB United Kingdom FR France IT Italy NL Netherlands PL Poland PT Portugal RU Russia US United States The following 5 c
316. quest fi eld 46 L_TAXAMT request field 176 L_TAXAMT response field 58 L_TAXAMTn request field 73 88 101 L_TIMESTAMPn response field 192 L_TIMEZONEn response field 192 L_TRANSACTIONIDn response field 192 L_TYPEn response field 192 LANDINGPAGE request field 64 LASTNAME request field 43 53 143 160 178 191 LASTNAME response field 81 124 152 167 170 302 August 2012 LASTPAYMENTAMT response field 151 LASTPAYMENTDATE response field 151 LOCALE response field 120 LOCALECODE request field 56 62 163 LoyaltyCardDiscountAmount 130 LoyaltyCardDiscountCurrency 130 Maestro AVS response codes 278 Maestro CVV2 response codes 279 Malaysian Ringgit 275 Manage Pending Transaction Status request fields 133 Manage Pending Transaction Status response fields 134 Manage Recurring Payments Profile Status request fields 154 Manage Recurring Payments Profile Status response fields 154 ManagePendingTransactionStatus API operation 133 ManagePendingTransactionStatus request message 133 ManagePendingTransactionStatus response message 134 ManageRecurringPaymentsProfileStatus API operation 154 ManageRecurringPaymentsProfileStatus request message 154 ManageRecurringPaymentsProfileStatus response message 154 Mass Payment request fields 135 MassPay API operation 135 MassPay request message 135 MassPay response fields 135 MassPay response message 135 MasterCard AVS response codes 277 MasterCard CVV2 response c
317. r transaction Please enter an address in the shipping address field in the address The long error message tells you which field is invalid August 2012 Name Value Pair API Developer Guide API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10727 Invalid Data There s an error with this There was a problem with a particular 10728 Invalid Data 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 10736 Invalid Data transaction Please enter an address in the shipping address There s an error with this transaction Please enter a city in the shipping address There s an error with this transaction Please enter a city in the shipping address There s an error with this transaction Please enter your state in the shipping address There s an error with this transaction Please enter your five digit postal code in the shipping address There s an error with this transaction Please enter a country in the shipping address There s an error with this transaction Please enter a country in the shipping address There s an error with this transaction Please enter a valid shipping address There s an error with this transaction Please enter a valid state in the shipping address There s an error
318. r account balance e Denied You denied the payment This happens only if the payment was previously pending e 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 PROF ILEID Optional An alphanumeric string generated by PayPal that uniquely identifies a recurring profile You can specify the Profile ID in the TransactionSearch API operation to obtain all payments associated with the identified profile Payer Name Fields Field Description SALUTATION Optional Buyer s salutation Character length and limitations 20 single byte characters FIRSTNAME Optional Buyer s first name Character length and limitations 25 single byte characters MIDDLENAME Optional Buyer s middle name Character length and limitations 25 single byte characters LASTNAME Optional Buyer s last name Character length and limitations 25 single byte characters SUFFIX Optional Buyer s suffix Character length and limitations 12 single byte characters Name Value Pair API Developer Guide August 2012 191 14 TransactionSearch API Operation TransactionSearch Response Message TransactionSearch Response Message TransactionSearch Response Fields Field Description L_TIMESTAMPn Date and time in UTC GMT that the transaction occurred L_TIMEZONEn Time zone of the transaction The value is always GMT L TYPEN Ty
319. r countries Character length and limitations 20 single byte characters Country code It is required if using a shipping address Character length and limitations 2 single byte characters Optional Phone number Character length and limitations 20 single byte characters Billing Period Details Fields Field Description TOTALBILLINGCYCLES TRIALTOTALBILLINGCY CLES Optional Number of billing cycles for payment period e For the regular payment period if no value is specified or the value is 0 the regular payment period continues until the profile is canceled or deactivated e For the regular payment period if the value is greater than 0 the regular payment period will expire after the trial period is finished and continue at the billing frequency for TotalBillingCycles cycles Required Billing amount for each billing cycle during this payment period This amount does not include shipping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Number of billing cycles for trial payment period 158 August 2012 Name Value Pair API Developer Guide Recurring Payments
320. r string on the credit card would be PAYPAL EBAY JanesFlow Indicates the type of transaction It is one of the following values e None Transaction is not identified as a particular type e Refund Identifies the transaction as a refund Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 Ship To Address Fields Field Description SHIPTONAME Person s name associated with this shipping address It is required if using a shipping address Character length and limitations 32 single byte characters August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations DoReference Transaction API Operation Field Description SHIPTOSTREET First street address It is required if using a shipping address Character length and limitations 100 single byte characters SHIPTOSTREET2 Optional Second street address Character length and limitations 100 single byte characters SHIPTOCITY Name of city It is required if using a shipping address Character length and limitations 40 single byte characters SHIPTOSTATE State or pro
321. racter length and limitations 13 single byte alphanumeric characters Status of buyer It is one of the following values e verified e unverified Character length and limitations 10 single byte alphabetic characters 80 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE GetExpressCheckoutDetails API Operation Field Description COUNTRYCODE Buyer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations 2 single byte characters BUSINESS Buyer s business name Character length and limitations 127 single byte characters Payer Name Fields Field Description SALUTATION Buyer s salutation Character length and limitations 20 single byte characters FIRSTNAME Buyer s first name Character length and limitations 25 single byte characters MIDDLENAME Buyer s middle name Character length and limitations 25 single byte characters LASTNAME Buyer s last name Character length and limitations 25 single byte characters SUFFIX Buyer s suffix Character length and limitations 12 single byte characters Address Type Fields Field Description PAYMENTREQUEST N SHIPTONAM Person s name associated with this shipping address You can specify up to E 10 payments where n is a digit between 0 and 9 inclusive SHIPTONAME deprecated Character length and limitations 32 single byte characters SHIPT
322. re APIs Character length and limitations 19 single byte characters AMT This value is the amount of the payment as specified by you on DoDirectPaymentRequest for reference transactions with direct payments AVSCODE Address Verification System response code Character length and limitations 1 single byte alphanumeric character CVV2MATCH Result of the CVV2 check by PayPal August 2012 Name Value Pair API Developer Guide DoDirectPayment API Operation DoDirectPayment Response Message Field Description L_FMFfilterIDn Filter ID including the filter type PENDING REPORT or DENY the filter JD and the entry number n starting from 0 Filter JD 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 L_FMFfilterNAMEN Filter name including the fi ter type PENDING REPORT or DENY the filter NAME and the entry number n starting from 0 PAYMENTADVICECODE Response code from the processor when a recurrng transaction is declined For de
323. re determined It is ODE one of the following values e API Callback e API Flatrate INSURANCEOPTIONSELEC The option that the buyer chose for insurance It is one of the following values TED e Yes The buyer opted for insurance e No The buyer did not opt for insurance SHIPPINGOPTIONISDEFA Indicates whether the buyer chose the default shipping option It is one of the ULT following values e true The buyer chose the default shipping option e false The buyer did not choose the default shipping option Character length and limitations true or false SHIPPINGOPTIONAMOUN The shipping amount that the buyer chose Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGOPTIONNAME The name of the shipping option such as air or ground August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE GetExpressCheckoutDetails API Operation Seller Details Type Fields Field Description PAYMENTREQUEST n SELLER Unique identifier for the merchant For parallel payments this field contains PAYPALACCOUNTID either the Payer Id or the email address of the merchant You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 127 single byte
324. reattempt the request Invoice ID Name Value Pair API Developer Guide August 2012 235 236 API Error Codes Authorization and Capture API Errors Error Short Returned By API Correcting This Code Message Long Message Call Error 10625 Transaction The amount exceeds the DoAuthorization Reattempt the request refused because maximum amount for a DoCapture with a lower amount of an invalid single transaction DoReauthorization argument See additional error messages for details 10626 Risk Transaction refused due DoAuthorization Contact the buyer to risk model DoCapture DoReauthorization 10627 Transaction The invoice ID field is DoAuthorization The Invoice ID field can refused because not supported for basic DoReauthorization be used only with of an invalid authorizations Do Void DoCapture argument See additional error messages for details 10628 This transaction This transaction cannot DoAuthorization Retry the request at a cannot be be processed at this time DoCapture later time processed at this Please try again later DoReduthorization time Pl t il DoVoid again later 10629 Reauthorization Reauthorization is not DoReauthorization Use DoAuthorization to not allowed allowed for this type of authorize the order authorization 10630 Item amount is Item amount is invalid DoAuthorization Check the item amount to invalid DoCapture ensure that it is not zero or negative 10631 Processor The au
325. 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 You can specify up to 10 payments where n is a digit between 0 and 9 inclusive IMPORTANT The notify URL applies only to DoExpressCheckout Payment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and limitations 2 048 single byte alphanumeric characters NOTIFYURL is deprecated since version 63 0 Use PAYMENTREQUEST 0 NOTIFYURL instead PAYMENTREQUEST Nn NOTETEX Optional Note to the merchant You can specify up to 10 payments where n T is a digit between 0 and 9 inclusive NOTETEXT deprecated Character length and limitations 255 single byte characters NOTETEXT is deprecated since version 63 0 Use PAYMENTREQUEST 0 NOTETEXT instead PAYMENTREQUEST N SOFTDES A per transaction description of the payment that is passed to the buyer s credit CRIPTOR card statement You can specify up to 10 payments where n is a digit between SOFTDESCRIPTOR deprecated 0 and 9 inclusive NOTE Ignore when PAYMENTREQUEST_n_ PAYMENTACTION Order SOFTDESCRIPTOR is deprecated since version 63 0 Use PAYMENTREQUEST O SOFTDESCRIPTOR instead Name Value Pair API Developer Guide August 2012 97 98 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMEN
326. recurring payments Transaction refused Invalid Data Gateway Decline Based on your input request profile already up to date Subscription profiles are not supported for recurring payments Transaction violates PayPal use Item Category value is invalid Only Digital or Physical are allowed This transaction cannot be processed Please enter a valid Credit Card Verification Number Scenario When merchant passes an item category value other than Digital or Physical SetCustomerBillingAgreement Errors SetCustomerBillingAgreement Errors Error Code Short Message Long Message Additional Information 10004 10404 10004 10405 10407 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 Invalid argument BillingType input field is set to None ReturnURL is missing Invalid value for request billing address parameter CancelURL is missing Invalid buyer email address BuyerEmail ReturnURL tag has no content CancelURL tag has no content I
327. request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma 140 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Operation Actvation Details Fields Field Description INITAMT FAILEDINITAMTACTION Optional Initial non recurring payment amount due immediately upon profile creation Use an initial amount for enrolment or set up fees NOTE All amounts included in the request must have the same currency Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Action you can specify when a payment fails It is one of the following values e ContinueOnFailure By default PayPal suspends the pending profile in the event that the initial payment amount fails You can override this default behavior by setting this field to ContinueOnFailure Then if the initial payment amount fails PayPal adds the failed payment amount to the outstanding balance for th
328. required and you must set it to Digital to get the best rates It is one of the following values e Digital e Physical These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST N ITEMCATEGORYO L_PAYMENTREQUEST nN ITEMCATEGORY1 L PAYMENTREQUEST n NA New field MEM Item name This field is required when you pass a value for ItemCategory These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST_n NAMEO L_PAYMENTREQUEST_n NAME1 Character length and limitations 127 single byte characters L PAYMENTREQUEST n DE Newfield scm Optional Item description These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST nN DESCO L PAYMENTREQUEST_n_DESC1 Character length and limitations 127 single byte characters L PAYMENTREQUEST_n AM New field Tm Cost of item This field is required when you pass a value for ItemCategory These parameters must be ordered sequentially beginning with 0 for example L PAYMENTREQUEST n_AMTO L_PAYMENTREQUEST_N_AMT1 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 L PAYMENTREQUEST_n_ NU New field MBERM Optional Item number These parameters must be ordered sequentially beginning with 0
329. ressCheckoutDetails Request Message GetExpressCheckoutDetails Request Fields Field Description METHOD Required Must be GetExpressCheckoutDetails 78 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE GetExpressCheckoutDetails API Operation Field Description TOKEN Required A timestamped token the value of which was returned by SetExpressCheckout response Character length and limitations 20 single byte characters GetExpressCheckoutDetails Response Message GetExpressCheckoutDetails Response Fields Field Description TOKEN The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request Character length and limitations 20 single byte characters CUSTOM A free form field for your own use as set by you in the Custom element of the SetExpressCheckout request Character length and limitations 256 single byte alphanumeric characters INVNUM Your own invoice or tracking number as set by you in the element of the same name in the SetExpressCheckout request Character length and limitations 127 single byte alphanumeric characters PHONENUM Buyer s contact phone number NOTE PayPal returns a contact phone 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 internati
330. review in Fraud Fraud Management Filters Management Filters 11611 Transaction blocked by Transaction blocked by your your settings in FMF settings in FMF 11612 Could not process your Could not process your request to request to accept deny the accept deny the transaction transaction 11821 This transaction cannotbe This transaction cannot be You cannot capture a payment after it processed processed because it has already has been denied by a Fraud Management been denied by a Fraud Filter You can control whether a Fraud Management Filter Management Filter denies a transaction by changing the filter s settings in the profile 12000 Transaction is not Transaction is not compliant due Check ECI ECI3DS CAVV XID fields compliant due to missing or invalid 3 D Secure authentication values Name Value Pair API Developer Guide to missing or invalid 3 D Secure authentication values August 2012 207 API Error Codes DirectPayment API Errors Error Code Short Message Long Message Corrective Action 12001 Transaction is not Transaction is not compliant due Check ECI ECI3DS CAVV XID fields compliant due to missing to missing or invalid 3 D Secure or invalid 3 D Secure authentication values authentication values 15001 Gateway Decline This transaction cannot be The transaction was rejected by PayPal processed because of excessive failures over a short period of time for this credit card Contact PayPal for more information
331. ring payments profile BillOutstandingAmount Request Message BillOutstandingAmount Request Fields Field Description METHOD Required Must be B1110utstandingAmount PROF ILEID Required Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response NOTE The profile must have a status of either Active or Suspended Character length and limitations 14 single byte alphanumeric characters 19 character profile IDs are supported for compatibility with previous versions of the PayPal API AMT Optional The amount to bill The amount must be less than or equal to the current outstanding balance of the profile If no value is specified PayPal attempts to bill the entire outstanding balance amount Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma NOTE Optional The reason for the non scheduled payment For profiles created using Express Checkout this message is included in the email notification to the buyer for the non scheduled payment transaction and can also be seen by both you and the buyer on the Status History page of the PayPal account BillOutstandingAmount Response Message BillOutstandingAmount Response Fields Field Description PROF ILEID Recurring payments pr
332. rrency Itincludes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma BUYEREMAILOPTINENAB Optional Enables the buyer to provide their email address on the PayPal pages to be LE notified of promotions or special events Is one of the following values e 0 Do not enable buyer to provide email address e 1 Enable the buyer to provide email address SURVEYQUESTION Optional Text for the survey question on the PayPal pages If the survey question is present at least 2 survey answer options must be present Character length and limitations 50 single byte characters SURVEYENABLE Optional Enables survey functionality It is one of the following values e 0 Disables survey functionality e 1 Enables survey functionality L_SURVEYCHOICEn Optional Possible options for the survey answers on the PayPal pages Answers are displayed only if a valid survey question is present Character length and limitations 15 single byte characters TOTALTYPE Optional Enables display of Estimated Total instead of Total in the cart review area It is one of the following values e Total e EstimatedTotal Character length and limitations 14 single byte characters This field is available with API Version 64 0 or later NOTETOBUYER Optional Displays a note to buyers in the cart review area below the total amount Use the note t
333. rrency of the loyalty card discount for example a 3 character currency code NOTE Use character string as shown Cost of item These parameters must be ordered sequentially beginning with 0 for example L_AMTO L_AMT1 August 2012 Name Value Pair API Developer Guide GetTransactionDetails API Operation GetTransactionDetails Response Message Field Description L OPTIONSNAMEN L OPTIONSVALUEN PayPal option names for an item in the shopping cart each name corresponds to an option value There can be multiple option names per item The option names are ordered sequentially beginning with 0 for example L OPTIONSNAMESO L_OPTIONSNAME 1 PayPal option values corresponding to option names of an item in the shopping cart The option names are ordered sequentially beginning with 0 for example L OPTIONSVALUEO L OPTIONSVALUE1 Auction Information Fields Field BUYERID CLOSINGDATE MULTIITEM Description Buyer s auction ID Auction s close date Counter used for multi item auction payments Subscription Terms Fields Field Description AMOUNT Amount subscriber is to be charged in 1 payment Character length and limitations No limit PERIOD Period of time that the subscriber is charged Character length and limitations No limit Name Value Pair API Developer Guide August 2012 131 a GetTransactionDetails API Operation GetTransactionDetails Response Message 132 Au
334. rsal 12206 The value of Order and Authorization are PaymentAction must be not acceptable values for Sale for Immediate PaymentAction when the item Payment item is an Immediate Payment 12207 Cart ID is required for Cart ID is required for Immediate Payment item Immediate Payment item 12208 eBay item amount does eBay item amount does not not match Express match Express Checkout API Checkout API item item amount amount 13100 Parallel payments Parallel payments functionality functionality is not available is not available Name Value Pair API Developer Guide August 2012 231 232 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 13101 Invalid Data Payment action of Order is only supported for parallel payments 13102 Payment Request ID is Payment Request ID is missing mandatory for parallel payments 13103 Duplicate Payment Payment Request ID must be Request ID passed unique for parallel payments 13104 Transaction refused Number of payment requests because of an invalid exceeds maximum number of argument See Additional supported requests error messages for details 13106 Invalid Data You cannot pass both the new and deprecated PaymentAction parameter 13107 Parallel payments partially One or more payment requests successful failed Check individual payment responses for more information 13110 Multi Payments Sale is Due to some te
335. rsion 67 0 Name Value Pair API Developer Guide August 2012 187 E RefundTransaction API Operation RefundTransaction Response Message Field Description CURRENCY CODE Currency code Character length and limitations 3 single byte characters REFUNDINFO Contains refund payment status information This field is available since version 84 0 MSGSUBID Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 RefundIinfoType Fields Field Description REFUNDSTATUS ns Payment StatusCodeType Status of the refund It is one of the following values e instant e delayed This field is available since version 84 0 PENDINGREASON Reason that the refund payment status is delayed It is one of the following values e none The refund status is instant e echeck The refund status is delayed This field is available since version 84 0 188 August 2012 Name Value Pair API Developer Guide TransactionSearch API Operation The TransactionSearch API searches transaction history for transactions that meet the specified criteria NOTE The maximum number of transactions that
336. s for details 10435 Transaction refused The customer has not yet because of an invalid confirmed payment for this argument See additional Express Checkout session error messages for details 10441 Transaction refused The NotifyURL element value because of an invalid exceeds maximum allowable argument See additional length error messages for details 10442 ButtonSource value The ButtonSource element truncated value exceeds maximum allowable length 10443 Transaction refused This transaction cannot be because of an invalid completed with argument See additional PaymentAction of Order error messages for details 10444 Transaction refused The transaction currency because of an invalid argument See additional error messages for details specified must be the same as previously specified August 2012 Name Value Pair API Developer Guide DoExpressCheckoutPayment API Errors API Error Codes Error Code Short Message Long Message Correcting This Error 10445 10446 10474 10481 10486 10482 10537 10538 10539 10725 10727 This transaction cannot be processed at this time Please try again later Unconfirmed email Invalid Data Transaction refused because of an invalid argument See additional error messages for details This transaction couldn t be completed Transaction refused because of an invalid argument See additional error messages for details Ri
337. s too long Maximum amount of order is less than itemized amounts Option not supported Option not supported Buyer ID is not present Immediate Payment item was not found More than one eBay item is present eBay Transaction ID and eBay Order ID must be null Cart ID is required for Immediate Payment item Maximum amount of order not specified you must specify the estimated value of the order when using a flat rate shipping option Shipping total is missing you must specify a shipping total when using a flat rate shipping option Insurance amount is missing you have offered insurance but have not specified an amount Callback URL is too long it must not exceed 1 024 characters Maximum amount of order is less than itemized amounts the value of all items including handling shipping tax and insurance cannot be greater than the maximum amount of the order Seller blocks payments via eBay checkout for all eBay items Express Checkout not supported for you Buyer ID must be specified to process an Immediate Payment item The item specified is either not valid Please check that the item is a or is not currently available for valid Immediate Payment item purchase as an Immediate Payment item Only one Immediate Payment item can be paid for in a single PayPal payment transaction Requests for eBay Immediate Payment items should not contain either eBay transaction ID or eBay order ID If the f
338. s used by the PayPal NVP API must be decoded The PayPal NVP API uses the HTTP protocol to send requests and receive responses from a PayPal API server You must decode all data returned using the HTTP protocol so that it can be displayed properly Most programming languages provide a way to decode strings Related information URL Encoding 24 August 2012 Name Value Pair API Developer Guide AddressVerify API Operation The AddressVerify API operation confirms whether a postal address and postal code match those of the specified PayPal account holder AddressVerify Request Message Address Verify Request Fields Field Description METHOD Required Must be AddressVerify EMAIL Required Email address of a PayPal member to verify Character length and limitations 255 single byte characters maximum with the input mask STREET Required First line of the billing or shipping postal address to verify To pass verification the value of Street must match the first 3 single byte characters of a postal address on file for the PayPal member Character length and limitations 35 single byte characters maximum including alphanumeric plus Whitespace and case of input value are ignored ZIP Required Postal code to verify To pass verification the value of Zip must match the first 5 single byte characters of the postal code of the verified postal address for the verified PayPal member Character length and
339. s without having to make an additional database L_PAYMENTREQUEST N IT query You can specify up to 10 payments where n is a digit between 0 and 9 EMWEIGHTUNITM inclusive and m specifies the list item within the payment These parameters L ITEMWEIGHTVALUEnand Must be ordered sequentially beginning with 0 for example L TTEMWEICHTUNITN L_PAYMENTREQUEST N ITEMWEIGHTVALUEO deprecated L_PAYMENTREQUEST N ITEMWEIGHTVALUE1 Character length and limitations Any positive integer L ITEMWEIGHTTVALUEN and L_ITEMWEIGHTUNITN are deprecated since version 63 0 Use L_PAYMENTREQUEST_0 ITEMWEIGHTVALUEM and L_PAYMENTREQUEST 0 ITEMWEIGHTUNITM instead Name Value Pair API Developer Guide August 2012 101 102 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description L_PAYMENTREQUEST_n_IT EMLENGTHVALUEM L_PAYMENTREQUEST_n_IT EMLENGTHUNITM L_ITEMLENGTHVALUEN and L_ITEMLENGHTUNITN deprecated L_PAYMENTREQUEST_n_IT EMWIDTHVALUEM L_PAYMENTREQUEST_n_IT EMWIDTHUNITM L_ITEMWIDTHVALUEN and L_ITEMWIDTHUNITn deprecated L_PAYMENTREQUEST_n_IT EMHETGHTVALUEM L_PAYMENTREQUEST_n_IT EMHEIGHTUNITM L_ITEMHETGHTVALUEN and L_ITEMHEIGHTUNITN deprecated L PAYMENTREQUEST_n IT EMURLM L_ITEMURLN deprecated Optional Item length corresponds to the length of the item 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 p
340. sCheckout API Errors SetExpressCheckout API Errors SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10001 ButtonSource value The transaction could not be loaded truncated 10001 Internal Error Internal Error 10003 Missing argument OtherPaymentMethodID is missing 10003 Missing argument OtherPaymentMethodLabel is missing 10003 Missing argument OtherPaymentMethodType is missing 10003 Missing argument One or more of these giropay URLs is missing giropaySuccessURL giropayCancelURL BanktxnPendingURL 10004 Transaction refused because Transaction refused because of an of an invalid argument See invalid argument See additional additional error messages for error messages for details details 10004 Transaction refused because The transaction id is not valid of an invalid argument See additional error messages for details 10004 Transaction refused because Invalid value for request billing of an invalid argument See address parameter additional error messages for details 10004 Transaction refused because Invalid item URL of an invalid argument See additional error messages for details 10004 Transaction refused because OtherPaymentMethodType is of an invalid argument See invalid additional error messages for details 10004 Transaction refused because RegistrationDate of buyer is invalid of an invalid argument See additional error messages for details
341. saction 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 alphanumeric characters CUSTOM Optional A free form field for your own use NOTE The value you specify is available only 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 256 single byte alphanumeric characters INVNUM Optional Your own invoice or tracking number NOTE The value you specify is available only 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 256 single byte alphanumeric characters BUTTONSOURCE Optional An identification code for use by third party applications to identify transactions Character length and limitations 32 single byte alphanumeric characters NOTIFYURL 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 IMPORTANT The notify URL applies only to DOExpressCheckout Payment This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails Character length and lim
342. scription 11 May 2010 Updated for 63 0 Added new NVP API fields to use in version 63 0 Express Checkout integrations Deprecated old fields Updated billing agreement API with functionality to obtain the latest billing address and to skip billing agreement creation Added ReverseTransaction API 10 March 2010 Updated information for 62 0 Describes Express Checkout fields recommended 21 January 2010 7 October 2009 16 June 2009 22 May 2009 08 April 2009 26 Nov 2008 23 Sept 2008 3 Sept 2008 June 2008 April 2008 February 2008 January 2008 September 2007 August 2007 to be used in applications that enable implementing parallel payments for a marketplace Updated information for 61 0 Added Express Checkout fields enabling you to provide gift and insurance options to the PayPal checkout pages Updated information for 60 0 updated currency table with new currencies and added Express Checkout API fields for Immediatee Payment and eBay Updated information for 58 0 added GetPalDetails API and fields for payment review Minor update to version 57 0 added CreateBillingAgreement to Enterprise edition Updated information for 57 0 Express Checkout Callback API and error codes Updated information for 55 0 Added information about using billing agreements with SetExpressCheckout Added information about payment review to GetTransactionDetails Rearranged material added error codes and moved some material to t
343. se contact Customer Service 10404 Transaction refused because ReturnURL is missing of an invalid argument See additional error messages for details 10405 Transaction refused because CancelURL is missing of an invalid argument See additional error messages for details 10407 Transaction refused because Invalid buyer email address of an invalid argument See BuyerEmail additional error messages for details 10409 You re not authorized to Express Checkout token was issued access this info for a merchant account other than yours 10410 Invalid token Invalid token August 2012 Name Value Pair API Developer Guide API Error Codes EE SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10411 This Express Checkout This Express Checkout session has If you receive this error you session has expired expired Token value is no longer must return your buyer to valid PayPal to approve the use of PayPal again Display an error message to inform the buyer that the transaction expired and provide a button to return to PayPal In this situation you are effectively restarting the entire checkout process Do not reuse the expired token value on SetExpressCheckout request However because you already know the final OrderTotal be sure to update the value for that element if appropriate You might also want to update the values for ReturnURL and CancelURL if necessary 10412
344. se field 109 PAYMENTINFO_n PAYMENTSTATUS response field 110 PAYMENTINFO_n PAYMENTTYPE response field 108 PAYMENTINFO_n PENDINGREASON response field 111 PAYMENTINFO n PROTECTIONELIGIBILITY response field 112 PAYMENTINFO_n PROTECTIONELIGIBILITYTYP E response field 113 PAYMENTINFO_n REASONCODE response field 112 PAYMENTINFO_n TAXAMT response field 109 August 2012 303 304 Index PAYMENTINFO_n TRANSACTIONID response field 108 109 PAYMENTINFO_n TRANSACTIONTYPE response field 108 PaymentltemType response fields 130 PaymentPeriod Amount request field 140 PaymentReason request field 65 172 PAYMENTREQUEST_n ACK response field 91 115 PAYMENTREQUEST n ADDRESSSTATUS response field 82 PAYMENTREQUEST_ n AL LOWE DPAYMENTMETHOD response field 86 PAYMENTREQUEST n ALLOWEDPA YMENTMETHOD request field 98 PAYMENTREQUEST_n ALLOWEDPAYMENTMET HOD request field 70 PAYMENTREQUEST_n_AMT request field 67 94 PAYMENTREQUEST n AMT response field 83 PAYMENTREQUEST_ n CURRENCYCODE request field 67 94 PAYMENTREQUEST_n CURRENCYCODE response field 83 PAYMENTREQUEST_n CUSTOM request field 69 97 PAYMENTREQUEST_n CUSTOM response field 85 PAYMENTREQUEST_n_DESC request field 69 PAYMENTREQUEST_n_ DESC response field 85 PAYMENTREQUEST _n ERRORCODE response field 91 115 PAYMENTREQUEST_n HANDLINGAMT request field 69 96 PAYMENTREQUEST_ n HANDLINGAMT response field 85 PAYMENTREQUEST n INSURANCEAMT reques
345. sed to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 DoAuthorization Response Message DoAuthorization Response Fields Field Description TRANSACTIONID Authorization identification number AMT Amount you specified in the request Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma MSGSUBID Optional A message ID used for idempotence to uniquely identify a message This ID can later be used to request the latest results for a previous request without generating a new request Examples of this include requests due to timeouts or errors during the original request Character length and limitations string of up to 38 single byte characters This field is available since version 92 0 Name Value Pair API Developer Guide August 2012 33 Authorization and Capture API Operation Reference DoAuthorization API Operation AuthorizationInfo Fields Field Description PAYMENTSTATUS Status of the payment It is one of the following values e None No status e C
346. separator must be a period and the optional thousands separator must be a comma HANDLINGAMT is deprecated since version 63 0 Use PAYMENTREQUEST 0 HANDLINGAMT instead Optional Sum of tax for all items in this order You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only NOTE PAYMENTREQUEST_n_TAXAMT is required if you specify L_PAYMENTREQUEST n_ TAXAMTm Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TAXAMT is deprecated since version 63 0 Use PAYMENTREQUEST_0 TAXAMT instead Optional Description of items the buyer is purchasing You can specify up to 10 payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only NOTE The value you specify is available only 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 alphanumeric characters DESC is deprecated since version 63 0 Use PAYMENTREQUEST_ 0 DESC instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE DoExpre
347. sic authorization subject to settlement with PayPal Authorization and Capture e Order This payment is an order authorization subject to settlement with PayPal Authorization and Capture NOTE You cannot set this field to Sale in SetExpressCheckout request and then change the value to Authorization or Order in the DoExpressCheckout Payment request If you set the field to Authorization or Order in SetExpressCheckout you may set the field to Sale Character length and limitations Up to 13 single byte alphabetic characters PAYMENTACTION is deprecated since version 63 0 Use PAYMENTREQUEST 0 PAYMENTACTION instead A unique identifier of the specific payment request Required when implementing parallel payments You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations Up to 127 single byte characters PAYMENTREQUESTID is deprecated since version 63 0 Use PAYMENTREQUEST 0 PAYMENTREQUESTID instead August 2012 Name Value Pair API Developer Guide Address Fields ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTREQUEST N SHIPTONAM E SHIPTONAME deprecated PAYMENTREQUEST N SHIPTOSTR EET SHIPTOSTREET deprecated PAYMENTREQUEST N SHIPTOSTR EET2 SHIPTOSTREET2 deprecated PAYMENTREQUEST N SHIPTOCIT Y SHIPTOCITY deprecated PAYMENTREQUEST nN SHIPTOSTA TE SHIPTOSTATE deprecated PAYMENTREQUEST
348. sion 63 0 Use PAYMENTINFO n EXPECTEDECHECKCLEARDATE instead Shipping method selected by the user during check out SHIPPINGMETHOD is deprecated since version 63 0 Use PAYMENTINFO n SHIPPINGMETHOD instead This field holds the category of the instrument only when it is promotional Return value 1 represents BML Code used to identify the promotion offer Name Value Pair API Developer Guide August 2012 107 6 ExpressCheckout API Operations DoExpressCheckoutPayment API Operation Field Description PAYMENTINFO n OFFER TRACKINGID Unique identification for merchant buyer offer combo Payment Information Fields When implementing parallel payments up to 10 payment information type sets of payment information type parameter fields can be returned each representing one payment you are hosting on your marketplace Field Description PAYMENTINFO N TRANS ACTIONID TRANSACTIONID deprecated PAYMENTINFO_n TRANS ACTIONTYPE TRANSACTIONTYPE deprecated PAYMENTINFO n PAYME NTTYPE PAYMENTTYPE deprecated Unique transaction ID of the payment Unique transaction ID of the payment You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Store this number for tracking the order It represents an order placeholder in the PayPal system for a subsequent authorization by UATP NOTE Ifthe PaymentAction of the request was Authorization or Order this value is your Authorizat
349. sive and m specifies the list item within the payment L_FMFfilterIDn is deprecated since version 63 0 Use L _PAYMENTINFO_n FMFfilterlDn instead Filter name including the filter type PENDING REPORT or DENY the filter NAME and the entry number m starting from 0 Filter name including the filter type PENDING REPORT or DENY the filter NAME and the entry number m starting from 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 L_FMFfilterNAMEN is deprecated since version 63 0 Use L PAYMENTINFO_n FMFfilterNAMEN instead ns InstrumentDetailsType Promotional instrument information This field is introduced in API version 71 0 ns OfferDetailsType Specific information for an offer This field is introduced in API version 71 0 114 August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE DoExpressCheckoutPayment API Operation Payment Error Type Fields Field Description PAYMENTREQUEST_n SH ORTMESSAGE PAYMENTREQUEST n LO NGMESSAGE PAYMENTREQUEST n_ ER RORCODE PAYMENTREQUEST n_ SE VERITYCODE PAYMENTREQUEST n AC xs string Payment error short message You can specify up to 10 payments where n is a digit between 0 and 9 inclusive xs string Payment error long message You can specify up to 10 payments where n is a digit between 0 and 9 inclusive xs string Payme
350. sk Control Country Filter Failure Risk Control Max Amount Failure Payment declined by your Risk Controls settings PayPal Risk Model Shipping Address Country Error Shipping Address Empty This transaction cannot be processed at this time Please try again later A confirmed email is required to make this API call This transaction cannot be processed The country code in the shipping address must match the buyer s country of residence PaymentAction of Authorization is not allowed with Unilateral and Non Credentialed authentication This transaction couldn t be completed Please redirect your customer to PayPal PaymentAction of Order is not allowed with Unilateral and Non Credentialed authentication The transaction was refused because the country was prohibited as a result of your Country Monitor Risk Control Settings The transaction was refused because the maximum amount was excceeded as a result of your Maximum Amount 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 buyer selects the country of residence when they sign up for their PayPal account The country of residence displays after the dash in the title on the Account Overview page Redirect the buyer back to PayPal using the original token so that the customer can use or add a new f
351. son other than those listed above For more information contact PayPal Customer Service NOTE PendingReason is returned in the response only if Payment Status is Pending PROTECTIONELIGIBILITY Prior to version 64 4 the kind of seller protection in force for the transaction It is one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment and Item Not Received e PartiallyEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Merchant is not protected under the Seller Protection Policy Name Value Pair API Developer Guide August 2012 35 36 Authorization and Capture API Operation Reference DoReauthorization API Operation Field Description PROTECTIONELIGIBILITY Since version 64 4 the kind of seller protection in force for the transaction It is TYPE one of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNotReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is available since version 64 4 DoReauthorization API Operation DoReaut
352. specified Message specified in MSGSUBID parameter is time Submission ID a duplicate result parameters of the original request are attached 11996 Use Adaptive Payment To do a refund on an Adaptive Payment Refund API transaction please use the Adaptive Payment Refund API 12302 Dispute Refund Not This transaction already has a PayPal Allowed dispute filed 13513 Duplicate request for The specified Invoice ID is a duplicate specified Invoice ID 13531 Funding source provided The funding source provided for this for this operation is not operation is not supported Please supported provide a valid value 13601 Refund cannot exceed the Refunds to users without PayPal transaction amount accounts cannot exceed the transaction amount 13602 Insufficient funds Refund failed due to insufficient funds in your PayPal account Name Value Pair API Developer Guide August 2012 241 API Error Codes MassPay API Errors MassPay API Errors MassPay API Errors Error Code Short Message Long Message 10001 10001 10001 10001 10001 10002 10004 10004 10004 10004 10004 10004 Invalid account number Internal Error Internal Error ButtonSource value truncated Transaction refused because of an invalid argument See additional error messages for details Account locked Transaction refused because of an invalid argument See additional error messages for details Transaction refused b
353. sponse field 114 L _PAYMENTINFO_n FMFfilterNAMEm response field 114 L_PAYMENTRE QUEST_n ITEMWEIGHTVALUEm response field 88 Index L PAYMENTREQUESST n EBAYITEMAUCTIONT XNIDm request field 75 103 L PAYMENTREQUEST_n_AMTHm request field 72 100 145 287 290 L_PAYMENTREQUEST_ n AMTm response field 87 L PAYMENTREQUEST_n DESCm request field 72 100 144 287 290 L PAYMENTREQUEST_n_DESCm response field 87 L PAYMENTREQUEST_n EBAYCARTIDm request field 75 104 L PAYMENTREQUEST_n EBAYITEMAUCTIONT XNIDm response field 90 L PAYMENTREQUEST_n EBAYITEMCARTIDm response field 90 L PAYMENTREQUEST_n EBAYITEMNUMBERm request field 75 103 L PAYMENTREQUEST_n EBAYITEMNUMBERm response field 89 L PAYMENTREQUEST_n EBAYITEMORDERIDm request field 75 103 L PAYMENTREQUEST_n EBAYITEMORDERIDm response field 90 L PAYMENTREQUEST_n ITEMCATEGORYm request field 74 103 144 287 L PAYMENTREQUEST_n ITEMCATEGORYm response field 89 L PAYMENTREQUEST_n ITEMHEIGHTUNITm request field 74 102 L PAYMENTREQUEST_n ITEMHEIGHTUNITm response field 89 L PAYMENTREQUEST_n ITEMHEIGHTVALUEm request field 74 102 L PAYMENTREQUEST_n ITEMHEIGHTVALUEm response field 89 L PAYMENTREQUEST_n ITEMLENGTHUNITm request field 73 102 L PAYMENTREQUEST_n ITEMLENGTHUNITm response field 88 L PAYMENTREQUEST_n ITEMLENGTHVALUEm requ est field 73 102 L PAYMENTREQUEST_n ITEMLENGTHVALUEm response field 88 L PAYMENTREQUEST_n ITEMURLm request field 74 102 L PAYMENTREQUEST_n ITEM
354. ss information on file at PayPal It is one of the following values e None The request value of the Street element was unmatched No comparison of the Zip element was made Matched The request value of the Zip element matches the zip code of the postal address on file for the PayPal member Unmatched The request value of the Zip element does not match the zip code of the postal address on file for the PayPal member Country code ISO 3166 on file for the PayPal email address Character length and limitations 2 single byte characters The token contains encrypted information about the member s email address and postal address If you pass the value of the token in the HTML variable address api_token of Buy Now buttons PayPal prevents the buyer from using an email address or postal address other than those that PayPal verified with this API call The token is valid for 24 hours Character length and limitations 94 single byte characters 26 August 2012 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference The Authorization and Capture API operations describe the PayPal API operations related to delayed payment settlement DoCapture API Operation Captures an authorized payment DoCapture Request Message DoCapture Request Fields Field Description METHOD Required Must be DoCapture AUTHORIZATIONID Required Authorization identification number of the payment you wan
355. ssCheckoutPayment API Operation Field Description PAYMENTREQUEST nN CUSTOM Optional A free form field for your own use You can specify up to 10 CUSTOM deprecated payments where n is a digit between 0 and 9 inclusive NOTE The value you specify is available only 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 256 single byte alphanumeric characters CUSTOM is deprecated since version 63 0 Use PAYMENTREQUEST_0 CUSTOM instead PAYMENTREQUEST_N INVNUM Optional Your own invoice or tracking number You can specify up to 10 INVNUM deprecated payments where n is a digit between 0 and 9 inclusive except for digital goods which supports single payments only NOTE The value you specify is available only 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 256 single byte alphanumeric characters INVNUM is deprecated since version 63 0 Use PAYMENTREQUEST_0_INVNUM instead PAYMENTREQUEST_n NOTIFYU Optional Your URL for receiving Instant Payment Notification IPN about RL this transaction If you do not specify this value in the request the notification NOTIFYURL deprecated URL from your Merchant Profile is used if one exists Optional Your URL for
356. st message 162 SetCustomerBillingA greement response message 165 SetExpressCheckout API operation 59 SetExpressCheckout request message 59 SetExpressCheckout response message 78 SETTLEAMT response field 109 126 181 SGD 275 276 Shegel 275 Ship To Address response fields 148 167 SHIPDISCAMT request field 44 Shipping Options request fields 76 SHIPPINGAMT reque st field 174 SHIPPINGAMT request field 44 51 68 95 157 159 SHIPPINGAMT response field 84 150 SHIPPINGCALCULATIONMODE response field 90 115 121 SHIPPINGDISCAMT r esponse field 84 August 2012 SHIPPINGDISCAMT request field 68 95 SHIPPINGOPTIONAMOUNT request field 104 SHIPPINGOPTIONAMOUNT response field 90 115 SHIPPINGOPTIONISDEFAULT request field 104 SHIPPINGOPTIONISDEFAULT response field 90 115 SHIPPINGOPTIONNAME request field 104 SHIPPINGOPTIONNAME response field 90 115 ShipTo Address request fields 47 66 99 141 157 172 ShipTo Address response fields 81 SHIPTOCITY request fie ld 57 SHIPTOCITY request field 47 66 99 141 158 173 SHIPTOCITY response field 82 124 148 153 167 SHIPTOCOUNTRY request field 47 57 66 99 142 158 173 SHIPTOCOUNTRY response field 82 SHIPTOCOUNTRYCODE response field 125 148 153 167 SHIPTONAME request field 47 66 99 141 157 172 SHIPTONAME response field 81 124 148 153 167 SHIPTOPHONENUM request field 43 47 54 67 100 142 144 158 161 173 178 SHIPTOPHONENUM response field 82 125
357. stal Code Empty Code is required code 10731 Shipping Address Country The field Shipping Address Country code is empty in Empty Country is required shipping address 10736 Shipping Address Invalid A match of the Shipping Address Match of shipping address city City State Postal Code City State and Postal Code failed state and postal code failed 10747 Invalid Data This transaction cannot be IPAddress field is invalid processed without a valid IP address 10748 Invalid Data This transaction cannot be CVV2 field is missing processed without a Credit Card Verification number 10755 Unsupported Currency This transaction cannot be processed due to an unsupported currency 11084 User does not have a good User does not have a good funding Scenario The credit card funding source with which source with which to pay associated with the account to pay could not be used and there is no other funding source with which to complete the transaction 11091 The transaction was The transaction was blocked as it The transaction was declined by blocked as it would exceed would exceed the sending limit for PayPal Please have the buyer the sending limit for this this buyer contact PayPal Customer buyer Service 11302 Cannot pay self The transaction was refused Cannot pay self Merchant is because you cannot send money to referencing own transaction yourself 11451 Billing Agreement Id or Billing Agreement Id or Invalid reference id transacti
358. stom annotation field for your own use pale NOTE For recurring payments this field is ignored Character length and limitations 256 single byte alphanumeric bytes Name Value Pair API Developer Guide August 2012 77 6 ExpressCheckout API Operations GetExpressCheckoutDetails API Operation Tax Id Details Type Fields Field Description TAXIDTYPE Buyer s tax ID type This field is required for Brazil and used for Brazil only For Brazil use only The tax ID type is BR_CPF for individuals and BR_CNPJ for businesses This field is introduced in API version 72 0 TAXIDDETAILS Buyer s tax ID This field is required for Brazil and used for Brazil only For Brazil use only The tax ID is 11 single byte characters for individuals and 14 single byte characters for businesses This field is introduced in API version 72 0 SetExpressCheckout Response Message SetExpressCheckout Response Fields Field Description TOKEN A timestamped token by which you identify to PayPal that you are processing this payment with Express Checkout The token expires after three hours If you set the token in the SetExpressCheckout request the value of the token in the response is identical to the value in the request Character length and limitations 20 single byte characters GetExpressCheckoutDetails API Operation The GetExpressCheckoutDetails API operation obtains information about an Express Checkout transaction GetExp
359. t PayPal creates a single billing agreement for all transactions associated with buyer Use this value unless you need per transaction billing agreements You must specify version 58 0 or higher to use this option Other defined values are not valid L_BILLINGAGREEMENTD Description of goods or services associated with the billing agreement This field is ESCRIPTIONN required for each recurring payment billing agreement PayPal recommends that the description contain a brief summary of the billing agreement terms and conditions For example buyer is billed at 9 99 per month for 2 years Character length and limitations 127 single byte alphanumeric characters L_PAYMENTTYPEN Optional Type of PayPal payment you require for the billing agreement It is one of the following values e Any e InstantOnly NOTE For recurring payments this field is ignored L BILLINGAGREEMENTC Optional Custom annotation field for your own use vee NOTE For recurring payments this field is ignored Character length and limitations 256 single byte alphanumeric bytes SetCustomerBillingAgreement Response Message SetCustomerBillingAgreement Response Fields Field Description TOKEN A unique time stamped token which uniquely identifies this transaction in subsequent API calls NOTE The token expires after 3 hours Character length and limitations 20 single byte characters Name Value Pair API Developer Guide August 2012 165 1
360. t It is not OK to have no default Internal name of the shipping option such as Air Ground Expedited and so forth This field is required if you specify the Callback URL Character length and limitations 50 character string Amount of the flat rate shipping option This field is required if you specify the Callback URL Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma The gift message the buyer entered on the PayPal pages Limitations 100 single byte characters Indicates whether a gift receipt widget is enabled on the PayPal pages It is one of the following values e 0 Do not enable gift receipt widget e 1 Enable gift receipt widget Label for the gift wrap option such as Blue box with ribbon Limitations 25 single byte characters Amount to be charged to the buyer for the gift wrap Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma The email address the buyer entered on the PayPal pages to be notified of promotions or special events Limitations 127 single byte
361. t 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 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 The amount is not a valid number The amount exceeds the max limit of a single mass pay item l The amount is less than or equal to zero The unique id string length exceeds the maximum limit of 30 characters The unique id string contains a space as a character The transaction id is not valid 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 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 p
362. t field 68 95 PAYMENTREQUEST n INSURANCEAMT response field 84 PAYMENTREQUEST_n INSURANCEOPTIONOFFE RED request field 68 96 PAYMENTREQUEST_n_INVNUM request field 70 97 PAYMENTREQUEST_n INVNUM response field 86 PAYMENTREQUEST_n ITEMAMT request field 67 95 289 PAYMENTREQUEST_n ITEMAMT respo nse field 83 PAYMENTREQUEST_n LONGMESSAGE response field 91 115 PAYMENTREQUEST_n NOTETEXT request field 70 97 August 2012 PAYMENTREQUEST_ n NOTETEXT response field 86 PAYMENTREQUEST_n NOTIFYURL request field 70 97 PAYMENTREQUEST_n NOTIFYURL response field 86 PAYMENTREQUEST_n PAYMENTACTION request field 71 98 289 PAYMENTREQUEST_n PAYMENTREQUESTID request field 71 98 PAYMENTREQUEST_n PAYMENTREQUESTID response field 87 91 113 PAYMENTREQUEST_n SECUREME R CHANTACCOUNT ID response field 116 PAYMENTREQUEST_n SELLERID request field 104 PAYMENTREQUEST_n SELLERPAYPALACCOUN TID request field 74 PAYMENTREQUEST_n SELLERPAYPALACCOUN TID response field 91 116 PAYMENTREQUEST_n SELLERREGISTRATIOND ATE request field 105 PAYMENTREQUEST_n SELLERUSERNAME request field 105 PAYMENTREQUEST_n SEVERITYCODE response field 91 115 PAYMENTREQUEST_n SHIPDISCAMT request field 68 95 PAYMENTREQUEST_n SHIPDISCAMT response field 84 PAYMENTREQUEST_n SHIPPINGAMT request field 68 95 PAYMENTREQUEST_n SHIPPINGAMT response field 84 PAYMENTREQUEST_n SHIPTOCITY request field 66 99 PAYMENTREQUEST_n SHIPTOCITY respo
363. t Error Code o 285 Whats New in Version 72 0 286 New TaxldDetailsType Structure in SetExpressCheckout Request 286 New TaxldDetailsType Structure in GetExpressCheckoutDetails Response 286 Whats New in Version 69 287 New PaymentDetailsltemType Structure in CreateRecurringPaymentsProfile Request 287 Changes to PaymentDetailsltemType in DoReferenceTransaction Request 288 Whats New in Version 66 a 289 Changes to PaymentDetailsType in SetExpressCheckout and DoExpressCheckoutPayment Requests 0 e 2 289 Changes to PaymentDetailsltemTypein SetExpressCheckout and DoExpressCheckoutPayment Requests 2 2 e 289 Changes to PaymentDetailsltemType in GetExpressCheckoutDetails Response 291 Revision History ee a 293 Index 6 ee ee si a e a a ROL Name Value Pair API Developer Guide August 2012 9 fon Contents 10 August 2012 Name Value Pair API Developer Guide What s New What s New in Version 93 0 Maintenance release New 10486 error code added for redirects when the process declines the transaction The transaction couldn t be completed Please redirect your customer to PayPal Name Value Pair API Developer Guide August 2012 11 al What s New in Version 93 0 12 August 2012 Name Value Pair API Developer Guide Preface About This Guide The Name Value Pa
364. t be one of Day Week Month SemiMonth or Year 11519 Invalid amount Bill amount must be greater than 0 11520 Invalid currency for amount This currency is currently not Currency must be USD supported for amount 11521 Invalid shipping amount Shipping amount must be gt 0 11522 Invalid currency for This currency is currently not Currency must be USD shipping amount supported for shipping amount 11523 Invalid tax amount Tax amount must be gt 0 11524 Invalid currency for tax This currency is currently not Currency must be USD amount supported for tax amount 11531 Invalid profile status The profile status must be one of A ctive C ancelled or e X pired August 2012 Name Value Pair API Developer Guide API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 11543 Invalid payer country The payer s country is currently not supported 11544 Invalid period status The trial period status must be one of A ctive or C ancelled 11545 Denied Payer s account is denied 11546 Denied Merchant account is denied 11547 This feature is not available Recurring payments feature is not at this time currently available try again later 11548 Invalid currency code Invalid currency code all currency codes much match 11549 Start Date is required Subscription start date is required 11550 Start Date should be valid Subscription start date should be valid 11551 Profile ID is missing from Profile I
365. t be the same as the username In the case of eBay it is different Character length and limitations 255 single byte characters Name Value Pair API Developer Guide August 2012 75 76 ExpressCheckout API Operations SetExpressCheckout API Operation Field Description BUYERUSERNAME xs string Optional The user name of the user at the marketplaces site BUYERREGISTRATIONDA xs dateTime TE Optional Date when the user registered with the marketplace Character length and limitations Date and time are in UTC GMTformat for example 2011 06 24T05 38 48Z FundingSourceDetails Type Fields Field Description ALLOWPUSHFUNDING Optional Indicates whether the merchant can accept push funding It is one of the following values e 0 Merchant can accept push funding e 1 Merchant cannot accept push funding NOTE This field overrides the setting in the merchant s PayPal account Shipping Options Type Fields Field Description L SHIPPINGOPTIONISDEF AULTN L_SHIPPINGOPTIONNAMEN L_SHIPPINGOPTIONAMOUN Tn Default shipping optio displayed on the PayPal pages This field is required if you specify the Callback URL It is one of the following values e true This is the default flat rate shipping option PayPal displays this option and its amount by default e false This flat rate shipping option and its amount are not displayed as the default NOTE There must be ONE and ONLY ONE de
366. t field 62 163 PAL response field 119 PARENTTRANSACTIONID re sponse field 125 180 PAY MENTREQUEST_n_DESC request field 96 Payer Information request fields 42 53 143 160 177 Payer Information response fields 80 123 152 166 169 Name Value Pair API Developer Guide Payer Name request fields 53 143 191 Payer Name response fields 81 124 167 169 PAYERBUSINESS response field 123 166 169 PAYERID req uest field 143 PAYERID request field 93 PAYERID response field 80 123 166 169 PAYERSTATUS request field 143 PAYERSTATUS response field 80 123 166 169 PAYFLOWCOLOR request field 63 164 PAYME NREQUEST_n INSURANCEOPTIONOFFERE D response field 84 Payment Details Item request fields 46 71 100 144 175 287 288 290 Payment Details Item response fields 87 Payment Details request fields 43 67 94 173 Payment Details response fields 83 Payment Error Type response fields 91 115 Payment Information response fields 108 125 179 Payment Item Information response fields 129 Payment Request Info Type response fields 91 PAYMENTACTION reque st field 63 PAYMENTACTION request field 41 71 93 98 171 289 PAYMENTINFO_n_AMT response field 109 PAYMENTINFO n CURRENCYCODE response field 109 PAYMENTINFO_n EBAYITEMAUCTIONTXNID response field 113 PAYMENTINFO n EXCHANGERATE response field 110 PAYMENTINFO_n FEEAMT response field 109 PAYMENTINFO_n HOLDDECISION response field 112 PAYMENTINFO_n ORDERTIME respon
367. t fields 156 pdate Recurring Payments Profile response fields 161 pdateRecurringPaymentsProfile API operation 156 pdateRecurringPaymentsProfile request message 156 pdateRecurringPaymentsProfile response message 161 RL encoding 20 SD 276 User Selected Options response fields 90 115 Goq ad Ee E V Visa AVS response codes 277 Visa CVV2 response codes 279 VPAS response field 50 X XID request field 48 Y Yen 275 276 Z ZIP request field 25 43 54 144 161 178 ZIPMATCH response field 26 Zloty 275 276 August 2012 307 308 August 2012 Name Value Pair API Developer Guide
368. t to capture This is the transaction ID returned from DoExpressCheckout Payment DoDirect Payment or CheckOut For point of sale transactions this is the transaction ID returned by the CheckOut call when the payment action is Authorization Character length and limitations 19 single byte characters maximum AMT Required Amount to capture Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma CURRENCY CODE Optional A 3 character currency code default is USD COMPLETETYPE Required Indicates whether or not this is your last capture It is one of the following values e Complete This is the last capture you intend to make e NotComplete You intend to make additional captures NOTE If Complete any remaining amount of the original authorized transaction is automatically voided and all remaining open authorizations are voided Name Value Pair API Developer Guide August 2012 27 28 Authorization and Capture API Operation Reference DoCapture API Operation Field Description INVNUM NOTE SOFTDESCRIPTOR MSGSUBID Optional Your invoice number or other identification number that is displayed to you and to the buyer in their transaction history The value is recorded only if the auth
369. tails on the codes see https merchant paypal com us cgi bin amp cmd _render content amp content_ID merchant cc_compliance_error_codes Related information AVS Response Codes AVS Response Codes for Visa MasterCard Discover and American Express AVS Response Codes for Maestro Name Value Pair API Developer Guide August 2012 49 4 DoDirectPayment API Operation DoDirectPayment Response Message ThreeDSecure Response Fields Field Description VPAS Visa Payer Authentication Service status The value indicates whether Verified by Visa confirms that the information received is acceptable It is eturned only for Verified by Visa transactions Authentication e Good result 2 or D e Bad result 1 Attempted authentication e Good result 3 6 8 A or C e Bad result 4 7 or 9 No liability shift Blank 0 or B ECISUBMITTED3DS Electronic Commerce Indicator ECI that PayPal submitted with the payment authorisation request This might not be the same value received from the merchant In rare cases PayPal is required to use a different ECI for authorisation based on the full set of 3 D Secure values provided from the cmpi_authenticate request MasterCard e 01 Merchant Liability e 02 Issuer Liability Visa e 05 Issuer Liability e 06 Issuer Liability e 07 Merchant Liability 50 August 2012 Name Value Pair API Developer Guide DoNonReferencedCredit API Operation The
370. ted and the funds have been added successfully to your account balance e 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 e Failed The payment has failed This happens only if the payment was made from the buyer s bank account In Progress The transaction has not terminated For example 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 e Refunded You refunded the payment Reversed A payment was reversed due to a chargeback or other type of reversal PayPal removes the funds from your account balance and returns them to the buyer The ReasonCode element specifies the reason for the reversal Processed A payment has been accepted e Voided An authorization for this transaction has been voided Name Value Pair API Developer Guide August 2012 37 Authorization and Capture API Operation Reference DoReauthorization API Operation Field Description PEND INGREASON Reason the payment is pending It is one of the following values e none No pending reason e address The payment is pending because your customer did not include a confirmed shipping address and your Payment Receivi
371. tem calculation mismatch The regular non trial billing period amount is different than the sum of the amounts for each item in the cart Tax calculation mismatch The tax amount for the regular non trial billing period is different than the sum of the tax for each item in the cart Scenario Merchant passes item category as either Digital or Physical but does not also pass one of the following parameters name amount or quantity Scenario Merchant is not signed up for digital goods but passes item category as Digital Scenario When the regular non trial billing period amount is different than the sum of the amounts for each item in the cart Scenario When the regular non trial billing period is different than the sum of the tax for each item in the cart Name Value Pair API Developer Guide August 2012 255 256 API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10004 Transaction refused Invalid payment type argument because of an invalid argument See additional error messages for details 10009 Transaction refused The account for the counterparty is Merchant is locked or inactive locked close restricted 10010 Invalid Invoice Non ASCII invoice id is not Non ASCII characters are used supported in InvoicelD field 10201 Agreement canceled Billing Agreement was cancelled Billing agreement is not active 10202 Exceed max Transaction
372. ter 81219 Invalid Parameter ItemAmt Invalid parameter 81220 Invalid Parameter ShippingAmt Invalid parameter 81221 Invalid Parameter HandlingTotal Amt Invalid parameter 81222 Invalid Parameter TaxAmt Invalid parameter 81223 Invalid Parameter IPAddress Invalid parameter 81224 Invalid Parameter ShipToName Invalid parameter 81225 Invalid Parameter L_Amt Invalid parameter 81226 Invalid Parameter Amt Invalid parameter 81227 Invalid Parameter L_TaxAmt Invalid parameter 81229 Invalid Parameter CompleteType Invalid parameter 81230 Invalid Parameter CurrencyCode Invalid parameter August 2012 Name Value Pair API Developer Guide API Error Codes ES DirectPayment API Errors Error Code Short Message Long Message 81232 81234 81235 81236 81237 81238 81239 81243 81244 81245 81247 81248 81249 81250 81251 99998 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 Internal Error TransactionEntity Invalid parameter ExpDate Invalid parameter FirstName Invalid parameter LastName Invalid parameter Street Invalid parameter Street2 Invalid parameter City Invalid parameter RefundType Invalid parameter StartDate Invalid parameter EndDate Invalid parameter CreditCardType Inv
373. the payment page By default the color is white Character length and limitations 6 character HTML hexadecimal ASCII color code PAYMENTACTION Optional How you want to obtain payment If the transaction does not include a deprecated one time purchase this field is ignored It is one of the following values e Sale This is a final sale for which you are requesting payment default e Authorization This payment is a basic authorization subject to settlement with PayPal Authorization and Capture e Order This payment is an order authorization subject to settlement with PayPal Authorization and Capture NOTE You cannot set this field to Sale in SetExpressCheckout request and then change this value to Authorization or Order in the DoExpressCheckout Payment request If you set the field to Authorization or Order in SetExpressCheckout you may set the field to Sale Character length and limitations Up to 13 single byte alphabetic characters This field is deprecated Use PAYMENTREQUEST_0 PAYMENTACTION instead EMAIL Optional Email address of the buyer as entered during checkout PayPal uses this value to pre fill the PayPal membership sign up portion on the PayPal pages Character length and limitations 127 single byte alphanumeric characters SOLUTIONTYPE Optional Type of checkout flow It is one of the following values e Sole Buyer does not need to create a PayPal account to check out This is referred to as PayPal Accou
374. thorization is DoAuthorization Warning being processed 11094 This This authorization can authorization only be handled through cannot be the marketplace which voided created it It cannot reauthorized or directly be voided capturedagainst reauthorized or captured against 13122 Transaction Transaction violates DoCapture refused PayPal use August 2012 Name Value Pair API Developer Guide API Error Codes GetTransactionDetails API Errors GetTransactionDetails API Errors GetTransactionDetails API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10004 Transaction refused because of an Store ID is required if Terminal ID is specified invalid argument See additional error messages for details TransactionSearch API Errors TransactionSearch API Errors Error Code Short Message Long Message 10001 Internal Error Internal Error 10001 ButtonSource value The transaction could not be loaded truncated 10003 Transaction refused because Start date is a required parameter of an invalid argument See additional error messages for details 10004 Transaction refused because Start date is invalid of an invalid argument See additional error messages for details 10004 Transaction refused because End date is invalid of an invalid argument See additional error messages for details 10004 Transaction refused because Currency is not supported of an invalid
375. ticipated data causes an error NOTE An HTTP form is automatically URL encoded by most browsers For example consider the following NVP string NAME Robert MooresCOMPANY R H Moore amp Associates It is encoded as follows NAME Robert Moore amp COMPANY R H Moore 26 Associates Use the following methods to URL encode or URL decode your NVP strings Encoding and decoding methods for URLs Language Method ASP NET Encode System Web HttpUtility UrlEncode buffer Encoding Default Decode System Web HttpUtility UrlDecode buffer Encoding Default Classic ASP Encode Server URLEncode Decode No built in function Several implementation examples are available on the Internet Java Encode java net URLEncoder encode Decode java net URLDecoder decode August 2012 Name Value Pair API Developer Guide PayPal Name Value Pair API Basics Executing NVP API Operations Language Method PHP Encode urlencode Decode urldecode ColdFusion Encode URLEncodedFormatstring charset Decode URLDecodeurlEncodedString charset Related information URL Decoding List Syntax for Name Value Pairs The PayPal API uses a special syntax for NVP fields defined as lists The NVP interface to the PayPal API requires a unique name for each field In the API lists are prefixed by L_ To identify an element within the list use the offset from the beginning of the list starting with 0 as the first element For
376. tion in force for the transaction It is one TYTYPE of the following values e Eligible Merchant is protected by PayPal s Seller Protection Policy for both Unauthorized Payment and Item Not Received e ItemNotReceivedEligible Merchant is protected by PayPal s Seller Protection Policy for Item Not Received e UnauthorizedPaymentEligible Merchant is protected by PayPal s Seller Protection Policy for Unauthorized Payment e Ineligible Merchant is not protected under the Seller Protection Policy This field is introduced in API version 64 4 STOREID xs string Storeld as entered in the transaction TERMINALID xs string Terminalld as entered in the transaction Payment Item Information Fields Field Description INVNUM Invoice number you set in the original transaction Character length and limitations 256 single byte alphanumeric characters CUSTOM Custom field you set in the original transaction Character length and limitations 127 single byte alphanumeric characters NOTE Memo entered by your customer in PayPal Website Payments note field Character length and limitations 255 single byte alphanumeric characters SALESTAX Amount of tax charged on payment Name Value Pair API Developer Guide August 2012 129 130 GetTransactionDetails API Operation GetTransactionDetails Response Message Payment Item Fields Field Description EbayItemTxnId L_EBAYTTEMTXNID L_DESCn L_NUMBERN L QTYN
377. tional Unavailable Not applicable Address Address and Postal Code No None NOTE The transaction is declined P Postal International Z Postal Code only no Address R Retry Not applicable S Service not Supported Not applicable Unavailable Not applicable Whole ZIP Nine digit ZIP code no Address Name Value Pair API Developer Guide August 2012 277 AVS and CVV2 Response Codes AVS Response Codes AVS Code Meaning Matched Details X Exact match Address and nine digit ZIP code Y Yes Address and five digit ZIP Z ZIP Five digit ZIP code no Address All others Error Not applicable Related information DoDirectPayment Response Fields AVS Response Codes for Maestro AVS Code Meaning Matched Details 0 All the address information matched All information matched 1 None of the address information None matched NOTE The transaction is declined 2 Part of the address information Partial matched 3 The merchant did not provide AVS Not applicable information Not processed 4 Address not checked or acquirer had Not applicable no response Service not available Null No AVS response was obtained Not applicable Default value of field Related information DoDirectPayment Response Fields 278 August 2012 Name Value Pair API Developer Guide AVS and CVV2 Response Codes CVV2 Response Codes CVV2 Response Codes CVV2 Response Codes for Visa MasterCard Discover and American Match
378. tional thousands separator must be a comma Optional Shipping discount for this order specified as a negative number Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Total handling costs for this order NOTE If you specify a value for HANDLINGAMT you must also specify a value for ITEMAMT Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Optional Sum of tax for all items in this order NOTE TAXAMT is required if you specify L_TAXAMTN Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma 44 August 2012 Name Value Pair API Developer Guide DoDirectPayment API Operation ES DoDirectPayment Request Message Field Description DESC Optional Description of items the buyer is purchasing NOTE The value you specify is available only if the tran
379. tor must be a comma Equivalent to 9 characters maximum for USD FEEAMT PayPal fee amount charged for the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Equivalent to 9 characters maximum for USD 30 August 2012 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference DoCapture API Operation Field Description SETTLEAMT TAXAMT EXCHANGERATE PAYMENTSTATUS Amount deposited in your PayPal account after a currency conversion Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Equivalent to 9 characters maximum for USD Tax charged on the transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma Equivalent to 9 characters maximum for USD Exchange rate if a currency conversion occurred Relevant only if your
380. type EXPDATE Credit card expiration date This field is required if you are using recurring payments with direct payments Character length and limitations 6 single byte alphanumeric characters including leading zero in the format MMYYYY STARTDATE Month and year that Maestro card was issued Character length and limitations Must be 6 digits including leading zero in the format MMYYYY ISSUENUMBER Issue number of Maestro card Character length and limitations 2 numeric digits Payer Info Fields Field Description EMAIL Email address of buyer Character length and limitations 127 single byte characters FIRSTNAME Buyer s first name Character length and limitations 25 single byte characters LASTNAME Buyer s last name Character length and limitations 25 single byte characters 152 August 2012 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Operation Address Fields Field Description ADDRESSOWNER eBay company that maintains this address It is one of the following values e eBay e PayPal ADDRESSSTATUS Status of street address on file with PayPal It is one of the following values e none e Confirmed e Unconfirmed SHIPTONAME Person s name associated with this address Character length and limitations 32 single byte characters SHIPTOSTREET First street address Character length and limitations 100 single byte characters SHI
381. ue Pair API Developer Guide Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API Operation PayerNameType Fields Field Description SALUTATION Buyer s salutation Character length and limitations 20 single byte characters FIRSTNAME Buyer s first name Character length and limitations 25 single byte characters MIDDLENAME Buyer s middle name Character length and limitations 25 single byte characters LASTNAME Buyer s last name Character length and limitations 25 single byte characters SUFFIX Buyer s suffix Character length and limitations 12 single byte characters Address Fields Field Description ADDRESSSTATUS Status of street address on file with PayPal It is one of the following values e none e Confirmed e Unconfirmed SHIPTONAME Person s name associated with this address Character length and limitations 32 single byte characters SHIPTOSTREET First street address Character length and limitations 100 single byte characters SHIPTOSTREET2 Second street address Character length and limitations 100 single byte characters SHIPTOCITY Name of city Character length and limitations 40 single byte characters SHIPTOSTATE State or province Required for U S addresses only Character length and limitations 40 single byte characters SHIPTOZIP U S ZIP code or other country specific postal code Character length and limitations 20 singl
382. uired if using a shipping address You can specify up to 10 payments where n is a digit between 0 and 9 inclusive Character length and limitations 2 single byte characters SHIPTOCOUNTRY is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOCOUNTRYCODE instead August 2012 Name Value Pair API Developer Guide ExpressCheckout API Operations CE SetExpressCheckout API Operation Field Description PAYMENTREQUEST N SHIPTOPHO Optional Phone number You can specify up to 10 payments where n is a NENUM digit between 0 and 9 inclusive SHIPTOPHONENUM deprecated Character length and limitations 20 single byte characters SHIPTOPHONENUM is deprecated since version 63 0 Use PAYMENTREQUEST 0 SHIPTOPHONENUM instead Payment Details Type Fields When implementing parallel payments you can create up to 10 sets of payment details type parameter fields each representing one payment you are hosting on your marketplace Field Description PAYMENTREQUEST n_ AMT AMT deprecated PAYMENTREQUEST NM CUR RENCYCODE CURRENCYCODE deprecated PAYMENTREQUEST n_ ITE MAMT ITEMAMT deprecated Required Total cost of the transaction to the buyer If shipping cost and tax charges are known include them in this value If not this value should be the current sub total of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases Set this f
383. unding instrument Name Value Pair API Developer Guide August 2012 229 230 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10728 Shipping Address City The field Shipping Address Empty City is required 10729 Shipping Address State The field Shipping Address Empty State is required 10730 Shipping Address Postal The field Shipping Address Code Empty Postal Code is required 10731 Shipping Address Country The field Shipping Address Empty Country is required 10736 Shipping Address Invalid A match of the Shipping City State Postal Code Address City State and Postal Code failed 11001 Exceeds maximum length Value of NoteText element is truncated 11610 Payment Pending your Payment Pending your review review in Fraud in Fraud Management Filters Management Filters 11611 Transaction blocked by Transaction blocked by your your settings in FMF settings in FMF 11612 Could not process your Could not process your request request to accept deny the to accept deny the transaction transaction 11820 Transaction refused Invalid Order URL because of an invalid argument See additional error messages for details Invalid shipping amount Invalid shipping amount it should equal the shipping amount of the selected shipping option Invalid shipping options Invalid shipping options you must specify a name and amount for each shipping option 11821 Invalid shipp
384. unt refunded to the original payer Say for example a buyer makes 100 purchase the buyer was refunded 20 a week ago and is refunded 30 in this transaction The gross refund amount is 30 in this transaction Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma NETREFUNDAMT Amount subtracted from PayPal balance of the original recipient of payment to make this refund Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma TOTALREFUNDEDAMT Total amount refunded so far from the original purchase Say for example a buyer makes 100 purchase the buyer was refunded 20 a week ago and is refunded 30 in this transaction The gross refund amount is 30 in this transaction The total refunded amount is 50 Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma This field is available since ve
385. ure in SetExpressCheckout Request TaxldDetailsType Fields Field Description TAXIDTYPE New field The buyer s tax ID type This field is required for Brazil and used for Brazil only For Brazil use only The tax ID type is BR_CPF for individuals and BR_CNPJ for businesses TAXID New field The buyer s tax ID This field is required for Brazil and used for Brazil only For Brazil use only The tax ID is 11 single byte character for individuals and 14 single byte characters for businesses New TaxldDetailsType Structure in GetExpressCheckoutDetails Response TaxldDetailsType Fields Field Description TAXIDTYPE New field The buyer s tax ID type This field is required for Brazil and used for Brazil only For Brazil use only The tax ID type is BR_CPF for individuals and BR_CNPJ for businesses TAXID New field The buyer s tax ID This field is required for Brazil and used for Brazil only For Brazil use only The tax ID is 11 single byte character for individuals and 14 single byte characters for businesses 286 August 2012 Name Value Pair API Developer Guide What s New in Version 69 fiona What s New in Version 69 New PaymentDetailsltemType Structure in CreateRecurringPaymentsProfile Request PaymentDetailsltemType Fields Field Description L PAYMENTREQUEST_n IT New field EMCATEGORYM Indicates whether the item is digital or physical goods For digital goods this field is
386. usive and m specifies the list item within the payment These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST N ITEMHEIGHTVALUEO L PAYMENTREQUEST N ITEMHEIGHTVALUE1 Character length and limitations Any positive integer L_ITEMHEIGHTVALUEN and L_ITEMHEIGHTUNITM are deprecated since version 63 0 Use L_PAYMENTREQUEST 0 ITEMHEIGHTVALUEM and L PAYMENTREQUEST 0 ITEMHEIGHTUNITN instead Optional URL for the 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 Nn ITEMURLO L PAYMENTREQUEST N ITEMURL1 L_ITEMURLN is deprecated since version 63 0 Use L_PAYMENTREQUEST 0 ITEMURLM instead Indicates whether an item is digital or physical For digital goods this field is required and must be set to Digital 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 except for digital goods which only supports single payments These parameters must be ordered sequentially beginning with 0 for example L_PAYMENTREQUEST n_ITEMCATEGORY0O L PAYMENTREQUEST_n ITEMCATEGORY1 It is one of the following values e Digital e Physical This field is available since version 65 1 Seller Details Type Fields Field Description PAYMENTREQUEST N SELL ERPA
387. vince It is required if using a shipping address Character length and limitations 40 single byte characters SHIPTOZIP U S ZIP code or other country specific postal code It is required if using a U S shipping address may be required for other countries Character length and limitations 20 single byte characters SHI PTOCOUNTRY Country code It is required if using a shipping address Character length and limitations 2 single byte characters SHIPTOPHONENUM Optional Phone number Character length and limitations 20 single byte characters Payment Details Fields Field Description AMT Required The total cost of the transaction to the buyer If shipping cost and tax charges are known include them in this value If not this value should be the current subtotal of the order If the transaction includes one or more one time purchases this field must be equal to the sum of the purchases Set this field to 0 if the transaction does not include a one time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged When the field is set to 0 purchase specific fields are ignored Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma CURRENCYCODE Optional A
388. which field is invalid 10722 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error city in the shipping address message tells you which field is invalid 10723 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error state in the shipping address message tells you which field is invalid 10724 Invalid Data There s an error with this There was a problem with a particular transaction Please enter your field in the address The long error five digit postal code in the message tells you which field is invalid shipping address 10725 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid field in the address The long error country in the shipping address message tells you which field is invalid 10726 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a field in the address The long error complete shipping address message tells you which field is invalid 10726 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a field in the address The long error complete shipping address message tells you which field is invalid 10727 Invalid Data There s an error with this There was a problem with a particula
389. would exceed user s Transaction would exceed the monthly maximum monthly limit 10203 Action required Transaction failed action required by user 10204 User s account is closed or User s account is closed or restricted restricted 10205 Risk Transaction refused due to risk model 10206 Duplicate Transaction was already processed 10207 Retry Transaction failed but user has Retry the transaction with an alternate funding source alternate funding source 10209 Disabled Preapproved Payments not Merchants is not enabled for enabled preapproved payments PAP applies only to legacy PAP billing agreements 10210 No Funding Transaction failed because has no Payee has no funding sources funding sources 10211 Invalid MP ID Invalid MP ID 10212 Profile preference setting A profile preference is set to A profile preference is set that automatically deny certain automatically denies this kind of transactions transaction 10213 Invalid Soft Descriptor The soft descriptor passed in contains invalid characters 10214 Soft descriptor format error 10215 Soft Descriptor truncated The soft descriptor was truncated 10216 Confirmed address required Transaction refused because a Transaction refused because a confirmed address is not available confirmed address is not available August 2012 Name Value Pair API Developer Guide API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional
390. yment 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 DoAuthorization API Operation Authorize a payment DoAuthorization Request Message DoAuthorization Request Fields Field Description METHOD Required Must be DoAuthorization TRANSACTIONID Required Value of the order s transaction identification number returned by PayPal Character length and limitations 19 single byte characters AMT Required Amount to authorize Character length and limitations Value is a positive number which cannot exceed 10 000 USD in any currency It includes no currency symbol It must have 2 decimal places the decimal separator must be a period and the optional thousands separator must be a comma August 2012 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference baw DoAuthorization API Operation Field Description TRANSACTIONENTITY Optional Type of transaction to authorize The only allowable value is Order which means that the transaction represents a buyer order that can be fulfilled over 29 days CURRENCY CODE Optional A 3 character currency code MSGSUBID Optional A message ID used for idempotence to uniquely identify a message This ID can later be u
391. your review in Fraud Management Filters Transaction blocked by your settings in FMF Could not process your request to accept deny the transaction Transaction violates PayPal Use Item Category value is invalid Only Digital or Physical are allowed This transaction cannot be processed Reference transaction is not associated with a billing agreement Reference id either not found or could not be decrypted 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 This error is not fatal and generates a warning The shipping address on file does not match the requested shipping address Scenario When merchant passes an item category value other than Digital or Physical This transaction cannot be processed without a Credit Card Verification number Name Value Pair API Developer Guide August 2012 261 262 API Error Codes AddressVerify API Errors AddressVerify API Errors AddressVerify API Errors Error Code Short Message Long Message 10004 10004 10004 10009 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

PayPal Name-Value Pair API - 2012 Developer's Guide

Contents

Download Pdf Manuals

Related Search

Related Contents