Websiteoscommerce

PayPalReferenceStandardVariableReferenceTheStandardVariableReferencecontainsallofthevariablesthatcanbeincludedinastan-dardcheckouttransaction.
ThisincludescodeforBuyNowbuttons,subscriptions,donations,cartupload,andthePayPalshoppingcart.
ThecmdVariableThecmdvariablemustbeincludedinallstandardcheckoutforms.
IttellsPayPalwhattypeofactiontotake.
ItcantakethevaluesshowninTableA-1.
TableA-1.
ThecmdVariableValueDescription_xclickBuyNowbuttonsanddonations.
_s-xclickFlagthatthenextvalueisanEWP-encryptedblob.
*_xclick-subscriptionsSubscriptions.
_cartPayPalShoppingCartorcartupload.
_ext-enterPrepopulatingPayPalaccountsignup.
Requiresredirect_cmdtoalsobeincluded.
*Theremustalsobeacmdvariableintheencryptedblobthatspecifiestheactualcommandtobeexecuted.
SeeChapter4formoreinformation.
231APPENDIXActionVariablesVariablesthatspecifyactionstobetakendependingupontheuser'sactionsduringcheckoutareshowninTableA-2.
AllURLsmustbeURL-encoded.
TableA-2.
ActionVariablesVariableDescriptionRequiredcancel_returnURLwherethebuyerisreturnedifheorshecancelsatransaction.
Optionalnotify_urlURLtowhichPayPalpostsIPNsforatransaction.
OptionalreturnURLwherethebuyerisreturnedfollowingasuccessfultransaction.
OptionalrmReturnmethodusedwhenreturningthebuyertothemerchantOptionalwebsiteafteratransaction.
Default:GET1:GET2:POSTIndividualItemInformationVariablesVariablesforanindividualiteminastandardcheckouttransactionareshowninTableA-3.
TableA-3.
ItemInformationVariablesVariableDescriptionRequiredCharacterLengthaddSetto1toaddanitemtoPayPal-hostedOptional1shoppingcart.
amountPriceofthepurchase,notincludingOnlyforN/Ashipping,handling,ortax.
shoppingcartsdisplaySetto1foraViewCartbutton.
Optional1item_nameDescriptionofanitem.
Onlyforshoppingcarts127item_numberTrackingvariablepassedbacktothesellerOptional127atpaymentcompletion.
quantityNumberofitems.
Theamount,shipping,OptionalN/Aandtaxaremultipliedbythequantitytoderivethetotalpaymentamount.
undefined_quantityValueof1allowsthebuyertospecifytheOptional1quantity.
on0Firstoptionalfieldname.
Optional64on1Secondoptionalfieldname.
Optional64os0Firstsetofoptionvalues.
on0mustalsoOptional64or200*bedefined.
os1Secondsetofoptionvalues.
on1mustalsoOptional64or200*bedefined.
*Iftheos0oros1optionisselectedthroughatextboxorradiobutton,eachvalueshouldbenomorethan64characters.
Ifthisvalueisenteredbythecustomerinatextfield,thereisa200-characterlimit.
APPENDIXPAYPALREFERENCE232DisplayVariablesVariablesforcustomizingthevisualappearanceofthePayPalcheckoutpageareshowninTableA-4.
TableA-4.
DisplayVariablesVariableDescriptionRequiredCharacterLengthamountPriceofthepurchase,notincludingOnlyforshipping,handling,ortax.
shoppingcartscbtSetsthetextfortheContinuebuttonOptional60onthePayPalPaymentCompletepage.
cnLabelabovethenotefield.
Optional40cpp_header_imageURLforimageatthetopleftofpay-OptionalN/Amentpage(themaximumis75090pixels).
cpp_headerback_color*BackgroundcolorforpaymentOptionalpageheader.
cpp_headerborder_color*BordercoloraroundpaymentOptionalpageheader.
cpp_payflow_color*BackgroundcolorforthepaymentOptionalpagebelowtheheader.
Note:ColorsthatconflictwithPayPal'serrormessagesarenotallowed.
csBackgroundcolorofyourpaymentOptionalpages.
Defaultor0:Backgroundcoloriswhite.
1:Backgroundcolorisblack.
image_urlURLofthe15050pixelimageOptionaldisplayedasyourlogointheupper-leftcornerofPayPal'spages.
no_notePromptcustomertoincludeanoteOptional1withpayment.
Defaultor0:Customerispromptedtoincludeanote.
1:Customerisnotpromptedtoincludeanote.
no_shippingPromptcustomerforshippingaddress.
Optional1Defaultor0:Customerispromptedtoincludeashippingaddress.
1:Customerisnotaskedforashippingaddress.
2:Customermustprovideashippingaddress.
ContinuedAPPENDIXPAYPALREFERENCE233TableA-4.
ContinuedVariableDescriptionRequiredCharacterLengthpage_styleSetstheCustomPaymentPageStyleOptional30forpaymentpages;alphanumericASCIIlower7-bitcharactersonly,plusunderscore,nospaces.
primary:Alwaysusethepagestylesetasprimary.
paypal:UsethePayPaldefaultstyle.
other:Thenameofapagestyleyouhavedefined.
*Avalidvalueforthiscolorisacase-insensitivesix-characterHTMLhexadecimalcolorcodeinASCII.
TransactionInformationVariablesVariablesspecifictoindividualtransactionsareshowninTableA-5.
TableA-5.
TransactionInformationVariablesVariableDescriptionRequiredCharacterLengthaddress_override1:TheaddressspecifiedinprepopulationOptional1variablesoverridestheuser'sstoredaddress.
currency_codeCurrencyofthepayment.
ThedefaultisOptional3U.
S.
dollars.
customPass-throughvariableneverpresentedtoOptional256yourcustomer.
handlingHandlingcharges.
Notquantity-specific,thisOptionalhandlingcostischargedregardlessofthenumberofitemspurchased.
invoicePass-throughvariableyoucanusetoidentifyOptional127yourinvoicenumberforthispurchase.
redirect_cmdUsedonlyinconjunctionwithOptional40cmd="_ext-enter"forprepopulatingaPayPalformduringpayment.
Onlyvalidvalueis_xclick.
shippingCostofshippingifyouhaveenableditem-Optionalspecificshippingcosts.
Ifshippingisusedandshipping2isnotdefined,thisflatamountischargedregardlessofthequantityofitemspurchased.
TakeseffectonlyiftheoverridecheckboxischeckedinyourProfile.
shipping2Costofshippingeachadditionalitem.
OptionaltaxFlattaxamountregardlessofthebuyer'sOptionallocation.
OverridestaxsettingssetinyourProfile.
APPENDIXPAYPALREFERENCE234CartUploadVariablesVariablesforallcartuploadtransactionsareshowninTableA-6.
CartuploadmeanspassingthetotalcontentsoftheshoppingcarttoPayPalinasingleformattheendofthetransaction.
TableA-6.
CartUploadVariablesAllowableVariableDescriptionRequiredValuesamountPriceoftheitemorthetotalpriceofallitemsintheRequiredAnyvalidshoppingcart.
currencyamountbusinessEmailaddressforyourPayPalaccount.
RequiredAnemailaddresshandling_cartSinglehandlingfeetobechargedcartwide.
OptionalAnyvalidcurrencyamountitem_nameNameoftheitemoranamefortheentirecart.
RequiredpaymentactionTypeoftransaction.
OptionalSale,order,authori-zationtax_cartTotaltaxonentirecart.
OverridesanyindividualOptionaltax_xvalues.
uploadIndicatestheuseofthird-partyshoppingcart.
Required1CartUploadVariablesforIndividualCartItemsVariablesforincludingindividualitemdetailsforathird-partyshoppingcartareshowninTableA-7.
TableA-7.
CartUploadVariablesforIndividualCartItemsVariableDescriptionRequiredCharacterLengthamount_xPriceofitemx.
*Requiredhandling_xThecostofhandlingforitemx.
Optionalitem_name_xAlphanumericnameofitemxinthecart.
Required127item_number_xVariableforyoutotrackorderorotherpurchase.
Optional127on0_xFirstoptionalfieldnameforitemx.
Optional64on1_xSecondoptionalfieldnameforitemx.
Optional64os0_xFirstsetofoptionalvalue(s)foritemx.
RequiresOptional200thaton0_xalsobeset.
os1_xSecondsetofoptionalvalue(s)foritemx.
Optional200Requiresthaton1_xalsobeset.
quantity_xQuantityoftheitemx.
Mustbeapositiveinteger.
OptionalContinuedAPPENDIXPAYPALREFERENCE235TableA-7.
ContinuedVariableDescriptionRequiredCharacterLengthshipping_xCostofshippingthefirstpiece(quantityof1)Optionalofitemx.
shipping2_xCostofshippingeachadditionalpiece(quantityOptionaloftwoormore)ofitemx.
tax_xTaxamountforitemx.
Optional*xmuststartwith1andincrementby1foreachcartitem.
AddressOverrideVariablesIfyouincludeaddressoverridevariables,showninTableA-8,thevalueswilloverridethosestoredinthebuyer'sPayPalaccount.
Allvariablesareoptional.
Thesevariablescanalsobepassedinwithacmd=_ext_entertransactionwhenyouwanttosendthebuyertoanaccountcreationpagewithcertainvariableprefilled.
TableA-8.
AddressOverrideVariablesVariableDescriptionFormatCharacterLengthaddress1Streetaddress,line1Alphanumeric100address2Streetaddress,line2Alphanumeric100cityCityAlphanumeric40countryCountryAlphabetic2emailCustomer'semailaddressAlphanumeric127first_nameFirstnameAlphabetic32last_nameLastnameAlphabetic32lcLocale(language)ofthePayPalloginpageAlphabetic2night_phone_aAreacodeforU.
S.
phonenumbers;countryNumeric3codeforphonenumbersoutsidetheU.
S.
night_phone_bThree-digitprefixforU.
S.
phonenumbers;NumericentirephonenumberforphonenumbersoutsidetheU.
S.
,excludingcountrycodenight_phone_cFour-digitphonenumberforU.
S.
phoneNumeric4numbersstateStateTwo-character2U.
S.
orCanadianabbreviationzipPostalcodeNumeric32APPENDIXPAYPALREFERENCE236PrepopulatingBusinessAccountSignupVariablesIfyouincludethevariablesshowninTableA-9inaformtoregisterauserforaPayPalaccount,thecorrespondingfieldswillbeprefilledtospeeduptheregistrationprocess.
Allvariablesareoptional.
TableA-9.
PrepopulatingBusinessAccountSignupVariablesVariableDescriptionFormatCharacterLengthbusiness_address1Businessstreetaddress,line1Alphanumeric128business_address2Businessstreetaddress,line2Alphanumeric128business_cityBusinesscityAlphanumeric128business_stateBusinessstateTwo-character2officialU.
S.
orCanadianabbreviationbusiness_countryBusinesscountryAlphabetic2business_cs_emailCustomerserviceemailaddressAlphanumeric128business_cs_phone_aCustomerservicephonenumberNumeric3areacodeforU.
S.
phonenumbers;countrycodeforphonenumbersoutsidetheU.
S.
business_cs_phone_bCustomerservicethree-digitNumeric3prefixforU.
S.
phonenumbers;entirenumberforphonenum-bersoutsidetheU.
S.
,excludingcountrycodebusiness_cs_phone_cCustomerservicefour-digitphoneNumeric4numberforU.
S.
phonenumbersbusiness_urlURLofthebusiness'swebsiteAlphanumeric;128mustbeURL-encodedbusiness_night_phone_aAreacodeforU.
S.
phonenumbers;Numeric3countrycodeforphonenumbersoutsidetheU.
S.
business_night_phone_bThree-digitprefixforU.
S.
phoneNumericnumbers,ortheentirephonenumberforphonenumbersout-sidetheU.
S.
,excludingcountrycodebusiness_night_phone_cFour-digitphonenumberforU.
S.
Numeric4phonenumbersAPPENDIXPAYPALREFERENCE237PayPalSubscriptionVariablesVariablesspecifictousingPayPalSubscriptionsareshowninTableA-10.
TableA-10.
PayPalSubscriptionVariablesVariableDescriptionRequiredcmdMustbesetto_xclick-subscriptions.
RequiredbusinessEmailaddressofyourPayPalaccount.
Requireditem_nameDescriptionofsubscription(maximum127characters).
Optionala1Priceofthefirsttrialperiod.
Optionalp1Lengthofthefirsttrialperiod.
ThisnumberismodifiedbytheunitsOptionalvariablet1.
t1Unitsoffirsttrialperiod.
AcceptablevaluesareD(days),W(weeks),OptionalM(months),andY(years).
a2Priceofthesecondtrialperiod.
Optionalp2Lengthofthesecondtrialperiod.
ThisnumberismodifiedbytheOptionalunitsvariablet2.
t2Unitsofthesecondtrialperiod.
AcceptablevaluesareD(days),OptionalW(weeks),M(months),andY(years).
a3Regularpriceofthesubscription.
Requiredp3Lengthoftheregularbillingcycle.
ThisnumberismodifiedbytheRequiredunitsvariablet3.
t3Unitsoftheregularbillingcycle.
Acceptablevaluesare:D(days),RequiredW(weeks),M(months),Y(years).
srcRecurringpayments.
Ifsetto1,paymentwillrecurunlesscustomerOptionalcancels.
Default:Subscriptionwillnotrecur.
sraReattemptonfailure.
Ifsetto1,afailedpaymentwillbereattemptedOptionaltwice.
Default:Paymentisnotreattempted.
srtNumberofpaymentsthatwilloccurattheregularrate.
OptionalDefault:Paymentwillcontinuetorecurattheregularrateuntilthesubscriptioniscanceled.
no_noteMustbesetto1.
ThisensuresthatsubscriberisnotpromptedtoRequiredincludeanotewiththesubscription,afunctionthatPayPalSubscriptionsdoesnotsupport.
customUser-definedfield(maximum255characters)returnedtoyouinOptionalpaymentnotificationemails.
Thisfieldisnotshowntosubscribers.
invoiceUser-definedfield(maximum127characters)thatmustbeuniqueOptionalwitheachsubscription.
Showntosubscribers.
usr_manageUsernameandpasswordgenerationfield.
Ifsetto1,PayPalgeneratesOptionalausernameandpasswordforyoursubscriber.
ForusewithSubscriptionPasswordManagement.
modifySubscriptionmodificationbehavior.
OptionalDefault:Buyerscanonlycreatenewsubscriptions.
1:Buyerscanmodifycurrentsubscriptionsandsignupfornewsubscriptions.
2:Buyerscanonlymodifyexistingsubscriptions.
APPENDIXPAYPALREFERENCE238IPNandPDTVariableReferenceThisisalistofvariablesthatcanbeincludedintheInstantPaymentNotification(IPN)orPaymentDataTransfer(PDT)postthatPayPalsendstoyou.
FormoredetailsonIPNandPDT,seeChapter5.
IntheSandboxtestingenvironment,IPNpostsincludeanadditionalvariablecalledtest_ipnthatwillhaveavalueof1.
BuyerInformationVariablesBuyerinformationvariablesareshowninTableA-11.
TableA-11.
BuyerInformationVariablesVariableDescriptionMaximumLengthaddress_cityCityofbuyer'saddress.
40address_countryCountryofbuyer'saddress.
64address_country_codeTwo-characterISO3166countrycode.
2address_nameNameusedwithaddress.
128address_stateStateofcustomer'saddress.
40address_statusConfirmed:Buyerprovidedaconfirmedaddress.
Unconfirmed:Buyerprovidedaunconfirmedaddress.
address_streetBuyer'sstreetaddress.
200address_zipZIPcodeofbuyer'saddress.
20first_nameBuyer'sfirstname.
64last_nameBuyer'slastname.
64payer_business_nameBuyer'scompanyname.
127payer_emailBuyer'sprimaryemailaddress.
127payer_idUniquecustomerID.
13payer_statusverified:CustomerhasaverifiedPayPalaccount.
unverified:CustomerhasaunverifiedPayPalaccount.
residence_countryTwo-characterISO3166countrycode.
2test_ipnThisvariablewillbeincludedwithavalueof1ifitis1aSandboxIPN.
APPENDIXPAYPALREFERENCE239TransactionVariablesVariablesspecifictothetransactionarelistedinTableA-12.
TableA-12.
TransactionVariablesVariableDescriptionMaximumLengthbusinessEmailaddressoftherecipient.
127customCustomvalue;neverpresentedtothebuyer.
255invoiceVariabletoidentifythepurchase.
Mustbeunique.
127item_nameItemname.
127item_numberItemnumber.
127memoMemoasenteredbythebuyerduringcheckout.
255option_name1Option1name.
64option_name2Option2name.
64option_selection1Option1choiceasselectedbythebuyer.
200option_selection2Option2choiceasselectedbythebuyer.
200quantityQuantityofpurchase.
receiver_emailPrimaryemailaddressoftherecipient'sPayPalaccount.
127receiver_idUniqueaccountIDofrecipient.
13taxAmountoftaxchargedonpayment.
2decimalplacesPaymentVariablesVariablesusedwithWebsitePaymentsStandardandWebsitePaymentsProareshowninTableA-13.
TableA-13.
PaymentVariablesVariableDescriptionauth_idAuthorizationidentificationnumber.
auth_expAuthorizationexpirationdateandtime.
auth_statusStatusofauthorization.
Possiblevalues:CompletedPendingVoidedmc_gross_xAmountinthecurrencyofmc_currency,wherexistheshoppingcartdetailitemnumber.
mc_handling_xCombinedtotalofshippingandshipping2variables.
Onlyusedwhenshippingamountforaspecificitemissubmitted.
num_cart_itemsIfthisisaPayPalShoppingCarttransaction,numberofitemsincart.
option_name1Nameofoptionalfield1.
option_name2Nameofoptionalfield2.
APPENDIXPAYPALREFERENCE240VariableDescriptionoption_selection1_xValueofoptionalfield1.
option_selection2_xValueofoptionalfield2.
parent_txn_idInthecaseofarefund,reversal,orcanceledreversal,thisvariablecontainsthetxn_idoftheoriginaltransaction.
payment_dateTimestampgeneratedbyPayPal.
Format:18:30:30Jan1,2000PST.
payment_statusCanceled-Reversal:Areversalhasbeencanceled.
Completed:Thepaymenthasbeencompleted.
Denied:Youdeniedthepayment.
Expired:Thisauthorizationhasexpiredandcannotbecaptured.
Failed:Thepaymenthasfailed.
In-Progress:Thetransactionisinprogress(e.
g.
,anauthorizationwaitingforacaptureorvoid).
Partially-Refunded:Thetransactionhasbeenpartiallyrefunded.
Pending:Thepaymentispending(seepending_reasonforwhy).
Processed:AllpaymentsfromtheMassPaymenthavebeencompleted.
Refunded:Yourefundedthepayment.
Reversed:Apaymentwasreversedduetoachargebackorothertypeofreversal.
Processed:Apaymenthasbeenaccepted.
Voided:Thisauthorizationhasbeenvoided.
payment_typeecheck:PaymentisfundedviaaneCheck.
instant:PaymentisfundedwithPayPalbalance,creditcard,orinstanttransfer.
pending_reasonIncludedonlyifpayment_statusisPending.
address:ThepaymentispendingbecauseyourcustomerdidnotincludeaconfirmedshippingaddressandyourPaymentReceivingPreferencesissettoallowyoutomanuallyacceptordenyeachofthesepayments.
authorization:Youhavenotyetcapturedfundsforanauthorization.
echeck:PaymentwasmadebyaneCheckthathasnotyetcleared.
intl:Paymentispendingbecauseyouholdanon-U.
S.
accountanddonothaveawithdrawalmechanism.
multi-currency:Youdonothaveabalanceinthecurrencysent,andyoudonothaveyourPaymentReceivingPreferencessettoautomaticallyconvertandacceptthispayment.
unilateral:Paymentispendingbecauseitwasmadetoanemailaddressthatisnotyetregisteredorconfirmed.
upgrade:PaymentispendingbecauseitwasmadeviacreditcardandyoumustupgradetoaBusinessorPremieraccounttoreceivethefunds.
upgradecanalsomeanthatyouhavereachedthemonthlylimitfortransactionsonyouraccount.
verify:Paymentispendingbecauseyouarenotyetverified.
other:Paymentispendingforareasonotherthanthosepreviouslylisted.
reason_codeIncludedifpayment_statusisReversedorRefunded.
chargeback:Areversalhasoccurredonthistransactionduetoachargebackbyyourcustomer.
guarantee:Areversalhasoccurredonthistransactionduetoyourcustomertriggeringamoney-backguarantee.
buyer-complaint:Areversalhasoccurredonthistransactionduetoacomplaintaboutthetransactionfromyourcustomer.
refund:Areversalhasoccurredonthistransactionbecauseyouhavegiventhecustomerarefund.
other:Areversalhasoccurredonthistransactionduetoareasonnotpreviouslylisted.
ContinuedAPPENDIXPAYPALREFERENCE241TableA-13.
ContinuedVariableDescriptionremaining_settleAmountthatcanbecapturedontheauthorizationthisIPNreferences.
taxTotaltax.
transaction_entityTypeoftransactionthisIPNreferences.
Possiblevalues:authreauthorderpaymenttxn_idUniquetransactionID.
txn_typeTransactiontype.
Possiblevalues:cart:PayPalShoppingCarttransactionorExpressCheckoutwithmultipleitems.
express_checkout:ExpressCheckoutwithasingleitem.
merch_pmt:WebsitePaymentsPromonthlybillingfee.
masspay:PaymentwassentviaMassPayment.
send_money:TransactionoriginatedviaSendMoneyfeatureonPayPalwebsite.
virtual_terminal:TransactionoriginatedviaPayPalVirtualTerminal.
web_accept:TransactionoriginatedviaBuyNoworDonationbutton.
CurrencyandCurrencyExchangeVariablesVariablesdealingwithcurrencyexchange,ifthetransactioninvolvedmultiplecurrencies,arelistedinTableA-14.
TableA-14.
CurrencyandCurrencyExchangeVariablesVariableDescriptionexchange_rateExchangerateusedifacurrencyconversionoccurredmc_currencyCurrencyofthepaymentmc_feeTransactionfeeassociatedwiththepaymentmc_grossAmountofpayment,beforetransactionfeeissubtractedmc_gross_xAmountofitemnumberx,ifindividualcartitemdetailsareavailablemc_handlingHandlingcostassociatedwiththetransactionmc_handling_xHandlingcostofitemnumberx,ifindividualcartitemdetailsareavailablemc_shippingShippingcostassociatedwiththetransactionsettle_amountAmountdepositedintoseller'sprimarybalanceaftercurrencyconversionsettle_currencyCurrencyofsettle_amountAPPENDIXPAYPALREFERENCE242AuctionVariablesVariablesspecifictoanauction-basedtransaction,suchasthoseoriginatingoneBay,arelistedinTableA-15.
TableA-15.
AuctionVariablesVariableDescriptionauction_buyer_idBuyer'sauctionID.
Maximumis64characters.
auction_closing_dateAuction'sclosedate.
auction_multi_itemNumberofitemspurchasedinmulti-itemauctionpayments.
Allowsyoutocountthemc_grossforthefirstIPNyoureceive,sinceeachitemfromtheauctiongeneratesanIPNshowingtheamountforallauctionitems.
for_auctionWillbesettotrueforauctionpayments.
MassPaymentVariablesVariablesincludedwithIPNsassociatedwiththeMassPayAPIcallorthefile-basedMassPay-mentoptionareshowninTableA-16.
FormoreinformationonMassPayment,seeChapter6.
TableA-16.
MassPaymentVariablesVariableDescriptionmasspay_txn_id_xTransactionID,wherexistherecordnumberoftheMassPaymentitem.
mc_currency_xCurrencyofthepaymentamountandfee,wherexistherecordnumberoftheMassPaymentitem.
mc_fee_xTransactionfee,wherexistherecordnumberoftheMassPaymentitem.
mc_gross_xGrossamountofthepayment,wherexistherecordnumberoftheMassPaymentitem.
payment_dateFirstIPNisthetimestampwhentheMassPaymentstarted.
SecondIPNisthetimestampwhenallpaymentsarecompletedorreturned.
reason_codeIncludedifstatusisFailed.
Possiblevalues:1001:InvalidUserID.
1003:Countryofresidencecheckfailed.
1004:Countryoffundingsourcecheckfailed.
receiver_email_xPrimaryemailaddressofpaymentrecipient,wherexistherecordnumberoftheMassPaymentitem.
status_xStatusofthepayment,wherexistherecordnumberoftheMassPaymentitem.
Possiblevalues:Completed:Paymenthasbeenprocessed.
Failed:PaymentfailedbecauseofinsufficientPayPalbalance.
Reversed:Paymentwasnotclaimedafter30daysandhasbeenreturnedtothesender,orthereceiver'saccountwaslocked.
Unclaimed:Paymentremainsunclaimed.
Recipienthas30daystoclaimMassPaymentpayments.
unique_id_xUniqueIDfromtheinputsource.
APPENDIXPAYPALREFERENCE243SubscriptionVariablesVariablesincludedwithIPNsassociatedwithsubscriptionpaymentsareshowninTableA-17.
Formoreinformationonsubscriptions,seeChapter3.
TableA-17.
SubscriptionVariablesVariableDescriptiontxn_typeTransactiontype.
Possiblevalues:subscr_signup:Newsubscription.
subscr_cancel:Canceledsubscription.
subscr_failed:Failedsubscriptionpayment.
subscr_payment:Successfulsubscriptionpayment.
subscr_eot:Endoftermforasubscription.
subscr_modify:Subscriptionhasbeenmodified.
subscr_dateSubscriptionstartdateorenddate,dependingonvalueoftxn_type.
subscr_effectiveDatewhenmodifiedsubscriptionwillbecomeeffective,iftxn_typeissubscr_modify.
period1Trialsubscriptionfirstintervaltimeperiod(e.
g.
,sixweekswouldbe6W).
period2Trialsubscriptionsecondintervaltimeperiod.
period3Regularsubscriptionbillinginterval.
mc_amount1Billingamountforthefirsttrialperiod.
mc_amount2Billingamountforthesecondtrialperiod.
mc_amount3Billingamountfortheregularbillinginterval.
mc_currencyCurrencyforbillingamounts.
recurringIfsetto1,thesubscriptionisrecurring.
reattemptIfsetto1,failedsubscriptionpaymentswillbereattempteduptotwoadditionaltimes.
retry_atDatewhenPayPalwillreattemptthefailedsubscriptionpayment.
recur_timesNumberofpaymentinstallmentsthatwilloccurattheregularrate.
usernameIfSubscriptionPasswordManagementisused,thisisthePayPal-generatedusername.
passwordIfSubscriptionPasswordManagementisused,thisisthePayPal-generatedpassword.
subscr_idPayPal-generateduniqueidentifierforthesubscriber.
APPENDIXPAYPALREFERENCE244DisputeNotificationVariablesVariablesincludedwithIPNsassociatedwithdisputenotificationsareshowninTableA-18.
FormoreinformationonPayPal'sdisputeresolutionprocess,seeChapter9.
TableA-18.
DisputeNotificationVariablesVariableDescriptiontxn_typeWillbesettonew_caseforthenewcaseIPN.
txn_idSeller'soriginaltransactionIDforwhichthedisputehasbeenfiled.
case_idCaseidentificationnumber.
Format:PP-nnn-nnn-nnn,wherenisadigit.
case_typeCasetype.
Possiblevalues:complaint:BuyerfiledacomplaintviatheResolutionCenterchargeback:Buyerfiledacomplaintwithhisorherbank,whichhasthennotifiedPayPal.
case_creation_dateTimestampwhencasewascreated.
Format:HH:mm:ssmonDD,YYYYTZ,whereTZisthethree-charactertimezone.
reason_codeReasonforthecase.
Possiblevalues:non_receipt:Buyerclaimsheorshedidnotreceivegoodsorservicespaidfor.
not_as_described:Buyerclaimsgoodsandservicesreceiveddiffersignifi-cantlyfromdescription.
unauthorized:Buyerclaimsheorshedidnotauthorizetransaction.
duplicate:Buyerclaimsaduplicatepaymentwasmade.
merchandise:Buyerclaimsmerchandiseisdamagedorunsatisfactory.
special:Someotherreason.
APIErrorCodesThissectioncontainsPayPalAPIerrorcodesandtheircorrespondingmessages.
EachAPIerrorreturnsashortmessageandalongmessage.
Ifyouwanttodisplayanerrorcodetoacustomer,suchasonafailedcreditcardtransaction,usethelongmessage.
GeneralAPIErrorsTheerrorcodesshowninTableA-19canoccurwithanyAPIcall.
TableA-19.
GeneralAPIErrorCodesVariableShortMessageLongMessage10001InternalErrorInternalError10002Authentication/AuthorizationFailedClientcertificateisdisabled10002Authentication/AuthorizationFailedYoudonothavepermissionstomakethisAPIcall10006VersionerrorVersionisnotsupported10008SecurityerrorSecurityheaderisnotvalid10101ThisAPITemporarilyUnavailableThisAPIistemporarilyunavailable.
Pleasetrylater.
APPENDIXPAYPALREFERENCE245Authorization&CaptureAPIErrorCodesTheerrorcodesshowninTableA-20canoccurwhenusinganyoftheAPIsrelatedtoauthori-zations,captures,orders,andvoids.
TableA-20.
Authorization&CaptureAPIErrorCodesVariableShortMessageLongMessage10004InternalErrorInvalidargument10004TransactionrefusedbecauseofanCurrencyisnotsupportedinvalidargument10009TransactionrefusedAccountislockedorinactive10009TransactionrefusedAccountisrestricted10010InvalidInvoiceNon-ASCIIinvoiceidisnotsupported10011InvalidtransactionidvalueTransactionrefusedbecauseofaninvalidtransactionidvalue10600AuthorizationvoidedAuthorizationisvoided10601AuthorizationexpiredAuthorizationhasexpired10602AuthorizationcompletedAuthorizationhasalreadybeencompleted10603ThebuyerisrestrictedThebuyeraccountisrestricted10604AuthorizationmustincludebothAuthorizationtransactioncannotbeunilateral.
buyerandsellerItmustincludebothbuyerandsellertomakeanauth10605UnsupportedcurrencyCurrencyisnotsupported10606BuyercannotpayTransactionrejected,pleasecontactthebuyer10607Auth&CaptureunavailableAuthorization&Capturefeatureunavailable10608FundingsourcemissingThefundingsourceismissing10609InvalidTransactionIDTransactionidisinvalid10610AmountlimitexceededAmountspecifiedexceedsallowablelimit10611NotenabledAuthorization&Capturefeatureisnotenabledforthemerchant10612NomoresettlementMaximumnumberofallowablesettlementshasbeenreachedfortheauthorization10613CurrencymismatchCurrencyofcapturemustbethesameascurrencyofauthorization10614CannotvoidreauthYoucanvoidonlytheoriginalauthorization,notareauthorization10615CannotreauthreauthYoucanreauthorizeonlytheoriginalauthorization,notareauthorization10616Maximumnumberofreauthori-Maximumnumberofreauthorizationallowedforzationallowedfortheauthistheauthisreachedreached10617ReauthorizationnotallowedReauthorizationisnotallowedinsidehonorperiod10618TransactionalreadyvoidedorTransactionhasalreadybeenvoidedorexpiredexpiredAPPENDIXPAYPALREFERENCE246VariableShortMessageLongMessage10619InvoiceIDvalueexceedsmaximumInvoiceIDvalueexceedsmaximumallowableallowablelengthlength10620OrderhasalreadybeenvoidedorOrderhasalreadybeenvoidedorexpiredexpired10621OrderhasexpiredOrderhasexpired10622OrderisvoidedOrderisvoided10623MaximumnumberofauthorizationMaximumnumberofauthorizationallowedforallowedfortheorderisreachedtheorderisreached10624DuplicateinvoicePaymenthasalreadybeenmadeforthisInvoiceID10625TransactionrefusedbecauseofanTheamountexceedsthemaximumamountforinvalidargumentasingletransaction10626RiskTransactionrefusedduetoriskmodel10627TransactionrefusedbecauseofanTheinvoiceIDfieldisnotsupportedforbasicinvalidargumentauthorizations10628Thistransactioncannotbepro-Thistransactioncannotbeprocessedatthistimecessedatthistime10630ItemamountisinvalidItemamountisinvalidDirectPaymentAPIErrorCodesTheerrorcodesshowninTableA-21canoccurwhenusingtheDoDirectPaymentAPI.
Ifyouchoosetodisplayanerrorcodetoacustomerforafailedtransaction,usethelongmessage,nottheshortmessage.
TableA-21.
DirectPaymentAPIErrorCodesVariableShortMessageLongMessage10004TransactionrefusedbecauseofaninvalidHandlingtotalisinvalidargument10004TransactionrefusedbecauseofaninvalidItemtotalisinvalidargument10004TransactionrefusedbecauseofaninvalidShippingtotalisinvalidargument10004TransactionrefusedbecauseofaninvalidTaxtotalisinvalidargument10102PaymentActionofOrderTemporarilyPaymentActionofOrderistemporarilyUnavailableunavailable10400TransactionrefusedbecauseofaninvalidOrdertotalismissingargument10418TransactionrefusedbecauseofaninvalidThecurrenciesoftheshoppingcartargumentamountsmustbethesameContinuedAPPENDIXPAYPALREFERENCE247TableA-21.
ContinuedVariableShortMessageLongMessage10500InvalidConfigurationThistransactioncannotbeprocessedduetoaninvalidmerchantconfiguration10501InvalidConfigurationThistransactioncannotbeprocessedduetoaninvalidmerchantconfiguration10502InvalidDataThistransactioncannotbeprocessed.
Pleaseuseavalidcreditcard.
10503CreditLimitExceededThetransactionfailedasaresultofthecardexceedingthecreditlimit10504InvalidDataThistransactioncannotbeprocessed.
PleaseenteravalidCreditCardVerificationNumber.
10505GatewayDeclineThistransactioncannotbeprocessed10506TransactionDeclinedThetransactionwasdeclined10507InvalidConfigurationThistransactioncannotbeprocessed10508InvalidDataPleaseenteravalidcreditcardexpirationdate.
Theexpirationdatemustbeatwo-digitmonthandfour-digityear.
10509InvalidDataThistransactioncannotbeprocessed10510InvalidDataThecreditcardtypeisnotsupported10511InvalidDataThistransactioncannotbeprocessed10512InvalidDataThistransactioncannotbeprocessed.
Pleaseenterafirstname.
10513InvalidDataThistransactioncannotbeprocessed.
Pleaseenteralastname.
10514Streetaddress1inthebillingaddressisStreetaddress1inthebillingaddressismissingmissing10515ThecityinthebillingaddressismissingThecityinthebillingaddressismissing10516ThestateinthebillingaddressismissingThestateinthebillingaddressismissing10517ThecountryinthebillingaddressismissingThecountryinthebillingaddressismissing10518ThezipcodeinthebillingaddressismissingThezipcodeinthebillingaddressismissing10519InvalidDataPleaseenteracreditcard10520InvalidDataThistransactioncannotbeprocessed10521InvalidDataThistransactioncannotbeprocessed.
Pleaseenteravalidcreditcard.
10522InvalidcreditcardnumberPleasechecktomakesurethatthecreditcardnumberisvalid10523InternalErrorThistransactioncannotbeprocessedAPPENDIXPAYPALREFERENCE248VariableShortMessageLongMessage10524MissingShippingAddressNameYouhavepassedshippingaddresswithoutaname10525InvalidDataThistransactioncannotbeprocessed.
Theamounttobechargediszero.
10526InvalidDataThistransactioncannotbeprocessed.
Thecurrencyisnotsupportedatthistime.
10527InvalidDataThistransactioncannotbeprocessed.
Pleaseenteravalidcreditcardnumberandtype.
10528UnabletomakethistransactionUnabletomakethistransaction.
Itispossiblethattheamountwouldexceedthespendinglimitofthepayer.
10529Streetaddress1intheshippingaddressisStreetaddress1intheshippingaddressmissingismissing10530ThecityintheshippingaddressismissingThecityintheshippingaddressismissing10531ThestateintheshippingaddressismissingThestateintheshippingaddressismissing10532ThecountryintheshippingaddressisThecountryintheshippingaddressismissingmissing10533ThezipcodeintheshippingaddressisThezipcodeintheshippingaddressismissingmissing10534GatewayDeclineThistransactioncannotbeprocessed.
Pleaseenteravalidcreditcardnumberandtype.
10535GatewayDeclineThistransactioncannotbeprocessed.
Pleaseenteravalidcreditcardnumberandtype.
10536InvalidDataThetransactionwasrefusedasaresultofaduplicateinvoiceIDsupplied.
10537FilterDeclineThistransactioncannotbeprocessed.
Thetransactionwasdeclinedbythecountryfiltermanagedbythemerchant.
10538FilterDeclineThistransactioncannotbeprocessed10539FilterDeclineThistransactioncannotbeprocessed10540InvalidDataThetransactioncannotbeprocessedduetoaninvalidaddress10541GatewayDeclineThistransactioncannotbeprocessed.
Pleaseenteravalidcreditcardnumberandtype.
10542InvalidDataThistransactioncannotbeprocessed.
Pleaseenteravalidemailaddress.
10543CreditCardAuthorizationFailedWefailedtoauthorizethecreditcardContinuedAPPENDIXPAYPALREFERENCE249TableA-21.
ContinuedVariableShortMessageLongMessage10544GatewayDeclineThistransactioncannotbeprocessed10545GatewayDeclineThetransactionwasrefused10546GatewayDeclineThistransactioncannotbeprocessed10547InternalErrorThistransactioncannotbeprocessed10548InvalidConfigurationThistransactioncannotbeprocessed.
Themerchant'saccountisnotabletoprocesstransactions.
10549InvalidConfigurationThistransactioncannotbeprocessed.
Themerchant'saccountisnotabletoprocesstransactions.
10550InvalidConfigurationThistransactioncannotbeprocessed.
AccesstoDirectPaymentwasdisabledforyouraccount.
10552InvalidConfigurationThistransactioncannotbeprocessed.
ThemerchantaccountattemptingthetransactiondoesnothaveaconfirmedemailaddresswithPayPal.
10553GatewayDeclineThistransactioncannotbeprocessed.
Themerchantattemptedatransactionwheretheamountexceededtheupperlimitforthatmerchant.
10554FilterDeclineThistransactioncannotbeprocessedbecauseofamerchantriskfilterforAVS10555FilterDeclineThistransactioncannotbeprocessedbecauseofamerchantriskfilterforAVS10556FilterDeclineThistransactioncannotbeprocessedbecauseofamerchantriskfilterforAVS10701InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidbillingaddress.
10702InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidaddress1inthebillingaddress.
10703InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidaddress2inthebillingaddress.
10704InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidcityinthebillingaddress.
10705InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidtwo-characterstateinthebillingaddress.
10706InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourfivedigitpostalcodeinthebillingaddress.
10707InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidcountryinthebillingaddress.
10708InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteracompletebillingaddress.
10709InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteranaddress1inthebillingaddress.
10710InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteracityinthebillingaddress.
10711InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourstateinthebillingaddress.
APPENDIXPAYPALREFERENCE250VariableShortMessageLongMessage10712InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourfivedigitpostalcodeinthebillingaddress.
10713InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteracountryinthebillingaddress.
10713InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteracountryinthebillingaddress.
10714InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidbillingaddress.
10715InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidstateinthebillingaddress.
10716InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourfivedigitpostalcodeinthebillingaddress.
10717InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourfivedigitpostalcodeinthebillingaddress.
10718InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidcityandstateinthebillingaddress.
10719InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidshippingaddress.
10720InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidaddress1intheshippingaddress.
10721InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidaddress2intheshippingaddress.
10722InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidcityintheshippingaddress.
10723InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidstateintheshippingaddress.
10724InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourfivedigitpostalcodeintheshippingaddress.
10725InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidcountryintheshippingaddress.
10726InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteracompleteshippingaddress.
10727InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteranaddress1intheshippingaddress.
10728InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteracityintheshippingaddress.
10729InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourstateintheshippingaddress.
10730InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourfivedigitpostalcodeintheshippingaddress.
10731InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteracountryintheshippingaddress.
10732InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidshippingaddress.
ContinuedAPPENDIXPAYPALREFERENCE251TableA-21.
ContinuedVariableShortMessageLongMessage10733InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidstateintheshippingaddress.
10734InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourfivedigitpostalcodeintheshippingaddress.
10735InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteryourfivedigitpostalcodeintheshippingaddress.
10736InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidcityandstateintheshippingaddress.
10744InvalidDataThistransactioncannotbeprocessed.
Pleaseenteravalidcountrycodeinthebillingaddress.
10745InvalidDataThistransactioncannotbeprocessed.
Pleaseenteravalidcountrycodeintheshippingaddress.
10746InvalidDataThistransactioncannotbeprocessed.
Pleaseuseavalidcountryonthebillingaddress.
10747InvalidDataThistransactioncannotbeprocessed10748InvalidDataThistransactioncannotbeprocessedwithoutaCreditCardVerificationnumber10750InvalidDataThistransactioncannotbeprocessedwithoutaCreditCardVerificationnumber10751InvalidDataThere'sanerrorwiththistransaction.
Pleaseenteravalidstateinthebillingaddress.
10752GatewayDeclineThistransactioncannotbeprocessed.
(UsuallyCVVorAVScheck)10754GatewayDeclineThistransactioncannotbeprocessed10755InvalidDataThistransactioncannotbeprocessedduetoanunsupportedcurrency10756GatewayDeclineThetransactioncannotbeprocessed.
Thecountryandbillingaddressassociatedwiththiscreditcarddonotmatch.
10758InvalidConfigurationThere'sbeenanerrorduetoinvalidAPIusernameand/orpassword10759GatewayDeclineThistransactioncannotbeprocessed.
Pleaseenteravalidcreditcardnumberandtype.
10760InvalidConfigurationThistransactioncannotbeprocessed.
Thecountrylistedforyourbusinessaddressisnotcurrentlysupported.
10761GatewayDeclineThistransactioncannotbeprocessed.
Pleasecheckthestatusofyourfirsttransactionbeforeplacinganotherorder.
10762GatewayDeclineThistransactioncannotbeprocessed.
CheckCVVcodewithcardtype.
10763InvalidDataThistransactioncannotbeprocessed.
15001GatewayDeclineThetransactionwasrejectedbyPayPalbecauseofexcessivefailuresoverashortperiodoftimeforthiscreditcard15002GatewayDeclineThetransactionwasdeclinedbyPayPalAPPENDIXPAYPALREFERENCE252VariableShortMessageLongMessage15003InvalidConfigurationThetransactionwasdeclinedbecausethemerchantdoesnothaveavalidcommercialentityagreementonfilewithPayPal15004GatewayDeclineThistransactioncannotbeprocessed.
PleaseenteravalidCreditCardVerificationNumber15005ProcessorDeclineThetransactionwasdeclinedbytheissuingbank,notPayPal15006ProcessorDeclinePleaseenteravalidcreditcardnumberandtype.
Thetransactionwasdeclinedbytheissuingbank,notPayPal.
15007ProcessorDeclineThistransactioncannotbeprocessed.
Pleaseuseavalidcreditcard.
ExpressCheckoutAPIErrorCodesTheerrorcodesshowninTableA-22canoccurwhenusingPayPal'sExpressCheckoutAPIs.
Ifyouchoosetodisplayanerrorcodetoacustomerforafailedtransaction,usethelongmes-sage,nottheshortmessage.
TableA-22.
ExpressCheckoutAPIErrorCodesVariableShortMessageLongMessage10004TransactionrefusedbecauseofaninvalidHandlingtotalisinvalidargument10004TransactionrefusedbecauseofaninvalidItemtotalisinvalidargument10004TransactionrefusedbecauseofaninvalidShippingtotalisinvalidargument10004TransactionrefusedbecauseofaninvalidTaxtotalisinvalidargument10004TransactionrefusedbecauseofaninvalidMaximumamountisinvalidargument10400TransactionrefusedbecauseofaninvalidOrdertotalismissingargument10401TransactionrefusedbecauseofaninvalidCurrencyisnotsupportedargument10401TransactionrefusedbecauseofaninvalidOrdertotalisinvalidargument10402AuthorizationonlyisnotallowedforThismerchantaccountisnotpermittedmerchanttosetPaymentActiontoAuthorization10403TransactionrefusedbecauseofaninvalidCurrencyisnotsupportedargument10403TransactionrefusedbecauseofaninvalidMaximumamountisinvalidargument10404InvalidargumentReturnURLismissingContinuedAPPENDIXPAYPALREFERENCE253TableA-22.
ContinuedVariableShortMessageLongMessage10405InvalidargumentCancelURLismissing10406InvalidargumentPayerIDvalueisinvalid10407InvalidargumentInvalidbuyeremailaddress10408ExpressCheckouttokenismissingExpressCheckouttokenismissing10409YouarenotauthorizedtoaccessthisinfoExpressCheckouttokenwasissuedforamerchantaccountotherthanyours10410InvalidtokenInvalidtoken10411ExpressCheckoutsessionhasexpiredExpressCheckoutsessionhasexpired.
Tokenvalueisnolongervalid.
10412DuplicateinvoicePaymenthasalreadybeenmadeforthisInvoiceID10413InvalidargumentThetotalsofthecartitemamountsdonotmatchorderamounts10414InvalidargumentTheamountexceedsthemaximumamountforasingletransaction10415InvalidargumentAsuccessfultransactionhasalreadybeencompletedforthistoken10416InvalidargumentYouhaveexceededthemaximumnumberofpaymentattemptsforthistoken10417TransactioncannotcompleteThetransactioncannotcompletesuccessfully10418InvalidargumentThecurrenciesoftheshoppingcartamountsmustbethesame10419ExpresscheckoutPayerIDismissingExpressCheckoutPayerIDismissing10420InvalidargumentExpressCheckoutPaymentActionismissing10421ThisExpressCheckoutsessionbelongstoaThisExpressCheckoutsessionbelongsdifferentcustomertoadifferentcustomer.
Tokenvaluemismatch.
10422CustomermustchoosenewfundingsourcesThecustomermustreturntoPayPaltoselectnewfundingsources10423InvalidargumentThistransactioncannotbecompletedwithPaymentActionofAuthorization10424InvalidargumentShippingaddressisinvalid10425ExpressCheckouthasbeendisabledforthisExpressCheckouthasbeendisabledformerchantthismerchant10426InvalidargumentItemtotalisinvalid10427InvalidargumentShippingtotalisinvalid10428InvalidargumentHandlingtotalisinvalid10429InvalidargumentTaxtotalisinvalid10430InvalidargumentItemamountismissing10431InvalidargumentItemamountisinvalidAPPENDIXPAYPALREFERENCE254VariableShortMessageLongMessage10432InvalidargumentInvoiceIDvalueexceedsmaximumallowablelength10433InvalidargumentValueofOrderDescriptionelementhasbeentruncated10434InvalidargumentValueofCustomelementhasbeentruncated10435InvalidargumentThecustomerhasnotyetconfirmedpaymentforthisExpressCheckoutsession10436InvalidargumentPageStylevalueexceedsmaximumallowablelength10437Invalidargumentcpp-header-imagevalueexceedsmaximumallowablelength10438Invalidargumentcpp-header-border-colorvalueexceedsmaximumallowablelength10439Invalidargumentcpp-header-back-colorvalueexceedsmaximumallowablelength10440Invalidargumentcpp-payflow-colorvalueexceedsmaximumallowablelength10441TransactionrefusedbecauseofaninvalidTheNotifyURLelementvalueexceedsargumentmaximumallowablelength10442ButtonSourcevaluetruncatedTheButtonSourceelementvalueexceedsmaximumallowablelength10443ThistransactioncannotbecompletedwithThistransactioncannotbecompletedPaymentActionofOrderwithPaymentActionofOrder10445ThistransactioncannotbeprocessedatThistransactioncannotbeprocessedatthistimethistime.
Pleasetryagainlater10446UnconfirmedemailAconfirmedemailisrequiredtomakethisAPIcall10727ShippingAddress1EmptyThefieldShippingAddress1isrequired10728ShippingAddressCityEmptyThefieldShippingAddressCityisrequired10729ShippingAddressStateEmptyThefieldShippingAddressStateisrequired10730ShippingAddressPostalCodeEmptyThefieldShippingAddressPostalCodeisrequired10731ShippingAddressCountryEmpty10736ShippingAddressInvalidCityStatePostalAmatchoftheShippingAddressCity,CodeState,andPostalCodefailedAPPENDIXPAYPALREFERENCE255GetTransactionDetailsAPIErrorCodesTheerrorcodesshowninTableA-23canoccurwhenusingPayPal'sGetTransactionDetailsAPI.
TableA-23.
GetTransactionDetailsAPIErrorCodesVariableShortMessageLongMessage10004InvalidtransactiontypeYoucannotgetthedetailsforthistypeoftransaction10007PermissiondeniedYoudonothavepermissiontogetthedetailsofthistransactionMassPayAPIErrorCodesTheerrorcodesshowninTableA-24canoccurwhenusingPayPal'sMassPayAPI.
TableA-24.
MassPayAPIErrorCodesVariableShortMessageLongMessage10003MissingargumentTheamountismissing10003MissingargumentThecurrencyismissing10004TransactionrefusedbecauseofaninvalidTheamountislessthanorequaltozeroargument10004TransactionrefusedbecauseofaninvalidTheamountismissingargument10004TransactionrefusedbecauseofaninvalidTheamountisnotavalidnumberargument10004TransactionrefusedbecauseofaninvalidThecurrencyismissingargument10004TransactionrefusedbecauseofaninvalidThemasspayreceiver_typeisnotaargumentrecognizabletype10004TransactionrefusedbecauseofaninvalidThenotestringlengthexceedstheargumentmaximumlimitof4000characters10004TransactionrefusedbecauseofaninvalidThenumberofinputrecordsisgreaterargumentthanmaximumallowed10004TransactionrefusedbecauseofaninvalidThenumberofinputrecordsislessargumentthanorequaltozero10004TransactionrefusedbecauseofaninvalidTherecipient'semailandUserIDshouldargumentnotbespecifiedsimultaneously10004TransactionrefusedbecauseofaninvalidTherecipient'semailismissingargument10004TransactionrefusedbecauseofaninvalidTherecipient'sUserIDismissingargument10004TransactionrefusedbecauseofaninvalidTheuniqueidstringcontainsaspaceargumentasacharacter10004TransactionrefusedbecauseofaninvalidTheuniqueidstringlengthexceedstheargumentmaximumlimitof30charactersAPPENDIXPAYPALREFERENCE256VariableShortMessageLongMessage10301UsernotallowedTheuserisnotallowedtosendmoneythroughMassPay10302AccountlockedTheuseraccountislocked10303RestrictedaccountAccountisrestricted10304UnconfirmedemailTheuseraccounthasunconfirmedemail10305LimitExceededTheuseraccountneedstohaveitssendinglimitremovedinordertomakeamasspayment10306LimitExceededTheuser'sinternationalaccountneedstohaveitssendinglimitremovedinordertomakeamasspayment10307ReceiveonlyaccountTheuseraccountisreceiveonlyandthereforecannotsendpaymentsout10308MassPayserverconfigurationerrorThereissomeconfigurationerror10309MassPayserverunavailableThemasspayserverisunavailable10310UnabletocreatepaymentUnabletocreatepaymentsforMassPay10311UnabletosubmitpaymentUnabletosubmitpaymentsforMassPay10312MassPayservererrorTheMassPayserverhasreportederrors10313MassPayInvalidDataTheMassPayinputfileincludesinvaliddata10314MassPayinputparseerrorTheinputtotheMassPayserverisincorrect.
Pleasemakesurethatyouareusingacorrectlyformattedinput.
10317MassPayInvalidEmailTheMassPayinputfileincludesinvalidemail10320TransactionlimitexceededTheamountexceedsthemaxlimitofasingleMassPayitem10321InsufficientfundsTheaccountdoesnothavesufficientfundstodothisMassPay10327MassPayInvalidUserIDTheMassPayinputfileincludesinvalidUserID10360UnabletofindtheuserwiththeemailUnabletofindtheuserwiththeemailaddressaddress10361TheuseraccountnotavailableTheuseraccountnotavailableAPPENDIXPAYPALREFERENCE257RefundTransactionAPIErrorCodesTheerrorcodesshowninTableA-25canoccurwhenusingPayPal'sRefundTransactionAPI.
TableA-25.
RefundTransactionAPIErrorCodesVariableShortMessageLongMessage10004TransactionrefusedbecauseofaninvalidAtransactionidisrequiredargument10004TransactionrefusedbecauseofaninvalidTheMemofieldcontainsinvalidargumentcharacters10004TransactionrefusedbecauseofaninvalidThepartialrefundamountisnotvalidargument10004TransactionrefusedbecauseofaninvalidThepartialrefundamountmustbeaargumentpositiveamount10004TransactionrefusedbecauseofaninvalidYoucannotspecifyapartialamountargumentwithafullrefund10007PermissiondeniedYoudonothavepermissiontorefundthistransaction10009TransactionrefusedCannotdoafullrefundafterapartialrefund10009TransactionrefusedTheaccountforthecounterpartyislockedorinactive10009TransactionrefusedThepartialrefundamountisnotvalid10009TransactionrefusedThepartialrefundamountmustbelessthanorequaltotheoriginaltransactionamount10009TransactionrefusedThepartialrefundamountmustbelessthanorequaltotheremainingamount10009TransactionrefusedThepartialrefundmustbethesamecurrencyastheoriginaltransaction10009TransactionrefusedThistransactionhasalreadybeenfullyrefunded10009TransactionrefusedYouareoverthetimelimittoperformarefundonthistransaction10009TransactionrefusedYoucannotdoapartialrefundonthistransaction10009TransactionrefusedYoucannotrefundthistypeoftransaction10009TransactionrefusedYoudonothaveaverifiedACHAPPENDIXPAYPALREFERENCE258TransactionSearchAPIErrorCodesTheerrorcodesshowninTableA-26canoccurwhenusingPayPal'sTransactionSearchAPI.
TableA-26.
TransactionSearchAPIErrorCodesVariableShortMessageLongMessage10003TransactionrefusedbecauseofaninvalidStartdateisarequiredparameterargument10004TransactionrefusedbecauseofaninvalidAuctionitemidisnotvalidargument10004TransactionrefusedbecauseofaninvalidCurrencyisnotsupportedargument10004TransactionrefusedbecauseofaninvalidEnddateisinvalidargument10004TransactionrefusedbecauseofaninvalidPayeremailisinvalidargument10004TransactionrefusedbecauseofaninvalidReceiptidisnotvalidargument10004TransactionrefusedbecauseofaninvalidReceivercanonlybespecifiedforpay-argumentmentsyou'vereceived10004TransactionrefusedbecauseofaninvalidReceiveremailisinvalidargument10004TransactionrefusedbecauseofaninvalidStartdateisinvalidargument10004TransactionrefusedbecauseofaninvalidTransactionclassisnotsupportedargument10004TransactionrefusedbecauseofaninvalidYoucannotsearchforatransactionidargumentandareceiptid10007PermissiondeniedYoudonothavepermissionstomakethisAPIcall10007PermissiondeniedYoudonothavepermissionstosearchforthistransaction11002SearchwarningThenumberofresultsweretruncated.
Pleasechangeyoursearchparametersifyouwishtoseeallyourresults.
APPENDIXPAYPALREFERENCE259AddressVerifyAPIErrorCodesTheerrorcodesshowninTableA-27canoccurwhenusingPayPal'sAddressVerifyAPI.
YoumustbegrantedauthorizationfromPayPaltousetheAddressVerifyAPI.
TableA-27.
AddressVerifyAPIErrorCodesVariableShortMessageLongMessage10004TransactionrefusedbecauseofaninvalidInvalidemailformatargument10004TransactionrefusedbecauseofaninvalidInvalidstreetformatargument10004TransactionrefusedbecauseofaninvalidInvalidzipformatargument10009TheAPIisdisabledTheAddressVerifyAPIiscurrentlydisabledBillUserAPIErrorCodesTheerrorcodesshowninTableA-28canoccurwhenusingPayPal'sBillUserAPI.
YoumustbegrantedauthorizationfromPayPaltousetheBillUserAPI.
TableA-28.
BillUserAPIErrorCodesVariableShortMessageLongMessage10004TransactionrefusedbecauseofaninvalidAgreementidisnotvalidargument10004TransactionrefusedbecauseofaninvalidAmountisnotvalidargument10004TransactionrefusedbecauseofaninvalidHandlingisnotvalidargument10004TransactionrefusedbecauseofaninvalidInvoiceisnotvalidargument10004TransactionrefusedbecauseofaninvalidShippingisnotvalidargument10004TransactionrefusedbecauseofaninvalidTaxisnotvalidargument10004TransactionrefusedbecauseofaninvalidThetransactioncouldnotbeloadedargument10004TransactionrefusedbecauseofaninvalidThetransactionidisnotvalidargument10004InternalErrorTransactionrefusedbecauseofaninvalidargument10009TheAPIisdisabledTheAPIisdisabled10200NoinstantUserdoesnothaveinstantpaymentfundingsource10201AgreementcanceledAgreementwascanceledAPPENDIXPAYPALREFERENCE260VariableShortMessageLongMessage10202ExceedmaxTransactionwouldexceeduser'smonthlymaximum10203ActionrequiredTransactionfailedactionrequiredbyuser10204DeniedUser'saccountisclosedorrestricted10205RiskTransactionrefusedduetoriskmodel10206DuplicateTransactionwasalreadyprocessed10207RetryRetry10207RetryTransactionfailedbutuserhasalternatefundingsource10209DisabledPreapprovedPaymentsnotenabled10210NoFundingTransactionfailedbecausebuyerhasnofundingsources10211InvalidMPIDInvalidMPID10212ProfilepreferencesettingAprofilepreferenceissettoautomaticallydenycertaintransactions11001InvalidargumentThebuttonsourcefieldwastruncatedbecauseitwastoolong11001TransactionrefusedbecauseofaninvalidThecustomfieldwastruncatedbecauseargumentitwastoolong11001TransactionrefusedbecauseofaninvalidTheitemnamefieldwastruncatedargumentbecauseitwastoolong11001TransactionrefusedbecauseofaninvalidTheitemnumberfieldwastruncatedargumentbecauseitwastoolong11001TransactionrefusedbecauseofaninvalidThememofieldwastruncatedbecauseargumentitwastoolong11001TransactionrefusedbecauseofaninvalidThesubjectfieldwastruncatedbecauseargumentitwastoolongPayflowProRESULTCodesThissectioncontainstheRESULTcodesthatcanbereturnedfromaPayflowProtransaction.
WithPayflowPro,RESULTisthefirstvariablereturnedintheresponsestring.
ARESULTof0meansthetransactionwasapproved.
ARESULTgreaterthan0indicatesadeclineorerror;aRESULTlessthan0indicatesacommunicationerror.
TableA-29listsRESULTvaluesgreaterthan0;TableA-30listsRESULTvalueslessthan0.
APPENDIXPAYPALREFERENCE261RESULTValuesforDeclinesandErrorsTableA-29liststhepossibleRESULTvaluesthatcanoccurwhenaPayflowProtransactionisdeclined.
TableA-29.
RESULTValuesforDeclinesandErrorsRESULTMeaning1Userauthenticationfailed.
Logininformationorprocessorinformationmaybeincorrect,thetransactionmaybecomingfromanunknownIPaddress,oryoumaybesubmittingatesttransactiontotheliveservers.
2Invalidtendertype.
YourInternetmerchantaccountdoesnotsupportthesubmittedcreditcardtype.
3Invalidtransactiontype.
Transactiontypeisnotappropriateforthistransaction.
4Invalidamountformat.
UsetheformatDonotincludecurrencysymbolsorcommas.
5Invalidmerchantinformation.
ProcessordoesnotrecognizeyourInternetmerchantaccount.
6Invalidorunsupportedcurrencycode.
7Fieldformaterror.
Invalidinformationentered.
8Notatransactionserver.
9Toomanyparametersorinvalidstream.
10Toomanylineitems.
11Clienttimeoutwaitingforresponse.
12Declined.
Checkthecreditcardnumber,expirationdate,andtransactioninformation.
13Referral.
Transactioncannotbeapprovedelectronicallybutcanbeapprovedwithaverbalauthorization.
ContactyourmerchantbanktoobtainanauthorizationandsubmitamanualVoiceAuthorizationtransaction.
14InvalidClientCertificationID.
ChecktheHTTPheader.
IfthetagX-VPS-VIT-CLIENT-CERTIFICATION-IDismissing,RESULTcode14isreturned.
19OriginaltransactionIDnotfound.
20Cannotfindthecustomerreferencenumber.
22InvalidABAnumber.
23Invalidaccountnumber.
24Invalidexpirationdate.
25InvalidHostMapping.
Youarenotsetuptoacceptthistendercardtype.
26Invalidvendoraccount.
27Insufficientpartnerpermissions.
28Insufficientuserpermissions.
29InvalidXMLdocument.
30Duplicatetransaction.
31Errorinaddingtherecurringprofile.
32Errorinmodifyingtherecurringprofile.
33Errorincancelingtherecurringprofile.
APPENDIXPAYPALREFERENCE262RESULTMeaning34Errorinforcingtherecurringprofile.
35Errorinreactivatingtherecurringprofile.
36OLTPTransactionfailed.
37InvalidrecurringprofileID.
50Insufficientfundsavailableinaccount.
99Generalerror.
SeeRESPMSG.
100Transactiontypenotsupportedbyhost.
101Timeoutvaluetoosmall.
102Processornotavailable.
103Errorreadingresponsefromhost.
104Timeoutwaitingforprocessorresponse.
Tryyourtransactionagain.
105Crediterror.
Makesureyouhavenotalreadycreditedthistransaction,orthatthistransactionIDisforacreditabletransaction(e.
g.
,youcannotcreditanauthorization).
106Hostnotavailable.
107Duplicatesuppressiontimeout.
108Voiderror.
109Timeoutwaitingforhostresponse.
111Captureerror.
Eitheranattempttocaptureatransactionthatisnotanauthorizationtransactiontype,oranattempttocaptureanauthorizationtransactionthathasalreadybeencaptured.
112FailedAVScheck.
AddressandZIPcodedonotmatch.
113Merchantsalestotalwillexceedthesalescapwithcurrenttransaction.
ACHtrans-actionsonly.
114CardSecurityCode(CSC)mismatch.
Anauthorizationmaystillexistonthecardholder'saccount.
115Systembusy;tryagainlater.
116VPSInternalerror.
Failedtolockterminalnumber.
117Failedmerchantrulecheck.
118Invalidkeywordsfoundinstringfields.
122Merchantsaletotalwillexceedthecreditcapwithcurrenttransaction.
ACHtrans-actionsonly.
125FraudProtectionServicesFilter—declinedbyfilters.
126FraudProtectionServicesFilter—flaggedforreviewbyfilters.
Thetransactionflaggedyouraccount'sfraudfiltersandneedstobemanuallyreviewedtoaccept.
127FraudProtectionServicesFilter—notprocessedbyfilters.
128FraudProtectionServicesFilter—declinedbymerchantafterbeingflaggedforreviewbyfilters.
131Version1PayflowProSDKclientnolongersupported.
150Issuingbanktimedout.
151Issuingbankunavailable.
ContinuedAPPENDIXPAYPALREFERENCE263TableA-29.
ContinuedRESULTMeaning1000Generichosterrorreturnedbyyourcreditcardprocessor.
1001BuyerAuthenticationServiceunavailable.
1002BuyerAuthenticationService—transactiontimeout.
1003BuyerAuthenticationService—invalidclientversion.
1004BuyerAuthenticationService—invalidtimeoutvalue.
1011BuyerAuthenticationServiceunavailable.
1012BuyerAuthenticationServiceunavailable.
1013BuyerAuthenticationServiceunavailable.
1014BuyerAuthenticationService—merchantisnotenrolledforBuyerAuthenticationService(3-DSecure).
1016BuyerAuthenticationService—3-DSecureerrorresponsereceived.
InsteadofreceivingaPARESresponsetoaValidateAuthenticationtransaction,anerrorresponsewasreceived.
1017BuyerAuthenticationService—3-DSecureerrorresponseisinvalid.
AnerrorresponseisreceivedandtheresponseisnotwellformedforaValidateAuthenticationtransaction.
1021BuyerAuthenticationService—invalidcardtype.
1022BuyerAuthenticationService—invalidormissingcurrencycode.
1023BuyerAuthenticationService—merchantstatusfor3Dsecureisinvalid.
1041BuyerAuthenticationService—ValidateAuthenticationfailed:missingorinvalidPARES.
1042BuyerAuthenticationService—ValidateAuthenticationfailed:PARESformatisinvalid.
1043BuyerAuthenticationService—ValidateAuthenticationfailed:cannotfindsuccessfulVerifyEnrollment.
1044BuyerAuthenticationService—ValidateAuthenticationfailed:signaturevalidationfailedforPARES.
1045BuyerAuthenticationService—ValidateAuthenticationfailed:mismatchedorinvalidamountinPARES.
1046BuyerAuthenticationService—ValidateAuthenticationfailed:mismatchedorinvalidacquirerinPARES.
1047BuyerAuthenticationService—ValidateAuthenticationfailed:mismatchedorinvalidMerchantIDinPARES.
1048BuyerAuthenticationService—ValidateAuthenticationfailed:mismatchedorinvalidcardnumberinPARES.
1049BuyerAuthenticationService—ValidateAuthenticationfailed:mismatchedorinvalidcurrencycodeinPARES.
1050BuyerAuthenticationService—ValidateAuthenticationfailed:mismatchedorinvalidXIDinPARES.
1051BuyerAuthenticationService—ValidateAuthenticationfailed:mismatchedorinvalidorderdateinPARES.
1052BuyerAuthenticationService—ValidateAuthenticationfailed:thisPARESwasalreadyvalidatedforapreviousValidateAuthenticationtransaction.
APPENDIXPAYPALREFERENCE264RESULTValuesforCommunicationErrorsTableA-30liststhepossibleRESULTvaluesthatcanoccurwhenthePayflowProtransactiondoesnotoccurbecauseofacommunicationerror.
TableA-30.
RESULTValuesforCommunicationErrorsRESULTMeaning-1Failedtoconnecttohost-2Failedtoresolvehostname-5FailedtoinitializeSSLcontext-6Parameterlistformaterror:&inname-7Parameterlistformaterror:invalid[]namelengthclause-8SSLfailedtoconnecttohost-9SSLreadfailed-10SSLwritefailed-11Proxyauthorizationfailed-12Timeoutwaitingforresponse-13Selectfailure-14Toomanyconnections-15Failedtosetsocketoptions-20Proxyreadfailed-21Proxywritefailed-22FailedtoinitializeSSLcertificate-23Hostaddressnotspecified-24Invalidtransactiontype-25Failedtocreateasocket-26Failedtoinitializesocketlayer-27Parameterlistformaterror:invalid[]namelengthclause-28Parameterlistformaterror:name-29FailedtoinitializeSSLconnection-30Invalidtimeoutvalue-31Thecertificatechaindidnotvalidate,nolocalcertificatefound-32Thecertificatechaindidnotvalidate,commonnamedidnotmatchURL-40UnexpectedRequestIDfoundinrequest-41RequiredRequestIDnotfoundinrequest-99Outofmemory-100Parameterlistcannotbeempty-103Contextinitializationfailed-104UnexpectedtransactionstateContinuedAPPENDIXPAYPALREFERENCE265TableA-30.
ContinuedRESULTMeaning-105Invalidname/valuepairrequest-106Invalidresponseformat-107ThisXMLPayversionisnotsupported-108Theservercertificatechaindidnotvalidate-109Unabletodologging-111Thefollowingerroroccurredwhileinitializingfrommessagefile:.
.
.
-113UnabletoroundandtruncatethecurrencyvaluesimultaneouslyPayflowLinkVariableReferenceTableA-31containsthevariablesthatcanbeincludedinaPayflowLinkHTMLformtransaction.
TableA-31.
PayflowLinkVariableReferenceVariableDescriptionMaximumLengthADDRESSBillingaddress.
60ADDRESSTOSHIPShippingaddress.
120CARDNUMCreditcardnumber.
31CITYBillingcity.
32CITYTOSHIPShippingcity.
32COUNTRYBillingcountry.
4COUNTRYCODEShippingcountry.
4COMMENT1Customvalue;informationappearsinCustomReport.
255COMMENT2Customvalue;informationappearsinCustomReport.
255CSCCardSecurityCode.
4CUSTIDCustom;valuecanbereturnedtoyourwebserverwiththe11PostorSilentPostfeature.
DESCRIPTIONTransactiondescription.
255DLNUMDriver'slicensenumber(TeleChecktransactionsonly).
33ECHODATATrue/False:ReturnverboseamountofdatawhenPayflow5LinkusingthePostorSilentPostfeature.
Default:True.
EMAILBillingemailaddress.
40EMAILCUSTOMERTrue/False:Whetherornottosendthecustomeranotifi-5cationemailwhenasuccessfultransactionoccurs.
Default:SetinPayPalManager.
EMAILTOSHIPShippingemailaddress.
40EXPDATECardexpirationdate.
7FAXBillingfaxnumber.
20APPENDIXPAYPALREFERENCE266VariableDescriptionMaximumLengthFAXTOSHIPShippingfaxnumber.
20INVOICEInvoicenumber.
9METHODMethodofcustomerpayment:Cforcreditcard,ECHECKforelectroniccheck.
NAMEBillingname.
60NAMETOSHIPShippingname.
60ORDERFORMTrue/False:Controlswhetherthecustomer'sbrowseris5redirectedtothePayflowLinkOrderform,onwhichthecustomerenterstransactioninformation.
Default:True.
PHONEBillingphone.
20PHONETOSHIPShippingphone.
20PONUMPurchaseordernumber.
25SHIPAMOUNTThecostofshipping.
Decimalnumberwithtwodecimalplaces.
SHOWCONFIRMTrue/False:ControlswhetherthePayflowLinkConfirma-5tionpageisdisplayedtothecustomerbeforesubmittingthetransaction.
Default:True.
STATEBillingstate.
20STATETOSHIPShippingstate.
20TAXTheamountoftaxonatransaction.
12USER1Merchant-definedvalue;notshowntocustomer.
Returned255tomerchantwiththePostorSilentPostfeature.
USER2Merchant-definedvalue;notshowntocustomer.
Returned255tomerchantwiththePostorSilentPostfeature.
USER3Merchant-definedvalue;notshowntocustomer.
ReturnedvtomerchantwiththePostorSilentPostfeature.
USER4Merchant-definedvalue;notshowntocustomer.
Returned255tomerchantwiththePostorSilentPostfeature.
USER5Merchant-definedvalue;notshowntocustomer.
Returned255tomerchantwiththePostorSilentPostfeature.
USER6Merchant-definedvalue;notshowntocustomer.
Returned255tomerchantwiththePostorSilentPostfeature.
USER7Merchant-definedvalue;notshowntocustomer.
Returned255tomerchantwiththePostorSilentPostfeature.
USER8Merchant-definedvalue;notshowntocustomer.
Returned255tomerchantwiththePostorSilentPostfeature.
USER9Merchant-definedvalue;notshowntocustomer.
Returned255tomerchantwiththePostorSilentPostfeature.
USER10Merchant-definedvalue;notshowntocustomer.
Returned255tomerchantwiththePostorSilentPostfeature.
ZIPBillingZIPcode.
15ZIPTOSHIPShippingZIPcode.
15APPENDIXPAYPALREFERENCE267Aavariables,238accounthistorysearchingwithTransactionSearchAPI,131–135AccountInformationsettings,24–25APIaccess,28BusinessInformation,28Multi-UserAccess,27accountsettingsAccountInformationsettings,24–25,27–28PayPalFinancialInformationsettings,28–30SellingPreferencessettings,30–34accountstatus,19–20accounttypes,14–18accounting,10accountsmanagementPayflowLink,180ACHReports,210Ackcode,128ACTIONtypes,232values,171addvariable,232addressoverridevariables,236addressvariables,239addressverificationsystem.
SeeAVSaddress1variable,236address2variable,236AddressVerifyAPIerrorcodes,260AffiliateBuilderfeaturePayLoadz,9amountvariable,232–233,235amount_xvariable,235APIaccessPayPalAccountInformationsettings,28APIcalls,115endpoints,117makingviaNVPinterface,116–117makingviaSOAPinterface,116APICertificates,108comparedtoAPISignatures,108–109encrypting,110installing,111using,109–110APIcredentials,108APIerrorcodes,245APIPassword,108APISignatures,108–109APIUsername,108APIProfileinterface,118auctionvariables,243Authorization&CapturePayflowProGateway,164–165authorizationAPIerrorcodes,246–247Authorize&CaptureAPIs,135basicauthorizations,136ordersandorderauthorizations,136–137rules,136authorizingpayments,135basicauthorizations,136ordersandorderauthorizations,136–137rulesofAuthorizeandCapture,136auth_expvariable,240auth_idvariable,240auth_statusvariable,240AutoReturnfeature,88accountsettings,88–89rmvariable,89–90AVS(addressverificationsystem)codes,147–148testingresponseswithSimulator,168BBankAccountssectionPayPalFinancialInformationsettings,29BatchIDReport,209BillPoint,4Index269BillUserAPIerrorcodes,260–261Blinksale,10businessaccounts,15signupvariables,237BusinessInformationsectionPayPalAccountInformationsettings,28BusinessOverviewpagereportsettings,205businessvariable,235,238,240ButtonFactory,40,42andEWP,60ButtonEncryptionapplicationbuilding,65encryptingbuttons,64running,65–66ButtonEncryptionclasscreating,72–75exampleofusing,75BuyNowbutton,38additionalparameters,43–44ButtonFactory,40,42creatingwithPayflowLink,176–177samplebutton,38–39testing,39buyercommunication,avoidingchargebacks,220buyerinformationvariables,239CC#,encryptingbuttons,72CA(certificateauthority),56call()methodCallerServicesclass,119CallerServicesclass,119cancel_returnvariable,232capturesSeealsoAuthorizationandCaptureAPIerrorcodes,246–247performingmanuallywithPayPalManager,185cardverificationvalue.
SeeCVVCartUploadfeature,51–53cartuploadvariables,235–236casestudies,3case_creation_datevariable,245case_idvariable,245case_typevariable,245cbtvariable,233certificateauthority(CA),56chargebacks,219–220checkoutadvantagesofPayPal,2suggestionsforcheckoutpage,148–149cityvariable,236cmdvariable,238values,231cnvariable,233CorrelationID,128countries,PayPalavailability,20–23CountryMonitorcontrolPayPalSellingPreferencessettings,34countryvariable,236cpp_headerback_colorvariable,233cpp_headerborder_colorvariable,233cpp_header_imagevariable,233cpp_payflow_colorvariable,233createSignatureAPIProfile()methodProfileFactoryclass,119createSSLAPIProfile()methodProfileFactoryclass,119Credibility,advantagesofPayPal,2CreditCardsectionPayPalFinancialInformationsettings,28creditcardtransactionstestingwithSimulator,167–169csvariable,233CSVreportfiles,206–208currenciesandPayPalavailability,23–24CurrencyBalancessectionPayPalFinancialInformationsettings,29currencyexchangevariables,242currencyvariables,242currency_codevariable,234CustomAPIAuthorizationoption,114CustomPaymentPagessectionPayPalSellingPreferencessettings,33customvariable,234,238,240CVV(cardverificationvalue),147–149DDailyActivityreport,209DailySalesReport,192,197INDEX270Debugging,commonPayflowProerrors,169DeveloperCentral,11accessingSandboxemail,16–17creatingaccount,15–16otherfeatures,18retrievingpassword,18DeveloperCommunity,11digitalcertificates,56digitalgoodsdelivery,9DirectPayment,6,143directpaymentAVSandCVVcodes,147checkoutpage,148–149errorcodes,247–253testing,143usingNVPinterface,146–147usingSOAPinterface,143–146DirectPayment/VirtualTerminalcontrolPayPalSellingPreferencessettings,34displayvariable,232–234DisputeArea,FinancialStatement,201disputenotificationvariables,245DisputeReport,192,202disputeresolution,221PayPalResolutionCenter,222–227DoAuthorizationcall,106DoCapturecall,106DoDirectPaymentAPI,143AVSandCVVcodes,147testingcalls,143usingNVPinterface,146–147usingSOAPinterface,143–147DoDirectPaymentcall,106DoExpressCheckoutPaymentcall,151–152,173donations,44sampledonationsbutton,44–45DoReauthorizationcall,106DoVoidcall,106EE-Junkie,9eBayandPayPal,4eBayProStores,8eCheckandpendingpayments,96EmailsectionPayPalAccountInformationsettings,24emailvariable,236encryptButton()methodEWPServicesobject,66encryptedbuttons,58–60encryptedcodeandPayPal,59EncryptedWebsitePaymentssectionPayPalSellingPreferencessettings,33EncryptedWebsitePayments.
SeeEWPencryptingbuttonsButtonEncryptionapplication,64–66C#,72–75encryptedblob,64Javadevelopers,64Perl,82–85PHP,76–82VisualBasic6,68–72Windowsdevelopers,68encryptingdataandpublickeycryptography,56endpoints,117EWP(EncryptedWebsitePayments),55–56blockingunencryptedpayments,59ButtonFactory,60creatingcertificatesandkeys,60–64creatingencryptedbuttons,60encryptedcodecomparedtounencryptedcode,58–59encryptingbuttons,64–85howPayPalreadsencryptedcode,59PayPalSellingPreferencessettings,33publickeycryptography,56–58EWPProfileobject,66EWPServicesobjectencryptButton()method,66Excel,openingCSVreportfiles,206,208exchange_ratevariable,242ExpressCheckout,149bypassingorderreviewpage,153–154errorcodes,253–255implementingwithPayflowProAPI,171–173introduction,6presenting,150–151workingsof,151–153INDEX271Finditfasterathttp://superindex.
apress.
com/FFailedTransactionsReport,210FilterScorecardReport,210,213FinancialInformationsettingsPayPalaccount,28–30FinancialStatement,192,198–201first-partyAPIcalls,112first_namevariable,236,239for_auctionvariable,243fraudfiltersintroduction,186–187testinginObservemode,188fraudrisks,55FraudTransactionsReport,209GGetExpressCheckoutDetailscall,106,151–152,172GetTransactionDetailsAPI,90errorcodes,256makingsimpleAPIcallviaNVPinterface,122–127makingsimpleAPIcallviaSOAPinterface,119–122GetTransactionDetailscall,106GiftCertificatesandRewardVoucherssectionPayPalFinancialInformationsettings,29GrantAPIPermissionoption,112Hhandlingvariable,234handling_cartvariable,235handling_xvariable,235hostedshoppingcartsexample,112HTTPGETrmvariablesetting,89HTTPPOSTnotreceivingIPNPOSTs,102PDTsetting,91rmvariablesetting,89HTTPrequestPDTsetting,92HTTPresponsePDTsetting,91IIMA(InternetMerchantAccount)acquiring,158–159PayPalsolutionforbusinesses,157settingup,157image_urlvariable,233InstantPaymentNotificationsectionPayPalSellingPreferencessettings,32InstantPaymentNotification.
SeeIPNIntegrationCenter,11InternetMerchantAccount.
SeeIMAInvoiceTemplatessectionPayPalSellingPreferencessettings,33invoicevariable,234,238,240invoicing,10useofIDsoncheckoutpage,149IPN(InstantPaymentNotification),96debuggingINVALIDIPNresponse,103disputeresolution,102introduction,5ResolutionCenterIPNs,226–227samplecode,99–101SellingPreferencessettings,32troubleshooting,102usingwithPDT,102variablesthatcanbeincludedinpost,239–245workingsof,97–99itemdescriptionsandonlinedisputes,216iteminformationvariables,232item_namevariable,232,235,238,240item_name_xvariable,235item_numbervariable,232,240item_number_xvariable,235JJavaPayflowProSDK,163LLanguageEncodingsectionPayPalSellingPreferencessettings,34last_namevariable,236,239lcvariable,236INDEX272MMal'sE-Commerce,9masspaymentvariables,243MassPaycall,106file-basedMassPay,141refundingpayments,131rules,137–138sendingmoneywith,137MassPayAPI,138errorcodes,256–257usingNVPinterface,140–141usingSOAPinterface,138,140masspay_txn_id_xvariable,243MaximumAccountcontrolPayPalSellingPreferencessettings,34mc_currency_xvariable,243mc_fee_xvariable,243mc_gross_xvariable,240,243mc_handling_xvariable,240mc_xxxxvariables,242,244memovariable,240merchantprofilePayPalManager,184MerchantSolutions,8MicrosoftOfficeAccounting,10modifyvariable,238MonthlyBillingsectionPayPalFinancialInformationsettings,30MSOfficeAccounting,10Multi-UserAccessPayPalAccountInformationsettings,27multicurrencyactivityFinancialStatement,201MyStoreRewardscasestudy,3NName-ValuePair.
SeeNVPnight_phone_avariable,236night_phone_bvariable,236night_phone_cvariable,236NotificationssectionPayPalAccountInformationsettings,25notify_urlvariable,232no_notevariable,233,238no_shippingvariable,233num_cart_itemsvariable,240NVP(Name-ValuePair)interfaceissuingrefundswithRefundTransactionAPI,130–131makingAPIcalls,116–117,122–124NVPDecoderclass,126–127NVPEncoderclass,124–126sendingmoneywithMassPayAPI,140–141TransactionSearchAPI,134–135usingtosendrequeststoPayPalAPIservers,116NVPDecoderclass,126–127NVPEncoderclass,124–126OObservemode,testingfraudfilters,188OfficeAccounting,10on0variable,232on0_xvariable,235on1variable,232on1_xvariable,235onlinedisputes,215avoidingchargebacks,220disputeresolution,221–224,226–227establishingclearpolicies,216itemdescriptions,216resolutionplans,217–219returnpolicy,217shippingpolicy,217handlingchargebacks,219–220implementingIPCcompliance,227–230SPP(SellerProtectionPolicy),221option_name1variable,240option_name2variable,240option_selection1variable,240option_selection2variable,240orderauthorizations,136–137OrderReport,192ORIGIDvariable,170os0variable,232os0_xvariable,235os1variable,232os1_xvariable,235osCommerce,9INDEX273Finditfasterathttp://superindex.
apress.
com/Pp1variable,238p2variable,238p3variable,238page_stylevariable,234parent_txn_idvariable,241PasswordsectionPayPalAccountInformationsettings,25passwordvariable,244payer_business_namevariable,239payer_emailvariable,239payer_idvariable,239payer_statusvariable,239Payflowgateways,6introduction,157PayflowLinkcreatingaBuyNowbutton,176–177introduction,176managingaccounts,180receivingatransactionresponse,177–179testingtransactions,179PayflowProdebuggingcommonerrors,169implementingPayPalExpressCheckout,171–173introduction,159linkvariablereference,266–267processingacreditcardtransaction,160–166ReferenceTransactions,170–171resultcodes,261–266specifyinglocationofCertificate,162tendertypes,170testingcreditcardtransactions,167–169transactiontypes,170usingtheSDK,159WebsitePaymentsProUKAPImodeledon,142XMLPay,173–175PayLoadz,9PaymentCardIndustry.
SeePCI,PaymentDataTransfer.
SeePDTpaymentgatewaysacquiringanIMA,158–159introduction,157–158PaymentReceivingPreferencessectionPayPalSellingPreferencessettings,32paymentvariables,240–242paymentactionvariable,235payment_datevariable,241,243payment_statusvariable,241payment_typevariable,241PayPaladvantages,1–2asdigitalmoneyplatform,3–4eBayand,4introduction,1pre-integratedsolutions,8–10readingencryptedcode,59solutionsoffered,4–8PayPalaccountaccountsettingsAccountInformationsettings,24–25,27–28FinancialInformationsettings,28–30SellingPreferencessettings,30–34accountstatus,19–20accounttypes,14–18countries,20–23currencies,23–24introduction,13transactionfees,18–19PayPalAPI,105–106SeealsoAPI;transactionmanagementaccesssetuppage,112,114accessing,107CertificatescomparedtoSignatures,108–109credentials,108third-partyAPIcalls,112–115usingAPICertificates,109–111APIcalllifecycle,107APIoperations,106errorcodes,245–261handlingAPIresponses,127Ackcode,128CorrelationID,128introduction,5makingAPIcalls,115endpoints,117viaNVPinterface,116–117viaSOAPinterface,116INDEX274overview,106PayPalSDK,117downloading,118importantclasses,118–119simpleexampleofAPIcall,119NVPinterface,122–127SOAPinterface,120–122solutionsoffered,6PayPalExpressCheckout.
SeeExpressCheckoutPayPalJavaSDKencryptingbuttons,64using,66–68PayPalManageractivatingPayflowaccount,181FilterScorecardReport,213fraudprotection,185–188generatingreports,182introduction,180loggingin,180manualcapturesandsettlements,185merchantprofile,184RecurringBillingTransactionsReport,211–212reports,208–209TransactionSummaryReport,210virtualterminal,182–184PayPalMonthlyBillingsectionPayPalFinancialInformationsettings,30PayPalpubliccertificate,63PayPalreportingportalavailablereports,191–193DailySalesReport,197DisputeReport,202FinancialStatement,198–201openingCSVreportfilesinExcel,206–208reportingsettings,205–206SearchPaymentHistorylink,203–204SettlementFile,194–197TransactionReconciliationReport,193–194PayPalResolutionCenter,220,222–224IPNs,226–227PayPalSDK,117downloading,118importantclasses,118–119PayPalSettlementSummaryReport,209PayPalSolutionsDirectory,8PayPalwebsitegeneratingreports,191issuingrefundswithRefundTransactionAPI,131PayPalDev.
org,12PayPalTech,11PCI(PaymentCardIndustry)implementingcompliance,227additionalresources,230datasecuritystandardrequirements,228merchantlevelsfor,228validationrequirements,229PDT(PaymentDataTransfer),90accountsettings,92–93eCheckpendingpayments,96examplescript,93–96introduction,5shortcomings,96userabandonmentaftercheckout,96usingwithIPN,102variablesthatcanbeincludedinpost,239–245workingsof,91–92pending_reasonvariable,241periodxxxvariables,244Perl,encryptingbuttons,82–85personalaccounts,14PHP,encryptingbuttons,76–82PKCS12file,creating,61Postfeature,PayflowLink,178postpaymentprocessing,87AutoReturn,88–90IPN(InstantPaymentNotification),96–103PDT(PaymentDataTransfer),90–96postprocessingfilters,186PreapprovedPaymentAgreementReport,192PreapprovedPaymentssectionPayPalFinancialInformationsettings,30premieraccounts,15preprocessingfilters,186INDEX275Finditfasterathttp://superindex.
apress.
com/privatekeyscreating,61roleinpublickeycryptography,56securing,58ProfileReportReport,210ProfileFactoryclassintroduction,119publiccertificatescreating,61downloadingPayPalpubliccertificate,63uploadingtoPayPal,62publickeycryptography,56creatingaprivatekeyandpubliccertificate,61creatingPKCS12file,61downloadingPayPalpubliccertificate,63encryptingbuttons,64–85encryptingdata,56securingaprivatekey,58uploadingpubliccertificatetoPayPal,62verifyingsender'sidentity,57publickeysroleinpublickeycryptography,56Qquantityvariable,232,240quantity_xvariable,235QuickBooks,10Rreason_codevariable,241,243,245reattemptvariable,244receiver_emailvariable,240receiver_email_xvariable,243receiver_idvariable,240RecurringBillingTransactionsReport,210–212recurringpayments.
SeeSubscriptionsandRecurringPaymentsrecurringvariable,244recur_timesvariable,244redirect_cmdvariable,234ReferenceTransactions,PayflowPro,170–171refundtransactions,PayflowProGateway,165RefundTransactionAPI,129–131RefundTransactionAPIerrorcodes,258issuingrefunds,129refundingtransactionfees,131usingNVPinterface,130–131usingPayPalwebsite,131usingSOAPinterface,129–130RefundTransactioncall,106remaining_settlevariable,242reporting,191PayPalManagerreports,208–209FilterScorecardReport,213RecurringBillingTransactionsReport,211–212TransactionSummaryReport,210PayPalreportingportal,191–192availablereports,193DailySalesReport,197DisputeReport,202FinancialStatement,198–201openingCSVreportfilesinExcel,206,208reportingsettings,205–206SearchPaymentHistorylink,203–204SettlementFile,194–197TransactionReconciliationReport,193–194ReportsSubscriptionSettingsscreenexample,205ReputationsectionPayPalSellingPreferencessettings,32RequestAPICredentialsoption,112RequestAuthchildelement,175RequestDataelement,175requests,submittingtoPayflow,160–162residence_countryvariable,239resolutionplans,onlinedisputes,217–219resources,10–12responses,readingfromPayflowProGateway,165–166retry_atvariable,244returnpolicy,onlinedispute,217returnvariable,232RiskControlssectionPayPalSellingPreferencessettings,34rmvariable,89–90,232INDEX276SSalesTaxsectionPayPalSellingPreferencessettings,30sales,increaseofasadvantagesofPayPal,2Sandboxaccounts,15accessingemail,16–17creatingDeveloperCentralaccount,15–16creatingtestcreditcardnumbers,17Sandboxsubscriptionbuttoncreatingsample,45,47SearchPaymentHistorylinkPayPalreportingportal,203–204SecureSocketsLayer.
SeeSSLsecurityasadvantageofPayPal,2SellerProtectionPolicy.
SeeSSPSellingPreferencessettings,30sendingmoneywithMassPay,137–141setApiProfile()methodCallerServicesclass,119SetExpressCheckoutcall,106,151,172SettlementFile,192,194–197SettlementReport,209settlements,performingmanuallywithPayPalManager,185settle_amountvariable,242settle_currencyvariable,242Shipping&BillingReport,209ShippingCalculationssectionPayPalSellingPreferencessettings,30–31shippingpolicyandonlinedisputes,217shippingrequests,avoidingchargebacks,220shippingvariable,234shipping2variable,234shipping2_xvariable,236shipping_xvariable,236Shopify,112ShoppingCart,8–9using,50SilentPostfeaturePayflowLink,178SimulatortestingAVSresponses,168testingcardnumbers,167–168testingcardsecuritycode,169testingcardtransactions,167testingerrorcodes,168SOAPinterfacecomparedtoNVPinterface,117issuingrefundswithRefundTransactionAPI,129–130makingAPIcalls,115–116,120–122sendingmoneywithMassPayAPI,138–140usingTransactionSearchAPI,132–134SolutionsDirectory,11spoofemail,25–26SPP(SellerProtectionPolicy)onlinedisputes,221sravariable,238srcvariable,238srtvariable,238SSL(SecureSocketsLayer)PayPalAPIuses,5SSP(SellerProtectionPolicy),154StandardVariableReferenceactionvariables,232addressoverridevariables,236cartuploadvariables,235–236cmdvariable,231displayvariables,233–234iteminformationvariables,232PayPalsubscriptionvariables,238prepopulatingbusinessaccountsignupvariables,237transactioninformationvariables,234statevariable,236status_xvariable,243storefronts,8–9StreetAddresssectionPayPalAccountInformationsettings,25StringBufferclass,163StubHubcasestudy,3SubscriptionAgreementReport,192subscriptionvariables,238,244SubscriptionsandRecurringPayments,45cancelingsubscriptions,48modifyingsubscriptions,48reattemptingfailedsubscriptionpayments,47samplesubscriptionsbutton,45,47subscriptionIPNnotifications,49subscriptiontrialperiods,49subscriptionspasswordmanagement,48INDEX277Finditfasterathttp://superindex.
apress.
com/subscr_datevariable,244subscr_effectivevariable,244subscr_idvariable,244Tt1variable,238t2variable,238t3variable,238taxvariable,234,240,242tax_cartvariable,235tax_xvariable,236TENDERvariable,170testcreditcardnumbers,17testingPayflowLinktransactions,179test_ipnvariable,239third-partyAPIcalls,112grantingthird-partypermission,112–115hostedshoppingcartsexample,112TimeZonesectionPayPalAccountInformationsettings,27Transactionelement,175Transactionselement,175TransactionEventCodecategories,196–197transactionfees,18–19issuingrefundswithRefundTransactionAPI,131transactionID,90transactioninformationvariables,234transactionmanagementwithPayPalAPI,128authorizingpayments,135basicauthorizations,136ordersandorderauthorizations,136–137rulesofAuthorizeandCapture,136issuingrefundswithRefundTransactionAPI,129refundingtransactionfees,131usingNVPinterface,130–131usingPayPalwebsite,131usingSOAPinterface,129–130usingTransactionSearchAPI,131–132withNVPinterface,134–135withSOAPinterface,132,134TransactionReconciliationReport,192–194transactionresponsefromPayflowLink,177–179TransactionSummaryReport,209–210transactiontypes,170transactionvariables,240transactionsSeealsorefundsandvoidtransactionssubmittingarequesttoPayflow,160–162testingtransactionswithSimulator,167–169testingPayflowLinktransactions,179TransactionselementTransactionelement,175TransactionSearchAPIerrorcodes,259searchingaccounthistory,131–132usingNVPinterface,134–135usingSOAPinterface,132,134TransactionSearchcall,106transaction_entityvariable,242transactions,reviewing,188transfers,FinancialStatement,201TRXTYPEvariable,170txn_idvariable,242,245txn_typevariable,242,244–245Uundefined_quantityvariable,232unencryptedbuttoncode,58–59unencryptedpayments,blocking,59unique_id_xvariable,243uploadvariable,235usernamevariable,244usr_managevariable,238Vverifyingsender'sidentity,57VirtualTerminal,7–8virtualterminalPayPalManager,182–184VisualBasic6,encryptingbuttons,68–72voiceauthorizations,PayflowProGateway,166voidtransactions,PayflowProGateway,164–165INDEX278WWebServiceDefinitionLanguage.
SeeWSDLWebsitePaymentPreferencessectionPayPalSellingPreferencessettings,32WebsitePaymentsProandExpressCheckout,149applyingfor,142–143cancelling,154DirectPayment,143AVSandCVVcodes,147checkoutpageCVVcodes,148–149DoDirectPaymentAPIusingSOAP,143–147testing,143inUK,142introduction,6,141paymentvariables,240–242restofworld,142SSP(SellerProtectionPolicy),154WebsitePaymentsStandard,37BuyNowbutton,38–44donations,44–45introduction,5,37–38paymentvariables,240–242ShoppingCart,50SubscriptionsandRecurringPayments,45–50WindowsHTTPServicesCertificateConfigurationTool,111WinHttpCertCfg.
exe,111Withdrawals,FinancialStatement,201WSDL(WebServiceDefinitionLanguage)locationofPayPayWSDL,116XXMLSchemaDefinition(XSD)schema,116XMLPay,173formingarequest,174–175readingaresponse,175XMLPayRequestelementRequestAuthchildelement,175RequestDatachildelement,175XSD(XMLSchemaDefinition)schema,116YYahoo!
MerchantSolutions,8Zzipvariable,236INDEX279Finditfasterathttp://superindex.
apress.
com/