Home

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

1. L ITEMLENGTHVALUEn Optional Item length corresponds to the length of the item You can pass this data to L_ITEMLENGTHUNITn 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_ITEMLENGTHVALUEO L_ITEMLENGTHVALUE1 Character length and limitations Any positive integer Name Value Pair API Developer Guide 08 April 2009 139 140 Recurring Payments and Reference Transactions API Operations DoReference Transaction API Field Description ITEMWIDTHVALUEn Optional Item width corresponds to the width of the item You can pass this data to ITEMWIDTHUNITn 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 ITEMWIDTHVALUE1 Character length and limitations Any positive integer L_ITEMHEIGHTVALUEn Optional Item height corresponds to the height of the item You can pass this data to EMHE IGHTUNITn L IT 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_ITEMHETGHTVALU E0 L ITEMHEIGHTVALUE1 Character length and limitations Any positive integer
2. 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 is 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 for enabled the API caller and the account the billing agreement belongs to 10211 Invalid billing agreement Invalid transaction or billing ID agreement ID could not find Billing Agreement in database 11451 Billing Agreement Id or Billing Agreement Id or ReferenceID field is empty transaction Id is not valid transaction Id is not valid 11451 Billing Agreement Id or Billing Agreement Id or Reference id refers to an invalid transaction Id is not valid transaction Id is not valid transaction 11452 Merchant not enabled for Merchant not enabled for reference This
3. MIDDLENAME Payer s middle name Character length and limitations 25 single byte characters LASTNAME Payer s last name Character length and limitations 25 single byte characters SUFFIX Payer s suffix Character length and limitations 12 single byte characters Address Type Fields Field Description ADDRESSSTATUS Status of street address on file with PayPal Valid values are 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 Character length and limitations 40 single byte characters Required for U S addresses only SHIPTOZIP U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHIPTOCOUNTRYCODE Country code See Country Codes on page 225 Character limit Two single byte characters 58 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia GetExpressCheckoutDetails API Payment Details Type Fields Field Description AMT Required The t
4. BILLINGAGREEMENTD Optional Description of goods or services associated with the billing agreement ESCRIPTIONn L_CUSTOMn which 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 customer will be billed at 9 99 per month for 2 years Character length and limitations 127 single byte alphanumeric bytes Optional Custom annotation field for your own use NOTE For recurring payments this field is ignored Character length and limitations 256 single byte alphanumeric bytes BAUpdateResponseDetails Response GetBillingAgreementCustomerDetails Response Fields Payer Information Fields Payer Name Fields Ship To Address Fields Name Value Pair API Developer Guide 08 April 2009 131 fa Recurring Payments and Reference Transactions API Operations BAUpdate API Update Billing Agreement Details Response Fields Field Description BILLINGTYPEn BILLINGAGREEMENTD ESCRIPTIONn L_CUSTOMn BILLINGAGREEMENTSTA TUS L BILLINGAGREEMENTM AxXn Type of billing agreement Description of goods or services associated with the billing agreement which is required for each recurring payment billing agreement Character length and limitations 127 single byte alphanumeric bytes Custom annotation fiel
5. Country Code SOMALIA SO SOUTH AFRICA ZA SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS GS SPAIN ES SRI LANKA LK SUDAN SD SURINAME SR SVALBARD AND JAN MAYEN SJ SWAZILAND SZ SWEDEN SE SWITZERLAND CH SYRIAN ARAB REPUBLIC SY TAIWAN PROVINCE OF CHINA TW TAJIKISTAN TJ TANZANIA UNITED REPUBLIC OF TZ THAILAND TH TIMOR LESTE TL TOGO TG TOKELAU TK TONGA TO 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 08 April 2009 Name Value Pair API Developer Guide Country Codes ia Country Code 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 YEMEN YE ZAMBIA ZM ZIMBABWE ZW Name Value Pair API Developer Guide 08 April 2009 233 fon Country Codes 234 08 April 2009 Name Value Pair API Developer Guide State and Province Codes 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 Delawa
6. 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia DoReference Transaction API EbayltemPaymentDetailsltemType 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 NIDn These parameters must be 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 Credit Card Details Fields Field Description CREDITCARDTYPE Required Type of credit card Character length and limitations Up to ten single byte alphabetic characters Allowable values e Visa e MasterCard e Discover e Amex e Maestro See note e Solo See note For Canada only MasterCard and Visa are allowable Interac debit cards are not supported NOTE If the credit c
7. Field Description STATE Required State or province Character length and limitations 40 single byte characters COUNTRYCODE Required Country code Character limit Two single byte characters ZIP Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters PHONENUM Optional Phone number Character length and limit 20 single byte characters Name Value Pair API Developer Guide 08 April 2009 31 DoDirectPayment API DoDirectPayment Request Payment Details Type Fields Field Description AMT CURRENCYCODE ITEMAMT SHIPPINGAMT INSURANCEAMT SHIPPINGDISCOUNT INSURANCEOPTIONOFFE RED Required The total cost of the transaction to the customer 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 field to 0 if the transaction does not include a one time purchase for example when you set up a billing agreement for a recurring payment that is not immediately charged 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 Optional A three cha
8. Field Description METHOD Required Must be GetRecurringPaymentsProfileDetails 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 compatability with previous versions of the PayPal API GetRecurringPaymentsProfileDetails Response e GetRecurringPaymentsProfileDetails Response Fields e Recurring Payments Profile Fields e Ship To Address Fields e Billing Period Fields e Recurring Payments Summary Fields e Credit Card Fields e Payer Information Fields e Billing Address Fields 106 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations a GetRecurringPaymentsProfileDetails API GetRecurringPaymentsProfileDetails Response Fields Field Description PROF ILEID Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response STATUS Status of the recurring payment profile e ActiveProfile PendingProfile CancelledProfile e e e SuspendedProfile e ExpiredProfile DESC Description of the recurring payment Character length and limitations 127 single byte alphanumeric characters AUTOBILLOUTAMT This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle The outstanding balance is the
9. 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 OPTIONSNAME1 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 Fields Field Description BUYERID Customer s auction ID CLOSINGDATE Auction s close date 08 April 2009 Name Value Pair API Developer Guide GetTransactionDetails API GetTransactionDetails Response Field Description MULTIITE M Counter used for multi item auction payments Subscription Terms Fields Field Description AMT The amount subscriber is to be charged in one payment Character length and limitations no limit PERIOD The period of time that the subscriber will be charged Character length and limitations no limit Name Value Pair API Developer Guide 08 April 2009 83 irae GetTransactionDetails API GetTransactionDetails Response 84 08 April 2009 Name Value Pair API Developer Guide MassPay API Make a payment to one or more PayPal account holders e MassPay Request on page 85 e MassPay Response on page 87 MassPay Request e MassPay Request Fields e MassPay Item Details Fields N
10. 136 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations DoReference Transaction API Field Description SHIPPINGAMT INSURANCEAMT SHIPPINGDISCOUNT INSURANCEOPTIONOFFE RED HANDLINGAMT TAXAMT CUSTOM Optional Total shipping costs for this order 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 NOTE If you specify a value for SHIPPINGAMT you must also specify a value for ITEMAMT Optional Total shipping insurance costs for this order The value must be a non negative currency amount or nu11 if insurance options are offered 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 Optional Shipping discount for this order specified as a negative number 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
11. DoReference Transaction API Recurring Payments and Reference Transactions API Operations ia Payer Info Type Fields Field Description EMATL Optional Email address of payer Character length and limitations 127 single byte characters FIRSTNAME Required Payer s first name Character length and limitations 25 single byte characters LASTNAME Required Payer 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 COUNTRYCODE Required Country code Character limit Two single byte characters ZIP Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters PHONENUM Optional Phone number Character length and limit 20 single byte characters DoReferenceTransaction Response e DoReferenceTransaction Response Fields e Payment Information Fields Name Value Pair API Developer Guide 08 April 2009 143 DoReference Transaction API a Recurrin
12. PAYERID Required Unique PayPal customer account identification number as returned by GetExpressCheckoutDetails response Character length and limitations 13 single byte alphanumeric characters Optional Shipping options and insurance selected by the user RETURNEMFDETAILS Optional Flag to indicate whether you want the results returned by Fraud Management Filters By default you do not receive this information e 0 do not receive FMF details default e receive FMF details Payment Details Type Fields Field Description AMT Required The total cost of the transaction to the customer 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 field to 0 if the transaction does not include a one time purchase for example when you set up a billing agreement for a recurring payment that is not immediately charged 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 CURRENCYCODE Optional A three character currency code Default USD Name Value Pair API Developer Guide 08 April 2009 65 a Express Checkout API Operations DoExpressCheckoutPa
13. Character limit Two single byte characters ZIP Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters PHONENUM Optional Phone number Character length and limit 20 single byte characters CreateRecurringPaymentsProfile Response 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 08 April 2009 105 a Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Field Description STATUS 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 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 Obtain information about a recurring payments profile e GetRecurringPaymentsProfileDetails Request on page 106 e GetRecurringPaymentsProfileDetails Response on page 106 GetRecurringPaymentsProfileDetails Request GetRecurringPaymentsProfileDetails Request Fields
14. PAYMENTTYPE Indicates whether the payment is instant or delayed Character length and limitations Seven single byte characters Valid values e none e echeck e instant ORDERT IME Time date stamp of payment AMT The final amount charged including any shipping and taxes from your Merchant Profile Character length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD CURRENCYCODE Optional A three character currency code Default USD FEEAMT PayPal fee amount charged for the transactionCharacter length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD SETTLEAMT Amount deposited in your PayPal account after a currency conversion TAXAMT Tax charged on the transaction Character length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD EXCHANGERATE Exchange rate if a currency conversion occurred Relevant only if
15. 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 currency merchant is not supported 08 April 2009 Name Value Pair API Developer Guide API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 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 incorrect for this merchant password 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 t
16. 10619 Invoice ID 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 authorization the order is reached DeReauthosization allowed for the order is reached Dewar 10624 Duplicate Payment has already DoAuthorization Review the invoice ID invoice been made for this and reattempt the request Invoice ID Name Value Pair API Developer Guide 08 April 2009 197 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 DoReauthorizatio
17. API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10420 Transaction refused PaymentAction tag is missing PaymentAction tag is missing because of an invalid argument See additional error messages for details 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 additional 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 e
18. AddressVerify Request on page 156 e AddressVerify Response on page 156 Name Value Pair API Developer Guide 08 April 2009 155 a AddressVerify API AddressVerify Request AddressVerify Request AddressVerify Request Fields Field Description METHOD EMAIL STREET ZIP Required Must be AddressVerify Required Email address of a PayPal member to verify Maximum string length 255 single byte characters Input mask Required First line of the billing or shipping postal address to verify To pass verification the value of Street must match the first three single byte characters of a postal address on file for the PayPal member Street Maximum string length 35 single byte characters Alphanumeric plus Whitespace and case of input value are ignored Required Postal code to verify To pass verification the value of Zip must match the first five single byte characters of the postal code of the verified postal address for the verified PayPal member Maximum string length 16 single byte characters Whitespace and case of input value are ignored AddressVerify Response AddressVerify Response Fields Field Description CONF IRMATIONCODE STREETMATCH None The request value of the Email element does not match any email address on file at PayPal Confirmed If the response value of the StreetMatch element is Matched th
19. Character length and limitations 20 single byte characters PHONENUM Optional Phone number Character length and limit 20 single byte characters UpdateRecurringPaymentsProfile Response UpdateRecurringPaymentsProfile Response Fields Field Description PROFILEID Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response An error is returned if the profile specified in the BillOutstandingAmount request has a status of canceled or expired SetCustomerBillingAgreement API 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 e SetCustomerBillingA greement Request on page 124 Name Value Pair API Developer Guide 08 April 2009 123 a Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API e SetCustomerBillingAgreement Response on page 127 SetCustomerBillingAgreement Request e SetCustomerBillingAgreement Request Fields e Billing Agreement Details Fields on page 127 124 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia SetCustomerBillingAgreement API SetCustomerBillingAgreement Request Fields Field Description METHOD Required Mus
20. 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 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 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 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 authorize
21. L_ITEMHEIGHTVALUEO L ITEMHEIGHTVALUE1 Character length and limitations Any positive integer Name Value Pair API Developer Guide 08 April 2009 69 70 Express Checkout API Operations DoExpressCheckoutPayment API User Selected Options Type Fields Field Description SHIPPINGCALCULATION Optional Describes how the options that were presented to the user were MODE determined Is one of the following values INSURANCEOPTIONSELE CTED SHIPPINGOPTIONISDEF AULT SHIPPINGOPTIONAMOUN T SHIPPINGOPTIONNAME e API Callback e API Flatrate Optional The Yes No option that you chose for insurance Optional Is true if the buyer chose the default shipping option Character length and limitations true or false Optional The shipping amount that was chosen by the buyer 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 Optional Is true if the buyer chose the default shipping option EbayltemPaymentDetailsltemType Fields Field Description L_EBAYITEMNUMBERn L_EBAYITEMAUCTIONTX NIDn L_EBAYTTEMORDERIDn Optional Auction item number These parameters must be ordered sequentially beginning with 0 for example L_EBAYITEMN
22. PAYMENTACT ION EMAIL SOLUTIONTY PE LANDINGPAGE CHANN ELTYPE GIROPAYSUCC py ESSURL Optional Sets the background color for the header of the payment page By default the color is white Character length and limitation Six character HTML hexadecimal color code in ASCIL Optional Sets the background color for the payment page By default the color is white Character length and limitation Six character HTML hexadecimal color code in ASCIL Optional How you want to obtain payment e Sale indicates that this is a final sale for which you are requesting payment Default e Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization amp Capture e Order indicates that this payment is an order authorization subject to settlement with PayPal Authorization amp Capture If the transaction does not include a one time purchase this field is ignored NOTE You cannot set this value to Sale in SetExpressCheckout request and then change this value to Authorization or Order on the final API DoExpressCheckoutPayment request If the value is set to Authorization or Order in SetExpressCheckout the value may be set to Sale or the same value either Authorization or Order in DoExpressCheckout Payment Character length and limit Up to 13 single byte alphabetic characters Default value Sale Optional Email address of t
23. SHIPTONAME SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHIPTOCOUNTRYCODE SHIPTOPHONENUM Person s name associated with this address This field is required for shipping addresses but is optional for credit card billing addresses Character length and limitations 32 single byte characters First street address This field is required if the shipping address is used Character length and limitations 100 single byte characters Optional Second street address Character length and limitations 100 single byte characters Name of city This field is required if the shipping address is used Character length and limitations 40 single byte characters State or province This field is required if the shipping address is used Character length and limitations 40 single byte characters U S ZIP code or other country specific postal code This field is required if a U S shipping address is used and may be required for other countries Character length and limitations 20 single byte characters Country code This field is required if the shipping address is used Character limit 2 single byte characters Optional Phone number Character length and limit 20 single byte characters Billing Period Details Type Field Description BILLINGPERIOD BILLINGFREQUENCY Required Unit for billing during this subscription period On
24. 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 204 08 April 2009 Name Value Pair API Developer Guide API Error Codes Mass Pay 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 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 me
25. total amount of any previously failed scheduled payments that have yet to be successfully paid Valid values NoAutoBill or AddToNextBilling MAXFAILEDPAYMENTS The 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 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 AGGREGATEOPTIONALAM Total amount collected thus far for optional payments OUNT 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 FINALPAYMENTDUEDATE Final scheduled payment due date before the profile expires 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 v
26. 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 Required URL to which the customer s browser is returned after choosing to pay with PayPal NOTE PayPal recommends that the value be the final review page on which the customer confirms the order and payment or billing agreement Character length and limitations 2048 characters 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 2048 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 characters 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 Optional The value 1 indicates that you require that the customer s shipping address on file with PayPal be a confirmed address NOTE Setting this field overr
27. 2 The merchant has not implemented Not applicable CVV 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 08 April 2009 243
28. 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 invalid 10411 This Express Checkout This Express Checkout session has Token expired session has expired expired Token value is no longer valid 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 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 invalid Name Value Pair API Developer Guide 08 April 2009 215 API Error Codes CreateBillingAgreement Errors Error Code Short Message Long Message Additional Information 10411 This Express Checkout session has expired This Express Checkout session has expired Token value is no longer valid Token expired 216 08 April 2009 Name Value Pair API Developer Guide API Error Codes UpdateBillingAgreement Errors UpdateBillingAgreement Errors UpdateBillingAgreement Errors
29. Guide 08 April 2009 81 82 GetTransactionDetails API GetTransactionDetails Response Payment Item Information Fields Field Description INVNUM Invoice number you set in the original transaction Character length and limitations 127 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 Payment Item Fields Field Description L_DESCn L QTYn L AMTn L OPTIONSNAMEn L_OPTIONSVALUEn Amount of tax charged on payment These parameters must be ordered sequentially beginning with 0 for example L DESCO L DESCI 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 customer Character length and limitations no limit Cost of item These parameters must be ordered sequentially beginning with 0 for example L_AMTO L_AMT1
30. LY LIECHTENSTEIN LI LITHUANIA LT LUXEMBOURG LU MACAO MO MACEDONIA THE FORMER YUGOSLAV REPUBLIC OF MK MADAGASCAR MG MALAWI MW MALAYSIA MY MALDIVES MV MALI ML MALTA MT MARSHALL ISLANDS MH MARTINIQUE MQ MAURITANIA MR MAURITIUS MU MAYOTTE YT Name Value Pair API Developer Guide 08 April 2009 229 rm Country Codes 230 Country Code MEXICO MX MICRONESIA FEDERATED STATES OF FM MOLDOVA REPUBLIC OF MD MONACO MC MONGOLIA MN MONTSERRAT MS MOROCCO MA MOZAMBIQUE MZ MYANMAR MM NAMIBIA NA NAURU NR NEPAL NP NETHERLANDS NL NETHERLANDS ANTILLES AN NEW CALEDONIA NC NEW ZEALAND NZ NICARAGUA NI NIGER NE NIGERIA NG NIUE NU NORFOLK ISLAND NF NORTHERN MARIANA ISLANDS MP NORWAY NO OMAN OM PAKISTAN PK PALAU PW PALESTINIAN TERRITORY OCCUPIED PS PANAMA PA PAPUA NEW GUINEA PG 08 April 2009 Name Value Pair API Developer Guide Country Codes a Country Code 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 SAINT HELENA SH SAINT KITTS AND NEVIS KN SAINT LUCIA LC SAINT PIERRE AND MIQUELON PM SAINT VINCENT AND THE GRENADINES VC SAMOA WS SAN MARINO SM SAO TOME AND PRINCIPE ST SAUDI ARABIA SA SENEGAL SN SERBIA AND MONTENEGRO CS SEYCHELLES SC SIERRA LEONE SL SINGAPORE SG SLOVAKIA SK SLOVENIA SI SOLOMON ISLANDS SB Name Value Pair API Developer Guide 08 April 2009 231 rm Country Codes 232
31. Must have two decimal places decimal separator must be a period and the optional thousands separator must be a comma Name Value Pair API Developer Guide 08 April 2009 53 Express Checkout API Operations GetExpressCheckoutDetails API Billing Agreement Details Fields Field Description L BILLINGTYPEn BILLINGAGRE EME ESCRIPTIONn L_PAYMENTTYPEn L CUSTOMn NTD 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 NOTE Other defined values are not valid Description of goods or services associated with the billing agreement which 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 customer will be billed at 9 99 per month for 2 years Character length and limitations 127 single byte alphanumeric bytes Optional Specifies type of PayPal payment you require for the billing agreement e Any e InstantOnly NOTE For recurring payments this field is ignored Optional Custom annotation field for your own use NOTE For recurring payments this field is ignored Character length and limitations 256 single byte alphanumeric bytes SetExpressCheckout Response SetExpressCheckout Response Fields Field Descript
32. Reversed Display Only Partially Refunded Created Refunded Name Value Pair API Developer Guide 08 April 2009 151 a ManagePendingTransactionStatus API ManagePendingTransactionStatus Response 152 08 April 2009 Name Value Pair API Developer Guide GetBalance API Obtain the available balance for a PayPal account e GetBalance Request on page 153 e GetBalance Response on page 153 GetBalance Request GetBalance Request Fields Field Description METHOD Required Must be GetBalance RETURNALLCURRENCIES Optional Whether to return all currencies which 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 You can only include this field with API VERSION 51 and later prior versions return only the balance for the primary currency holding GetBalance Response GetBalance Response Fields Field Description L AMTn The available balance and associated currency code for the primary currency holding L_CURRENTYCODEn The currency code associated with the holding such as USD Name Value Pair API Developer Guide 08 April 2009 153 fon GetBalance API GetBalance Response 154 08 April 2009 Name Value Pair API Developer Guide AddressVerify API Confirms whether a postal address and postal code match those of the specified PayPal account holder e
33. Status of street address on file with PayPal Valid values are 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 22 08 April 2009 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference aa DoAuthorization API Field Description SHIPTOSTATE State or province Character length and limitations 40 single byte characters Required for U S addresses only SHIPTOZIP U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHIPTOCOUNTRYCODE Country code Character limit Two single byte characters Payer Name Fields Field Description SALUTATION Payer s salutation Character length and limitations 20 single byte characters FIRSTNAME Payer s first name Character length and limitations 25 single byte characters MIDDLENAME Payer s middle name Character length and limitations 25 single byte characters LASTNAME Payer s last name Character length and limitations 25 single by
34. a problem with a particular processed Please enter a valid field in the address The long error country code in the shipping message will tell you what field is address invalid 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 will tell you what 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 Verification 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 will tell you what 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
35. 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 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 have 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 08 April 2009 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 10001 10004 10004 10004 10004 10004 10004 10004 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 Transaction refused because of an invalid argument See additional error m
36. 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 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 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 Required The method sent to the PayPal server The value is always CallbackResponse 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations SetExpressCheckout API Field Description 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 th
37. characters including decimal point PAYMENTSTATUS Status of the payment The status of the payment 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 customer s bank account e In Progress The transaction has not terminated e g an authorization may be awaiting completion Partially Refunded The payment has been partially refunded Pending The payment is pending See the PendingReason field for more information 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 Processed A payment has been accepted e Voided An authorization for this transaction has been voided Name Value Pair API Developer Guide 08 April 2009 79 o GetTransactionDetails API GetTransactionDetai
38. currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD 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 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 AUTOBILLOUTAMT Optional This field indicates whether you would like PayPal to automatically bill the outstanding balance amount in the next billing cycle Valid values Must be NoAutoBill or AddToNextBilling MAXFAILEDPAYMENTS Optional The number of failed payments allowed before the profile is automatically suspended The specified value cannot be less than 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 Must be a valid date in UTC GMT format NOTE The profile may take up to 24 hours for activation 118 08 April 2009 Name Value Pair API Developer Guide Ship To Address Fields Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Field Description
39. 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 178 08 April 2009 Name Value Pair API Developer Guide SetExpressCheckout API Errors API Error Codes Error Code Short Message Long Message Correcting This Error 10412 Duplicate invoice Payment has already been made for PayPal checks that this InvoiceID InvoicelID values are unique for any particular merchant If you send an InvoiceID 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 get this error research why 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 of an invalid argument See do not match order amounts additional error messages for details 10415 Transaction refused because A successful transaction has already PayPal allows a token only of an invalid argument See been completed for this token once for a successful additional error messages for transaction details Handling this error If you dete
40. error messages for details Transaction cannot complete Transaction cannot complete 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 complete successfully Instruct the customer to use an alternative payment method The currencies of the shopping cart amounts must be the same Transaction refused because a confirmed address is not available 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 Name Value Pair API Developer Guide 08 April 2009 219 220
41. 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 Name Value Pair API Developer Guide 08 April 2009 189 190 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 10413 Transaction refused The totals of the cart item e ItemTotal because of an invalid amounts do not match order e ShippingTotal argument See additional amounts e HandlingTotal error messages for details e TaxTotal If you get this error research why it might have occurred and modify your implementation of Express Checkout to ensure proper addition of the values For the rules of this calculation see the PayPal Express Checkout Integration Guide 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 already been completed for argument See additional this token error messages for details 10416 Transact
42. invalid argument See additional error messages for details 10434 Transaction refused because of an invalid argument See additional error messages for details 10436 Transaction refused because of an invalid argument See additional error messages for details 10437 Transaction refused because of an invalid argument See additional error messages for details Shipping total is invalid Handling total is invalid Tax total is invalid Item amount is missing Item amount is invalid 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 08 April 2009 Name Value Pair API Developer Guide API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10438 Transaction refused because cpp header image value exceeds of an invalid argument See maximum allowable length additional error messages for details 10439 Transaction refused because cpp header image value exceeds of an invalid argument See maximum allowable length additional error messages for details 10440 Transaction refused because cpp header image value exceeds of an invalid argument See maximum allowable length additional error messages for details 10441 Transaction
43. 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 08 April 2009 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 reauth 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
44. items in this order 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 NOTE TAXAMT is required if you specify L_TAXAMTN Optional Description of items the customer is purchasing Character length and limitations 127 single byte alphanumeric characters Optional A free form field for your own use Character length and limitations 256 single byte alphanumeric characters Name Value Pair API Developer Guide 08 April 2009 49 a Express Checkout API Operations SetExpressCheckout API Field Description INVNUM Optional Your own invoice or tracking number Character length and limitations 127 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 NOTE If you do not specify this value in the request the notification URL from your Merchant Profile is used if one exists Character length and limitations 2 048 single byte alphanumeric characters 50 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operation
45. limitations 13 single byte alphanumeric characters PAYERSTATUS Status of payer Valid values are e verified e unverified Character length and limitations 10 single byte alphabetic characters COUNTRYCODE Payer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations Two single byte characters BUSINESS Payer s business name Character length and limitations 127 single byte characters Payer Name Fields Field Description SALUTATION Payer s salutation Character length and limitations 20 single byte characters FIRSTNAME Payer s first name Character length and limitations 25 single byte characters MIDDLENAME Payer s middle name Character length and limitations 25 single byte characters LASTNAME Payer s last name Character length and limitations 25 single byte characters SUFFIX Payer 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 CITY Required Name of city Character length and limitations 40 single byte characters 30 08 April 2009 Name Value Pair API Developer Guide DoDirectPayment API BE DoDirectPayment Request
46. own use Character length and limitations 256 single byte alphanumeric characters INVNUM Optional Your own invoice or tracking number Character length and limitations 127 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 NOTE If you do not specify this value in the request the notification URL from your Merchant Profile is used if one exists Character length and limitations 2 048 single byte alphanumeric characters Name Value Pair API Developer Guide 08 April 2009 33 a DoDirectPayment API DoDirectPayment Request Payment Details Item Type Fields Field Description L_NAMEn DESCn L AMTn L NUMBERN L QTYn L TAXAMTn ITEMWETGHTVALU ITEMWEGHTUNITn L_ITEMLENGTHVALU En mn L_ITEMLENGTHUNITn 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 Optional Item description Character length and limitations 127 single byte characters Optional Cost of item These parameters must be ordered sequential
47. payment Character length and limitations 17 single byte characters Name Value Pair API Developer Guide 08 April 2009 77 o GetTransactionDetails API GetTransactionDetails Response Field Description PARENTTRANSACTIONID e Parent or related transaction identification number This field is populated 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 ParentTransactionID is the original OrderID Character length and limits 16 digits in xxxx xxxx xxxx xxxx format RECEIPTID Receipt identification number Character length and limits 16 digits in xxxx xxxx xxxx xxxx format TRANSACTIONTYPE The type of transaction Valid values e cart e express checkout Character length and limitations 15 single byte characters PAYMENTTY PE Indicates whether the payment is instant or delayed Character length and limitations Seven single byte characters Valid values e none e echeck e instant ORDERT IME 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 Character
48. period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD SETTLEAMT Amount deposited in your PayPal account after a currency conversion TAXAMT Tax charged on the transaction Character length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD EXCHANGERATE Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the customer chooses to pay with a currency other than the non primary currency the conversion occurs in the customer s account Character length and limitations a decimal that does not exceed 17 characters including decimal point PAYMENTSTATUS Status of the payment Completed The payment has been completed and the funds have been added successfully to your account balance Pending The payment is pending See the PendingReason element for more information Name Value Pair API Developer Guide 08 April 2009 145 DoReference Transaction API a Recurring Payments and Reference Transactions API Operations Field Description PENDINGREASON The reason the payment is pending e none No pending reason g EASONCODI Gl address The payment is pending because your
49. product or service described herein PayPal Inc reserves the right to make changes to any information herein without further notice Contents Preface 9 This Document o a ea xos a a ecce a a e O oaa a a a aD a a O a a 9 Intended Audience coros a 8 2 6 aa oan he a eS a a a a a a a a a a E 9 Revision HISO es ea ead ea a e a e i a D O a e a E a o a Ea 9 Chapter 1 PayPal NVP API Overview 11 Introducing the PayPal NVP API 2 2 0 02 ee a 11 Integrating with the PayPal API aoaaa aaa eee ee 11 Basic Steps acs bee d aeina i ioa ia i a do ee ee a eed dee 12 Create a Web Application o o a ooa a 0 00002 eee es 12 Get API Credentials oa aaa 20000 ee ee 12 Create and Post the Request oaoa aa aa a 12 Interpret the Response aooaa a 13 Taking Your Application Live a oa a a 13 Set Up a PayPal Business Account oaoa a a 13 Set Up API Credentials ooo aaa a 000020022 eee 13 Modify YourCode da ka a aa p aa a ee 13 Technical Details ie a ae nates oh ie oh ia a a BE ee Ge a a a ae Be ee ee 14 Request Response Model 000 eee ee 14 Request Format 2 2 2 0000 ee ee 15 Response Format 0 0002 eee 17 Posting Using HTTPS esi nosade a aa a aT a a E A E 18 API Servers for API Signature Security oaa aa a 18 API Servers for API Certificate Security a aaa a 18 Chapter 2 Authorization and Capture API Operation Reference 19 DoGaptur
50. value exceeds maximum allowable length ReturnURL tag has no content CancelURL tag has no content Invalid BuyerEmail badly formatted or violates SMTP protocol defined email address format or BuyerEmail is passed as an empty tag PageStyle tag is too long cpp_header_image tag is too long maximum length is 127 cpp_header_border_color tag is too long maximum length is 6 cpp_header_back_ color tag is too long maximum length is 6 Name Value Pair API Developer Guide 08 April 2009 213 API Error Codes SetCustomerBillingAgreement Errors Error Code Short Message Long Message Additional Information 10440 10471 10472 10476 10477 11452 11453 11601 11602 Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Merchant not enabled for reference transactions Reference transactions temporarily unavailable Request for billing address failed Request for billing address failed cpp payflow color value exceeds maximum allowable length R
51. you must also specify a value for ITEMAMT INSURANCEAMT Optional Total shipping insurance costs for this order The value must be a non negative currency amount or nu11 if insurance options are offered 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 SHIPPINGDISCOUNT Optional Shipping discount for this order specified as a negative number 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 INSURANCEOPTIONOFFE Optional If true the Insurance drop down on the PayPal Review page displays the RED string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number Character length and limitations true or false Name Value Pair API Developer Guide 08 April 2009 59 Express Checkout API Operations GetExpressCheckoutDetails API Field Description HANDLINGAMT Optional Total handling costs for this order NOTE Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Regard
52. your primary email address Character length and limitations 127 single byte alphanumeric characters RECEIVERID Unique account ID of the payment recipient the seller This value is the same as the value of the recipient s referral ID Payer Information Fields Field Description EMAIL Email address of payer 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 payer Valid values are e verified e unverified Character length and limitations 10 single byte alphabetic characters SHIPTOCOUNTRYCODE Payer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations Two single byte characters PAYERBUSINESS Payer s business name Character length and limitations 127 single byte characters Payer Name Fields Field Description SALUTATION Payer s salutation Character length and limitations 20 single byte characters FIRSTNAME Payer s first name MIDDLENAMF Character length and limitations 25 single byte characters Payer s middle name Character length and limitations 25 single byte characters LASTNAME Payer s last name Character length and limitations 25 single byte characters SUFFIX Payer s suffix Character length and limitation
53. 1 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 Please contact Customer Service Name Value Pair API Developer Guide 08 April 2009 177 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10404 10405 10407 10409 10410 10411 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 You re not authorized to access this info Invalid token This Express Checkout session has expired ReturnURL is missing CancelURL is missing Invalid buyer email address BuyerEmail Express Checkout token was issued for a merchant account other than yours Invalid token This Express Checkout session has expired Token value is no longer valid If you receive this error you must return your customer to PayPal to approve the use of PayPal again Display an error message to inform the customer that the transaction expired and provide a button to return to PayPal In this situation you are
54. 123 SetCustomerBillingAgreement Request oaa aa a eee eee 124 SetCustomerBillingAgreement Response oaoa a 127 GetBillingAgreementCustomerDetails API a a a aa a a 127 GetBillingAgreementCustomerDetails Request oa oa aa a 128 GetBillingAgreementCustomerDetails Response oaoa aa 128 BAUpdate API 2 lt 2 goe ae ao Sareea a ae ee ee aed we E ete ed 130 BAUpdate Request 0 0000 0 pe ee 131 BAUpdateResponseDetails Response a a a a 131 DoReferenceTransaction API aaa aaa a 133 DoReferenceTransaction Request o aooaa a a 134 DoReferenceTransaction Response oaaao 000000 pees 143 Chapter 10 DoNonReferencedCredit API 147 DoNonReferencedCredit Request 0 20200 eee eae 147 DoNonReferencedCredit Response 02 0000 eee 150 Name Value Pair API Developer Guide 08 April 2009 fara Contents Chapter Chapter Chapter Chapter Chapter 11 ManagePendingTransactionStatus API ManagePendingTransactionStatus Request ManagePendingTransactionStatus Response 12 GetBalance API GetBalance Request 22 GetBalance Response 0 0008 s 13 AddressVerify API AddressVerify Request 2 2 200 AddressVerify Response A API Error Codes General API Errors 0 0 0 00000000004 Validation Errors Direct Payment API Errors 4 SetExpressCheckou
55. 471 Transaction refused because ReturnURL is missing of an invalid argument See additional error messages for details 10472 Transaction refused because CancelURL is missing of an invalid argument See additional error messages for details 10473 Error occurred in Multiple Order IDs are not supported communicating to eBay 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 08 April 2009 Name Value Pair API Developer Guide API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 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
56. 5 GetRecurringPaymentsProfileDetails API on page 106 ManageRecurringPaymentsProfileStatus API on page 113 BillOutstandingAmount API on page 114 UpdateRecurringPaymentsProfile API on page 115 SetCustomerBillingAgreement API on page 123 GetBillingAgreementCustomerDetails API on page 127 DoReferenceTransaction API on page 133 CreateRecurringPaymentsProfile API Create a recurring payments profile You must invoke the CreateRecurringPaymentsProfile 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 between billing agreements and recurring payments profiles To associate a a recurring payments profile with its billing agreement the description in the recurring payments profile must match the description of a billing agreement For version 54 0 and later use SetExpressCheckout to initiate creation of a billing agreement CreateRecurringPaymentsProfile Request on page 95 e CreateRecurringPaymentsProfile Response on page 105 CreateRecurringPaymentsProfile Request CreateRecurringPaymentsProfile Request e Recurring Payments Profile Details Schedule Details Name Value Pair API Developer Guide 08 April 2009 95 Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API e Billing Period Details e Activation Details e Shi
57. 520 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 11543 Invalid payer country The payer s country is currently not supported 08 April 2009 Name Value Pair API Developer Guide API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 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 ID is missing from the the request request 11552 Invalid profile ID The profile ID is invalid 11553 Invali
58. 9 121 fa Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Credit Card Details Fields Field Description CREDITCARDTYPE Required Type of credit card Character length and limitations Up to ten single byte alphabetic characters Allowable values e Visa e MasterCard e Discover e Amex e Maestro See note e Solo See note For Canada only MasterCard and Visa are allowable Interac debit cards are not supported NOTE If the credit card type is Maestro or Solo the CURRENCYCODE must be GBP In addition either STARTDATE or ISSUENUMBER must be specified ACCT Required Credit card number Character length and limitations numeric characters only No spaces or punctutation 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 Format MMYYYY Character length and limitations Six single byte alphanumeric characters including leading zero CVV2 Card Verification Value version 2 Your Merchant Account settings determine whether this field is required Character length for Visa MasterCard and Discover exactly three digits Character length for American Express exactly four digits To comply with credit card processing regulations you must not store this value after a transaction has been comple
59. Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization amp Capture e Sale indicates that this is a final sale for which you are requesting payment Character length and limit Up to 13 single byte alphabetic characters Default Sale NOTE Order is not allowed for Direct Payment Required IP address of the payer 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 Optional Flag to indicate whether you want the results returned by Fraud Management Filters By default you do not receive this information e 0 do not receive FMF details default e receive FMF details Credit Card Details Fields Field Description CREDITCARDTYPE ACCT Required Type of credit card Character length and limitations Up to ten single byte alphabetic characters Allowable values e Visa e MasterCard e Discover e Amex e Maestro See note e Solo See note For Canada only MasterCard and Visa are allowable Interac debit cards are not supported NOTE If the credit card type is Maestro or Solo the CURRENCYCODE must be GBP In addition either STARTDATE or ISSUENUMBER must be specified Required Credit card number Character length and limitations numeric characters only No sp
60. CancelOnFailure PayPal will create the recurring payment profile but will place it into a pending status until the initial payment is completed If the initial payment clears PayPal will notify you by IPN that the pending profile has been activated If the payment fails PayPal will notify you by IPN that the pending profile has been canceled Character length and limitations ContinueOnFailure or CancelOnFailure Ship To Address Fields Field Description SHIPTONAME SHIPTOSTREET SHIPTOSTREET2 SHIPTOCITY SHIPTOSTATE SHIPTOZIP Person s name associated with this address This field is required for shipping addresses but is optional for credit card billing addresses Character length and limitations 32 single byte characters First street address This field is required if the shipping address is used Character length and limitations 100 single byte characters Optional Second street address Character length and limitations 100 single byte characters Name of city This field is required if the shipping address is used Character length and limitations 40 single byte characters State or province This field is required if the shipping address is used Character length and limitations 40 single byte characters U S ZIP code or other country specific postal code This field is required if a U S shipping address is used and may be required for other countries Ch
61. 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 transaction Id is not valid transaction Id is not valid 11451 Billing Agreement Id or Billing Agreement Id or Reference transaction is not transaction Id is not valid transaction Id is not valid associated with a billing agreement 11451 Billing Agreement Id or Billing Agreement Id or Reference id either not found or transaction Id is not valid transaction Id is not valid could not be decrypted 08 April 2009 Name Value Pair API Developer Guide API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 11451 11452 11453 11453 11454 11459 11610 11611 11612 18014 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 Gateway Decline Billing Agreement Id or transaction Id is not valid Merchant not enabled for reference transactions Reference transaction feature not currentl
62. DE Address Verification System response code See AVS and CVV2 Response Codes on page 241 for possible values Character limit One single byte alphanumeric character CVV2MATCH Result of the CVV2 check by PayPal L_EMFfilterIDn Filter ID including the filter type which is either ACCEPT or DENY the filter JD 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 L_FMFfilterNAMEN Filter name including the filter type which is either ACCEPT or DENY the filter NAME and the entry number n starting from 0 Name Value Pair API Developer Guide 08 April 2009 37 a DoDirectPayment API DoDirectPayment Response 38 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations This chapter describes the PayPal API operations related to Express Checkout transactions e SetExpressCheckout API on page 43 e GetExpressCheckoutDet
63. H Moore amp Associates is URL coded as follows NAME Robert Moore amp COMPANY R 2E H 2E Moore 26 Associates Use the following methods to URL encode or URL decode your NVP strings 08 April 2009 Name Value Pair API Developer Guide PayPal NVP API Overview ina Technical Details URL Encoding Methods 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 PHP Encode urlencode Decode urldecode ColdFusion Encode URLEncodedFormatstring charset Decode URLDecodeurlEncodedString charset Request Format Each NVP request consists of required and optional parameters and their values Parameter names are not case sensitive The examples in this document use UPPERCASE for parameter names and divide the parameters into required security parameters and body parameters General Format of a Request Required Security USER apiUsername Parameters amp PWD api Password amp SIGNATURE apiSignature amp SUBJECT optionalThirdPartyEmailAddress amp VERSION 56 0 The following parameters are always required USER PWD VERSION The examples show the re
64. 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 will tell you what 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 will tell you what field is invalid 10707 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 billing address message will tell you what field is invalid 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 will tell you what 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 address in the billing address message will tell you what 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 address in the billing address message will tell you what field is invalid 10710 Invalid Data There s an error with this There was a problem with a particula
65. KD Hungarian Forint HUF Israeli New Sheqel ILS Japanese Yen JPY Mexican Peso MXN Norwegian Krone NOK New Zealand Dollar NZD Polish Zloty PLN Pound Sterling GBP Singapore Dollar SGD Swedish Krona SEK Swiss Franc CHF U S Dollar USD Name Value Pair API Developer Guide 08 April 2009 239 a Currency Codes 240 08 April 2009 Name Value Pair API Developer Guide AVS and CVV2 Response Codes e AVS Response Codes on page 241 e CVV2 Response Codes on page 243 AVS Response Codes e AVS Response Codes for Visa Mastercard Discover and American Express e AVS Response Codes for Maestro and Solo Name Value Pair API Developer Guide 08 April 2009 241 242 AVS and CVV2 Response Codes AVS Response Codes AVS Response Codes for Visa MasterCard Discover and American Express AVS Code Meaning Matched Details A Address Address only no ZIP B International A Address only no ZIP 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 E International Unavailable Not applicable N 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 U Unavailab
66. LUE1 Character length and limitations Any positive integer 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 These parameters must be ordered sequentially beginning with 0 for example L_ITEMLENGTHVALUEO L_ITEMLENGTHVALUE1 Character length and limitations Any positive integer 34 08 April 2009 Name Value Pair API Developer Guide DoDirectPayment API DEE DoDirectPayment Request Field Description ITEMWIDTHVALUEn Optional Item width corresponds to the width of the item You can pass this data to ITEMWIDTHUNITn 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 ITEMWIDTHVALUE1 Character length and limitations Any positive integer L_ITEMHEIGHTVALUEn Optional Item height corresponds to the height of the item You can pass this data to L_ITEMHEIGHTUNITn 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 L ITEMHEIGHTVALUE1 Character length and limitations Any positive integer Name Value Pair API De
67. MFDETAILS Optional Flag to indicate whether you want the results returned by Fraud Management Filters By default you do not receive this information e 0 do not receive FMF details default e receive FMF details SOFTDESCRIPTOR Optional The soft descriptor is a per transaction description of the payment that is passed to the consumer s credit card statement If a value for the soft descriptor field is provided the full descriptor displayed on the customer s statement has the following format lt PP PAYPAL gt lt Merchant descriptor as set in the Payment Receiving Preferences gt lt l1 space gt lt soft descriptor gt The soft descriptor can contain only the following characters e Alphanumeric characters e dash e asterisk o period e space If you use any other characters such as an error code is returned 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 either 4 or 8 characters are used by the PayPal prefix 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 i
68. NID Unique transaction ID of the payment NOTE If the PaymentAction of the request was Authorization or Order this value is your AuthorizationID for use with the Authorization amp Capture APIs Character length and limitations 19 single byte characters TRANSACTIONTYPE The type of transaction Character length and limitations 15 single byte characters Valid values e cart e express checkout 144 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia DoReference Transaction API Field Description PAYMENTTY PE Indicates whether the payment is instant or delayed Character length and limitations Seven single byte characters Valid values e none e echeck e instant ORDERT IME Time date stamp of payment AMT The final amount charged including any shipping and taxes from your Merchant Profile Character length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD CURRENCYCODE Optional A three character currency code Default USD FEEAMT PayPal fee amount charged for the transactionCharacter length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a
69. Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia GetRecurringPaymentsProfileDetails API 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 optional 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 separat
70. OMOROS KM CONGO CG CONGO THE DEMOCRATIC REPUBLIC OF THE CD COOK ISLANDS CK COSTA RICA CR COTE D IVOIRE CI 08 April 2009 Name Value Pair API Developer Guide Country Codes a Country Code CROATIA HR CUBA CU CYPRUS CY CZECH REPUBLIC CZ DENMARK DK DJIBOUTI DJ DOMINICA DM DOMINICAN REPUBLIC DO ECUADOR EC EGYPT EG EL SALVADOR SV EQUATORIAL GUINEA GQ ERITREA ER ESTONIA EE ETHIOPIA ET FALKLAND ISLANDS MALVINAS FK FAROE ISLANDS FO FIJI FJ 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 Name Value Pair API Developer Guide 08 April 2009 227 rm Country Codes 228 Country Code GREECE GR GREENLAND GL GRENADA GD GUADELOUPE GP GUAM GU GUATEMALA GT GUERNSEY GG GUINEA GN GUINEA BISSAU GW GUYANA GY HAITI HT 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 IRAN ISLAMIC REPUBLIC OF IR IRAQ IQ IRELAND IE ISLE OF MAN IM ISRAEL IL ITALY IT JAMAICA JM JAPAN JP JERSEY JE JORDAN JO 08 April 2009 Name Value Pair API Developer Guide Country Codes a Country Code KAZAKHSTAN KZ KENYA KE KIRIBATI KI KOREA DEMOCRATIC PEOPLE S REPUBLIC OF KP KOREA REPUBLIC OF KR KUWAIT KW KYRGYZSTAN KG LAO PEOPLE S DEMOCRATIC REPUBLIC LA LATVIA LV LEBANON LB LESOTHO LS LIBERIA LR LIBYAN ARAB JAMAHIRIYA
71. PTOSTATE SHIPTOZIP SHIPTOCOUNTRY PHONENUM SHIPTOSTREET2 Person s name associated with this shipping address Required if using a shipping address Character length and limitations 32 single byte characters First street address 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 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 Optional Phone number Character length and limit 20 single byte characters Payment Details Type Fields Field Description AMT Required The total cost of the transaction to the customer 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 fiel
72. Pair API Developer Guide API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 10525 Invalid Data 10526 Invalid Data 10527 Invalid Data 10534 Gateway Decline 10535 Gateway Decline 10536 Invalid Data 10537 Filter Decline 10538 Filter Decline 10539 Filter Decline 10540 Invalid Data 10541 Gateway Decline 10542 Invalid Data This transaction cannot be processed The amount to be charged is zero This transaction cannot be processed The currency is not supported at this time This transaction cannot be processed Please enter a valid credit card number and type This transaction cannot be processed Please enter a valid credit card number and type This transaction cannot be processed Please enter a valid credit card number and type This transaction cannot be processed This transaction cannot be processed This transaction cannot be processed This transaction cannot be processed The transaction cannot be processed due to an invalid address This transaction cannot be processed Please enter a valid credit card number and type This transaction cannot be processed Please enter a valid email address The merchant entered a amount of zero The currency code entered is not supported The credit card entered is invalid The credit card entered is currently restricted by PayPal Contact PayPal for more informatio
73. PayPal Name Value Pair API Developer Guide Last updated 08 April 2009 Name Value Pair API Developer Guide Document Number 100018 en_US 20090408 2009 PayPal Inc All rights reserved PayPal is a registered trademark of PayPal Inc The PayPal logo is a trademark of PayPal Inc Other trademarks and brands are the property of their respective owners The information in this document belongs to PayPal Inc It may not be used reproduced or disclosed without the written approval of PayPal Inc Copyright PayPal All rights reserved PayPal Europe S r l et Cie S C A Soci t en Commandite par Actions Registered office 22 24 Boulevard Royal L 2449 Luxembourg R C S Luxembourg B 118 349 Consumer advisory The PayPal payment service is regarded as a stored value facility under Singapore law As such it does not require the approval of the Monetary Authority of Singapore You are advised to read the terms and conditions carefully Notice of non liability PayPal Inc is providing the information in this document to you AS IS with all faults PayPal Inc makes no warranties of any kind whether express implied or statutory with respect to the information contained herein PayPal Inc assumes no liability for damages whether direct or indirect caused by errors or omissions or resulting from the use of this document or the information contained in this document or resulting from the application or use of the
74. RY CODE Payer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations Two single byte characters BUSINESS Payer s business name Character length and limitations 127 single byte characters 104 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations a CreateRecurringPaymentsProfile API Payer Name Fields Field Description SALUTATION Payer s salutation Character length and limitations 20 single byte characters FIRSTNAME Payer s first name Character length and limitations 25 single byte characters MIDDLENAME Payer s middle name Character length and limitations 25 single byte characters LASTNAME Payer s last name Character length and limitations 25 single byte characters SUFFIX Payer 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 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
75. Request 2 MassPay Response 2 RefundTransaction API RefundTransaction Request RefundTransaction Response 08 April 2009 Name Value Pair API Developer Guide Contents Chapter 8 TransactionSearch API 91 TransactionSearch Request 2 ee 91 TransactionSearch Response 2 ee 94 Chapter 9 Recurring Payments and Reference Transactions API Operations95 CreateRecurringPaymentsProfile AP 2 22 a 95 CreateRecurringPaymentsProfile Request 2 005 95 CreateRecurringPaymentsProfile Response 2 05 105 GetRecurringPaymentsProfileDetails AP 2 2 2220 4 106 GetRecurringPaymentsProfileDetails Request 106 GetRecurringPaymentsProfileDetails Response 106 ManageRecurringPaymentsProfileStatus API 222200 113 ManageRecurringPaymentsProfileStatus Request 114 ManageRecurringPaymentsProfileStatus Response 114 BillOutstandingAmount API 2 1 114 BillOutstandingAmount Request 2 aa a 115 BillOutstandingAmount Response 200200 eee eee 115 UpdateRecurringPaymentsProfile API 220 552252004 115 UpdateRecurringPaymentsProfile Request 2 2204 116 UpdateRecurringPaymentsProfile Response 220 123 SetCustomerBillngAgreement API aaa a
76. Response Fields Field Description TOKEN CUSTOM INVNUM PHONENUM PAY PALADJUSTMENT NOTE EA REDIRECTREQUIRED The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request Character length and limitations 20 single byte characters A free form field for your own use as set by you in the Custom element of SetExpressCheckout request Character length and limitations 256 single byte alphanumeric characters Your own invoice or tracking number as set by you in the element of the same name in SetExpressCheckout request Character length and limitations 127 single byte alphanumeric characters Payer s contact telephone number NOTE PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one Character length and limitations Field mask is XXX XXX XXXX for US numbers or XXX XXXXXXXX for international numbers A discount or gift certificate offered by PayPal to the buyer This amount will be 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 The text entered by the buyer on the PayPal website if the ALLOWNOTE field was set to 1 in SetExpressCheckout Character length and limitations 255 singl
77. 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 parameter 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 81232 Invalid Parameter TransactionEntity Invalid parameter 81234 Invalid Parameter ExpDate Invalid parameter 81235 Invalid Parameter FirstName Invalid parameter 81236 Invalid Parameter LastName Invalid parameter 81237 Invalid Parameter Street Invalid parameter 81238 Invalid Parameter Street2 Invalid parameter 81239 Invalid Parameter City Invalid parameter 81243 Invalid P
78. UMBERO 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 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 Address Fields Field Description NAME SHIPTOSTREET Person s name associated with this shipping address Required if using a shipping address Character length and limitations 32 single byte characters First street address Required if using a shipping address Character length and limitations 100 single byte characters 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia DoExpressCheckoutPayment API Field Description SHIPTOSTREET2 Optional Second street address Character length and limitations 100 single byte characters SHIPTOCITY Name of city Required if using a shipping address Character length and limitations 40 single byte characters SHIPTOSTATE State or province Required if using a shipping address Character length an
79. UTC GMT format NOTE The profile may take up to 24 hours for activation PROFILEREFERENCE Optional The merchant s own unique reference or invoice number Character length and limitations 127 single byte alphanumeric characters ScheduleDetails Fields Field Description DESC Required Description of the recurring payment NOTE This field must match the corresponding billing agreement description included in the SetExpressCheckout request Character length and limitations 127 single byte alphanumeric characters MAXFAILEDPAYMENTS Optional The 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 Name Value Pair API Developer Guide 08 April 2009 97 a Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Field Description AUTOBILLAMT Optional This field 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 Valid values Must be NoAutoBill or AddToNextBilling 98 08 April 2009 Name Value Pair API Developer Guide Rec
80. You can not refund this type of transaction 10009 Transaction refused You can not do a partial refund on this transaction 10009 Transaction refused The account for the counterparty is locked or inactive 10009 Transaction refused You can not refund this type of transaction 10011 Invalid transaction id value Transaction refused because of an invalid transaction id value 11001 Transaction refused Transaction class is not supported because of an invalid argument See additional error messages for details Name Value Pair API Developer Guide 08 April 2009 203 API Error Codes Mass Pay API Errors Mass Pay 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 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
81. aces or punctutation Must conform with modulo and length required by each credit card type 08 April 2009 Name Value Pair API Developer Guide DoDirectPayment API DEE DoDirectPayment Request Field Description EXPDATE Credit card expiration date This field is required if you are using recurring payments with direct payments Format MMYYYY Character length and limitations Six single byte alphanumeric characters including leading zero CVV2 Card Verification Value version 2 Your Merchant Account settings determine whether this field is required Character length for Visa MasterCard and Discover exactly three digits Character length for American Express exactly four digits To comply with credit card processing regulations you must not store this value after a transaction has been completed STARTDATE Optional Month and year that Maestro or Solo card was issued the MMYYYY format Character length Must be six digits including leading zero ISSUENUMBER Optional Issue number of Maestro or Solo card Character length two numeric digits maximum Name Value Pair API Developer Guide 08 April 2009 29 fo DoDirectPayment API DoDirectPayment Request Payerlnfo Type Fields Field Description EMAIL Email address of payer Character length and limitations 127 single byte characters PAYERID Unique PayPal customer account identification number Character length and
82. address Character length and limitations 100 single byte characters SHIPTOCITY Name of city This field is required if the shipping address is used Character length and limitations 40 single byte characters SHIPTOSTATE State or province This field is required if the shipping address is used Character length and limitations 40 single byte characters SHIPTOZIP U S ZIP code or other country specific postal code This field is required if a U S shipping address is used and may be required for other countries Character length and limitations 20 single byte characters SHIPTOCOUNTRYCODE Country code This field is required if the shipping address is used Character limit 2 single byte characters SHIPTOPHONENUM Optional Phone number Character length and limit 20 single byte characters DoDirectPayment Response 36 08 April 2009 Name Value Pair API Developer Guide DoDirectPayment API DoDirectPayment Response 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 amp Capture 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 AVSCO
83. ails API on page 54 e DoExpressCheckoutPayment API on page 63 Callback API Updates the PayPal Review page with shipping options insurance and tax information e Callback Request on page 40 e Callback Response on page 42 Name Value Pair API Developer Guide 08 April 2009 39 fa Express Checkout API Operations Callback API Callback Request Callback Request Fields Field Description METHOD TOKEN CURREN CYCODE LOCA IRCODE L NAME n ERN L DESC L AMTn L QTYn n ITEMWEIGHTVALUEn ITEMWETGHTUNITn Required Must be Callback Optional A timestamped token the value of which was returned by SetExpressCheckout response Character length and limitations 20 single byte characters Required The three character currency code for the transaction from the Express Checkout API Default USD Optional Locale of pages displayed by PayPal during Express Checkout Character length and limitations Any two character country code The following two character country codes are supported by PayPal e AU DE FR IT GB ES US Any other value will default to US Item name from the Express Checkout API These parameters must be ordered sequentially beginning with 0 for example L_NAMEO L NAME1 Item number from the Express Checkout API These parameters must be ordered sequential
84. alid date in UTC GMT format NOTE The profile may take up to 24 hours for activation Name Value Pair API Developer Guide 08 April 2009 107 a Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Field Description PROFILEREFERENCE The merchant s own unique reference or invoice number Character length and limitations 127 single byte alphanumeric characters 108 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations a GetRecurringPaymentsProfileDetails API Ship To Address Type Fields Field Description ADDRESSSTATUS Status of street address on file with PayPal Valid values are 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 Character length and limitations 40 single byte characters Required for U S addresses only SHIPTOZIP U S ZIP code or other country specific postal code Character length and limitations 20 single b
85. alid 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 08 April 2009 Name Value Pair API Developer Guide Country Codes Country Codes Country Code AFGHANISTAN AF ALAND ISLANDS AX ALBANIA AL ALGERIA DZ AMERICAN SAMOA AS ANDORRA AD ANGOLA AO ANGUILLA Al 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 BELARUS BY BELGIUM BE BELIZE BZ BENIN BJ BERMUDA BM Name Value Pair API Developer Guide 08 April 2009 225 rm Country Codes 226 Country Code BHUTAN BT BOLIVIA BO BOSNIA AND HERZEGOVINA BA BOTSWANA BW BOUVET ISLAND BV BRAZIL BR BRITISH INDIAN OCEAN TERRITORY IO BRUNEI DARUSSALAM BN BULGARIA BG BURKINA FASO BF BURUNDI BI CAMBODIA KH CAMEROON CM CANADA CA CAPE VERDE CV CAYMAN ISLANDS KY CENTRAL AFRICAN REPUBLIC CF CHAD TD CHILE CL CHINA CN CHRISTMAS ISLAND CX COCOS KEELING ISLANDS CC COLOMBIA co C
86. ame Value Pair API Developer Guide 08 April 2009 195 196 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 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
87. ame Value Pair API Developer Guide 08 April 2009 85 86 MassPay API MassPay Request MassPay Request Fields Field Description METHOD Required Must be MassPay EMAILSUBJECT Optional The subject line of the email that PayPal sends when the transaction is completed The subject line is the same for all recipients Character length and limitations 255 single byte alphanumeric characters CURRENCYCODE A three character currency code See Currency Codes on page 239 RECEIVERTY PE Optional Indicates how you identify the recipients of payments in this call to MassPay Must be EmailAddress or UserID MassPay Item Type Fields Field Description L EMAILIN CEIVERIDn L_AMTn L UNIQUI L NOTI EIDN See description Email address of recipient NOTE You must specify either L EMAILn or L RECEIVERIDN but you must not mix the two in the group of MassPay items Use only one or the other but not both in a single request These parameters must be ordered sequentially beginning with 0 for example L EMAILO L EMAILI Character length and limitations 127 single byte characters maximum See description Unique PayPal customer account number This value corresponds to the value of PayerID returned by GetTransactionDetails NOTE You must specify either L EMAILN or L_RECEIVERIDn but you must not m
88. amount 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 NOTE Optional The reason for the non scheduled payment For profiles created using Express Checkout this message will be 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 BillOutstandingAmount Response Fields Field Description PROF ILEID Recurring payments profile ID returned in the CreateRecurringPaymentsProfile response An error is returned if the profile specified in the Bil lOutstandingAmount request has a status of canceled or expired UpdateRecurringPaymentsProfile API Update a recurring payments profile e UpdateRecurringPaymentsProfile Request on page 116 e UpdateRecurringPaymentsProfile Response on page 123 Name Value Pair API Developer Guide 08 April 2009 115 fa Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API UpdateRecurringPaymentsProfile Request e UpdateRecurringPaymentsProfile Request Fields e Ship To Address Fields e Credit Card Fields e Payer Information Fields e Address Fields 116 08 April 2009 Na
89. amount was excceeded as a result of your Maximum Amount Risk Control Settings 10539 Payment declined 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 Address1 Empty The field Shipping Address1 is required 10728 Shipping Address City The field Shipping Address City is Empty required 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 11547 Recurring payments Recurring payments temporarily temporarily unavailable try unavailable again later 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 11802 Invalid Data You cannot pass both the new and deprecated Custom parameter Name Value Pair API Developer Guide 08 April 2009 183 184 API Error Codes SetExpressCheck
90. and added additional DoOReferenceTransaction error codes Added Recurring Payments APIs SetCustomerBillingAgreement GetBillingAgreementCustomerDetails and CreateRecurringPaymentsProfile Bug fixes including updating Line Item Details for Direct Payment and Express Checkout APIs changing some parameters to optional in DoDirectPayment adding SHIPTOCOUNTRYCODE and adding Switch Solo codes for AVS and CVV2 Updates for bug fixes First public release 08 April 2009 Name Value Pair API Developer Guide PayPal NVP API Overview This overview describes the PayPal Name Value Pair NVP API at a high level e Introducing the PayPal NVP API on page 11 e Basic Steps on page 12 e Taking Your Application Live on page 13 e Technical Details on page 14 Introducing the PayPal NVP API The PayPal NVP API is a simple programmatic interface that allows you the merchant to access PayPal s business functionality to e Accept PayPal in checkout on your website using Express Checkout e Charge a credit card using Direct Payment e Capture payments previously authorized through Express Checkout Direct Payment or Website Payments Standard e Reauthorize or void previous authorizations e Pay one or more recipients using Mass Payment e Issue full refunds or multiple partial refunds e Search transactions using a start date or other criteria e View details of a specific transaction The P
91. annot be processed This transaction cannot be processed 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 The transaction was declined by PayPal Contact PayPal for more information The transaction was declined by PayPal because of possible fraudulent activity Contact PayPal for more information The transaction was declined by PayPal because of possible fraudulent activity on the IP address Contact PayPal for more information None this is a PayPal internal error 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 merchant The transaction was decline
92. aracter length and limitations 20 single byte characters Name Value Pair API Developer Guide 08 April 2009 101 a Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Field Description SHIPTOCOUNTRYCODE Country code This field is required if the shipping address is used Character limit 2 single byte characters SHIPTOPHONENUM Optional Phone number Character length and limit 20 single byte characters 102 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia CreateRecurringPaymentsProfile API Credit Card Details Fields Field Description CREDITCARDTYPE Required Type of credit card Character length and limitations Up to ten single byte alphabetic characters Allowable values e Visa e MasterCard e Discover e Amex e Maestro See note e Solo See note For Canada only MasterCard and Visa are allowable Interac debit cards are not supported NOTE If the credit card type is Maestro or Solo the CURRENCYCODE must be GBP In addition either STARTDATE or ISSUENUMBER must be specified ACCT Required Credit card number Character length and limitations numeric characters only No spaces or punctutation Must conform with modulo and length required by each credit card type EXPDATE Credit card expiration date This field is requ
93. arameter RefundType Invalid parameter Name Value Pair API Developer Guide 08 April 2009 163 164 API Error Codes Validation Errors Error Code Short Message Long Message 81244 Invalid Parameter StartDate Invalid parameter 81245 Invalid Parameter EndDate Invalid parameter 81247 Invalid Parameter CreditCardType Invalid parameter 81248 Invalid Parameter Username Invalid parameter 81249 Invalid Parameter Password Invalid parameter 81250 Invalid Parameter Version Invalid parameter 81251 Internal Error Internal Service Error 08 April 2009 Name Value Pair API Developer Guide API Error Codes Direct Payment API Errors Direct Payment API Errors DirectPayment API Errors Error Code Short Message Long Message Corrective Action 10102 10401 10418 10426 10427 10428 10429 10432 10500 10501 PaymentAction of Order Temporarily Unavailable 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 a
94. ard type is Maestro or Solo the CURRENCYCODE must be GBP In addition either STARTDATE or ISSUENUMBER must be specified ACCT Required Credit card number Character length and limitations numeric characters only No spaces or punctutation 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 Format MMYYYY Character length and limitations Six single byte alphanumeric characters including leading zero Name Value Pair API Developer Guide 08 April 2009 141 a Recurring Payments and Reference Transactions API Operations DoReference Transaction API Field Description CVV2 Card Verification Value version 2 Your Merchant Account settings determine whether this field is required Character length for Visa MasterCard and Discover exactly three digits Character length for American Express exactly four digits To comply with credit card processing regulations you must not store this value after a transaction has been completed STARTDATE Optional Month and year that Maestro or Solo card was issued the MMYYYY format Character length Must be six digits including leading zero ISSUENUMBER Optional Issue number of Maestro or Solo card Character length two numeric digits maximum 142 08 April 2009 Name Value Pair API Developer Guide
95. at 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 will tell you what field is invalid 10712 Invalid Data There s an error with this There was a problem with a transaction Please enter your five particular field in the address digit postal code in the billing The long error message will tell address you what field is invalid 10713 Invalid Data There s an error with this There was a problem with a transaction Please enter a country in the billing address particular field in the address The long error message will tell you what field is invalid 208 08 April 2009 Name Value Pair API Developer Guide API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 10744 10748 10751 10752 10760 11089 11501 11502 11503 11504 11505 11506 11507 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 Invalid max failed payments Invalid trial amount This transaction cannot be processed Please enter a valid country code in the billing add
96. ator must be a comma Equivalent to nine characters maximum for USD Optional If true the Insurance drop down on the PayPal Review page displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number Character length and limitations true or false 32 08 April 2009 Name Value Pair API Developer Guide DoDirectPayment API DEE DoDirectPayment Request Field Description HANDLINGAMT Optional Total handling costs for this order 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 NOTE If you specify a value for HANDLINGAMT you must also specify a value for ITEMAMT TAXAMT Optional Sum of tax for all items in this order 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 NOTE TAXAMT is required if you specify L_TAXAMTN DESC Optional Description of items the customer is purchasing Character length and limitations 127 single byte alphanumeric characters CUSTOM Optional A free form field for your
97. ayPal NVP API makes it easy to add PayPal to your web application You construct an NVP string and post it to the PayPal server using HTTPS PayPal posts back a reponse in NVP format Integrating with the PayPal API You can develop with the PayPal NVP API using two different approaches Integrate Directly You can integrate directly with the PayPal NVP API using the programming language of your choice This is the most straightforward and flexible approach You can download web samples that show how to integrate directly using Classic ASP PHP and ColdFusion Name Value Pair API Developer Guide 08 April 2009 11 12 PayPal NVP API Overview Basic Steps Integrate Using an SDK You can integrate with the NVP API using a software development kit SDK SDKs are provided for Java and ASP NET The SDKs provide simple functions for integrating with the NVP API Basic Steps This section describes the basic steps for programming with the PayPal NVP API During application development your application communicates with the PayPal Sandbox test environment Taking Your Application Live on page 13 describes how to move your application to the live PayPal environment Create a Web Application Your NVP API implementation usually runs in a web application You can write your own application or use one of the samples as a starting point Get API Credentials To access the PayPal API you need API credentials either an API signat
98. ayment 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 The reason for a reversal if TransactionType is reversal none No reason code chargeback A reversal has occurred on this transaction due to a chargeback by your customer guarantee A reversal has occurred on this transaction due to your customer triggering a money back guarantee buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your customer refund A reversal has occurred on this transaction because you have given the customer a refund other A reversal has occurred on this transaction due to a reason not listed above 80 08 April 2009 Name Value Pair API Developer Guide GetTransactionDetails API E GetTransactionDetails Response Field Description PROTECTIONELIGIBILI The the kind of seller protection in force for the transaction which is one of the TY following values e Eligible Seller is protected by PayPal s Seller Protection Policy for Unauthorized Payments and Item Not Received e PartiallyEligible Seller is protected by PayPal s Seller Protection Policy for Item Not Received e Ineligible Seller is not protected under the Seller Protection Policy Name Value Pair API Developer
99. character country codes are supported by PayPal e AU DE FR IT GB ES US Any other value will default to US See Country Codes on page 225 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 from the Profile subtab of the My Account tab of your PayPal account Character length and limitations 30 single byte alphabetic characters HDRIMG Optional 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 If you do not specify an image the business name is displayed Character length and limit 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 limitation Six character HTML hexadecimal color code in ASCI Name Value Pair API Developer Guide 08 April 2009 45 a Express Checkout API Operations SetExpressCheckout API Field Description HDRBACKCOLOR PAY FLOWCOLOR
100. customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments To change your preference go to the Preferences section of your Profile authorization The payment is pending because it has been authorized but not settled You must capture the funds first echeck The payment is pending because it was made by an eCheck that has not yet cleared intl The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overview multi currency You do not have a balance in the currency sent and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment You must manually accept or deny this payment order The payment is pending because it is part of an order that has been authorized but not settled paymentreview The payment is pending while it is being reviewed by PayPal for risk unilateral The payment is pending because it was made to an email address that is not yet registered or confirmed verify The payment is pending because you are not yet verified You must verify your account before you can accept this payment other The payment is pending for a reason other than those listed above For more information contact PayPal customer service The reason for a reversal if TransactionType is rev
101. d Description METHOD OFFERINSURANCEOPTIO L SHIPPINGOPTIONNAM En L_SHIPPINGOPTIONLAB ELn L_SHIPPINGOPTIONAMO UNTn L_SHIPPINGOPTIONISD EFAULT L_TAXAMTn L_INSURANCEAMOUNTn METHOD Required The method sent to the PayPal server The value is always CallbackResponse Optional Indicates whether or not PayPal should display insurance in a drop down list on the Review page When the value is true PayPal displays the drop down 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
102. d 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 Optional If true the Insurance drop down on the PayPal Review page displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number Character length and limitations true or false Optional Total handling costs for this order 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 NOTE If you specify a value for HANDLINGAMT you must also specify a value for ITEMAMT Optional Sum of tax for all items in this order 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 NOTE TAXAMT is required if you specify L_TAXAMTN 66 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations a DoExpressCheckoutPayment API Field Description DESC Optional Description of items the c
103. d 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 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 will tell you what field is invalid 10702 Invalid Data There s an error with this There was a problem with a particular transaction Please enter a valid address in the billing address field in the address The long error message will tell you what field is invalid Name Value Pair API Developer Guide 08 April 2009 169 170 API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 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 will tell you what 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 will tell you what field is invalid 10705
104. d NVP string over an HTTPS connection to one of the PayPal API servers PayPal provides a live server and a Sandbox server that allows you to process transactions in a test environment API Servers for API Signature Security If you use an API signature post the request to one of these servers Sandbox https api 3t sandbox paypal com nvp Live https api 3t paypal com nvp API Servers for API Certificate Security If you use an API certificate post the request to one of these servers Sandbox https api sandbox paypal com nvp Live https api paypal com nvp 18 08 April 2009 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference This chapter describes the PayPal API operations related to delayed payment settlement DoCapture API on page 19 DoAuthorization API on page 23 DoReauthorization API on page 24 DoVoid API on page 25 DoCapture API Capture an authorized payment e DoCapture Request on page 20 e DoCapture Response on page 21 Name Value Pair API Developer Guide 08 April 2009 a Authorization and Capture API Operation Reference DoCapture API DoCapture Request DoCapture Request Fields Field Description METHOD AUTHORIZATIONID CURRE INCYCODE COMP ET ETYPE INVNUM Bi NOTE Required Must be DoCapture Required The authorization identification number of the pa
105. d 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 11564 The number of failed The number of failed payments payments should be greater than the current number of failed payments should be greater than the current number of failed payments Name Value Pair API Developer Guide 08 April 2009 211 212 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 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 amount amount 11570 The maximum number of The maximum number of failed failed payments should be paym
106. d 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 to decline transaction when the AVS returned a partial match 168 08 April 2009 Name Value Pair API Developer Guide API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 10556 Filter Decline This transaction cannot be The transaction was declined because of processed a merchant risk filter for AVS Specifically the merchant has set to decline transaction when the AVS was unsupported 10561 Invalid Data There s an error with this transaction Please enter complete billing address 10562 Invalid Data This transaction cannot be processed Please enter a valid credit card expiration year 10563 Invalid Data This transaction cannot be processed Please enter a valid credit card expiration month 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 approve
107. d for your own use Character length and limitations 256 single byte alphanumeric bytes Optional Type of billing agreement The current status of the billing agreement which is one of the following values e Active the billing agreement is currently active e Canceled the billing agreement has been cancelled Maximum amount for this billing agreement NOTE This field only has a value if the customer signed up for PayPal using Preapproved Payments it is included for backwards compatibility with legacy systems Payer Information Fields Field Description EMAIL Email address of payer 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 payer Valid values are e verified e unverified Character length and limitations 10 single byte alphabetic characters SHIPTOCOUNTRYCODE Payer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations Two single byte characters PAYERBUSINESS Payer s business name Character length and limitations 127 single byte characters Payer Name Fields Field Description SALUTATION Payer s salutation Character length and limitations 20 single byte characters 132 08 April 2009 Name Value Pair API Developer Guide Recur
108. d limitations 40 single byte characters SHIPTOZIP 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 SHIPTOCOUNTRY Country code Required if using a shipping address Character limit 2 single byte characters PHONENUM Optional Phone number Character length and limit 20 single byte characters DoExpressCheckoutPayment Response e DoExpressCheckoutPayment Response Fields e Payment Information Fields Name Value Pair API Developer Guide 08 April 2009 71 72 Express Checkout API Operations DoExpressCheckoutPayment API 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 NOTE The text entered by the buyer on the PayPal website if the ALLOWNOTE field was set to 1 in SetExpressCheckout Character length and limitations 255 single byte characters REDIRECTREQUIRE Flag to indicate whether you need to redirect the customer to back to PayPal after L_EMFfilterIDn L_EMFfilterNAMEN completing the transaction NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany Filter ID includi
109. d to 0 if the transaction does not include a one time purchase for example when you set up a billing agreement for a recurring payment that is not immediately charged 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 CURRENCYCODE Optional A three character currency code Default USD ITEMAMT Optional Sum of cost of all items in this order 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 NOTE ITEMAMT is required if you specify L_AMTn 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations SetExpressCheckout API Field Description SHIPPINGAMT INSURANCEAMT SHIPPINGDISCOUNT INSURANCEOPTIONOFFE RED HANDLINGAMT TAXAMT CUSTOM Optional Total shipping costs for this order 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 NOTE If you specify a value for SHIPPINGAMT you must also specify a value for ITEMAMT Optional T
110. d to Express Checkout token was issued for access this info a merchant account other than yours 10410 Invalid token Invalid token Name Value Pair API Developer Guide 08 April 2009 187 API Error Codes GetExpressCheckoutDetails API Errors Error Code Short Message Long Message Correcting This Error 10411 This Express Checkout session has expired This Express Checkout session has expired Token value is no longer valid 188 08 April 2009 Name Value Pair API Developer Guide API Error Codes DoExpressCheckoutPayment API Errors DoExpressCheckoutPayment API Errors Errors Error Code Short Message Long Message Correcting This Error 10001 Internal Error Transaction failed due to internal error 10001 Internal Error Warning an internal error has occurred The transaction id may not be correct 10001 ButtonSource value The transaction could not be truncated loaded 10001 Internal Error Internal Error 10004 Transaction refused Transaction refused because of because of an invalid an invalid argument See argument See additional additional error messages for error messages for details details 10004 Transaction refused The transaction id is not valid because of an invalid argument See 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
111. ded Order is voided 10623 Maximum number of Maximum number of authorization authorization allowed for allowed for the order is reached the order is reached 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 Address1 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 State is Shipping address error in state Empty required field 10730 Shipping Address Postal The field Shipping Address Postal Shipping address error in postal 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 11302 Cannot pay self The transaction was refused
112. e on page 71 Name Value Pair API Developer Guide 08 April 2009 63 64 Express Checkout API Operations DoExpressCheckoutPayment API DoExpressCheckoutPayment Request DoExpressCheckout Request Fields Payment Details Type Fields eBay Item Payment Details Item Type Fields Payment Details Item Type Fields Address Fields 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations a DoExpressCheckoutPayment API DoExpressCheckoutPayment Request Fields Field Description METHOD Required Must be DoExpressCheckoutPayment TOKEN Required The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request Character length and limitations 20 single byte characters PAYMENTACTION Required How you want to obtain payment e Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization amp Capture e Order indicates that this payment is is an order authorization subject to settlement with PayPal Authorization amp Capture e Sale indicates that this is a final sale for which you are requesting payment NOTE You cannot set this value to Sale on SetExpressCheckout request and then change this value to Authorization on the final PayPal Express Checkout API DoExpressCheckoutPayment request Character length and limit Up to 13 single byte alphabetic characters
113. e entire postal address is confirmed Unconfirmed PayPal responds that the postal address is unconfirmed NOTE The values Confirmed and Unconfirmed both indicate that the member email address passed verification 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 three 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 156 08 April 2009 Name Value Pair API Developer Guide AddressVerify API oa AddressVerify Response Field Description ZIPMATCH 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 COUNTRYCODE Two character country code ISO 3166 on file for the PayPal email address See Country Codes on page 225 TOKEN 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 preven
114. e APl a a 2 ace eed Sea da Se RA aa RRA ER Re hae we cee he 19 DoCapture Request 0000 2 ee ee 20 DoCapture Response 0000 ee 21 DoAuthorization APIs so abe edge ed eo eG EE we ow AG ae se 23 DoAuthorization Request 0 0000 ee ee 24 DoAuthorization Response 0000 ee ee 24 DoReauthorization API 2 a aaa a 24 Name Value Pair API Developer Guide 08 April 2009 fara Contents Chapter 3 Chapter 4 Chapter 5 Chapter 6 Chapter 7 DoReauthorization Request DoReauthorization Response DoVoid API a a aoed ee i e a a aa A DoVoid Request aoaaa a a DoVoid Response oaoa a aa a a 00008 DoDirectPayment API DoDirectPayment Request DoDirectPayment Response Express Checkout API Operations Callback API 2 eaa aaa a a a Callback Request o aa Callback Response noaoae SetExpressCheckout API oaoa aaa SetExpressCheckout Request aoaaa aaa SetExpressCheckout Response GetExpressCheckoutDetails API GetExpressCheckoutDetails Request GetExpressCheckoutDetails Response DoExpressCheckoutPayment API DoExpressCheckoutPayment Request DoExpressCheckoutPayment Response GetTransactionDetails API GetTransactionDetails Request GetTransactionDetails Response MassPay API MassPay
115. e associated amount and the string Yes SetExpressCheckout API Initiates an Express Checkout transaction Optionally the SetExpressCheckout API operation can set up billing agreements for reference transactions and recurring payments e Callback Request on page 40 e SetExpressCheckout Response on page 54 SetExpressCheckout Request e SetExpressCheckout Request Fields on page 44 e Address Fields on page 48 e Payment Details Type Fields on page 48 e Payment Details Item Type Fields on page 51 e EbayltemPaymentDetailsItemType Fields on page 53 e Shipping Options Type Fields on page 53 e Billing Agreement Details Fields on page 54 Name Value Pair API Developer Guide 08 April 2009 43 44 Express Checkout API Operations SetExpressCheckout API SetExpressCheckout Request Fields Field Description METHOD TOKEN MAXAMT RETURNURL CANCELURL CALLBACKURL CALLBACKURL REQCONFIRMSHIPPING NOSHIPPING Required Must be SetExpressCheckout Optional A timestamped token the value of which was returned by SetExpressCheckout response Character length and limitations 20 single byte characters Optional The expected maximum total amount of the complete order including shipping cost and tax charges If the transaction does not include a one time purchase this field is ignored Limitations Must not exceed 10
116. e byte characters Flag to indicate whether you need to redirect the customer to back to PayPal after completing the transaction NOTE Use this field only if you are using giropay or bank transfer payment methods in Germany Payer Information Fields Field Description EMAIL PAYERID PAYERSTATUS Email address of payer Character length and limitations 127 single byte characters Unique PayPal customer account identification number Character length and limitations 13 single byte alphanumeric characters Status of payer Valid values are e verified e unverified Character length and limitations 10 single byte alphabetic characters 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia GetExpressCheckoutDetails API Field Description COUNTRY CODE Payer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations Two single byte characters BUSINESS Payer s business name Character length and limitations 127 single byte characters Name Value Pair API Developer Guide 08 April 2009 57 Express Checkout API Operations GetExpressCheckoutDetails API Payer Name Fields Field Description SALUTATION Payer s salutation Character length and limitations 20 single byte characters FIRSTNAME Payer s first name Character length and limitations 25 single byte characters
117. e characters maximum ACCT Optional Search by credit card number as set by you for the original transaction This field searches the records for items sold by the merchant not the items purchased 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 AUCTIONITEMNUMBER Optional Search by auction item number of the purchased goods 92 08 April 2009 Name Value Pair API Developer Guide TransactionSearch API a TransactionSearch Request Field Description TRANSACTIONCLASS 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 e All all transaction classifications Sent only payments sent Received only payments received MassPay only mass payments MoneyRequest only money requests FundsAdded only funds added to balance FundsWithdrawn only funds withdrawn from balance Referral only transactions involving referrals Fee only transactions involving fees Subscription only transactions involving subscriptions Dividend only transactions involving dividends Billpay only transactions involving BillPay Transactions Refund only transactions involving funds CurrencyConversions only transactions involving currency conversion
118. e characters maximum for USD 100 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Activation Details Type 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 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 Optional By default PayPal will suspend the pending profile in the event that the initial payment amount fails You can override this default behavior by setting this field to ContinueOnFailure which indicates that if the initial payment amount fails PayPal should add the failed payment amount to the outstanding balance for this recurring payment profile When this flag is set to Cont inueOnFailure a success code will be returned to the merchant in the CreateRecurringPaymentsProfile response and the recurring payments profile will be activated for scheduled billing immediately You should check your IPN messages or PayPal account for updates of the payment status If this field is not set or is set to
119. e does not store these values securely The sample code should never be used in production You may see sample code where these values are stored in an HTML form The following is an example of what you should NOT do in production lt form method post action h lt input type hidden name USI lt input type hidden name PW ttps api 3t sandbox paypal com nvp gt lt UNPROTECTED VALUES DO NOT USE IN PRODUCTION gt ER value xxxxxx paypal com gt D value abcdefg gt lt input type hidden name SIGNATURE valuce XXXXXXXXXXXXXXX gt lt form gt API Parameters The request body must contain the name of the API method in the METHOD parameter In addition each method has required and optional parameters 16 METHOD methodName requiredAndOptionalParameters 08 April 2009 Name Value Pair API Developer Guide PayPal NVP API Overview a Technical Details Response Format A response from the PayPal servers is a URL encoded name value pair string just like the request except it has the following general format General Format of a Successful Response Success Response Fields ACK Success amp TIMESTAMP date timeOfRespons amp CORRELATIONID debuggingToken amp VERSION amp BUILD buildNumber API Response Fields amp NAME1 valuel amp NAME2 value2 amp NAME3 value3 amp Each response includes the ACK field If the ACK field s value is Success or S
120. e number Character length and limit 20 single byte characters DoNonReferencedCredit Response DoNonReferencedCredit Response Fields Field Description TRANSACTIONID Unique identifier of a transaction Character length and limitations 17 single byte alphanumeric characters CURRENCYCODE Currency code The only valid currencies are AUD CAD EUR GBP JPY and USD 150 08 April 2009 Name Value Pair API Developer Guide ManagePendingTIransactionStatu s API Accept or deny a pending transaction held by Fraud Management Filters e ManagePendingTransactionStatus Request on page 151 e ManagePendingTransactionStatus Response on page 151 ManagePendingTransactionStatus Request 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 which is one of the following actions e Accept accepts the payment e Deny rejects the payment ManagePendingTransactionStatus Response ManagePendingTransactionStatus Response Fields Field Description TRANSACTIONID The transaction ID of the transaction whose payment has been denied or accepted STATUS The status of the transaction which is one of the following values e Pending e Processing Completed Denied
121. e of the following values e Day e Week e SemiMonth e Month e 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 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 Name Value Pair API Developer Guide 08 April 2009 119 fa Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Field Description TOTALBILLINGCYCLES TRIALBILLINGPERIOD TRIALBILLINGFRE QUE NCY TRIALTOTALBILLINGCY CLES Optional The 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 pe
122. e ordered sequentially beginning with 0 for example L_ITEMWIDTHVALUEO L ITEMWIDTHVALUE1 ITEMLENGTHVALUEn The length of the item You can pass this data to the shipping carrier as is without ITEMLENGTHUNITn having to make an additional database query These parameters must be ordered sequentially beginning with 0 for example ITEMLENGTHVALUEO ITEMLENGTHVALUE1 SHIPTOSTREET First street address Required if using a shipping 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 Required if using a shipping address Character length and limitations 40 single byte characters SHIPTOSTATE State or province 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 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 Required if using a shipping address Character limit 2 single byte characters Name Value Pair API Developer Guide 08 April 2009 41 42 Express Checkout API Operations Callback API Callback Response Callback Response Fields Fiel
123. earch Response on page 94 TransactionSearch Request e TransactionSearch Request Fields on page 92 e Payer Name Fields on page 94 Name Value Pair API Developer Guide 08 April 2009 91 a TransactionSearch API TransactionSearch Request TransactionSearch Request Fields Field Description METHOD Required Must be TransactionSearch STARTDATE Required The earliest transaction date at which to start the search No wildcards are allowed The value must be in UTC GMT format ENDDATE Optional The latest transaction date to be included in the search 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 this is the primary email Can also be a non primary email RECEIPTID Optional Search by the PayPal Account Optional receipt ID 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 sold by the merchant not the items purchased NOTE No wildcards are allowed Character length and limitations 127 single byt
124. ell you what field is invalid Name Value Pair API Developer Guide 08 April 2009 171 172 API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 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 address in the shipping address message will tell you what 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 will tell you what 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 will tell you what 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 will tell you what 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 will tell you what field is shipping address invalid 10725 Invalid Data There s an error with this There was a probl
125. em with a particular transaction Please enter a valid field in the address The long error country in the shipping address message will tell you what 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 will tell you what 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 will tell you what field is invalid 10727 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 shipping address message will tell you what field is invalid 10727 Invalid Data There s an error with this There was a problem with a particular transaction Please enter an address 1 in the shipping address field in the address The long error message will tell you what field is invalid 08 April 2009 Name Value Pair API Developer Guide API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 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 In
126. ency 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 These parameters must be ordered sequentially beginning with 0 for example L_TAXAMTO L_TAXAMT1 ITEMWEIGHTVALUEn Optional Item weight corresponds to the weight of the item You can pass this data ITEMWEGHTUNITn 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 Character length and limitations Any positive integer ITEMLENGTHVALUEn Optional Item length corresponds to the length of the item You can pass this data to ITEMLENGTHUNITn 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_ITEMLENGTHVALUEO L_ITEMLENGTHVALUE1 Character length and limitations Any positive integer Name Value Pair API Developer Guide 08 April 2009 61 Express Checkout API Operations GetExpressCheckoutDetails API Field Description ITEMWIDTHVALUEn Optional Item width corresponds to the width of the item You can pass this data to ITEMWIDTHUNITn the shipping carrier as is without havi
127. ents 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 11590 Profile update is not Based on your input request required profile already up to date 15004 Gateway Decline This transaction cannot be processed Please enter a valid Credit Card Verification Number 08 April 2009 Name Value Pair API Developer Guide SetCustomerBillingAgreement Errors API Error Codes SetCustomerBillingAgreement Errors SetCustomerBillingAgreement Errors Erro
128. equentially beginning with 0 for example L_ITEMWIDTHVALUEO L ITEMWIDTHVALUE1 Character length and limitations Any positive integer L_ITEMHEIGHTVALUEn Optional Item height corresponds to the height of the item You can pass this data to L_ITEMHEIGHTUNITn 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 L ITEMHEIGHTVALUE1 Character length and limitations Any positive integer 52 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia SetExpressCheckout API EbayltemPaymentDetailsltemType 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 NIDn These parameters must be 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 se
129. equest e DoReauthorization Response 24 08 April 2009 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference ioe DoVoid API DoReauthorization Request DoReauthorization Request Fields Field Description METHOD Required Must be DoReauthorization AUTHORIZATIONID Required The value of a previously authorized transaction identification number returned by PayPal Character length and limits 19 single byte characters maximum AMT Required Amount to reauthorize Limitations Value is a positive number which cannot 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 CURRENCY CODE A three character currency code See Currency Codes on page 239 DoReauthorization Response DoReauthorization Response Fields Field Description AUTHORIZATIONID A new authorization identification number Character length and limits 19 single byte characters maximum DoVoid API Void an order or an authorization e DoVoid Request e DoVoid Response Name Value Pair API Developer Guide 08 April 2009 25 a Authorization and Capture API Operation Reference DoVoid API DoVoid Request DoVoid Request Fields Field Description METHOD Required Must be DoVoid AUTHORIZATIONID Required The value of the original authorization ide
130. er 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 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 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 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 08 April 2009 117 fa Recurring Payments and Reference Transactions API Operations UpdateRecurringPaymentsProfile API Field Description 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 Does not exceed 10 000 USD in any currency No currency symbol Regardless of
131. ersal none No reason code chargeback A reversal has occurred on this transaction due to a chargeback by your customer guarantee A reversal has occurred on this transaction due to your customer triggering a money back guarantee buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your customer refund A reversal has occurred on this transaction because you have given the customer a refund other A reversal has occurred on this transaction due to a reason not listed above 146 08 April 2009 Name Value Pair API Developer Guide DoNonReferencedCredit API Issue a credit to a card not referenced by the original transaction e DoNonReferencedCredit Request on page 147 e DoNonReferencedCredit Response on page 150 DoNonReferencedCredit Request e DoNonReferencedCredit Request Fields e Credit Card Fields e Payer Information Fields e Address Fields Name Value Pair API Developer Guide 08 April 2009 147 a DoNonReferencedCredit API DoNonReferencedCredit Request DoNonReferencedCredit Request Fields Field Description METHOD Required Must be DoNonReferencedCredit AMT Required Total of order including shipping handling and tax 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 Am
132. erview page 10481 Transaction refused PaymentAction of because of an invalid Authorization is not allowed argument See additional with Unilateral and Non error messages for details Credentialed authentication 10482 Transaction refused PaymentAction of Order is not because of an invalid allowed with Unilateral and argument See additional Non Credentialed error messages for details authentication 10537 Risk Control Country The transaction was refused Filter Failure because the country was prohibited as a result of your Country Monitor Risk Control Settings 08 April 2009 Name Value Pair API Developer Guide DoExpressCheckoutPayment API Errors API Error Codes Error Code Short Message Long Message Correcting This Error 10538 10539 10725 10727 10728 10729 10730 10731 10736 11610 11611 11612 11820 Risk Control Max Amount Failure Payment declined by your Risk Controls settings PayPal Risk Model Shipping Address Country Error Shipping Address 1 Empty Shipping Address City Empty Shipping Address State Empty Shipping Address Postal Code Empty Shipping Address Country Empty Shipping Address Invalid City State Postal Code 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 because of an invalid a
133. essages 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 Internal Error Warning an internal error has occurred The transaction id may not be correct The transaction could not be loaded Internal Error 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 partial refund amount must be a positive amount You can not specify a partial amount with a full refund A transaction id is required Transaction class is not supported Name Value Pair API Developer Guide 08 April 2009 201 202 API Error Codes RefundTransaction API Errors Error Code Short Message Long Message Correcting This Error 10004 Transaction refused The transaction id is not valid because of an invalid argument See additional error messages for details 10007 Permission denied You do not have permission to refund this transaction 10007 Permission denied You do not have permissions to make this API call 10009 Transaction refused You do not have a verified ACH This error can be caused by ins
134. etumURL is invalid CancelURL is invalid Merchant not enabled for reference transactions Reference transaction feature not currently available try again later Billing address request is not enabled for merchant Feature not yet available cpp_payflow_color tag is too long maximum length is 6 ReturnURL tag contains invalid URL CancelURL tag contains invalid URL This merchant is not enabled for Mark reference transaction Warning only Feature not enabled because system is running in standin mode Warning only 214 08 April 2009 Name Value Pair API Developer Guide API Error Codes GetBillingAgreementCustomerDetails Errors GetBillingAgreementCustomerDetails Errors GetBillingAgreementCustomerDetails 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 invalid 10411 This Express Checkout This Express Checkout session has 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
135. f an invalid PayPal recommends that you return argument See additional your customer to PayPal to 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 customer 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 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 argument See additional error messages for details been truncated Name Value Pair API Developer Guide 08 April 2009 191 192 API E
136. f payer Valid values are e verified e unverified Character length and limitations 10 single byte alphabetic characters SHIPTOCOUNTRYCODE Payer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations Two single byte characters PAYERBUSINESS Payer s business name Character length and limitations 127 single byte characters Payer Name Fields Field Description SALUTATION Payer s salutation Character length and limitations 20 single byte characters FIRSTNAME Payer s first name Character length and limitations 25 single byte characters MIDDLENAME Payer s middle name Character length and limitations 25 single byte characters LASTNAME Payer s last name Character length and limitations 25 single byte characters SUFFIX Payer s suffix Character length and limitations 12 single byte characters Ship To Address Type Fields Field Description ADDRESSSTATUS Status of street address on file with PayPal Valid values are e none e Confirmed e Unconfirmed Name Value Pair API Developer Guide 08 April 2009 129 fa Recurring Payments and Reference Transactions API Operations BAUpdate API Field Description SHIPTONAME Person s name associated with this address Character length and limitations 32 single byte characters SHIPTOSTREET First street address Character le
137. fileStatus Response on page 114 Name Value Pair API Developer Guide 08 April 2009 113 Recurring Payments and Reference Transactions API Operations BillOutstandingAmount API ManageRecurringPaymentsProfileStatus Request ManageRecurringPaymentsProfileStatus Request Fields Field Description METHOD Required Must be ManageRecurringPaymentsProfileStatus 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 compatability with previous versions of the PayPal API ACTION Required The 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 Reactivate 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 will be included in the email notification to the buyer when the status of the profile is successfully changed and can also be seen by both you and the buyer on the Status History page of the PayPal account ManageRecurringPaymentsProfileStatus Response ManageRecurringPaymentsProfileStatus Response Fields Field Description PROF ILEID Recurring payments profile ID
138. g Payments and Reference Transactions API Operations DoReferenceTransaction Response Fields for Express Checkout Field Description AVSCODE Address Verification System response code See AVS and CVV2 Response Codes on page 241 for possible values Character limit One single byte alphanumeric character CVV2MATCH Result of the CVV2 check by PayPal BILLINGAGREEMENTID Returned if the value of ReferencelID in the request is a billing agreement identification number L FMFfilterIDn Filter ID including the filter type which is either ACCEPT or DENY the filter ID and 7 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 L_FEMFfilterNAMEN Filter name including the filter type which is either ACCEPT or DENY the filter NAME and the entry number n starting from 0 Payment Information Fields Field Description TRANSACTIO
139. ge Long Message Corrective Action 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 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 com
140. haracter length and limitations 2 048 single byte alphanumeric characters 60 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia GetExpressCheckoutDetails API Payment Details Item Type 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 AMTn Optional Cost of item These parameters must be ordered sequentially beginning with 0 for example L AMTO L AMT1 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 NOTE Ifyou specify a value for L_ AMTn you must specify a value for ITEMAMT 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 characters L OTYn Optional Item quantity These parameters must be ordered sequentially beginning with 0 for example L OTYO L OTY1 Character length and limitations Any positive integer L_TAXAMTn Optional Item sales tax NOTE Character length and limitations Must not exceed 10 000 USD in any curr
141. he 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 Optional Type of checkout flow e Sole Express Checkout for auctions e Mark Normal Express Checkout Optional Type of PayPal page to display e Billing non PayPal account e Login PayPal account login Optional Type of channel e Merchant non auction seller e eBayltem eBay auction Optional The URL on the merchant site to redirect to after a successful giropay payment Use this field only if you are using giropay or bank transfer payment methods in Germany 46 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia SetExpressCheckout API Field Description GIROPAYCANCELURL Optional The URL on the merchant site to redirect to after a successful giropay payment 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 Use this field only if you are using giropay or bank transfer payment methods in Germany Name Value Pair API Developer Guide 08 April 2009 47 48 Express Checkout API Operations SetExpressCheckout API Address Fields Field Description NAME SHIPTOSTREET SHIPTOCITY SHI
142. he shipping amount of the selected shipping option 194 08 April 2009 Name Value Pair API Developer Guide API Error Codes Authorization and Capture API Errors Authorization and Capture API Errors Authorization amp 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 DoAuthorization 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 N
143. his transaction Please enter a valid postal code in the billing address There s an error with this transaction Please enter a valid city and state in the billing address There s an error with this transaction Please enter a valid shipping address There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will t
144. his merchant Name Value Pair API Developer Guide 08 April 2009 207 a API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 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 will tell you what field is invalid 10710 Invalid Data There s an error with this There was a problem with a transaction Please enter a city in particular field in the address the billing address The long error message will tell you wh
145. ides the setting you have specified in your Merchant Account Profile Character length and limitations One single byte numeric character Allowable values 0 1 Optional The value 1 indicates that on the PayPal pages no shipping address fields should be displayed whatsoever Character length and limitations One single byte numeric character Allowable values 0 1 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia SetExpressCheckout API Field Description ALLOWNOTE Optional The value 1 indicates that the customer may 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 Character length and limitations One single byte numeric character Allowable values 0 1 ADDRESSOVERRIDE Optional The value 1 indicates that 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 customer Displaying the PayPal street address on file does not allow the customer to edit that address Character length and limitations One single byte numeric character Allowable values 0 1 LOCALECODE Optional Locale of pages displayed by PayPal during Express Checkout Character length and limitations Any two character country code The following two
146. iew 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 The reason for a reversal if TransactionType is reversal none No reason code chargeback A reversal has occurred on this transaction due to a chargeback by your customer guarantee A reversal has occurred on this transaction due to your customer triggering a money back guarantee buyer complaint A reversal has occurred on this transaction due to a complaint about the transaction from your customer refund A reversal has occurred on this transaction because you have given the customer a refund other A reversal has occurred on this transaction due to a reason not listed above 74 08 April 2009 Name Value Pair API Developer Guide GetTransactionDetai
147. iled reponses Taking Your Application Live After you have finished coding and testing your application deploy your application to the live PayPal server using your PayPal business account and API credentials for that account Set Up a PayPal Business Account When you are ready to deploy your application to the live PayPal server create a PayPal business account on https www paypal com Set Up API Credentials To use the APIs you need a set of credentials to identify yourself to PayPal Create an API signature for your business account For instructions on setting up API credentials for the business account go to https www paypal com IntegrationCenter ic_certificate html IMPORTANT If you are using API signature you must protect the API signature values 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 The sample code does not store these values securely The sample code should never be used in production NoTE While API signature is recommended you can also use API certificate Modify Your Code In your application change the following items from the PayPal Sandbox values to the live PayPal server values Name Value Pair API Developer Guide 08 April 2009 13 14 PayPal NVP API Overview Technical Details e The server addre
148. illing 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 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 CURRENCYCODE Required A three character currency code Default USD 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 Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD TAXAMT 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 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 08 April 200
149. ion 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 Obtain information about an Express Checkout transaction e GetExpressCheckoutDetails Request on page 55 e GetExpressCheckoutDetails Response on page 55 54 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations GetExpressCheckoutDetails API GetExpressCheckoutDetails Request GetExpressCheckoutDetails Request Fields Field Description METHOD Required Must be GetExpressCheckoutDetails TOKEN Required A timestamped token the value of which was returned by SetExpressCheckout response Character length and limitations 20 single byte characters GetExpressCheckoutDetails Response e GetExpressCheckoutDetails Response Fields e Payer Information Fields e Payer Name Fields e Ship To Address Fields e Payment Details Type Fields e Payment Details Item Type Fields e eBay Item Payment Details Item Type Fields Name Value Pair API Developer Guide 08 April 2009 55 56 Express Checkout API Operations GetExpressCheckoutDetails API GetExpressCheckoutDetails
150. ion 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 customer that PayPal is complete complete successfully Instruct unable to process the payment and the customer to use an redisplay alternative payment methods alternative payment method with which the customer 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 PayerID 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 different customer belongs to a different customer Token value mismatch associating the Tokens and PayerIDs 08 April 2009 Name Value Pair API Developer Guide API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 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 o
151. ired Country code Character limit Two single byte characters DoReferenceTransaction API Process a payment from a buyer s account which is identified by a previous transaction e DoReferenceTransaction Request on page 134 Name Value Pair API Developer Guide 08 April 2009 133 DoReference Transaction API i Recurring Payments and Reference Transactions API Operations e DoReferenceTransaction Response on page 143 DoReferenceTransaction Request e DoReferenceTransaction Request Fields e Ship To Address Fields e Payment Details Type Fields e Payment Details Item Type Fields e eBay Item Payment Details Item Type Fields e Credit Card Fields e Payer Information Fields e Billing Address Fields 134 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia DoReference Transaction API 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 e Authorization indicates that this payment is a basic authorization subject to settlement with PayPal Authorization amp Capture e Sale indicates that this is a final sale for which you are requesting payment RETURNE
152. ired if you are using recurring payments with direct payments Format MMYYYY Character length and limitations Six single byte alphanumeric characters including leading zero CVV2 Card Verification Value version 2 Your Merchant Account settings determine whether this field is required Character length for Visa MasterCard and Discover exactly three digits Character length for American Express exactly four digits To comply with credit card processing regulations you must not store this value after a transaction has been completed STARTDATE Optional Month and year that Maestro or Solo card was issued the MMYYYY format Character length Must be six digits including leading zero ISSUENUMBER Optional Issue number of Maestro or Solo card Character length two numeric digits maximum Payerlnfo Type Fields Field Description EMAIL Email address of payer Character length and limitations 127 single byte characters PAYERID Unique PayPal customer account identification number Character length and limitations 13 single byte alphanumeric characters Name Value Pair API Developer Guide 08 April 2009 103 a Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Field Description PAYERSTATUS Status of payer Valid values are e verified e unverified Character length and limitations 10 single byte alphabetic characters COUNT
153. isabled 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 08 April 2009 Name Value Pair API Developer Guide API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10216 10400 10401 10402 10406 10412 10413 10414 10417 10417 10418 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
154. ix the two in the group of MassPay items Use only one or the other but not both in a single request These parameters must be ordered sequentially beginning with 0 for example L_RECEIVERIDO L RECEIVERID1 Character length and limitations 17 single byte characters maximum Required Payment amount These parameters must be ordered sequentially beginning with 0 for example L_AMTO L_AMT1 NOTE You cannot mix currencies in a single MassPayRequest A single request must include items that are of the same currency Optional Transaction specific identification number for tracking in an accounting system These parameters must be ordered sequentially beginning with 0 for example L_UNIQUEIDO L_UNIQUEID1 Character length and limitations 30 single byte characters No whitespace allowed Optional Custom note for each recipient Character length and limitations 4 000 single byte alphanumeric characters 08 April 2009 Name Value Pair API Developer Guide MassPay API MassPay Response MassPay Response The fields in the response are the standard response header fields Name Value Pair API Developer Guide 08 April 2009 87 Ln MassPay API MassPay Response 88 08 April 2009 Name Value Pair API Developer Guide RefundTransaction API Issue a refund to the PayPal account holder associated with a transaction e RefundTransaction Request on page 89 e RefundTransac
155. le Not applicable W Whole ZIP Nine digit ZIP code no Address 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 AVS Response Codes for Maestro and Solo 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 08 April 2009 Name Value Pair API Developer Guide AVS and CVV2 Response Codes ioe CVV2 Response Codes AVS Code Meaning Matched Details 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 CVV2 Response Codes e CVV2 Response Codes for Visa MasterCard Discover and American Express e CVV2 Response Codes for Maestro and Solo CVV2 Response Codes for Visa MasterCard Discover and American Express CVV2 Code Meaning Matched Details M Match CVV2CSC N No match None P Not processed Not applicable S Service not supported Not applicable U Service not available Not applicable X No response Not applicable CVV2 Response Codes for Maestro and Solo CVV2 Code Meaning Matched Details 0 Matched CVV2 1 No match None
156. 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 CURRENCYCODE A three character currency code FEEAMT PayPal fee amount charged for the transactionCharacter length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD SETTLEAMT Amount deposited in your PayPal account after a currency conversion 78 08 April 2009 Name Value Pair API Developer Guide GetTransactionDetails API E GetTransactionDetails Response Field Description TAXAMT Tax charged on the transaction Character length and limitations Does not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD EXCHANGERATE Exchange rate if a currency conversion occurred Relevant only if your are billing in their non primary currency If the customer chooses to pay with a currency other than the non primary currency the conversion occurs in the customer s account Character length and limitations a decimal that does not exceed 17
157. less of currency decimal separator must be a period and the optional thousands separator must be a comma Equivalent to nine characters maximum for USD NOTE If you specify a value for HANDLINGAMT you must also specify a value for ITEMAMT TAXAMT Optional Sum of tax for all items in this order 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 NOTE TAXAMT is required if you specify L_TAXAMTN DESC Optional Description of items the customer is purchasing Character length and limitations 127 single byte alphanumeric characters CUSTOM Optional A free form field for your own use Character length and limitations 256 single byte alphanumeric characters INVNUM Optional Your own invoice or tracking number Character length and limitations 127 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 NOTE If you do not specify this value in the request the notification URL from your Merchant Profile is used if one exists C
158. lid agreement is disabled or merchant configuration inactive 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 processed Please enter a valid The CVV is between 3 4 digits Credit Card Verification Number long 10505 Gateway Decline This transaction cannot be The transaction was refused processed because the AVS response returned the value of N and the merchant account is not able to accept such transactions 10507 Invalid Configuration This transaction cannot be Your PayPal account is restricted processed Please contact PayPal contact PayPal for more Customer Service information 10508 Invalid Data This transaction cannot be The expiration date must be a processed Please enter a valid two digit month and four digit credit card expiration date year 10509 Invalid Data This transaction cannot be You must submit an IP address processed of the buyer with each API call 10510 Invalid Data The credit card type is not The credit card type entered is supported Try another card type not currently supported by PayPal 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 name required for t
159. ls API Obtain information about a specific transaction e GetTransactionDetails Request on page 75 e GetTransactionDetails Response on page 75 GetTransactionDetails Request 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 NOTE All fields defined in the formal structure of Get TransactionDetailsResponse are not necessarily returned Data are returned in a response only if PayPal has recorded data that corresponds to the field e Receiver Information Fields e Payer Information Fields e Address Fields e Payer Name Fields e Payer Name Fields e Payment Information Fields e Payment Item Information Fields e Subscription Fields e Subscription Terms Fields Name Value Pair API Developer Guide 08 April 2009 GetTransactionDetails API GetTransactionDetails Response Receiver Information Fields Field Description RECEIVEREMAIL Primary email address of the payment recipient the seller 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
160. ls Response Field Description PENDINGREASON 2 EKASONCOD NOTE PendingReason is returned in the response only if Payment Status is Pending The reason the payment is pending GI none No pending reason address The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments To change your preference go to the Preferences section of your Profile authorization The payment is pending because it has been authorized but not settled You must capture the funds first echeck The payment is pending because it was made by an eCheck that has not yet cleared intl The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overview multi currency You do not have a balance in the currency sent and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment You must manually accept or deny this payment order The payment is pending because it is part of an order that has been authorized but not settled paymentreview The payment is pending while it is being reviewed by PayPal for risk unilateral The payment is pending because it was made to an email address that is not yet registered or confirmed verify The p
161. ly beginning with 0 for example L NUMBERO L_NUMBER1 Item description from the Express Checkout API These parameters must be ordered sequentially beginning with 0 for example L DESCO L_DESC1 Item unit price from the Express Checkout API These parameters must be ordered sequentially beginning with 0 for example L_AMTO L_AMT1 Item unit quantity from the Express Checkout API These parameters must be ordered sequentially beginning with 0 for example L OTYO 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 40 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia Callback API Field Description T ITEMHEIGHTVALUEn The height of the item You can pass this data to the shipping carrier as is without ITEMHEIGHTUNITn having to make an additional database query These parameters must be ordered sequentially beginning with 0 for example L_ITEMHEIGHTVALUEO ITEMHEIGHTVALUE1 ITEMWIDTHVALUEn The width of the item You can pass this data to the shipping carrier as is without ITEMWIDTHUNITn having to make an additional database query These parameters must b
162. ly beginning with 0 for example L AMTO0 L AMT1 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 NOTE If you specify a value for L_ AMTn you must specify a value for ITEMAMT 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 characters 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 Optional Item sales tax 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 These parameters must be ordered sequentially beginning with 0 for example L_TAXAMTO L_TAXAMT1 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 These parameters must be ordered sequentially beginning with 0 for example L_ITEMWEIGHTVALUEO L ITEMWEIGHTVA
163. me Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia UpdateRecurringPaymentsProfile API 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 compatability with previous versions of the PayPal API NOTE Optional The reason for the update to the recurring payments profile This message will be included in the email notification to the buyer for the recurring payments profile update This note can also be seen by both you and the buyer on the Status History page of the PayPal account 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 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 ILEREFERENCE Optional The merchant s own unique reference or invoice number Character length and limitations 127 single byte alphanumeric characters ADDITIONALBILLINGCY Optional The numb
164. merchant is not enabled for reference transactions transactions Mark reference transaction DoReferenceTransaction Errors All Reference Transactions Related API Errors Error Code Short Message Long Message Additional Information 10001 Internal Error Internal Error Name Value Pair API Developer Guide 08 April 2009 217 218 API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10002 Authentication Authorizati on Failed 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 ASCHI characters are used supported in InvoicelD field 10201 Agreement canceled Billing Agreement was cancelled Billing agreement is not active 10202 Exceed max Transaction 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 D
165. n The credit card entered is invalid The merchant entered an invoice ID that 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 The transaction was declined by the country filter managed by the merchant To accept this transaction change your risk settings on PayPal The transaction was declined by the maximum amount filter managed by the merchant To accept this transaction change your risk settings on PayPal The transaction was declined by PayPal Contact PayPal for more information The transaction was declined by PayPal because of an invalid address The credit card entered is currently restricted by PayPal Contact PayPal for more information The email address provided by the buyer is in an invalid format Name Value Pair API Developer Guide 08 April 2009 167 aa API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 10544 Gateway Decline 10545 Gateway Decline 10546 Gateway Decline 10547 Internal Error 10548 Invalid Configuration 10549 Invalid Configuration 10550 Invalid Configuration 10552 Invalid Configuration 10553 Gateway Decline 10554 Filter Decline 10555 Filter Decline This transaction cannot be processed This transaction cannot be processed This transaction c
166. n 10627 Transaction The invoice ID field is DoAuthorization The Invoice ID field can refused because not supported for basic DoReauthorization only be used 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 DoReauthorization time Pl t F e DoVoid again later 10629 Reauthorization Reauthorization is not DoReauthorization Use DoAuthorization to not allowed allowed for this type of authorize the an 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 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 198 08 April 2009 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 TransactionSearch API Errors TransactionSearch API Errors Error Code Short Message Long Message 10001 Internal Error Inter
167. n PayPal s admin 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 would be PAYPAL EBAY JanesFlow Name Value Pair API Developer Guide 08 April 2009 135 a Recurring Payments and Reference Transactions API Operations DoReference Transaction API Ship To Address Fields Field Description SHIPTONAME SHIPTOSTREET SHIPTOCITY SHIPTOSTATE SHIPTOZIP SHI PTOCOUNTRYCODE SHIPTOPHONENUM SHIPTOSTREET2 Person s name associated with this address This field is required for shipping addresses but is optional for credit card billing addresses Character length and limitations 32 single byte characters First street address This field is required if the shipping address is used Character length and limitations 100 single byte characters Optional Second street address Character length and limitations 100 single byte characters Name of city This field is required if the shipping address is used Character length and limitations 40 single byte characters State or province This field is required if the shipping address is used Character length and limitations 40 single byte characters U S ZIP code or other country specific postal code This field is required if a U S shipping address is used and may be req
168. n invalid argument See additional error messages for details Invalid argument Invalid Configuration Invalid Configuration PaymentAction of Order is temporarily unavailable Please try later or use other PaymentAction Order total is missing The currencies of the shopping cart amounts must be the same Item total is invalid Shipping total is invalid Handling total is invalid Tax total is invalid Invoice ID value exceeds maximum allowable length This transaction cannot be Occurs when you have not agreed to the processed due to an invalid billing agreement merchant configuration This transaction cannot be Occurs when the billing agreement is processed due to an invalid disabled or inactive merchant configuration Name Value Pair API Developer Guide 08 April 2009 165 166 API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 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 10507 Invalid Co
169. nal 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 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 10004 Transaction refused because Receipt id is not valid of an invalid argument See additional error messages for details Name Value Pair API Developer Guide 08 April 2009 199 200 API Error Codes TransactionSearch API Errors Error Code Short Message Long Message 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
170. nfiguration 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 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 08 April 2009 Name Value
171. ng option type as the default The callback timeout is zero you must specify a longer timeout value Flat rate shipping options are missing you must specify flat rate shipping options when you specify a callback URL Invalid shipping total it should equal the shipping amount of the selected shipping option Line items missing line items are required when you specify a callback URL for flat rate shipping options Name Value Pair API Developer Guide 08 April 2009 185 186 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 11828 Maximum amount of order Maximum amount of order not not specified specified you must specify the estimated value of the order when using a flat rate shipping option 11829 Shipping total is missing Shipping total is missing you must specify a shipping total when using a flat rate shipping option 11830 Insurance amount is missing Insurance amount is missing you have offered insurance but have not specified an amount 11831 Callback URL is too long Callback URL is too long it must not exceed 1 024 characters 11832 Maximum amount of orderis Maximum amount of order is less less than itemized amounts than itemized amounts the value of all items including handling shipping tax and insurance cannot be greater than the maximum amount of the order 08 April 2009 Name Value Pair API Developer Guide API Error Codes
172. ng the filter type which is either ACCEPT or DENY the filter JD 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 Filter name including the filter type which is either ACCEPT or DENY the filter NAME and the entry number n starting from 0 Payment Information Fields Field Description TRANSACTIONID Unique transaction ID of the payment NOTE If the PaymentAction of the request was Authorization or Order this value is your AuthorizationID for use with the Authorization amp Capture APIs Character length and limitations 19 single byte characters 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia DoExpressCheckoutPayment API Field Description TRANSACTIONTYPE The type of transaction Character length and limitations 15 single byte characters Valid values e cart e express checkout
173. ng to make an additional database query These parameters must be ordered sequentially beginning with 0 for example L_ITEMWIDTHVALUEO L_ITEMWIDTHVALUE1 Character length and limitations Any positive integer ITEMHEIGHTVALUEn Optional Item height corresponds to the height of the item You can pass this data to ITEMHEIGHTUNITn 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 L_ITEMHEIGHTVALUE1 Character length and limitations Any positive integer 62 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia DoExpressCheckoutPayment API User Selected Options Type Fields Field Description SHIPPINGCALCULATION Optional Describes how the options that were presented to the user were MODE determined Is one of the following values e API Callback e API Flatrate INSURANCEOPTIONSELE Optional The Yes No option that you chose for insurance CTED SHIPPINGOPTIONISDEF Optional Is true if the buyer chose the default shipping option AULT Character length and limitations true or false SHIPPINGOPTIONAMOUN Optional The shipping amount that was chosen by the buyer T Limitations Must not exceed 10 000 USD in any currency No currency symbol Mu
174. ngth 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 Character length and limitations 40 single byte characters Required for U S addresses only SHIPTOZIP U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHIPTOCOUNTRYCODE Country code Character limit Two single byte characters BAUpdate API Update or delete a billing agreement e BAUpdate Request on page 131 e BAUpdateResponseDetails Response on page 131 130 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia BAUpdate API BAUpdate Request Update Billing Agreement Request Fields Field Description METHOD REFERENCE ID Required Must be BillAgreementUpdate Required An ID such as a billing agreement ID or a reference transaction ID that is associated with a billing agreement BILLINGAGRE EMENTSTA Optional Type of billing agreement TUS The current status of the billing agreement which is one of the following values e Active the billing agreement is currently active e Canceled the billing agreement has been cancelled
175. ntification number returned by a PayPal product 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 limits 19 single byte characters NOTE Optional An informational note about this void that is displayed to the payer in email and in his transaction history Character length and limits 255 single byte characters DoVoid Response DoVoid Response Fields Field Description AUTHORIZATIONID The authorization identification number you specified in the request Character length and limits 19 single byte characters 26 08 April 2009 Name Value Pair API Developer Guide DoDirectPayment API Process a credit card payment e DoDirectPayment Request e DoDirectPayment Response DoDirectPayment Request e DoDirectPayment Request Fields e Credit Card Fields e Payer Information Fields e Payer Name Fields e Billing Address Fields e Payment Details Type Fields e Payment Details Item Type Fields e eBay Item Payment Details Item Type Fields e Ship To Address Fields Name Value Pair API Developer Guide 08 April 2009 27 28 DoDirectPayment API DoDirectPayment Request DoDirectPayment Request Fields Field Description METHOD PAYMENTACT ION IPADDRESS RETURNFMFDETAILS Required Must be DoDirectPayment Optional How you want to obtain payment e
176. o card Character length two numeric digits maximum 112 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia ManageRecurringPaymentsProfileStatus API Payer Info Type Fields Field Description Email address of payer Character length and limitations 127 single byte characters FIRSTNAME Payer s first name Character length and limitations 25 single byte characters LASTNAME Payer s last name Character length and limitations 25 single byte characters Address Fields Field Description STREET First street address Character length and limitations 100 single byte characters STREET2 Second street address Character length and limitations 100 single byte characters CITY Name of city Character length and limitations 40 single byte characters STATE State or province Character length and limitations 40 single byte characters COUNTRYCODE Country code Character limit Two single byte characters ZIP U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters PHONENUM Phone number Character length and limit 20 single byte characters ManageRecurringPaymentsProfileStatus API Cancel suspend or reactivate a recurring payments profile e ManageRecurringPaymentsProfileStatus Request on page 114 e ManageRecurringPaymentsPro
177. ons DoReference Transaction API Field Description INVNUM Optional Your own invoice or tracking number Character length and limitations 127 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 NOTE If you do not specify this value in the request the notification URL from your Merchant Profile is used if one exists Character length and limitations 2 048 single byte alphanumeric characters 138 08 April 2009 Name Value Pair API Developer Guide DoReference Transaction API Recurring Payments and Reference Transactions API Operations ia Payment Details Item Type 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 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 Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Regardless of currenc
178. or Name Value Pair API Developer Guide TABLE P 1 Revision History Date Description 08 April 2009 Updated information for 57 0 Express Checkout Callback API 26 Nov 2008 Updated information for 55 0 23 Sept 2008 Added information about using billing agreements with SetExpressCheckout 3 Sept 2008 Added information about payment review to GetTransactionDetails June 2008 Rearranged material added error codes and moved some material to the Express Checkout Integration Guide April 2008 Added Fraud Management Filters information Changed recurring payments information February 2008 Added that ther VERSION parameter must be 50 0 in the API call to use recurring payments January 2008 e Added billing agreement fields to SetExpressCheckout for recurring payments e Updated CreateRecurringPaymentsProfile for new recurring payments features e Added new recurring payments APIs e Added DoNonReferencedCredit API Name Value Pair API Developer Guide 08 April 2009 i Revision History TABLE P 1 Revision History 10 Date September 2007 August 2007 April 2007 February 2007 December 2006 October 2006 Description 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 DoExpressCheckoutPaym nt DoReferenceTransaction
179. or is a period and the optional thousands separator is a comma Equivalent to nine characters maximum for USD Credit Card Details Fields Field Description CREDITCARDTYPE Type of credit card Character length and limitations Up to ten single byte alphabetic characters Allowable values e Visa e MasterCard e Discover e Amex e Maestro See important note e Solo See important note NOTE Ifthe credit card type is Maestro or Solo the currencyId must be GBP In addition either StartMonth and StartYear or IssueNumber must be specified ACCT Credit card number Only the last 4 digits of the credit card number are returned Character length and limitations numeric characters only No spaces or punctutation Must conform with modulo and length required by each credit card type Name Value Pair API Developer Guide 08 April 2009 111 a Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Field Description EXPDATE Credit card expiration date This field is required if you are using recurring payments with direct payments Format MMYYYY Character length and limitations Six single byte alphanumeric characters including leading zero STARTDATE Month and year that Maestro or Solo card was issued the MMYYYY format Character length Must be six digits including leading zero ISSUENUMBER Issue number of Maestro or Sol
180. otal cost of the transaction to the customer 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 field to 0 if the transaction does not include a one time purchase for example when you set up a billing agreement for a recurring payment that is not immediately charged 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 CURRENCYCODE Optional A three character currency code Default USD ITEMAMT Optional Sum of cost of all items in this order 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 NOTE ITEMAMT is required if you specify L_AMTn SHIPPINGAMT Optional Total shipping costs for this order 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 NOTE If you specify a value for SHIPPINGAMT
181. otal shipping insurance costs for this order The value must be a non negative currency amount or nu11 if insurance options are offered 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 Optional Shipping discount for this order specified as a negative number 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 Optional If true the Insurance drop down on the PayPal Review page displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number Character length and limitations true or false Optional Total handling costs for this order 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 NOTE If you specify a value for HANDLINGAMT you must also specify a value for ITEMAMT Optional Sum of tax for all
182. ount NetAmount ShippingAmount TaxAmount NETAMT Optional Total amount of all items in this transaction 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 The only valid currencies are AUD CAD EUR GBP JPY and USD SHIPPINGAMT Optional Total shipping costs in this transaction Limitations Value must be zero or greater and cannot 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 The only valid currencies are AUD CAD EUR GBP JPY and USD TAXAMT Optional Sum of tax for all items in this order Limitations The value must be zero or greater and cannot 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 The only valid currencies are AUD CAD EUR GBP JPY and USD CURRENCYCODE Required Currency code Default USD The only valid currencies are AUD CAD EUR GBP JPY and USD NOTE Optional Field used by merchant to record why this credit was issued to a buyer Similar to a memo field Freeform text String field 148 08 April 2009 Name Value Pair API Developer Guide DoNonRefe
183. out API Errors Error Code Short Message Long Message Correcting This Error 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 for 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 11813 Callback URL not valid or Invalid callback URL longer than 1024 chars 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
184. p To Address e Credit Card Details e Payer Information e Payer Name e Billing Address 96 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia CreateRecurringPaymentsProfile API 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 Recurring Payments Profile Details Fields Field Description SUBSCRIBERNAME Optional 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 Required The date when billing for this profile begins Must be a valid date in
185. pleted but the total of items in the cart did not match the total of all items 08 April 2009 Name Value Pair API Developer Guide API Error Codes SetExpressCheckout 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 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 10007 Permission denied You do not have permission to make this API call 10010 Invalid Invoice Non ASCII invoice id is not supported 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 1040
186. pping and tax amounts NOTE All amounts in the CreateRecurringPaymentsProfile request must have the same currency 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 TRIALBILLINGPERIOD Unit for billing during this subscription period required if you specify an optional trial period One of the following values Day Week SemiMonth Month 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 08 April 2009 99 a Recurring Payments and Reference Transactions API Operations CreateRecurringPaymentsProfile API Field Description TRIALBILLINGFRE QUE NCY TRIALTOTALBILLINGCY CLES TRIALAMT CURRENCY CODE 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 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 pe
187. ptional Item description Character length and limitations 127 single byte characters Optional Cost of item These parameters must be ordered sequentially beginning with 0 for example L_AMTO L AMT1 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 NOTE If you specify a value for L_ AMTn you must specify a value for ITEMAMT 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 characters 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 Optional Item sales tax 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 These parameters must be ordered sequentially beginning with 0 for example L_TAXAMTO L_TAXAMT1 Optional Item weight corresponds to the weight of the item You can pass this data to the shipping carrier as is wi
188. quentially beginning with 0 for example L EBAYITEMORDERIDO L_EBAYITEMORDERID1 Character length 64 single byte characters Shipping Options Type Fields Field Description L_SHIPPINGOPTIONISD Shipping option Required if specifying the Callback URL EFAULTn When the value of this flat rate shipping option is true PayPal selects it by default for the buyer and reflects it in the default total NOTE There must be ONE and ONLY ONE default It is not OK to have no default Character length and limitations Boolean true or false L SHIPPINGOPTIONNAM Shipping option Required if specifying the Callback URL En The internal name of the shipping option such as Air Ground Expedited and so forth Character length and limitations 50 character string L_SHIPPINGOPTIONLAB Shipping option Required if specifying the Callback URL ELn The label for the shipping option as displayed to the user Examples include Air Next Day Expedited 3 5 days Ground 5 7 days and so forth Shipping option labels can be localized based on the buyer s locale which PayPal sends to your website as a parameter value in the callback request Character length and limitations 50 character string L_SHIPPINGOPTIONAMO Shipping option Required if specifying the Callback URL UNTn The amount of the flat rate shipping option Limitations Must not exceed 10 000 USD in any currency No currency symbol
189. quired security parameters like this requiredSecurityParameters Body Parameters amp METHOD methodName amp otherRequiredAndOptionalParameters Name Value Pair API Developer Guide 08 April 2009 15 a PayPal NVP API Overview Technical Details In practice you need to concatenate all parameters and values into a single URL encoded string After the METHOD parameter you can specify the parameters in any order Security Parameters The security parameters are described below These are your PayPal API credentials Required Security Parameters API Credentials Parameter Value USER Required Your PayPal API Username PWD Required Your PayPal API Password VERS ION lt current version gt SIGNATURE SUBJECT Required Version number of the NVP API service such as 56 0 Optional Your PayPal API signature string If you use an API certificate do not include this parameter Optional Email address of a PayPal account that has granted you permission to make this call Set this parameter only if you are calling an API on a different user s behalf 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 The sample cod
190. r Code Short Message Long Message Additional Information 10004 10404 10004 10405 10407 10436 10437 10438 10439 Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details Transaction refused because of an invalid argument See additional error messages for details 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 PageStyle value exceeds maximum allowable length cpp header image value exceeds maximum allowable length cpp header border color value exceeds maximum allowable length cpp header back color
191. r transaction Please enter a city in field in the address The long error the billing address message will tell you what 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 the billing address field in the address The long error message will tell you what field is invalid 08 April 2009 Name Value Pair API Developer Guide API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 10711 Invalid Data 10712 Invalid Data 10713 Invalid Data 10713 Invalid Data 10714 Invalid Data 10715 Invalid Data 10716 Invalid Data 10717 Invalid Data 10718 Invalid Data 10719 Invalid Data 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 There s an error with t
192. racter currency code Default USD Optional Sum of cost of all items in this order 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 NOTE ITEMAMT is required if you specify L_AMTn Optional Total shipping costs for this order 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 NOTE If you specify a value for SHIPPINGAMT you must also specify a value for ITEMAMT Optional Total shipping insurance costs for this order The value must be a non negative currency amount or nu11 if insurance options are offered 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 Optional Shipping discount for this order specified as a negative number 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 separ
193. ransaction 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 Thistransactioncannotbe This transaction cannot be The transaction was declined by PayPal processed at this time processed at this time Please try Contact PayPal for more information Please try again later again later 11610 Payment Pending your Payment Pending your review in 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 been denied by a Fraud Management Filter has been denied by a Fraud Management Filter You can control whether a Fraud Management Filter will deny a transaction by changing the filter s settings in the profile Name Value Pair API Developer Guide 08 April 2009 175 176 API Error Codes Direct Payment API Errors Error Code Short Messa
194. rchant 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 would be PAYPAL EBAY JanesFlow DoCapture Response e DoCapture Response Fields e Payer Information Fields e Ship To Address Fields e Payer Name Fields Name Value Pair API Developer Guide 08 April 2009 21 a Authorization and Capture API Operation Reference DoCapture API Do Capture Response Fields Field Description AUTHORIZATIONID The authorization identification number you specified in the request Character length and limits 19 single byte characters maximum Payerlnfo Type Fields Field Description EMAIL Email address of payer 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 payer Valid values are e verified e unverified Character length and limitations 10 single byte alphabetic characters COUNTRYCODE Payer s country of residence in the form of ISO standard 3166 two character country codes Character length and limitations Two single byte characters BUSINESS Payer s business name Character length and limitations 127 single byte characters Ship To Address Type Fields Field Description ADDRESSSTATUS
195. re DE District of Columbia DC Federated States of Micronesia FM Florida FL Name Value Pair API Developer Guide 08 April 2009 235 ae State and Province Codes 236 Canadian Province or U S State Abbreviation Georgia 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 GA GU HI ID IL IN IA KS KY 08 April 2009 Name Value Pair API Developer Guide State and Province Codes aa Canadian Province or U S State Abbreviation Oklahoma OK Oregon OR Palau PW 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 gt Gl Armed Forces Armed Forces Pacific AP Name Value Pair API Developer Guide 08 April 2009 237 State and Province Codes 238 08 April 2009 Name Value Pair API Developer Guide Currency Codes Currencies and Currency Codes Supported by PayPal Currency Currency Code Australian Dollar AUD Canadian Dollar CAD Czech Koruna CZK Danish Krone DKK Euro EUR Hong Kong Dollar H
196. red parameter missing 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 parameter missing 81119 Missing Parameter ItemAmt Required parameter missing 81120 Missing Parameter ShippingAmt Required parameter missing 81121 Missing Parameter HandlingTotal Amt Required parameter missing Name Value Pair API Developer Guide 08 April 2009 161 162 API Error Codes Validation Errors Error Code Short Message Long Message 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 Mis
197. refused because The NotifyURL element value of an invalid argument See exceeds maximum allowable length additional error messages for details 10442 ButtonSource value The ButtonSource element value truncated exceeds maximum allowable length 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 Name Value Pair API Developer Guide 08 April 2009 181 182 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 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 10
198. rencedCredit API ol DoNonReferencedCredit Request Credit Card Details Fields Field Description CREDITCARDTYPE Required Type of credit card Character length and limitations Up to ten single byte alphabetic characters Allowable values e Visa e MasterCard e Discover e Amex e Maestro See note e Solo See note For Canada only MasterCard and Visa are allowable Interac debit cards are not supported NOTE If the credit card type is Maestro or Solo the CURRENCYCODE must be GBP In addition either STARTDATE or ISSUENUMBER must be specified ACCT Required Credit card number Character length and limitations numeric characters only No spaces or punctutation 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 Format MMYYYY Character length and limitations Six single byte alphanumeric characters including leading zero CVV2 Card Verification Value version 2 Your Merchant Account settings determine whether this field is required Character length for Visa MasterCard and Discover exactly three digits Character length for American Express exactly four digits To comply with credit card processing regulations you must not store this value after a transaction has been completed STARTDATE Optional Month and year that Maes
199. ress This transaction cannot be processed without a Credit Card Verification 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 Max failed payments if supplied must be gt 0 Trial amount must be gt 0 There was a problem with a particular field in the address The long error message will tell you what 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 field
200. 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 BillOutstandingAmount API Bill the buyer for the outstanding balance associated with a recurring payments profile e BillOutstandingA mount Request on page 115 e BillOutstandingAmount Response on page 115 114 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia UpdateRecurringPaymentsProfile API BillOutstandingAmount Request BillOutstandingAmount Request Fields Field Description METHOD Required Must be BillOutstandingAmount 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 compatability with previous versions of the PayPal API NOTE The profile must have a status of either Active or Suspended AMT Optional The amount to bill The amount must be less than or equal to the current outstanding balance of the profile Ifno value is specified PayPal will attempt to bill the entire outstanding balance
201. rgument See additional error messages for details Invalid shipping amount 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 Address 1 is required The field Shipping Address City is required The field Shipping Address State is required The field Shipping Address Postal Code is required The field Shipping Address Country is required A match of the Shipping Address City State and Postal Code failed 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 Invalid Order URL Invalid shipping amount it should equal the shipping amount of the selected shipping option Name Value Pair API Developer Guide 08 April 2009 193 API Error Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 11821 11826 Invalid shipping options Invalid shipping options Invalid shipping total Invalid shipping options you must specify a name and amount for each shipping option Invalid shipping options you must specify a name and amount for each shipping option type Invalid shipping total it should equal t
202. ring Payments and Reference Transactions API Operations a DoReference Transaction API Field Description FIRSTNAME Payer s first name Character length and limitations 25 single byte characters MIDDLENAME Payer s middle name Character length and limitations 25 single byte characters LASTNAME Payer s last name Character length and limitations 25 single byte characters SUFFIX Payer s suffix Character length and limitations 12 single byte characters Ship To Address Fields Field Description ADDRESSSTATUS Required Status of street address on file with PayPal Valid values are e none e Confirmed e Unconfirmed SHIPTONAME Required Person s name associated with this address Character length and limitations 32 single byte characters SHIPTOSTREET Required First street address Character length and limitations 100 single byte characters SHIPTOSTREET2 Optional Second street address Character length and limitations 100 single byte characters SHIPTOCITY Required Name of city Character length and limitations 40 single byte characters SHIPTOSTATE Optional State or province Character length and limitations 40 single byte characters Required for U S addresses only SHIPTOZIP Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHIPTOCOUNTRYCODE Requ
203. riod 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 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 Unit for billing during this subscription period required if you specify an optional trial period One of the following values Day Week SemiMonth Month 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 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 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 The number of billing cycles for trial payment period 120 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia UpdateRecurringPaymentsProfile API Field Description TRIALAMT B
204. riod is SemiMonth the billing frequency must be 1 Optional The 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 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 Required A three character currency code Default USD 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 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 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 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 nin
205. rmine that your customers are clicking your Place Order button twice PayPal recommends that you disable the button after your customer has clicked it 10418 Transaction refused because The currencies of the shopping cart of an invalid argument See amounts must be the same additional error messages for details 10425 Express Checkout has been Express Checkout has been disabled disabled for this merchant for this merchant Please contact Customer Service 10426 Transaction refused because Item total is invalid of an invalid argument See additional error messages for details Name Value Pair API Developer Guide 08 April 2009 179 180 API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 10427 Transaction refused because of 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 10432 Transaction refused because of an invalid argument See additional error messages for details 10433 Transaction refused because of an
206. ror 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 Createl GetRec Manage Recurrin gPaymentsProfil urringPaymentsProfileDetails Recurrin Updatel Recurrin BillOutstandin gPaymentsProfil leStatus gPaymentsProfil gAmount 08 April 2009 Name Value Pair API Developer Guide Recurring Payments Errors API Error Codes 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 10478 Invalid Data Recurring payments profile description must be provided if the billing agreement type is recurring payments 10501 Invalid Configuration This transaction cannot be Occurs when the billing processed due to an inva
207. rror Codes DoExpressCheckoutPayment API Errors Error Code Short Message Long Message Correcting This Error 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 specified must be the same as argument See additional previously specified error messages for details 10445 This transaction cannot be This transaction cannot be processed at this time processed at this time Please Please try again later try again later 10446 Unconfirmed email A confirmed email is required to make this API call 10474 Invalid Data This transaction cannot be The buyer selects the country of processed The country code in residence when they sign up for their the shipping address must PayPal account The country of match the buyer s country of residence is displayed after the dash in residence the title on the Account Ov
208. rrors General API Errors General API Errors Error Code Short Message Long Message Correcting This Error 10002 Authentication Authoriza Username Password is incorrect This error can be caused by an incorrect tion Failed 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 10002 Authentication Authoriza You do not have permission to tion Failed make this API call 10002 Authentication Authoriza Account is locked or inactive tion Failed 10002 Internal Error Internal Error 10002 Authentication Authoriza Internal Error tion Failed 10002 Authentication Authoriza Account is not verified tion Failed 10002 Authentication Authoriza This call is not defined in the tion Failed database 10002 Authentication Authoriza Token is not valid tion Failed 10002 Restricted account Account is restricted Your PayPal merchant account has been restricted Contact your PayPal account manager for resolution 10002 Authentication Authoriza Token is not valid tion Failed 10002 Authentication Authoriza API access is disabled for this tion Failed account 10002 Authentication Authoriza Client certificate is disabled tion Failed 10002 Restricted account Account is restricted 10006 Version error Version is not supported 10008 Security error Security header is not valid 10101 This API Temporaril
209. s 12 single byte characters 76 08 April 2009 Name Value Pair API Developer Guide GetTransactionDetails API ia GetTransactionDetails Response Address Fields Field Description ADDRESSOWNER eBay company that maintains this address Valid values are e eBay e PayPal ADDRESSSTATUS Status of street address on file with PayPal Valid values are 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 Character length and limitations 40 single byte characters Required for U S addresses only SHIPTOZIP U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters SHIPTOCOUNTRYCODE Country code Character limit Two single byte characters Expanded name of country Character length and limitations 64 single byte alphanumeric characters SHIPTOPHONENUM Country code Character limit Two single byte characters Payment Information Fields Field Description TRANSACTIONID Unique transaction ID of the
210. s 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 AMT Optional Search by transaction amount NOTE You must set the currencyID attribute to one of the three character currency codes for any of the supported PayPal currencies CI CURRENCYCOD Optional Search by currency code STATUS Optional Search by transaction status e Pending The payment is pending The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason field Processing The payment is being processed e Success 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 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 Name Value Pair API Developer Guide 08 April 2009 93 TransactionSearch API TransactionSearch Response Payer Name Fields Field Description SALUTATION Payer s salutation Character length and limitations 20 single byte characters FIRSTNAME Payer s first name Character leng
211. s invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid Name Value Pair API Developer Guide 08 April 2009 173 174 API Error Codes Direct Payment API Errors Error Code Short Message Long Message Corrective Action 10736 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 shipping message will tell you what field is address invalid 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 will tell you what field is address invalid 10745 Invalid Data This transaction cannot be There was
212. s API Billing Agreement Details 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 NOTE Other defined values are not valid BILLINGAGREEMENTD Description of goods or services associated with the billing agreement which 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 customer will be billed at 9 99 per month for 2 years Character length and limitations 127 single byte alphanumeric bytes L PAYMENTTYPEN Optional Specifies type of PayPal payment you require for the billing agreement e Any e InstantOnly NOTE For recurring payments this field is ignored L_CUSTOMn Optional Custom annotation field for your own use NOTE For recurring payments this field is ignored Character length and limitations 256 single byte alphanumeric bytes SetCustomerBillingAgreement Response SetCustomerBillingAgreement Response Fields Field Description TOKEN A unique time stamped token which uniquely identifies this transaction for subsequent API calls NOTE The token expires after three hours Character length and limitations 20 single byte characters GetBillingAgreemen
213. s are missing from the request Name Value Pair API Developer Guide 08 April 2009 209 210 API Error Codes Recurring Payments Errors Error Code Short Message Long Message Additional Information 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 trialtax This currency is currently not Currency must be USD amount supported for trial tax amount 11516 Invalid billing frequency Billing Frequency must be gt 0 and 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 must be one of Day Week Month SemiMonth or Year 11519 Invalid amount Bill amount must be greater than 0 11
214. s ia SetExpressCheckout API Payment Details Item Type 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 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 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 NOTE Ifyou specify a value for L_AMTn you must specify a value for ITEMAMT 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 characters L _OTYn Optional Item quantity These parameters must be ordered sequentially beginning with 0 for example L OTY0 L OTY1 Character length and limitations Any positive integer L_TAXAMTn Optional Item sales tax NOTE Character length and limitations Must not exceed 10 000 USD in any currency No currency symbol Regardless of currency decimal separator mu
215. sing 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 Parameter CountryCode Required parameter missing 81143 Missing Parameter RefundType Required parameter missing 81144 Missing Parameter StartDate Required parameter missing 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 08 April 2009 Name Value Pair API Developer Guide API Error Codes Validation Errors Error Code Short Message Long Message 81203 Invalid Parameter NotifyURL Invalid parameter 81205 Invalid Parameter ShipToStreet Invalid parameter 81206 Invalid Parameter ShipToStreet2 Invalid parameter 81207 Invalid Parameter
216. ss in the URL See Posting Using HTTPS on page 18 e API credentials you set up in Set Up API Credentials on page 13 Technical Details This section describes details of the technologies used by the PayPal NVP API Request Response Model When you use the PayPal NVP API you post an NVP request to PayPal and PayPal posts back an NVP response URL Format The request and response are in URL encoded format which is defined by the Worldwide Web Consortium W3C URL is defined as part of the URI specification Find out more about URI at http www w3 org Addressing 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 e Name value pairs are separated by an ampersand amp For example FIRSTNAME Robert amp MI DDLENAME Herbert amp LASTNAME Moore e The values for each field in an NVP string are URL encoded URL Encoding The request and response are URL encoded URL 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 For example the following NVP string NAME Robert Moore amp COMPANY R
217. ssages 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 pay server is unavailable Unable to create payments for masspay Name Value Pair API Developer Guide 08 April 2009 205 206 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 er
218. st be a period and the optional thousands separator must be a comma Equivalent to nine characters maximum for USD These parameters must be ordered sequentially beginning with 0 for example L_TAXAMTO L_TAXAMT1 ITEMWEIGHTVALUEn Optional Item weight corresponds to the weight of the item You can pass this data ITEMWEGHTUNITn 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 Character length and limitations Any positive integer L ITEMLENGTHVALUEn Optional Item length corresponds to the length of the item You can pass this data to L_ITEMLENGTHUNITn 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_ITEMLENGTHVALUEO L_ITEMLENGTHVALUE1 Character length and limitations Any positive integer Name Value Pair API Developer Guide 08 April 2009 51 a Express Checkout API Operations SetExpressCheckout API Field Description ITEMWIDTHVALUEn Optional Item width corresponds to the width of the item You can pass this data to ITEMWIDTHUNITn the shipping carrier as is without having to make an additional database query These parameters must be ordered s
219. st have two decimal places decimal separator must be a period and the optional thousands separator must be a comma SHIPPINGOPTIONNAME Optional Is true if the buyer chose the default shipping option EbayltemPaymentDetailsltemType 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 NIDn These parameters must be ordered sequentially beginning with 0 for example L_EBAYITEMAUCTIONTXNIDO L EBAYIT EMAUCTIONTXNID1 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 DoExpressCheckoutPayment API 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 e DoExpressCheckoutPayment Request on page 64 e DoExpressCheckoutPayment Respons
220. t API Errors 02 GetExpressCheckoutDetails API Errors DoExpressCheckoutPayment API Errors Authorization and Capture API Errors GetTransactionDetails API Errors TransactionSearch API Errors 8 RefundTransaction API Errors 2 Mass Pay API Errors 2 20055 Recurring Payments Errors SetCustomerBillingAgreement Errors GetBillingAgreementCustomerDetails Errors CreateBillingAgreement Errors 4 UpdateBillingAgreement Errors DoReferenceTransaction Errors AddressVerify API Errors oaoa ManagePendingTransactionStatus API Errors B Country Codes 08 April 2009 Name Value Pair API Developer Guide Contents ional Chapter C State and Province Codes ge Ses er ahs ey Sate En ee Ae Ge gt tee Se Ss 235 Chapter D Currency Codes 058 228588 es 239 Chapter E AVS and CVV2 Response Codes 241 AVS Response Codes 2 ee 241 CVV2 Response Codes 1 aa a a a a a 243 Name Value Pair API Developer Guide 08 April 2009 fon Contents 8 08 April 2009 Name Value Pair API Developer Guide Preface This Document The Name Value Pair API Developer Guide describes the PayPal Name Value Pair API Intended Audience The Name Value Pair API Developer Guide is written for web developers who are implementing solutions using the Name Value Pair API Revision History Revision history f
221. t be SetCustomerBillingAgreement RETURNURL Required URL to which the customer s browser is returned after choosing to pay with PayPal NOTE PayPal recommends that the value be the final review page on which the customer 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 LOCALECODE Optional Locale of pages displayed by PayPal during checkout Character length and limitations Any two character country code The following two character country codes are supported by PayPal e AU e DE FR IT GB ES US Any other value will default to US See Country Codes on page 225 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 from the Profile subtab of the My Account tab of your PayPal account Character length and limitations 30 single byte alphabetic characters HDRIIMG Optional A URL for the image you want to appear at the top left of the pa
222. tCustomerDetails API Obtain information about a billing agreement s PayPal account holder e GetBillingAgreementCustomerDetails Request on page 128 e GetBillingAgreementCustomerDetails Response on page 128 Name Value Pair API Developer Guide 08 April 2009 127 a Recurring Payments and Reference Transactions API Operations GetBillingAgreementCustomerDetails API GetBillingAgreementCustomerDetails Request 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 three hours Character length and limitations 20 single byte characters GetBillingAgreementCustomerDetails Response e GetBillingAgreementCustomerDetails Response e Payer Information Fields e Payer Name Fields e Ship To Address Fields 128 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia GetBillingAgreementCustomerDetails API GetBillingAgreementCustomerDetails Response Fields Payer Information Fields Field Description EMAIL Email address of payer 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 o
223. ta This transaction cannot be CreditCardNumber and or processed Please enter a valid CreditCardType is invalid credit card number and type 10537 Risk Control Country Filter The transaction was refused Transaction refused due to Failure because the country was prohibited country monitor risk control as aresult of your Country Monitor Risk Control Settings 10538 Risk Control Max Amount The transaction was refused Transaction refused due to max Failure because the maximum amount was amount risk control excused as a result of your Maximum Amount Risk Control Settings 10539 Payment declined by your Payment declined by your Risk Transaction declined by Risk Risk Controls settings Controls settings PayPal Risk Control settings PayPal Risk PayPal Risk Model Model model 10546 Gateway Decline This transaction cannot be IP fraud models failed processed 10560 Invalid Data The issue number of the credit card IssueNumber is invalid is invalid 10567 Invalid Data A Start Date or Issue Number is None of Start date or issue required number is specified only applies to Switch and Solo credit cards 10600 Authorization voided Authorization voided 10601 Authorization expired Authorization has expired 10621 Order has expired Order has expired Name Value Pair API Developer Guide 08 April 2009 221 222 API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10622 Order is voi
224. te characters SUFFIX Payer s suffix Character length and limitations 12 single byte characters DoAuthorization API Authorize a payment e DoAuthorization Request e DoAuthorization Response Name Value Pair API Developer Guide 08 April 2009 23 a Authorization and Capture API Operation Reference DoReauthorization API DoAuthorization Request DoAuthorization Request Fields Field Description METHOD Required Must be DoAuthorization TRANSACTIONID Required The value of the order s transaction identification number returned by PayPal Character length and limits 19 single byte characters maximum AMT Required Amount to authorize Limitations Value is a positive number which cannot 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 TRANSACTIONENTITY Optional Type of transaction to authorize The only allowable value is Order which means that the transaction represents a customer order that can be fulfilled over 29 days CURRENCY CODE Optional A three character currency code See Currency Codes on page 239 DoAuthorization Response DoAuthorization Response Fields Field Description TRANSACTIONID An authorization identification number AMT The amount you specified in the request DoReauthorization API e DoReauthorization R
225. ted STARTDATE Optional Month and year that Maestro or Solo card was issued the MMYYYY format Character length Must be six digits including leading zero ISSUENUMBER Optional Issue number of Maestro or Solo card Character length two numeric digits maximum Payer Info Type Fields Field Description EMAIL Optional Email address of payer Character length and limitations 127 single byte characters FIRSTNAME Required Payer s first name Character length and limitations 25 single byte characters 122 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia SetCustomerBillingAgreement API Field Description LASTNAME Required Payer 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 COUNTRYCODE Required Country code Character limit Two single byte characters ZIP Required U S ZIP code or other country specific postal code
226. th and limitations 25 single byte characters MIDDLENAME Payer s middle name Character length and limitations 25 single byte characters LASTNAME Payer s last name Character length and limitations 25 single byte characters SUFFIX Payer s suffix Character length and limitations 12 single byte characters TransactionSearch Response TransactionSearch Response Fields Field Description TIMESTAMPn The date and time in UTC GMT format the transaction occurred TIMEZONEn The time zone of the transaction TYPEN The type of the transaction EMATLn The email address of either the payer 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 customer NAMEn Display name of the payer L_TRANSACTIONIDn Seller s transaction ID L_STATUSn The status of the transaction L AMTn The total gross amount charged including any profile shipping cost and taxes FEEAMTn The fee that PayPal charged for the transaction NETAMTn The net amount of the transaction 94 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations This chapter describes the PayPal API operations related to recurring payments and reference transactions CreateRecurringPaymentsProfile API on page 9
227. th and limits 255 single byte characters 20 08 April 2009 Name Value Pair API Developer Guide Authorization and Capture API Operation Reference ioe DoCapture API Field Description SOFTDESCRIPTOR Optional The soft descriptor is a per transaction description of the payment that is passed to the consumer s credit card statement If a value for the soft descriptor field is provided the full descriptor displayed on the customer 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 o period e space If you use any other characters such as an error code is returned 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 either 4 or 8 characters are used by the PayPal prefix 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 admin tools e The me
228. thout having to make an additional database query These parameters must be ordered sequentially beginning with 0 for example L_ITEMWEIGHTVALUEO L ITEMWEIGHTVALUE1 Character length and limitations Any positive integer 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 These parameters must be ordered sequentially beginning with 0 for example L_ITEMLENGTHVALUEO L_ITEMLENGTHVALUE1 Character length and limitations Any positive integer 68 08 April 2009 Name Value Pair API Developer Guide Express Checkout API Operations ia DoExpressCheckoutPayment API Field Description ITEMWIDTHVALUEn Optional Item width corresponds to the width of the item You can pass this data to ITEMWIDTHUNITn 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 ITEMWIDTHVALUE1 Character length and limitations Any positive integer L_ITEMHEIGHTVALUEn Optional Item height corresponds to the height of the item You can pass this data to L_ITEMHEIGHTUNITn the shipping carrier as is without having to make an additional database query These parameters must be ordered sequentially beginning with 0 for example
229. tion Response on page 89 RefundTransaction Request RefundTransaction Request Fields Field Description METHOD Required Must be RefundTransaction TRANSACTIONID Required Unique identifier of a transaction Character length and limitations 17 single byte alphanumeric characters REFUNDTY PE Required Type of refund you are making e Other e Full e Partial AMT See description Refund amount Amount is required if RefundType is Partial NOTE If RefundType is Full do not set Amount NOTE Optional Custom memo about the refund Character length and limitations 255 single byte alphanumeric characters RefundTransaction Response 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 GROSSREFUNDAMT Amount of money refunded to original payer NETREFUNDAMT Amount subtracted from PayPal balance of original recipient of payment to make this refund Name Value Pair API Developer Guide 08 April 2009 89 a RefundTransaction API RefundTransaction Response 90 08 April 2009 Name Value Pair API Developer Guide TransactionSearch API Search transaction history for transactions that meet the specified criteria e TransactionSearch Request on page 91 e TransactionS
230. to nine characters maximum for USD Optional If true the Insurance drop down on the PayPal Review page displays the string Yes and the insurance amount If true the total shipping insurance for this order must be a positive number Character length and limitations true or false Optional Total handling costs for this order 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 NOTE If you specify a value for HANDLINGAMT you must also specify a value for ITEMAMT Optional Sum of tax for all items in this order 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 NOTE TAXAMT is required if you specify L_TAXAMTN Optional Description of items the customer is purchasing Character length and limitations 127 single byte alphanumeric characters Optional A free form field for your own use Character length and limitations 256 single byte alphanumeric characters Name Value Pair API Developer Guide 08 April 2009 137 a Recurring Payments and Reference Transactions API Operati
231. tro or Solo card was issued the MMYYYY format Character length Must be six digits including leading zero ISSUENUMBER Optional Issue number of Maestro or Solo card Character length two numeric digits maximum Payer Info Type Fields Field Description EMAIL Optional Email address of payer Character length and limitations 127 single byte characters FIRSTNAME Required Payer s first name Character length and limitations 25 single byte characters Name Value Pair API Developer Guide 08 April 2009 149 DoNonReferencedCredit API DoNonReferencedCredit Response Field Description LASTNAME Required Payer 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 COUNTRYCODE Required Country code Character limit Two single byte characters ZIP Required U S ZIP code or other country specific postal code Character length and limitations 20 single byte characters PHONENUM Optional Phon
232. ts 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 Name Value Pair API Developer Guide 08 April 2009 157 fo AddressVerify API AddressVerify Response 158 08 April 2009 Name Value Pair API Developer Guide API Error Codes The PayPal API can return multiple errors for any operation e General API Errors on page 160 e Validation Errors on page 161 e Direct Payment API Errors on page 165 e SetExpressCheckout API Errors on page 177 e GetExpressCheckoutDetails API Errors on page 187 e DoExpressCheckoutPayment API Errors on page 189 e Authorization and Capture API Errors on page 195 e TransactionSearch API Errors on page 199 e RefundTransaction API Errors on page 201 e Mass Pay API Errors on page 204 e Recurring Payments Errors on page 206 e SetCustomerBillingAgreement Errors on page 213 e GetBillingAgreementCustomerDetails Errors on page 215 e CreateBillingAgreement Errors on page 215 e UpdateBillingAgreement Errors on page 217 e DoReferenceTransaction Errors on page 217 e AddressVerify API Errors on page 224 e ManagePendingTransactionStatus API Errors on page 224 Name Value Pair API Developer Guide 08 April 2009 159 160 API Error Codes General API E
233. uccess WithWarning you should process the API response fields In a successful response you can ignore all fields up to and including the BUILD field The important fields begin after the BUILD field Error Responses If the ACK value is Error or Warning API response fields are not returned An error response has the following general format Format of an Error Response Response Fieldson ACK Error amp TIMESTAMP date timeOfResponse amp Multiple errors can be Error CORRELATIONID debuggingToken amp VERSION VersionNos 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_SHORTMESSAGEO shortMessage amp LONGMESSAGEO longMessage amp SEVERITYCODE0 severityCode For possible causes of errors and how to correct them see the explanation of the specific error code short message and long message in API Error Codes on page 159 ACK Parameter Values The following table lists values for the ACK parameter ACK Parameter Values Type of Response Value Successful response Success SuccessWithWarning Error response Failure FailureWithWarning Warning Name Value Pair API Developer Guide 08 April 2009 17 fa PayPal NVP API Overview Posting Using HTTPS Posting Using HTTPS Your web application posts the URL encode
234. ufficient funds in your PayPal balance to cover the amount of the refund and either your not having yet verified the bank account associated with your PayPal account or your not having any bank account associated with your PayPal account at all Ensure that you have sufficient funds in your PayPal balance and that you have verified the associated bank account 10009 Transaction refused The partial refund amount must be less than or equal to the original transaction amount 10009 Transaction refused The partial refund amount must be less than or equal to the remaining amount 10009 Transaction refused The partial refund amount is not valid 10009 Transaction refused Because a complaint case exists on this transaction only a refund of the full or full remaining amount of the transaction can be issued 10009 Transaction refused You are over the time limit to perform a refund on this transaction 10009 Transaction refused Can not do a full refund after a partial refund 10009 Transaction refused Account is locked or inactive 10009 Transaction refused The partial refund must be the same currency as the original transaction 08 April 2009 Name Value Pair API Developer Guide API Error Codes RefundTransaction API Errors Error Code Short Message Long Message Correcting This Error 10009 Transaction refused This transaction has already been fully refunded 10009 Transaction refused Account is restricted 10009 Transaction refused
235. uired for other countries Character length and limitations 20 single byte characters Country code This field is required if the shipping address is used Character limit 2 single byte characters Optional Phone number Character length and limit 20 single byte characters Payment Details Type Fields Field Description AMT CURRENCY CODE ITEMAMT Required The total cost of the transaction to the customer 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 field to 0 if the transaction does not include a one time purchase for example when you set up a billing agreement for a recurring payment that is not immediately 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 Optional A three character currency code Default USD Optional Sum of cost of all items in this order 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 NOTE ITEMAMT is required if you specify L_AMTn
236. ular 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 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 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 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 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 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 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 110 08 April 2009
237. ure or API certificate that identify you Use the following sample API signature and password in your sample programs that run in the PayPal Sandbox test environment NOTE If you are using the samples this signature is already in the code Details of the Sample API Signature API username sdk three apil sdk com API password QFZCWNSHZM8VBG70 API signature A IzdhZZjhg29XO2qnhapuwx1DzyAZQ92FRP5dgqBzVesOkzbqdUONzmOU Create and Post the Request Create an NVP request string and post it to PayPal sandbox server Add code to your web application to do the following tasks 1 URL encode the name and value parameters in the request to ensure correct transmission of all characters This is described in URL Encoding on page 14 2 Construct the NVP API request string as described in Request Format on page 15 The NVP format is described in NVP Format on page 14 08 April 2009 Name Value Pair API Developer Guide PayPal NVP API Overview ia Taking Your Application Live 3 Post the NVP request to the PayPal Sandbox as described in Posting Using HTTPS on page 18 Interpret the Response PayPal processes your request and posts back a reponse in NVP format Add code to your web application to do the following tasks 1 Receive the HTTP post response and extract the NVP string 2 URL decode the parameter values as described in URL Encoding on page 14 3 Take appropriate action for successful and fa
238. urring Payments and Reference Transactions API Operations a CreateRecurringPaymentsProfile API Billing Period Details Type Field Description BILLINGPERIOD Required Unit for billing during this subscription period One of the following values Day Week SemiMonth Month 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 The 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 AMT Required Billing amount for each billing cycle during this payment period This amount does not include shi
239. ustomer is purchasing Character length and limitations 127 single byte alphanumeric characters CUSTOM Optional A free form field for your own use Character length and limitations 256 single byte alphanumeric characters INVNUM Optional Your own invoice or tracking number Character length and limitations 127 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 NOTE If you do not specify this value in the request the notification URL from your Merchant Profile is used if one exists Character length and limitations 2 048 single byte alphanumeric characters Name Value Pair API Developer Guide 08 April 2009 67 fa Express Checkout API Operations DoExpressCheckoutPayment API Payment Details Item Type Fields Field Description L_NAMEn DESCn L AMTn L_NUMBERn L QTYn L_TAXAMTn ITEMWETGHTVALUI ITEMWEGHTUNITn L_ITEMLENGTHVALUI En mn L_ITEMLENGTHUNITn 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 O
240. valid Data 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 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 was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field is invalid There was a problem with a particular field in the address The long error message will tell you what field i
241. veloper Guide 08 April 2009 35 DoDirectPayment API DoDirectPayment Response EbayltemPaymentDetailsitemType 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 NIDn These parameters must be 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 Ship To Address Fields Field Description SHIPTONAME Person s name associated with this address This field is required for shipping addresses but is optional for credit card billing addresses Character length and limitations 32 single byte characters SHIPTOSTREET First street address This field is required if the shipping address is used Character length and limitations 100 single byte characters SHIPTOSTREET2 Optional Second street
242. xecutes 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 argument See additional error messages for details has been truncated long maximum length is 127 Warning only API executes 08 April 2009 Name Value Pair API Developer Guide API Error Codes DoReference Transaction Errors Error Code Short Message Long Message Additional Information 10434 Transaction refused Value of Custom element has been Custom field is too long because of an invalid truncated maximum length is 256 argument See additional Warning only API executes error messages for details 10441 Transaction refused The NotifyURL element value NotifyURL field is too long because of an invalid exceeds maximum allowable maximum length for notify URL argument See additional length is 2048 error messages for details 10442 ButtonSource value The ButtonSource element value ButtonSource field is too long truncated exceeds maximum allowable maximum length is 32 Warning length only API executes 10504 The cvv 2 is invalid This transaction cannot be CVV field is invalid processed Please enter a valid Credit Card Verification Number 10527 Invalid Da
243. y decimal separator must be a period and the optional thousands separator must be a comma Equivalent to nine characters maximum for USD NOTE Ifyou specify a value for L_AMTn you must specify a value for ITEMAMT 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 characters L _OTYn Optional Item quantity These parameters must be ordered sequentially beginning with 0 for example L OTY0 L OTY1 Character length and limitations Any positive integer L_TAXAMTn Optional Item sales tax 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 These parameters must be ordered sequentially beginning with 0 for example L_TAXAMTO L_TAXAMT1 ITEMWEIGHTVALUEn Optional Item weight corresponds to the weight of the item You can pass this data ITEMWEGHTUNITn 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 Character length and limitations Any positive integer
244. y This API is temporarily Unavailable unavailable Please try later 08 April 2009 Name Value Pair API Developer Guide API Error Codes Validation Errors 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 Specified 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 Requi
245. y 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 your review in Fraud Management Filters Transaction blocked by your settings in FMF Could not process your request to accept deny the transaction This transaction cannot be processed 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 This transaction cannot be processed without a Credit Card Verification number Name Value Pair API Developer Guide 08 April 2009 223 224 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 error messages for details The API is disabled Invalid email format Inv
246. yment 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 Six character HTML hexadecimal color code in ASCI Name Value Pair API Developer Guide 08 April 2009 125 a Recurring Payments and Reference Transactions API Operations SetCustomerBillingAgreement API Field Description HDRBACKCOLOR Optional Sets the background color for the header of the payment page By default the color is white Character length and limitation Six character HTML hexadecimal color code in ASCIL PAYFLOWCOLOR Optional Sets the background color for the payment page Character length and limitation Six character HTML hexadecimal color code in ASCIL 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 126 08 April 2009 Name Value Pair API Developer Guide Recurring Payments and Reference Transactions API Operations ia GetBillingAgreementCustomerDetail
247. yment API Field Description IT SH EMAMT IPPINGAMT INSURANCEAMT SH INSURANCEOPTIONOFFE IPPINGDISCOUNT RED HANDLINGAMT TAXAMT Optional Sum of cost of all items in this order 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 NOTE ITEMAMT is required if you specify L_AMTN Optional Total shipping costs for this order 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 NOTE If you specify a value for SHIPPINGAMT you must also specify a value for ITEMAMT Optional Total shipping insurance costs for this order The value must be a non negative currency amount or null if insurance options are offered 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 Optional Shipping discount for this order specified as a negative number NOTE Character length and limitations Must not excee
248. yment you want to capture This is the transaction id returned from DoExpressCheckoutPayment or DoDirectPayment Character length and limits 19 single byte characters maximum Required Amount to capture Limitations Value is a positive number which cannot 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 Optional A three character currency code Default USD Required The value Complete indicates that this the last capture you intend to make The value NotComplete indicates that 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 Character length and limits 12 single byte alphanumeric characters Optional Your invoice number or other identification number that is displayed to the merchant and customer in his transaction history NOTE This value on DoCapture will overwrite a value previously set on DoAuthorization NOTE The value is recorded only if the authorization you are capturing is an order authorization not a basic authorization Character length and limits 127 single byte alphanumeric characters Optional An informational note about this settlement that is displayed to the payer in email and in his transaction history Character leng
249. you specify a callback URL 08 April 2009 Name Value Pair API Developer Guide API Error Codes SetExpressCheckout API Errors Error Code Short Message Long Message Correcting This Error 11821 11822 11823 11824 11825 11826 11827 Invalid callback timeout Line items missing Callback URL is too long Multiple default shipping options specified No default shipping option specified Invalid shipping total Invalid shipping options Invalid shipping options Multiple default shipping options specified No default shipping option specified Invalid callback timeout Flat rate shipping options are missing Invalid shipping total Line items missing The callback timeout is is zero you must specify a longer timeout Line items are required when specify a callback URL for flate rate shipping options The callback URL must not exceed 1 024 characters You can only specify one default shipping option at a time You must specify a default shipping option Invalid shipping total it should equal the shipping amount of the default shipping option Invalid shipping options you must specify a name and amount for each shipping option Invalid shipping options you must specify a name and amount for each shipping option type More than one shipping option type is marked as the default you can only specify one default shipping option at a time You must specify one shippi
250. your are billing in their non primary currency If the customer chooses to pay with a currency other than the non primary currency the conversion occurs in the customer s account Character length and limitations a decimal that does not exceed 17 characters including decimal point PAYMENTSTATUS Status of the payment Completed The payment has been completed and the funds have been added successfully to your account balance Pending The payment is pending See the PendingReason element for more information Name Value Pair API Developer Guide 08 April 2009 73 a Express Checkout API Operations DoExpressCheckoutPayment API Field Description PENDINGREASON The reason the payment is pending e none No pending reason g EASONCODI Gl address The payment is pending because your customer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments To change your preference go to the Preferences section of your Profile authorization The payment is pending because it has been authorized but not settled You must capture the funds first echeck The payment is pending because it was made by an eCheck that has not yet cleared intl The payment is pending because you hold a non U S account and do not have a withdrawal mechanism You must manually accept or deny this payment from your Account Overv
251. yte characters SHIPTOCOUNTRYCODE Country code Character limit Two single byte characters Billing Period Details Type Field Description BILLINGPERIOD Unit for billing during this subscription period One of the following values Day Week SemiMonth Month 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 08 April 2009 109 a Recurring Payments and Reference Transactions API Operations GetRecurringPaymentsProfileDetails API Field Description BILLINGFREQUENCY TOTALBILLINGCYCLES SHIPPINGAMT TAXAMT 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 The 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 For the reg

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

Contents

Download Pdf Manuals

Related Search

Related Contents