Home

PayPal Website Payments Standard - 2012 - Button Manager API (SOAP) User Guide

1. Button Hosting The Button Manager API can create four kinds of buttons hosted encrypted clear text and token buttons Buttons that you can view on the My Saved Buttons page of your PayPal profile are called hosted buttons Hosted buttons are stored on PayPal The parameters associated with this kind of button are secure Hosted buttons provide the greatest flexibility because you can instruct PayPal to change them dynamically and PayPal maintains information about their state such as the inventory level associated with the button NOTE You cannot use hosted buttons with Hosted Sole Solution you should use token buttons instead Encrypted buttons are not stored on PayPal The parameters associated with this kind of button are encrypted Encrypted buttons are similar to hosted buttons with regard to secure operation however you must update the web pages that use an encrypted button each time the button or its associated information changes You should use an encrypted button only if a hosted button cannot be used Clear text buttons are not stored on PayPal The parameters associated with this kind of button are not encrypted Clear text buttons are not hosted and are not encrypted They can be used dynamically because you can change the value of a parameter on the fly However if you use them recognize the risk that sensitive information can be altered or stolen Token buttons are not stored on PayPal They are onl
2. BMSetinventory Request The request specifies inventory values related to a hosted button as well as inventory values that are specific to each menu item Button Manager SOAP API April 2012 43 44 Button Manager API Reference BMSetInventory API Operation te AbstractRequest Type 0 DetaillevelCodeType e Detaillevel el Errorlanguage 0 1 string e Version se fe any e HostedButtonID e TrackInv e TrackPnl JE ItemTrackingDetails e OptionIndex JE OptionTrackingDetails e SoldoutURL pea DigitalDownloadKeys e ReuseDigitalDownloadKeys e AppendDigitalDownloadkeys 0 0 0 1 0 0 0 0 0 string BMSetInventoryRequestType 1 1 10 1 1 1 1000 string ItemTrackingDetailsType e ItemNumber 0 1 string ItemQty 0 1 TtemQtyDelta 0 1 el Item lert 0 1 e ItemCost 0 1 string string string string te OptionTrackingDetailsType e OptionNumber 0 1 string string gt OptionQty 0 1 string string OptionSelect 0 1 string string gt OptionQtyDelta 0 1 string ItemTrackingDetailsType Option lert 0 1 gt OptionCost 0 1 string string string OptionTrackingDetailsType string string string BMSetlnventory Request Fields Field Description HostedButtonID TrackInv TrackPnl xs string Required The ID of the hosted button whose inv
3. Spanish default e en English Button Manager SOAP API April 2012 23 Button Manager API Reference BMCreateButton API Operation Country Button Language Options Switzerland e de German default e fr French en English United States en English default fr French es Spanish zh Chinese BMCreateButton Response The response contains an ID if the button is hosted on PayPal and code for HTML in a website and for a link in email AbstractResponse Type E Timestamp 0 1 dateTime e Ack AckCodeType gt CorrelationID 0 1 string e Errors 0 ErrorType Version string e Build string e any BMCreateButtonResponseType e Website string e Email 0 1 string e Mobile 0 1 string e HostedButtonID 0 1 string BMCreateButton Response Fields Field Description Website xs string HTML code for web pages Email xs string Code for email links links in other documents that support external links and links to the Hosted Solution checkout flow 24 April 2012 Button Manager SOAP API Button Manager API Reference BMCreateButton API Operation Field Description HostedButtonID xs string ID of a PayPal hosted button or a Hosted Solution token BMCreateButton Errors Error Code Short Message Long Message Correcting This Error 10001 Internal Error Internal Error 11923 Invalid Argument The button image value specified is inva
4. 0 o kran 57 HTML Variables for Payment Transactions 0 o 62 HTML Variables for Shopping Carts o e 63 HTML Variables for Recurring Payments Buttons vr rv an 65 HTML Variables for Displaying PayPal Checkout Pages o 71 HTML Variables for Filling Out PayPal Checkout Pages Automatically 74 HTML Variables for the Instant Update API 0 o 75 4 April 2012 Preface This document describes the Button Manager API for SOAP Intended Audience This document is intended for merchants and developers implementing PayPal Payment Standard previously known as Website Payments Standard buttons using an API Revision History Revision history for Button Manager API SOAP TABLE P 1 Revision History Date Description 04 03 12 Updated references to Website Payments Standard and Website Payments Pro to PayPal Payments Standard and PayPal Payments Pro respectively 02 13 12 Maintenance release 05 10 10 Added information about installment plans automatic billing and subscribe buttons 02 03 10 Added error code 01 11 10 Added download key information and updated for version 61 0 06 03 09 Added HTML Variable appendix and updated for version 57 0 03 31 09 Initial draft Button Manager SOAP API April 2012 ET Revision History 6 April 2012 Button Manager SOAP API PayPal Payments Standard But
5. A corresponding option selection in osO must also be set e Optional for Buy Now Add to Cart Subscribe Automatic Billing and Installment Plan buttons e Not used with Donate or Buy Gift Certificate buttons HTML Variables for Payment Transactions HTML variables for payment transactions provide information about entire payments regardless of the individual items involved with the payment You can use these variables with Add to Cart buttons and the Cart Upload command 62 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard Feen HTML Variables for Shopping Carts HTML Variables for Payment Transactions Name address override currency code custom handling invoice tax cart weight cart weight unit Required or Optional Optional Optional Optional Optional Optional Optional Optional Optional Description 1 The address specified with automatic fill in variables overrides the PayPal member s stored address Buyers see the addresses that you pass in but they cannot edit them PayPal does not show addresses if they are invalid or omitted The currency of the payment The default is USD Pass through variable for your own tracking purposes which buyers do not see Default No variable is passed back to you Handling charges This variable is not quantity specific The same handling cost applies regardless of the number of items on the orde
6. BMButtonSearch BMGetButtonDetails 8 Click Submit Button Manager SOAP API April 2012 13 a PayPal Payments Standard Button Manager API Overview Granting Third Party Permission for APIs 14 April 2012 Button Manager SOAP API Using the Button Manager API With SOAP These examples show basic Button Manager API capabilities The examples show how to create buttons and set inventory levels e Specifying HTML Variables e Creating a Button Using SOAP e Tracking Inventory for a Button Using SOAP Specifying HTML Variables When you create or update a button using the Button Manager API you must specify the same HTML variables that you specify when creating any PayPal Payments Standard button Although you can use the ButtonVar field to specify any HTML variables some variables are commonly used in specific ways The following table provides additional information about some of these variables HTML Variable Notes item_name Name or description of item Must be specified for Add to Cart buttons Character length and limitations 127 single byte alphanumeric characters amount The price or amount of the item Required for Add to Cart buttons May not be used when a dropdown with price L_OPTIONOPRICEn is defined Limitations Value must be a positive number No currency symbol Must have two decimal places decimal separator must be a period and the optional thousands separator must be a comma a3 Price of
7. Button Manager API Reference BMUpdate Button API Operation BMUpdateButton Request The hosted button ID identifies the button you want to modify The remaining request fields specify the characteristics of your button le AbstractReguest Type ButtonTypeType Detaillevel 0 DetaillevelCodeType el ErrorLanguage 0 1 string ButtonCodeType e Version string PE any 0 1 ButtonSubTypeType OptionDetailsType e OptionName string E iii OptionSelectionDetails 0 100 OptionSelectionDetailsType e HostedButtonID string ButtonType 0 1 ButtonTypeType ButtonImageType e ButtonCode 0 1 ButtonCodeType e ButtonSubType 0 1 ButtonSubTypeType O BuyNomTextType e Buttonvar 0 1000 string e OptionDetails 0 5 OptionDetailsType E subsciberextrype voc E TextBox 0 2 string CountryCodeType e ButtonImage 0 1 ButtonImageType e ButtonImageURL 0 1 string e BuyNowText 0 1 BuyNowTextType e SubscribeText 0 1 SubscribeTextType e ButtonCountry 0 1 CountryCodeType e ButtonLanguage string E OptionSelectionDetailsType e OptionName string e OptionSelection string e OptionSelectionDetails 0 100 OptionSelectionDetailsType e Price 0 1 string e OptionType 0 1 OptionTypelistType e PaymentPeriod 0 10 InstallmentDetailsType e OptionSelection string E Price 0 1 string Ze InstallmentDetailsType Opti
8. API Button Manager API Reference BMGetinventory API Operation Option Tracking Details Fields OptionNumber OptionQty OptionSelect OptionQtyDelta OptionAlert OptionCost xs string The menu item s ID for an option in a dropdown menu xs string The current inventory level of the option associated with this menu item xs string The menu item s name in a dropdown menu xs string Not used xs string The quantity of the option associated with this menu item below which PayPal sends you an email notification xs string The cost of the option associated with this menu item BMGetInventory Errors Error Code Short Message Long Message Correcting This Error 10001 Internal Error Internal Error 11950 Invalid Data A hosted button ID must be specified 11951 Invalid Argument The hosted button ID specified is invalid 11953 Invalid Data You can only track inventory and profit amp loss for buy now cart or subscription buttons 11991 Invalid Data The hosted button id specified does not have any inventory or cost associated with it 11992 Invalid Argument You do not have permissions to access this button Please check the hosted button ID and try again Button Manager SOAP API April 2012 53 Button Manager API Reference BMGetinventory API Operation 54 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard You can use all variables supported for your b
9. BMUpdateButton Response 0 kaka knakk 32 BMUpdateButton Errors 222 arv vr rakk ra krakk 33 BMButtonSearch API Operation Lava rv vr rv krakk ee 34 BMButtonSearch Request 2 2 2 vr vara rn nrk 35 April 2012 EN Contents BMButtonSearch Response 2 vrak a 36 BMButtonSearch Errors Lav var rakk rann arr ks 37 BMGetButtonDetails API Operation 2 2 vr rv vrak annan 37 BMGetButtonDetails Request arva vr arna nr rann 37 BMGetButtonDetails Response 2 arv vr rv knarr krana ans 38 BMGetButtonDetails Errors 2 22 rav vr o 41 BMManageButtonStatus API Operation LL aa rar vr rare kran 41 BMManageButtonStatus Request LL av rav nrk rann 41 BMManageButtonStatus Response kr a 42 BMManageButtonStatus Errors 2 22 arva vr rn ren 42 BMSetInventory API Operation 2 o vr rv rn ra 43 BMSetlnventory Request kr rn kn ken 43 BMSetinventory Response kr kr rn 46 BMSetlnventory Errors o rv vr rv kr kr rar kne 47 BMGetlnventory API Operation 2 o rakk kran 50 BMGetinventory Request 2 rav 0 0 knr knr nen 50 BMGetinventory Response 2 0 krakk ka kr k ren 51 BMGetlnventory Errors 2 ar kr o 53 Appendix A HTML Variables for PayPal Payments Standard 55 Technical HTML Variables o rv e e 55 HTML Variables for Individual Items
10. ButtonCodeType Version string F any 0 1 ButtonSubTypeType E OptionDetailsType e OptionName string E BMCreateButtonRequestType OptionSelectionDetails 0 100 OptionSelectionDetailsType e ButtonImageURL 0 1 string e BuyNowText 0 1 BuyNowTextType e SubscribeText 0 1 SubscribeTextType e ButtonCountry 0 1 CountryCodeType e ButtonType 0 1 ButtonTypeType ButtonCode 0 1 ButtonCodeType ButtonimageType e ButtonSubType 0 1 ButtonSubTypeType e Buttonvar 0 1000 string O BuyNomTextType e OptionDetails 0 5 OptionDetailsType e TextBox 0 2 string Subsribetexttype e ButtonImage 0 1 ButtonImageType e ButtonLanguage string e OptionName string e OptionSelection string e OptionSelectionDetails 0 100 OptionSelectionDetailsType e Price 0 1 string e OptionType 0 1 OptionTypeListType e PaymentPeriod 0 10 InstallmentDetailsType e OptionSelection string e Price 0 1 string OptionType 0 1 OptionTypeListType BillingPeriod 0 1 BilingPeriodType E PaymentPeriod 0 10 InstallmentDetailsType e BilingFrequency 0 1 int e TotalBillingCycles 0 1 int e Amount 0 1 string e Shipping amp mount 0 1 string e TaxAmount 0 1 string April 2012 Button Manager SOAP API Button Manager API Reference oo BMCreateButton API Operation BMCreateButton
11. Request Fields Field Description ButtonCode ebl ButtonCodeType Optional The kind of button code to create It is one of the following values e HOSTED A secure button stored on PayPal default for all buttons except View Cart Unsubscribe and Pay Now e ENCRYPTED An encrypted button not stored on PayPal default for View Cart button e CLEARTEXT An unencrypted button not stored on PayPal default for Unsubscribe button e TOKEN A secure button not stored on PayPal used only to initiate the Hosted Solution checkout flow default for Pay Now button Since version 65 1 ButtonType ebl ButtonTypeType Required The kind of button you want to create It is one of the following values e BUYNOW Buy Now button CART Add to Cart button GIFTCERTIFICATE Gift Certificate button SUBSCRIBE Subscribe button DONATE Donate button UNSUBSCRIBE Unsubscribe button VIEWCART View Cart button PAYMENTPLAN Installment Plan button since version 63 0 AUTOBILLING Automatic Billing button since version 63 0 PAYMENT Pay Now button since version 65 1 NOTE Do not specify BUYNOW if BUTTONCODE TOKEN specify PAYMENT instead Do not specify PAYMENT if BUTTONCODE HOSTED E ButtonSubType ebl ButtonSubTypeType Optional The use of button you want to create It is one of the following values e PRODUCTS button is used to purchase products defau
12. URL specified is invalid The currency code value specified is invalid Button Manager SOAP API April 2012 49 Button Manager API Reference BMGetinventory API Operation BMGetinventory API Operation Use the BMGet Inventory API operation to determine the inventory levels and other inventory related information for a button and menu items associated with the button Typically you call BMGet Inventory to obtain field values before calling BMSet Inventory to change the inventory levels e BMGetInventory Request e BMGetInventory Response e BMGetInventory Errors BMGetinventory Request The hosted button ID identifies the button whose inventory you want to track AbstractRequest Type e Detaillevel 0 DetaillevelCodeType gt ErrorLanguage 0 1 string gt Version string e any 0 1 BMGetInventoryRequestType ses e HostedButtonID string BMGetIinventory Request Fields Field Description HostedButtonID xs string Required The ID of the hosted button whose inventory information you want to obtain DigitalDownloadKeys xs string Optional One or more digital download keys up to a maximum of 1 000 keys Character length and limitations 1 000 single byte alphanumeric characters each 50 April 2012 Button Manager SOAP API BMGetInventory Response Button Manager API Reference BMGetinventory API Operation The response fields contain inventory information related to the button
13. and Installment Plan buttons e Not used with Donate or Buy Gift Certificate buttons See description 64 or 200 See description 60 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard FN HTML Variables for Individual Items Required or Character Name Optional Description Length option index See The cardinal number of the option field on0 through on9 description that has product options with different prices for each option Include option index if the option field with prices is not ono e Optional for Buy Now Add to Cart Subscribe Automatic Billing and Installment Plan buttons e Not used with Donate or Buy Gift Certificate buttons Default 0 option select0 Optional For priced options the value of the first option selection of 64 the on0 dropdown menu The values must match exactly as the following sample code shows lt option value small gt small 10 00 lt option gt lt input type hidden name option_select0 value small gt e Optional for Buy Now Add to Cart Subscribe Automatic Billing and Installment Plan buttons e Not used with Donate or Buy Gift Certificate buttons option_amount0 Optional For priced options the amount that you want to charge for 64 the first option selection of the on0 dropdown menu Use only numeric values the currency is taken from the currency_code variable For example lt option value small gt small 10 00 lt
14. by both together or none at all 11964 Invalid Data You must either track inventory and or track profit amp loss 11965 Invalid Data You cannot track inventory by item and cost by option at the same time or vice versa 11966 Invalid Argument Item number specified is invalid It must be a string less than 127 characters 11967 Invalid Data You cannot set inventory for more option selections than the number of option selections saved in the button 11968 Invalid Data Option numbers must be unique within an individual button 11969 Invalid Data An option name index value must be specified when tracking inventory or profit amp loss by option 11970 Invalid Argument Option name index value specified is invalid 11971 Invalid Data Inventory and or profit amp loss must be managed by item or an option with price when one is defined 11972 Invalid Data Option name index value specified does not exist 11973 Invalid Data ItemQty and or ItemQtyDelta must be an integer 11974 Invalid Data An item quantity or item quantity delta value cannot be specified when TrackInv is 0 48 April 2012 Button Manager SOAP API Button Manager API Reference b BMSetlnventory API Operation Error Code Short Message Long Message Correcting This Error 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 12210 Invalid Data Invalid Data Invalid
15. g if the billing frequency is 2 and the billing period is Month the billing cycle is every 2 months The default billing frequency is 1 xs int Optional The total number of billing cycles regardless of the duration of a cycle 1 is the default xs string Optional The base amount to bill for the cycle 22 April 2012 Button Manager SOAP API Button Manager API Reference b BMCreateButton API Operation ShippingAmount xs string Optional The shipping amount to bill for the cycle in addition to the base amount TaxAmount xs string Optional The tax amount to bill for the cycle in addition to the base amount Button Language Options The button language must be compatible with the country identified by the country code Country Button Language Options All countries not identified below e en English default Austria e de German default e en English Belgium e en English default e nl Dutch e fr French Canada e en English default e fr French China worldwide e en English default e zh Chinese France e fr French default e en English Germany e de German default e en English Hong Kong e zh Chinese default e en English Italy e it Italian default e en English Japan e ja Japanese default e en English Mexico e es Spanish default e en English Netherlands e nl Dutch default e en English Poland e pl Polish default e en English Spain e es
16. in addition to the base amount BMGetButtonDetails Errors Short Message Long Message Correcting This Error 10001 Internal Error Internal Error 11950 Invalid Data hosted button ID must be specified 11951 Invalid Argument The hosted button ID specified is invalid 11951 Invalid Argument The hosted button ID specified is invalid 11992 Invalid Argument You do not have permissions to access this button Please check the hosted button ID and try again BMManageButtonStatus API Operation Use the BMManageButtonStatus API operation to change the status of a hosted button Currently you can only delete a button e BMManageButtonStatus Request e BMManageButtonStatus Response e BMUpdateButton Errors BMManageButtonStatus Request The request specifies the hosted button s ID and the status you want to set the button to Button Manager SOAP API April 2012 41 Button Manager API Reference BMManageButtonStatus API Operation te AbstractRequest Type ButtonStatusType 0 DetaillevelCodeType e DetailLewel e Errorlanguage 0 1 string e Version fe any string 0 1 BMManageButtonStatusRequestT ype e HostedButtonID 0 1 string e ButtonStatus 0 1 ButtonStatusType BMManageButtonStatus Request Fields Field HostedButtonID ButtonStatus Description xs string Required The ID of the hosted button whose status you want to change ebl But
17. is case insensitive six character HTML hexadecimal color code in ASCII NOTE Background colors that conflict with PayPal s error messages are not allowed in these cases the default color is white Deprecated for Buy Now and Add to Cart buttons and the Cart Upload command le Optional The language of the login or sign up page that subscribers 2 see when they click the Subscribe button If unspecified PayPal determines the language by using a cookie in the subscriber s browser If there is no PayPal cookie the default language is U S English 72 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard Feen HTML Variables for Displaying PayPal Checkout Pages Required or Character Name Optional Description Length no note Optional Do not prompt buyers to include a note with their payments 1 Allowable values are e 0 provide a text box and prompt for the note e hide the text box and the prompt The default is 0 cn Optional Label that appears above the note field This value is not 40 saved and does not appear in any of your notifications If this variable is omitted the default label above the note field is Add special instructions to merchant The cn variable is not valid with Subscribe buttons or if you include no note 1 no shipping Optional Do not prompt buyers for a shipping address 1 Allowable values are e 0 prompt for an address but do not require one e 1 do
18. marked as primary in your account profile e page style name use the custom payment page style from your account profile that has the specified name The default is primary if you added a custom payment page style to your account profile Otherwise the default is paypal image url Optional The URL of the 150x50 pixel image displayed as your logo 1 024 in the upper left corner of the PayPal checkout pages Default Your business name if you have a PayPal Business account or your email address if you have PayPal Premier or Personal account cpp cart border Optional The HTML hex code for your principal identifying color 6 color PayPal blends your color to white in a gradient fill that borders the cart review area of the PayPal checkout user interface Valid value is 6 single byte hexadecimal characters that represent an HTML hex code for a color e Valid only for Buy Now and Add to Cart buttons and the Cart Upload command e Not used with Subscribe Donate or Buy Gift Certificate buttons cpp header _ Optional The image at the top left of the checkout page The image s No limit image maximum size is 750 pixels wide by 90 pixels high PayPal recommends that you provide an image that is stored only on a secure https server Deprecated for Buy Now and Add to Cart buttons and the Cart Upload command Button Manager SOAP API April 2012 71 A HTML Variables for PayPal Payments Standard HTML Variables for Displaying PayPa
19. only if the return variable is set cancel return Optional A URL to which PayPal redirects the buyers browsers if 1 024 they cancel checkout before completing their payments For example specify a URL on your website that displays a Payment Canceled page Default PayPal redirects the browser to a PayPal webpage HTML Variables for Filling Out PayPal Checkout Pages Automatically HTML variables for filling out PayPal checkout pages automatically let you specify information about buyers PayPal recommends that you include automatic fill out variables with all of your payment buttons for consistent address handling in the checkout experience of your buyers NOTE When you pass in address_override 1 or tax or shipping variables PayPal HTML Variables for Filling Out PayPal Checkout Pages Automatically for Buyers displays the values in the payment widget Also PayPal hides the calculation widget regardless of setting up shipping and tax rates in your Account Profile Required or Character Name Optional Description Length address1 Optional Street 1 of 2 fields 100 address2 Optional Street 2 of 2 fields 100 city Optional City 40 country Optional Sets shipping and billing country 2 email Optional Email address 127 first_name Optional First name 32 last_name Optional Last name 64 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard a HTML Variables for the Instant Up
20. or a set of radio buttons each allowable value should be no more than 64 characters If buyers enter this value in a text field there is a 200 character limit NOTE The option field on0 must also be defined For example it could be size For priced options include the price and currency symbol in the text of the option selections as the following sample code shows lt option value small gt small 10 00 lt option gt Add a corresponding option select0 and option amount variable for each priced option Priced options are supported only for Buy Now and Add to Cart buttons Only one dropdown menu option selection can have priced options e Optional for Buy Now Add to Cart Subscribe Automatic Billing and Installment Plan buttons e Not used with Donate or Buy Gift Certificate buttons Option selection of the buyer for the second option field onl If the option field is a dropdown menu or a set of radio buttons each allowable value should be no more than 64 characters If buyers enter this value in a text field there is a 200 character limit You can specify a maximum of 7 option selections 6 with Subscribe buttons by incrementing the option selection index os0 through os6 You can implement up to 5 option selections as dropdown menus and up to 2 option selections as test boxes NOTE corresponding option field on0 through on6 must be defined e Optional for Buy Now Add to Cart Subscribe Automatic Billing
21. subscription Must be specified for Subscribe buttons Value must be a positive number No currency symbol Must have two decimal places decimal separator must be a period and the optional thousands separator must be a comma p3 Regular billing cycle Must be specified for Subscribe buttons Limitations Must be a positive integer greater than 0 and less than or equal to 30 t3 Regular billing cycle units Must be specified for Subscribe buttons shopping url URL where recipients can shop and redeem gift certificates Required for Gift Certificate buttons Character length and limitations 255 single byte alphanumeric characters Button Manager SOAP API April 2012 15 16 Using the Button Manager API With SOAP Creating a Button Using SOAP HTML Variable Notes no_note Must be specified for Subscribe buttons Enables a subscriber to not be prompted to include a note with the subscription a function which PayPal subscriptions does not support This variable must be included and the value must be set to 1 business Secure Merchant ID or Email Address When omitted defaults to the secure merchant ID of the merchant If an email address is specified then it the following requirements apply e A merchant or 3rd Party calling the API directly may specify an unregistered email and create an unencrypted button only e A 3rd Party calling the API on behalf of a registered merchant must specify an email address associated with
22. times out For example Express 2 days You can include a maximum of 10 shipping options as fallbacks Substitute x with ordinal numbers starting with 0 Iinclude 1 instance of this variable with its index x set to 0 If you include just 1 instance include fallback shipping option is default x with its index X set to 0 and its value set to 1 Allowable values for x are 0 9 Required Shipping amount for option x to use as a fallback if the response times out Allowable values for X are 0 9 Required Indicates that shipping option x is the default and should be selected in the dropdown menu as a fallback if the response times out Only one shipping option can be the default for buyers Check that you set instance only of fallback shipping option is default xtothe value 1 Allowable values are e 1 shipping option x is the default shipping option e 0 shipping option x is not the default shipping option Allowable values for X are 0 9 Character Length 1024 1 50 76 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard a HTML Variables for the Instant Update API Required or Character Name Optional Description Length fallback_insura Optional Indicates that insurance is offered PayPal ignores this 1 nce_option_offe HTML variable if fallback insurance amount is red omitted or the value is 0 or less Allowable values are e 1 insurance is offered e 0 insura
23. to make changes to any information herein without further notice Preface Chapter Contents 5 Intended Audience a 5 Revision HISO o xx ds bes dar ror eda ske Ge HEVET do LA KG A A 5 1 PayPal Payments Standard Button Manager API Overview 7 Button Manager Introduction 22 arr vr vr kran 7 Generated Button Code ee 8 Button Hosting s ia s d darra aaea kr krana 10 Hosted Button Manipulation a a aa aa a 10 Inventory Management Using Hosted Buttons a La oa a a a 11 Inventory Management for Digital Downloads ar rar ra vrak ranks 11 Button Manager API Summary 22 ar rv vr krakk ka krakk nrk 12 Hosted Solution Links 2222 av rv rar rar kran 12 Granting Third Party Permission for APIs 2 2 a vr eee eee eee 12 Chapter 2 Using the Button Manager API With SOAP 2 2 42415 Specifying HTML Variables 2 ar rv e o 15 Creating a Button Using SOAP 2 rv 0 nrk nn ka 16 Tracking Inventory for a Button Using SOAP rv eae 18 Chapter 3 Button Manager API Reference 19 BMCreateButton API Operation 2 rak rak rakk ran 19 BMCreateButton Request 222 a vr av rav rn arna ra kranen 19 BMCreateButton Response 2 2 a ra vrak nrk nr arna narr 24 BMCreateButton Errors rar annars 25 BMUpdateButton API Operation 0 00002 ee ka 26 BMUpdateButton Request 2 av vr rakk eee ee 27
24. variables set up the Cart Upload to use your callback server Include the following required variables in the Cart Upload command to have PayPal send Instant Update requests to your callback server Include the following optional variables when appropriate Button Manager SOAP API April 2012 75 A HTML Variables for PayPal Payments Standard HTML Variables for the Instant Update API HTML Variables to Set Up an Instant Update Payment Name callback url callback timeou E callback versio n fallback tax am ount fallback shippi ng option name x fall back_shippi ng_option_amoun t_x fall back_shippi ng_option_is_de faul Tx Required or Optional Description Required The URL of your Instant Update callback server Required The timeout in seconds for callback responses from your Instant Update callback server After exceeding the timeout PayPal uses the fallback values on the Review Your Payment page for tax shipping and insurance Allowable values are 1 6 PayPal recommends the value 3 IMPORTANT Use values other than 3 only when instructed to do so by your PayPal representative Optional The version of the Instant Update API that your callback server uses The default is the current version Optional Tax amount to use as a fallback if the callback response times out Required Name and label of shipping option x to use as a fallback if the callback response
25. with the button ReuseDigitalDownloadKeys xs string Optional Whether to reuse download keys e 0 do not reuse keys default e 1 reuse keys NOTE If you do not reuse the download keys you must replenish the keys when you sell out of the product being downloaded AppendDigitalDownloadKey xs string 5 Optional Whether to append download keys e 0 donot append keys default e 1 append keys NOTE If you do not append the download keys unused keys will be replaced DigitalDownloadKeys xs string Optional One or more digital download keys up to a maximum of 1 000 keys Character length and limitations 1 000 single byte alphanumeric characters each Item Tracking Details Fields ItemNumber xs string Optional The ID for an item associated with this button ItemQty xs string The quantity you want to specify for the item associated with this button Specify either the absolute quantity in this field or the change in quantity in the quantity delta field Button Manager SOAP API April 2012 45 46 Button Manager API Reference BMSetInventory API Operation ItemQtyDelta ItemAlert ItemCost xs string The change in quantity you want to specify for the item associated with this button Specify either the change in quantity in this field or the absolute quantity in the item quantity field xs string Optional The quantity of the item associated with this button below which PayPal sends you an email notifi
26. xs string Optional The price associated with the first menu item NOTE If you specify a price you cannot set a button variable to amount ebl OptionTypeListType Optional The installment option type for an OPTIONNNAME which is one of the following values e FULL Payment in full e VARIABLE Variable installments e EMI Equal installments NOTE Only available for Installment Plan buttons ns InstallmentDetailsType Optional Information about an installment option Installment Details BillingPeriod BillingFrequency ebl BillingPeriodType Optional The installment cycle unit which is one of the following values e NoBillingPeriodType None default Day Week SemiMonth Month Year xs int Optional The installment cycle frequency in units e g if the billing frequency is 2 and the billing period is Month the billing cycle is every 2 months The default billing frequency is 1 40 April 2012 Button Manager SOAP API Button Manager API Reference b BMManageButtonStatus API Operation TotalBillingCycles xs int Optional The total number of billing cycles regardless of the duration of a cycle 1 is the default Amount xs string Optional The base amount to bill for the cycle ShippingAmount xs string Optional The shipping amount to bill for the cycle in addition to the base amount TaxAmount xs string Optional The tax amount to bill for the cycle
27. API to create these Website Payment Standard and Hosted Sole Solution buttons e Buy Now e Add to Cart and View Cart e Donate e Buy Gift Certificate Button Manager SOAP API April 2012 i PayPal Payments Standard Button Manager API Overview Generated Button Code e Subscribe and Unsubscribe e Pay Now Hosted Sole Solution only e Installment Plan e Automatic Billing The following buttons are some of those that you can create using the Button Manager API Generated Button Code When you create a button PayPal responds by generating code that you can paste into your web page or document The generated code includes e HTML code for including the button in web pages e URL link code for adding buttons to email and documents that support links NOTE Not all merchants in every country can use all the buttons that can be created For example German merchants cannot use Subscribe buttons even though they can be 8 April 2012 Button Manager SOAP API PayPal Payments Standard Button Manager API Overview REM Generated Button Code created through the API If you can create the button for the specified country using Create PayPal payment button on PayPal your merchant will be able to use the button This example shows the PayPal code for displaying a hosted Add to Cart button to sell a wireless mouse lt form target paypal action https www sandbox paypal com cgi bin webscr method post gt lt input type
28. Build z fe any dateTime AckCodeType string ErrorType string string BMSetInventoryResponseType ses e TransactionID BMSetInventory Response Fields string Field Description TransactionID xs string Transaction ID BMSetinventory Errors ae Short Message Long Message Correcting This Error 10001 Internal Error Internal Error 11950 Invalid Data A hosted button ID must be specified 11951 Invalid Argument The hosted button ID specified is invalid 11951 Invalid Argument The hosted button ID specified is invalid 11953 Invalid Data You can only track inventory and profit amp loss for buy now cart or subscription buttons 11954 Invalid Data A TrackInv value must be specified 11955 Invalid Data A TrackPnl value must be specified 11956 Invalid Argument The TrackInv value specified is invalid 11957 Invalid Argument The TrackPnl value specified is invalid Button Manager SOAP API April 2012 47 Button Manager API Reference BMSetInventory API Operation Error Code Short Message Long Message Correcting This Error 11958 Invalid Data You cannot specify both an ItemQty and ItemQtyDelta value 11959 Invalid Data You cannot specify both an OptionQty and OptionQtyDelta value 11960 Invalid Data You cannot specify item level or option level inventory when TrackInv is 0 11961 Invalid Data You must either track inventory by item or by option when TrackInv is 1 It cannot be tracked
29. Data Invalid Argument Invalid Argument Invalid Data Invalid Argument Invalid Argument Invalid Argument Invalid Argument Invalid Argument Invalid Data Invalid Argument Invalid Argument Invalid Argument Invalid Argument Invalid Argument The number of option quantity or option quantity delta values specified is greater than the number of option selections in the saved button You must specify either option quantity or option quantity delta values with a valid integer value An option quantity or option quantity delta value must not be specified when TrackInv is 0 Item alert must be specified as a positive integer Item alert must not be specified when TrackInv is 0 The number of option alert values specified is greater than the number of option selections in the saved button Option alert values must be specified as a positive integer Option alert values cannot be specified when TrackInv is 0 Item cost value must be specified when tracking profit amp loss by item The item cost value specified is invalid An item cost value cannot be specified when TrackPnl is 0 The number of option cost values specified is greater than the number of option selections in the saved button Option cost values must be specified when tracking profit amp loss by option An option cost value specified is invalid An option cost value cannot be specified when TrackPnl is 0 The sold out
30. PayPal Button Manager API SOAP Button Manager SOAP API Document Number 10090 en US 201204 O 2012 PayPal Inc All rights reserved PayPal is a registered trademark of PayPal Inc The PayPal logo is a trademark of PayPal Inc Other trademarks and brands are the property of their respective owners The information in this document belongs to PayPal Inc It may not be used reproduced or disclosed without the written approval of PayPal Inc Copyright PayPal All rights reserved PayPal S r l et Cie S C A Soci t en Commandite par Actions Registered office 22 24 Boulevard Royal L 2449 Luxembourg R C S Luxembourg B 118 349 Consumer advisory The PayPal payment service is regarded as a stored value facility under Singapore law As such it does not require the approval of the Monetary Authority of Singapore You are advised to read the terms and conditions carefully Notice of non liability PayPal Inc is providing the information in this document to you AS IS with all faults PayPal Inc makes no warranties of any kind whether express implied or statutory with respect to the information contained herein PayPal Inc assumes no liability for damages whether direct or indirect caused by errors or omissions or resulting from the use of this document or the information contained in this document or resulting from the application or use of the product or service described herein PayPal Inc reserves the right
31. See Upload the contents of a third party shopping cart or a 1 description custom shopping cart This variable must be set as follows upload 1 The alternatives are the add 1 variable and the display 1 variables which are used with the PayPal Shopping Cart HTML Variables for Recurring Payments Buttons Recurring Payments buttons are e Subscribe buttons e Automatic Billing buttons Button Manager SOAP API April 2012 65 66 HTML Variables for PayPal Payments Standard HTML Variables for Recurring Payments Buttons e Installment Plan buttons HTML variables for recurring payments buttons set terms for different kinds of PayPal automatic payment plans Subscribe Button HTML Variables Required or Character Name Optional Description Length business Required Your PayPal ID or an email address associated with your PayPal account Email addresses must be confirmed item name Optional Description of item being sold If you are collecting 127 aggregate payments the value can be a summary of all items purchased a tracking number or a generic term such as subscription If this variable is omitted buyers see a field in which they can enter the item name currency_code Optional The currency of prices for trial periods and the subscription 3 The default is USD al Optional Trial period 1 price For a free trial period specify 0 pl See Trial period 1 duration Required if you specify al Specify 2 descripti
32. account PayPal determines which kind of button was clicked by decoding the encrypted code or by looking up the saved button in the merchant s account Button Manager SOAP API April 2012 55 A HTML Variables for PayPal Payments Standard Technical HTML Variables HTML Variables for Special PayPal Features Required or Character Name Optional Description Length notify url Optional The URL to which PayPal posts information about the 255 payment in the form of Instant Payment Notification messages hosted button i See Required for buttons that have been saved in PayPal See d description accounts otherwise not allowed description The identifier of a button that was saved in a merchant s PayPal account PayPal assigns the value when payment buttons are first created and saved in merchants PayPal accounts NOTE merchant s PayPal account can have a maximum of 1 000 saved payment buttons bn Optional An identifier of the source that built the code for the button that the buyer clicked sometimes known as the build notation Specify a value using the following format lt Company gt _ lt Service gt _ lt Product gt _ lt Country gt Substitute lt Service gt with an appropriate value from the following list e BuyNow AddToCart Donate Subscribe AutomaticBilling InstallmentPlan BuyGiftCertifcate ShoppingCart Substitute lt Product gt with WPS always for Website Payments Standard payment buttons and for the Website Payment
33. age htm1 lt soldoutURL gt lt com paypal soap api BMSet InventoryRequestType gt 18 April 2012 Button Manager SOAP API Button Manager API Reference The Button Manager API enables you to programatically create edit and delete PayPal Payments Standard buttons hosted on PayPal and track product inventory associated with these buttons You can also create non hosted buttons with the Button Manager API however only hosted buttons support button maintenance and inventory management BMCreateButton API Operation MUpdateButton API Operation MButtonSearch API Operation MGetButtonDetails API Operation MManageButtonStatus API Operation MSetInventory API Operation B B B B B B MGetInventory API Operation BMCreateButton API Operation Use the BMCreateButton API operation to create a PayPal Payments Standard button You can create either a button that is hosted on PayPal or a non hosted button BMCreateButton Request BMCreateButton Response e BMCreateButton Errors BMCreateButton Request The request fields specify the characteristics of your button which include associated menu items related to the button You can specify up to 5 menu items each of which can include up to 10 possible selections Button Manager SOAP API April 2012 19 Button Manager API Reference BMCreateButton API Operation le AbstractReguest Type ButtonTypeType e Detaillevel 0 DetaillevelCodeType el Errorlanguage 0 1 string
34. al only stores the inventory of keys and does not track how a specific key is used although PayPal does provide options for making this process simpler When you specify the inventory for a button you can specify the usage of download keys e Whether the keys you specify should be appended to the current list of keys or whether the list of keys should be replaced which allows you to replenish the list of keys or replace the list entirely e Whether the list of keys are to be reused or not If you do not reuse keys PayPal will also notify you when the item is sold out meaning that there are no more keys available Button Manager SOAP API April 2012 11 PayPal Payments Standard Button Manager API Overview Button Manager API Summary Button Manager API Summary The Button Manager API is available for both NVP and SOAP API Operation Description BMCreateButton Create button code BMUpdateButton Update a hosted button BMManageButtonStatus Delete a button BMGetButtonDetails Obtain information about the parameters associated with a button BMButtonSearch Obtain a list of all buttons BMGet Inventory Obtain the inventory levels associated with a button BMSet Inventory Specify the inventory levels associated with a button Hosted Solution Links Hosted Solution links are URLs you create with the Button Manager API to initiate the Hosted Solution checkout flow NOTE Although you can use the Button M
35. ames must not exceed 64 characters 11941 Invalid Argument An option selection value specified is invalid Option selection values must not exceed 64 characters 11942 Invalid Argument An option price value specified is invalid Make sure any punctuation marks are in the correct places 11943 Invalid Argument The button country value specified is invalid 11945 Invalid Data The button country and language code combination specified is invalid 11947 Invalid Argument The tax rate specified is invalid Make sure any punctuation marks are in the correct places and value specified is in the range 0 0 to 100 11948 Invalid Argument The amount specified is invalid Make sure any punctuation marks are in the correct places 12210 Invalid Argument The currency code value specified is invalid 13117 Invalid Argument Subtotal amount is not valid 13118 Invalid Argument Tax amount is not valid 13119 Invalid Argument Handling amount is not valid 13120 Invalid Argument Shipping amount is not valid BMUpdateButton API Operation Use the BMUpdateButton API operation to modify a PayPal Payments Standard button that 1s hosted on PayPal This operation replaces all fields in the specified button therefore you must specify a value for each field you want to include for the button whether or not it changed e BMUpdateButton Request e BMUpdateButton Response e BMUpdateButton Errors 26 April 2012 Button Manager SOAP API
36. amount is not valid 13119 Invalid Argument Handling amount is not valid 13120 Invalid Argument Shipping amount is not valid BMButtonSearch API Operation Use the BMButtonSearch API operation to obtain a list of your hosted PayPal Payments Standard buttons e BMButtonSearch Request e BMButtonSearch Response e BMButtonSearch Errors 34 April 2012 Button Manager SOAP API Button Manager API Reference b BMButtonSearch API Operation BMButtonSearch Request The request contains optional fields that are not currently used All hosted buttons are automatically requested te AbstractRequest Type e Detaillevel 0 DetaillevelCodeType e ErrorLanquage 0 1 string e Version string PE any 0 1 BMButtonSearchRequestType e StartDate 0 1 dateTime e EndDate 0 1 dateTime BMButtonSearch Request Fields Field Description StartDate xs dateTime Required Starting date for the search The value must be in UTC GMT format for example 2009 08 24T05 38 48Z No wildcards are allowed EndDate xs dateTime Optional Ending date for the search The value must be in UTC GMT format for example 2010 05 01T05 38 48Z No wildcards are allowed Button Manager SOAP API April 2012 35 4 Button Manager API Reference BMButtonSearch API Operation BMButtonSearch Response The response contains a list of all hosted buttons and their associated characteristics te AbstractResponze Type te Bu
37. an item to the PayPal Shopping Cart If both add and display are specified display takes precedence 64 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard oa HTML Variables for Recurring Payments Buttons Required or Character Name Optional Description Length handling_ cart Optional Single handling fee charged cart wide If handling_cart is used in multiple Add to Cart buttons the handling_cart value of the first item is used item_name_x Required The name associated with item x To pass an aggregate name for the entire cart use item name 1 Applies only to the Cart Upload command paymentaction Optional Indicates whether the payment is a final sale or an authorization for a final sale to be captured later Allowable values are e sale e authorization e order The default value is sale Set the value to authorization to place a hold on the PayPal account for the authorized amount Set the value to order to authorize the payment without placing a hold on the PayPal account IMPORTANT If you set paymentaction to order use the Authorization amp Capture API to authorize and capture the payment payments The Merchant Services on the PayPal website let you capture payments only for authorizations not for orders shopping_url Optional The URL of the page on the merchant website that buyers go to when they click the Continue Shopping button on the PayPal Shopping Cart page upload
38. anager API to create buttons that initiate the Hosted Solution checkout flow do not confuse a button for Hosted Solution with hosted buttons that you also create with the Button Manager API You create the Hosted Solution checkout link dynamically when your buyer attempts to check out For example when your buyer clicks your check out button you call the BMCreateButton API operation to create the link and then redirect the buyer s browser to PayPal using the link The buyer then pays on the PayPal Hosted Solution page After making the payment PayPal returns the buyer to the page you specified when you created the link Granting Third Party Permission for APIs If you allow a shopping cart or another party to create buttons on your behalf you must grant the party permission to execute Button Manager API operations for you To grant third party permissions 1 Log in to your PayPal account 2 Select My Account Profile 3 Click API Access from the Profile Summary 4 Click Grant API Permission April 2012 Button Manager SOAP API PayPal Payments Standard Button Manager API Overview Granting Third Party Permission for APIs 5 Click Configure a custom API authorization 6 Enter your Partner API username as specified by your shopping cart or third party 7 Check each Button Manager API you want to provide access to BMManageButtonStatus BMCreateButton BMUpdateButton BMSetinventory C BMGetinventory
39. are configured with a basis of weight the sum of weight values is used to calculate the shipping charges for the payment Allowable values are decimals numbers with 2 significant digits to the right of the decimal point weight_unit Optional The unit of measure if weight is specified Allowable values are e lbs e kgs The default is 1bs ond Optional First option field name and label The os0 variable contains 64 the corresponding value for this option field For example if on0 is size os0 could be large e Optional for Buy Now Add to Cart Subscribe Automatic Billing and Installment Plan buttons e Not used with Donate or Buy Gift Certificate buttons onl Optional Second option field name and label The os1 variable 64 contains the corresponding value for this option field For example if on1 is color then os1 could be blue You can specify a maximum of 7 option field names 6 with Subscribe buttons by incrementing the option name index on0 through on6 e Optional for Buy Now Add to Cart Subscribe Automatic Billing and Installment Plan buttons e Not used with Donate or Buy Gift Certificate buttons Button Manager SOAP API April 2012 59 A HTML Variables for PayPal Payments Standard HTML Variables for Individual Items Required or Name Optional Description Character Length os0 Optional osl Optional Option selection of the buyer for the first option field on0 If the option field is a dropdown menu
40. button not stored on PayPal default for Unsubscribe button NOTE You cannot change the kind of button code after after the button has been created ButtonSubType ebl ButtonSubTypeType Optional The use of button you want to create It is one of the following values e PRODUCTS button is used to purchase products default for Buy Now and Add to Cart buttons e SERVICES button is used to purchase services NOTE You cannot change the button usage after after the button has been created ButtonVar xs string Optional HTML standard button variables It is a list of variables in which n is a digit between 0 and 999 inclusive do not include leading zeros Character length and limitations 63 single byte alphanumeric characters each 28 April 2012 Button Manager SOAP API Button Manager API Reference b BMUpdate Button API Operation Field Description OptionDetails ns OptionDetailsType Optional Menu items TextBox xs string Optional Text description for a menu item It is a list of variables in which n is a digit between 0 and 1 inclusive ButtonImage ebl ButtonImageType Optional The kind of button image It is one of the following values e REG regular default e SML small e CC small button image with credit card logos not applicable for Unsubscribe or View Cart buttons NOTE Specify either the kind of button image or the URL ButtonImageURL xs string Optional The button s URL NOTE Specify
41. cation xs string Optional The cost of the item associated with this button Option Tracking Details Fields OptionNumber OptionQty OptionSelect OptionQtyDelta OptionAlert OptionCost xs string Optional The menu item s ID for an option in a dropdown menu xs string The quantity you want to specify for the option associated with this menu item Specify either the absolute quantity in this field or the change in quantity in the quantity delta field xs string Optional The menu item s name in a dropdown menu xs string The change in quantity you want to specify for the option associated with this menu item Specify either the change in quantity in this field or the absolute quantity in the quantity field xs string Optional The quantity of the option associated with this menu item below which PayPal sends you an email notification xs string Optional The cost of the option associated with this menu item Limitations Value must be a positive number with no currency symbol It must have two decimal places and the decimal separator must be a period It may have an optional comma for the thousands separator BMSetinventory Response The response contains only the transaction ID April 2012 Button Manager SOAP API Button Manager API Reference BMSetInventory API Operation AbstractResponse Type Timestamp e Ack 0 1 e CorrelationID 0 1 e Errors 0 e Version e
42. ce amount x Required The amount associated with item x To pass an aggregate amount for the entire cart use amount 1 Applies only to the Cart Upload command business Required Your PayPal ID or an email address associated with your PayPal account Email addresses must be confirmed discount amount Optional Single discount amount charged cart wide Cart It must be less than the selling price of all items combined in the cart This variable overrides any individual item discount_amount_x values if present Applies only to the Cart Upload command discount_amount Optional The discount amount associated with item x x It must be less than the selling price of the associated item This amount is added to any other item discounts in the cart Applies only to the Cart Upload command discount_rate_c Optional Single discount rate percentage to be charged cart wide art It must be set to a value less than 100 The variable overrides any individual item discount_rate_x values if present Applies only to the Cart Upload command discount rate X Optional The discount rate associated with item x It must be set to a value less than 100 The variable takes into account all quantities of item x Applies only to the Cart Upload command display See Display the contents of the PayPal Shopping Cart to the 1 description buyer This variable must be set as follows display 1 The alternative is the add 1 variable which adds
43. date API Required or Character Name Optional Description Length le Optional Sets the language for the billing information log in page 2 only The default is US charset Optional Sets the character set and character encoding for the billing information log in page on the PayPal website In addition this variable sets the same values for information that you send to PayPal in your HTML button code The default is based on the language encoding settings in your Account Profile night phone a Optional The area code for U S phone numbers or the country code See for phone numbers outside the U S PayPal fills in the description buyer s home phone number automatically night phone b Optional The three digit prefix for U S phone numbers or the entire See phone number for phone numbers outside the U S description excluding country code PayPal fills in the buyer s home phone number automatically night phone c Optional The four digit phone number for U S phone numbers See PayPal fills in the buyer s home phone number description automatically state Optional State code 2 zip Optional Postal code 32 HTML Variables for the Instant Update API HTML variables for the Instant Update API set up the Cart Upload command for the Instant Update API callback Establish your own Instant Update callback server before you use these variables Instant Update Variables to Set Up a Payment for the Instant Update API Some Instant Update
44. ed Duration of payment period m Specify the number of time pm units with option selectn tm If the value of option selectn type Is E the value of this variable applies to all payments in the plan option selectn Required Units of time for payment period m 1 tm Allowable values are e D for days allowable range for p3 is 1 to 90 e W for weeks allowable range for p3 is 1 to 52 e M for months allowable range for p3 is 1 to 24 e Y for years allowable range for p3 is 1 to 5 option selectn Required Number of payments that are the same in amount and 1 nm duration as this one e If the value of option selectn type is F set the value to 1 e If the value of option selectn type is E set the value to the number of payments in the plan e If the value of option selectn type is F and no subsequent payments are the same as this one set the value to 1 70 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard Fen HTML Variables for Displaying PayPal Checkout Pages HTML Variables for Displaying PayPal Checkout Pages HTML variables for displaying PayPal checkout pages control how the pages appear and function HTML Variables for Displaying PayPal Checkout Pages Required or Character Name Optional Description Length page_style Optional The custom payment page style for checkout pages 30 Allowable values are e paypal use the PayPal page style e primary use the page style that you
45. either the kind of button image or the URL BuyNowText ebl BuyNowText Type Optional The button text for a Buy Now button It is one of the following values e BUYNOW button text is Buy Now default e PAYNOW button text is Pay Now SubscribeText ebl SubscribeTextType Optional The button text for a Subscribe button It is one of the following values e BUYNOW button text is Buy Now e SUBSCRIBE button text is Subscribe default ButtonCountry ebl CountryCodeType Optional The country in which the transaction occurs By default it is the merchant s country of registration with PayPal ButtonLanguage xs string Optional The language in which to display the button text It must be compatible with the country code Character length and limitations 2 single byte alphanumeric characters Option Details Fields Field Description Opt ionName xs string Optional The menu name Button Manager SOAP API April 2012 29 4 Button Manager API Reference BMUpdateButton API Operation Field Description OptionSelectionDetails ns OptionSelectionDetailsType Optional Menu items Option Selection Details Fields OptionSelection Price OptionType PaymentPeriod xs string Optional The menu item s name xs string Optional The price associated with the first menu item NOTE If you specify a price you cannot set a button variable to amount ebl OptionTypeListType Optio
46. entory you want to set xs string Required Whether to track inventory levels associated with the button It is one of the following values e 0 do not track inventory e 1 track inventory xs string Required Whether to track the gross profit associated with inventory changes It is one of the following values e 0 do not track the gross profit e 1 track the gross profit NOTE The gross profit is calculated as the price of the item less its cost multiplied by the change in the inventory level since the last call to BMSet Inventory ebl ItemTrackingDetails Optional Item tracking details for the button April 2012 Button Manager SOAP API Button Manager API Reference b BMSetlnventory API Operation Field Description OptionIndex xs string Optional Option index which identifies the button Option index 0 is the menu that contains the price if one exists otherwise it is the first menu without a price Character length and limitations 1 single byte alphanumeric character SoldoutURL xs string Optional The URL to which the buyer s browser is redirected when the inventory drops to 0 NOTE Specifying a URL in this field also prevents a sale when the inventory drops to 0 otherwise sales can continue even when inventory is unavailable Character length and limitations 127 single byte alphanumeric characters ebl OptionTrackingDetails Optional Option tracking details for menu items associated
47. hidden name cmd value s xclick gt lt input type hidden name hosted button id value 19218 gt lt table gt lt tr gt lt td gt lt input type hidden name on0 value Color gt Color lt td gt lt tr gt lt tr gt lt td gt lt select name 0s0 gt lt option value Red gt Red 10 00 lt option value Blue gt Blue 8 00 lt option value Green gt Green 12 00 lt select gt lt td gt lt tr gt lt tr gt lt td gt lt input type hidden name on1 value Size gt Size lt td gt lt tr gt lt tr gt lt td gt lt select name os1 gt lt option value Small gt Small lt option value Large gt Larg lt select gt lt td gt lt tr gt lt table gt input type hidden name currency_code value USD gt lt i lt input type image src https www sandbox paypal com en US i btn btn cart LG gif border 0 name submit alt gt lt img alt border 0 src https www sandbox paypal com en US i scr pixel gif width 1 height 1 gt lt form gt When you display a web page with this code this button appears Color Red 10 00 Size Small Y Add to Cart PayPal generated code for a link would be as follows https www sandbox paypal com cgi bin webscr cmd s xclick amp hosted button id 19218 For a link PayPal does not generate code for options Button Manager SOAP API April 2012 9 PayPal Payments Standard Button Manager API Overview Button Hosting
48. input type hidden name option_amount0 lt option gt value 10 00 gt e Optional for Buy Now Add to Cart Subscribe Automatic Billing and Installment Plan buttons e Not used with Donate or Buy Gift Certificate buttons Button Manager SOAP API April 2012 61 A HTML Variables for PayPal Payments Standard HTML Variables for Payment Transactions Required or Character Name Optional Description Length option selectl Optional For priced options the value of the second option selection 64 of the on0 dropdown menu For example lt option value medium gt small 10 00 lt option gt lt input type hidden name option select value medium gt You can specify a maximum of 10 option selections by incrementing the option selection index option select O through option select 9 NOTE corresponding option selection in os0 must also be set e Optional for Buy Now Add to Cart Subscribe Automatic Billing and Installment Plan buttons e Not used with Donate or Buy Gift Certificate buttons option amountl Optional For priced options the amount that you want to charge for 64 the second option selection of the on0 dropdown menu For example lt option value small gt medium 15 00 lt option gt lt input type hidden name option_amount1 value 15 00 gt You can specify a maximum of 10 option amounts by incrementing the option amount index option amount O through opt ion_amount 9 NOTE
49. integers Button Manager SOAP API April 2012 TT A HTML Variables for PayPal Payments Standard HTML Variables for the Instant Update API Required or Character Name Optional Description Length length unit Optional Unit of measure for the value specified by length x Allowable values are any values that you choose to provide PayPal passes the value to your callback server in callback requests 78 April 2012 Button Manager SOAP API
50. l Checkout Pages Required or Character Name Optional Description Length cpp_ Optional The background color for the header of the checkout page 6 headerback_ Valid value is case insensitive six character HTML color hexadecimal color code in ASCII Deprecated for Buy Now and Add to Cart buttons and the Cart Upload command cpp_ Optional The border color around the header of the checkout page 6 headerborder_co The border is a 2 pixel perimeter around the header space lor which has a maximum size of 750 pixels wide by 90 pixels high Valid value is case insensitive six character HTML hexadecimal color code in ASCII Deprecated for Buy Now and Add to Cart buttons and the Cart Upload command cpp_logo_image Optional A URL to your logo image Use a valid graphics format 127 such as gif jpg or png Limit the image to 190 pixels wide by 60 pixels high PayPal crops images that are larger PayPal places your logo image at the top of the cart review area NOTE PayPal recommends that you store the image on a secure https server Otherwise web browsers display a message that checkout pages contain non secure items Valid value is 127 single byte alphanumeric characters e Valid only for Buy Now and Add to Cart buttons and the Cart Upload command e Not used with Subscribe Donate or Buy Gift Certificate buttons cpp_payflow_ Optional The background color for the checkout page below the 6 color header Valid value
51. le AbatractResponse Type Timestamp 0 1 dateTime Ack AckCodeType CorrelationID 0 1 string Errors 0 ErrorType Version string Build string ns any E BMGetInventoryResponseType e HostedButtonID string e TrackInv string e TrackPnl string JE ItemTrackingDetails 0 1 ItemTrackingDetailsType se e OptionIndex 0 1 string e OptionName 0 1 string OptionTrackingDetails 0 10 OptionTrackimgDetailsType e SoldoutURL 0 1 string e DigitalDownloadkeys 0 1000 string BMGetinventory Response Fields fe ItemTrackingDetailsType e ItemNumber 0 1 string e ItemQty 0 1 string e ItemQtyDelta 0 1 string e Item lert 0 1 string e ItemCost 0 1 string fe OptionTrackingDetailsType e OptionNumber 0 1 string e OptionQty 0 1 string e OptionSelect 0 1 string e OptionQtyDelta 0 1 string e Option lert 0 1 string e OptionCost 0 1 string Field Description HostedButtonID xs string The ID of the hosted button whose inventory you want to set TrackInv xs string Whether to track inventory levels associated with the button It is one of the following values e 0 do not track inventory e 1 track inventory Button Manager SOAP API April 2012 51 52 Button Manager API Reference BMGetlnventory API Operation Field Description TrackPnl xs string Whether to track the gross profit associated with i
52. lid 11924 Invalid Argument The button image URL specified is invalid 11925 Invalid Argument The button type specified is invalid 11926 Invalid Data One of the parameters specified using ButtonVar is invalid 11927 Invalid Argument The buy now button text specified is invalid 11928 Invalid Argument The email or merchant ID specified is invalid 11929 Invalid Data A cart button must have an item name and amount specified 11930 Invalid Data A gift certificate button must have a valid shopping URL specified 11931 Invalid Argument The subscription button text specified is invalid 11932 Invalid Data You must specify a corresponding number of entries for option names and selections 11933 Invalid Data You cannot skip index numbers for option selections Option selections must be specified sequentially 11934 Invalid Data You must specify the same number of entries for option prices and selections 11936 Invalid Data You cannot specify both an item price and prices for individual selections within an option 11937 Invalid Argument A text box name specified is invalid Text box names must not exceed 64 characters Button Manager SOAP API April 2012 25 Button Manager API Reference BMUpdateButton API Operation Error Code Short Message Long Message Correcting This Error 11938 Invalid Argument The button code value specified is invalid 11940 Invalid Argument An option name specified is invalid Option n
53. lt for Buy Now and Add to Cart buttons e SERVICES button is used to purchase services ButtonVar xs string Optional HTML standard button variables Option Details Fields Field Description Opt ionName xs string Optional The menu name Button Manager SOAP API April 2012 21 4 Button Manager API Reference BMCreateButton API Operation Field Description OptionSelectionDetails ns OptionSelectionDetailsType Optional Menu items Option Selection Details Fields OptionSelection Price OptionType PaymentPeriod xs string Optional The menu item s name xs string Optional The price associated with the first menu item NOTE If you specify a price you cannot set a button variable to amount ebl OptionTypeListType Optional The installment option type for an OPTIONNNAME which is one of the following values e FULL Payment in full e VARIABLE Variable installments e EMI Equal installments NOTE Only available for Installment Plan buttons ns InstallmentDetailsType Optional Information about an installment option Installment Details BillingPeriod BillingFrequency TotalBillingCycles Amount ebl BillingPeriodType Optional The installment cycle unit which is one of the following values e NoBillingPeriodType None default Day Week SemiMonth Month Year xs int Optional The installment cycle frequency in units e
54. n Response Fields Field Description Website xs string HTML code for web pages Email xs string Code for email links and links in other documents that support external links 32 April 2012 Button Manager SOAP API Button Manager API Reference BMUpdate Button API Operation Field Description HostedButtonID xs string ID of a PayPal hosted button BMUpdateButton Errors Error Code Short Message Long Message Correcting This Error 10001 Internal Error Internal Error 11923 Invalid Argument The button image value specified is invalid 11924 Invalid Argument The button image URL specified is invalid 11925 Invalid Argument The button type specified is invalid 11926 Invalid Data One of the parameters specified using ButtonVar is invalid 11927 Invalid Argument The buy now button text specified is invalid 11928 Invalid Argument The email or merchant ID specified is invalid 11929 Invalid Data A cart button must have an item name and amount specified 11930 Invalid Data A gift certificate button must have a valid shopping URL specified 11931 Invalid Argument The subscription button text specified is invalid 11932 Invalid Data You must specify a corresponding number of entries for option names and selections 11933 Invalid Data You cannot skip index numbers for option selections Option selections must be specified sequentially 11934 Invalid Data You must specify the same number of entrie
55. nal The installment option type for an OPTIONNNAME which is one of the following values e FULL Payment in full e VARIABLE Variable installments e EMI Equal installments NOTE Only available for Installment Plan buttons ns InstallmentDetailsType Optional Information about an installment option Installment Details BillingPeriod BillingFrequency TotalBillingCycles Amount ebl BillingPeriodType Optional The installment cycle unit which is one of the following values e NoBillingPeriodType None default Day Week SemiMonth Month Year xs int Optional The installment cycle frequency in units e g if the billing frequency is 2 and the billing period is Month the billing cycle is every 2 months The default billing frequency is 1 xs int Optional The total number of billing cycles regardless of the duration of a cycle 1 is the default xs string Optional The base amount to bill for the cycle 30 April 2012 Button Manager SOAP API Button Manager API Reference b BMUpdate Button API Operation ShippingAmount xs string Optional The shipping amount to bill for the cycle in addition to the base amount TaxAmount xs string Optional The tax amount to bill for the cycle in addition to the base amount Button Language Options The button language must be compatible with the country identified by the country code Country Button Language Option
56. nce is not offered fallback_insura Optional Insurance amount to use as a fallback if the callback nce_amount response times out Include the fallback insurance option offered HTML variable if you specify an insurance amount The fallback insurance amount applies to all shipping options that you specify Instant Update Variables for Dimensions of Individual Items Shipping charges are calculated sometimes by using the dimensions of individual items in the shopping cart Include the following optional dimensional variables below in the Cart Upload command to provide the information to your callback server HTML Variables to Set Up an Instant Update Payment for Dimension Based Shipping Charges Required or Character Name Optional Description Length height x Optional Height of item x in the shopping cart Allowable values are positive integers height unit Optional Unit of measure for the values specified by the height x values Allowable values are any values that you choose to provide PayPal passes the value to your callback server in callback requests width x Optional Width of item x in the shopping cart Allowable values are positive integers width unit Optional Unit of measure for the value specified by width x Allowable values are any values that you choose to provide PayPal passes the value to your callback server in callback requests length x Optional Length of item x in the shopping cart Allowable values are positive
57. not prompt for an address e 2 prompt for an address and require one The default is 0 return Optional The URL to which PayPal redirects buyers browser after 1 024 they complete their payments For example specify a URL on your site that displays a Thank you for your payment page Default PayPal redirects the browser to a PayPal webpage rm Optional Return method The FORM METHOD used to send data to the 1 URL specified by the return variable Allowable values are e 0 all shopping cart payments use the GET method e 1 the buyer s browser is redirected to the return URL by using the GET method but no payment variables are included e 2 the buyer s browser is redirected to the return URL by using the POST method and all payment variables are included The default is 0 NOTE The rm variable takes effect only if the return variable is set Button Manager SOAP API April 2012 73 74 HTML Variables for PayPal Payments Standard HTML Variables for Filling Out PayPal Checkout Pages Automatically Required or Character Name Optional Description Length cbt Optional Sets the text for the Return to Merchant button on the 60 PayPal Payment Complete page For Business accounts the return button displays your business name in place of the word Merchant by default For Donate buttons the text reads Return to donations coordinator by default NOTE The cbt variable takes effect
58. nse e BMUpdateButton Errors BMGetButtonDetails Request The request includes only the ID of the hosted button whose details you want to obtain o MbstractReguestType e DetailLewel 0 DetaillevelCodeType e ErrorLanguage 0 1 string e Version string fe any 0 1 BMGetButtonDetailsRequestType ees e HostedButtonID string Button Manager SOAP API April 2012 37 Button Manager API Reference BMGetButtonDetails API Operation BMGetButtonDetails Request Fields Field Description HostedButtonID xs string Required The ID of the hosted button whose details you want to obtain BMGetButtonDetails Response The response fields contain all non inventory information related to the button te AbstractResponse Type ButtonTypeType Timestamp Ack 0 1 gt CorrelationID 0 1 Errors Version gt Build alany ss ish ieee e OptionName 38 e Website 0 e Email 0 e Mobile 0 e HostedButtonID 0 e ButtonType 0 e ButtonCode 0 e ButtonSubType 0 e ButtonYar o e OptionDetails 0 e TextBox 0 e ButtonImage 0 e ButtonImageURL 0 e BuyNowText 0 e subscribeText O e ButtonCountry 0 ButtonLanguage 0 0 BMGetButtonDetailsResponseType 1 1 1 1 1 1 1 1000 5 2 1 1 1 1 1 1 dateTime AckCodeType ButtonCodeType string ErrorType Butt
59. nt is applied regardless of the quantity of items purchased Valid only for Buy Now and Add to Cart buttons discount_amount Optional Discount amount associated with each additional quantity of 2 the item It must be equal to or less than the selling price of the item A discount_amount must also be specified as greater than or equal to 0 for discount_amount2 to take effect Valid only for Buy Now and Add to Cart buttons discount_rate Optional Discount rate percentage associated with an item It must be set to a value less than 100 If you do not set discount_rate2 the value in discount rate applies only to the first item regardless of the quantity of items purchased Valid only for Buy Now and Add to Cart buttons discount_rate2 Optional Discount rate percentage associated with each additional quantity of the item It must be equal to or less 100 A discount_rate must also be specified as greater than or equal to 0 for discount rate to take effect Valid only for Buy Now and Add to Cart buttons Button Manager SOAP API April 2012 57 A HTML Variables for PayPal Payments Standard HTML Variables for Individual Items Name Required or Optional Description Character Length discount num item name item number quantity shipping shipping2 Optional See description See description Optional Optional Optional Number of additional quantities of the item to which the discoun
60. nventory changes It is one of the following values e 0 do not track the gross profit e 1 track the gross profit NOTE The gross profit is calculated as the price of the item less its cost multiplied by the change in the inventory level since the last call to BMSet Inventory ebl ItemTrackingDetails Item tracking details for the button OptionIndex xs string Option index which identifies the button Option index 0 is the menu that contains the price if one exists otherwise it is the first menu without a price Character length and limitations 1 single byte alphanumeric character ebl OptionTrackingDetails Option tracking details for menu items associated with the button Soldout URL xs string The URL to which the buyer s browser is redirected when the inventory drops to 0 NOTE A value in this field also prevents a sale when the inventory drops to 0 otherwise sales can continue even when inventory is unavailable Character length and limitations 127 single byte alphanumeric characters ltem Tracking Details Fields ItemNumber xs string The ID for an item associated with this button ItemQty xs string The current inventory level of the item associated with this button ItemQtyDelta xs string Not used ItemAlert xs string The quantity of the item associated with this button below which PayPal sends you an email notification ItemCost xs string The cost of the item associated with this button April 2012 Button Manager SOAP
61. on an integer value in the allowable range for the units of duration that you specify with t 1 El See Trial period 1 units of duration Required if you specify al 1 description Allowable values are e D for days allowable range for p2 is 1 to 90 e W for weeks allowable range for p2 is 1 to 52 e M for months allowable range for p2 is 1 to 24 e Y for years allowable range for p2 is 1 to 5 a2 Optional Trial period 2 price Can be specified only if you also specify al p2 See Trial period 2 duration Required if you specify a2 Specify 2 description an integer value in the allowable range for the units of duration that you specify with t2 t2 See Trial period 2 units of duration 1 description Allowable values are e D for days allowable range for p2 is 1 to 90 e W for weeks allowable range for p2 is 1 to 52 e M for months allowable range for p2 is 1 to 24 e Y for years allowable range for p2 is 1 to 5 a3 Required Regular subscription price p3 Required Subscription duration Specify an integer value in the 2 allowable range for the units of duration that you specify with t 3 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard AT HTML Variables for Recurring Payments Buttons Required or Character Name Optional Description Length 3 Required Regular subscription units of duration 1 Allowable values are e D for days allowable range for p3 is 1 to 90 e W for weeks allowable
62. onSubTypeType string E OptionDetailsType string e OptionName string e OptionSelectionDetails 0 100 OptionSelectionDetailsType ButtonImageType string BuyNowTextType string i SubscribeTextType string string CountryCodeType ButtonTypeType ButtonCodeType ButtonSubTypeType string OptionDetailsType string ButtonImageType string BuyNowTextType SubscribeTextType CountryCodeType string E OptionSelectionDetailsType string e OptionSelection string e OptionSelectionDetails 0 100 OptionSelectionDetailsType e Price 0 1 string e OptionType 0 1 OptionTypeListType e PaymentPeriod 0 10 InstallmentDetailsType April 2012 Button Manager SOAP API E o ptionS electionDetailsT ype e OptionSelection e Price e OptionType e PaymentPeriod 0 10 InstallmentDetailsType string OptionTypeListType Button Manager API Reference oo BMGetButtonDetails API Operation OptionTypeListType InstallmentDetailsType string e BillingPeriod 0 1 BilingPeriodType e BilingFrequency 0 1 int e TotalBillingCycles 0 1 int e Amount 0 1 string e Shipping4mount 0 1 string e TaxAmount 0 1 string BMGetButtonDetails Response Fields Field Description ButtonType ButtonCode ButtonSubType HostedButtonID Website Email ButtonVar ebl ButtonTypeType The kind of button It is one of the follo
63. onType 0 1 OptionTypeListType BillingPeriod 0 1 BilingPeriodType E PaymentPeriod 0 10 InstallmentDetailsType e BilingFrequency 0 1 int e TotalBillingCycles 0 1 int e Amount 0 1 string e Shipping amp mount 0 1 string e TaxAmount 0 1 string Button Manager SOAP API April 2012 27 4 Button Manager API Reference BMUpdateButton API Operation BMUpdateButton Request Fields Field Description HostedButtonID xs string Required The ID of the hosted button you want to modify ButtonType ebl ButtonTypeType Required The kind of button you want to update It is one of the following values e BUYNOW Buy Now button e CART Add to Cart button e GIFTCERTIFICATE Gift Certificate button e SUBSCRIBE Subscribe button e DONATE Donate button e UNSUBSCRIBE Unsubscribe button e VIEWCART View Cart button e PAYMENTPLAN Installment Plan button since version 63 0 e AUTOBILLING Automatic Billing button since version 63 0 NOTE You cannot change the kind of button after the button has been created ButtonCode ebl ButtonCodeType Optional The kind of button code to create It is one of the following values e HOSTED A secure button stored on PayPal default for all buttons except View Cart and Unsubscribe e ENCRYPTED An encrypted button not stored on PayPal default for View Cart button e CLEARTEXT An unencrypted
64. optionDetails gt 10 A J rype gt lt buttonImage gt lt value gt lt m value gt REG lt m value gt lt value gt lt buttonImage gt lt buttonImageURL gt lt buttonImageURL gt Button Manager SOAP API April 2012 17 Using the Button Manager API With SOAP Tracking Inventory for a Button Using SOAP lt buyNowText gt lt value gt lt m__value gt BUYNOW lt m__value gt lt value gt lt buyNowText gt lt subscribeText gt lt value gt lt m value gt SUBSCRIBE lt m value gt lt value gt lt subscribeText gt lt buttonCountry gt lt value gt lt m value gt US lt m value gt lt value gt lt buttonCountry gt lt buttonLanguage gt lt buttonLanguage gt lt com paypal soap api BMCreateButtonRequestType gt Tracking Inventory for a Button Using SOAP The example for a button lt com paypal shows the SOAP parameters that enable tracking of inventory and profit and loss L soap api BMSet InventoryRequestType gt lt hostedButtonID gt 41 lt hostedButtonID gt lt trackInv gt 1 lt trackInv gt lt trackPn L gt 1 lt trackPnl gt lt itemTrackingDetails gt lt itemNumber gt 234234 lt itemNumber gt lt itemQty gt 10 lt itemQOty gt lt itemAlert gt 2 lt itemAlert gt lt itemCost gt 4 lt itemCost gt lt itemTrackingDetails gt lt soldoutURL gt http www YourSoldOutLandingP
65. or you and also lets your buyer know if the item is sold out You can specify inventory tracking on an item by item basis and also by option such as color or size within the item An e mail alerts you if inventory falls below the threshold you specify If an item is sold out you can specify whether or not to accept a payment anyway Optionally you can specify a URL where your buyer s browser is redirected if the item is sold out You can also enable profit and loss tracking for an item or option associated with a button If you enable this feature you must provide the cost of the item or option PayPal then calculates your gross profit which is the selling price of the item less the specified cost Inventory Management for Digital Downloads If you use hosted buttons you can chose to specify a list of download keys which are keys that you define and are associated with the item being sold These keys are useful when you want to sell digital goods with a key to enable access To use this feature you set the inventory for the button to include one or more download keys up to a maximum of 1 000 keys These keys are then available when you get the inventory for a button For example when a customer orders software or music you could obtain an unused key from the list of download keys and email it to your customer so they can download the item You are responsible for choosing the appropriate key from the list and how it is used PayP
66. r Default No handling charges are included Pass through variable you can use to identify your invoice number for this purchase Default No variable is passed back to you Cart wide tax overriding any individual item tax_x value If profile based shipping rates are configured with a basis of weight PayPal uses this value to calculate the shipping charges for the payment This value overrides the weight values of individual items Allowable values are decimals numbers with 2 significant digits to the right of the decimal point The unit of measure if weight_cart is specified Allowable values are e lbs e kgs The default value is lbs Character Length 1 256 127 HTML Variables for Shopping Carts HTML variables for shopping carts can be used with Add to Cart buttons as well as with third party shopping carts or custom carts that initiate payment processing with the Cart Upload command Button Manager SOAP API April 2012 63 A HTML Variables for PayPal Payments Standard HTML Variables for Shopping Carts HTML Variables for Shopping Carts Required or Character Name Optional Description Length add See Add an item to the PayPal Shopping Cart 1 description This variable must be set as follows add 1 The alternative is the display 1 variable which displays the contents of the PayPal Shopping Cart to the buyer If both add and display are specified display takes preceden
67. range for p3 is 1 to 52 e M for months allowable range for p3 is 1 to 24 e Y for years allowable range for p3 is 1 to 5 src Optional Recurring payments Subscription payments reoccur unless 1 subscribers cancel their subscriptions before the end of the current billing cycle or you limit the number of times that payments recur with the value that you specify for srt Allowable values are e 0 subscription payments do not recur e 1 subscription payments recur The default is 0 srt Optional Recurring times Number of times that subscription 2 payments recur Specify an integer above 1 Valid only if you specify src 1 sra Optional Reattempt on failure If a recurring payment for a legacy 1 subscription fails in which the subscription ID starts with S PayPal attempts to collect the payment two more times before canceling the subscription otherwise when the subscription ID starts with I the profile is suspended after the attempt instead of cancelled Allowable values are e 0 do not reattempt failed recurring payments e 1 reattempt failed recurring payments before canceling or suspending The default is 1 no_note Required Do not prompt buyers to include a note with their payments 1 Allowable values for Subscribe buttons e hide the text box and the prompt For Subscribe buttons always include no_note set to 1 custom Optional User defined field which PayPal passes through the system 255 and returns to
68. rged an amount according to the shipping methods they choose The cost of shipping each additional unit of this item If this variable is omitted and profile based shipping rates are configured buyers are charged an amount according to the shipping methods they choose This shipping variable is valid only for Buy Now and Add to Cart buttons 127 127 58 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard oa HTML Variables for Individual Items Required or Character Name Optional Description Length tax Optional Transaction based tax override variable Set this variable to a flat tax amount to apply to the payment regardless of the buyer s location This value overrides any tax settings set in your account profile Valid only for Buy Now and Add to Cart buttons Default Profile tax settings if any apply tax_rate Optional Transaction based tax override variable Set this variable toa 6 percentage that applies to the amount multiplied by the quantity selected during checkout This value overrides any tax settings set in your account profile Allowable values are numbers 0 001 through 100 Valid only for Buy Now and Add to Cart buttons Default Profile tax settings if any apply undefined_ Optional 1 allows buyers to specify the quantity 1 quantity e Optional for Buy Now buttons e Not used with other buttons weight Optional Weight of items If profile based shipping rates
69. s All countries not identified below e en English default Austria e de German default e en English Belgium e en English default e nl Dutch e fr French Canada e en English default e fr French China worldwide e en English default e zh Chinese France e fr French default e en English Germany e de German default e en English Hong Kong e zh Chinese default e en English Italy e it Italian default e en English Japan e ja Japanese default e en English Mexico e es Spanish default e en English Netherlands e nl Dutch default e en English Poland e pl Polish default e en English Spain e es Spanish default e en English Button Manager SOAP API April 2012 31 Button Manager API Reference BMUpdateButton API Operation Country Button Language Options Switzerland e de German default e fr French en English United States en English default fr French es Spanish zh Chinese BMUpdateButton Response The response contains the hosted button ID code for HTML in a website and code for a link in email te AbstractResponse Type e Timestamp 0 1 dateTime e Ack AckCodeType e CorrelationID 0 1 string e Errors 0 ErrorType Version string e Build string e any BMUpdateButtonResponseType e Website string e Email 0 1 string e Mobile 0 1 string e HostedButtonID 0 1 string BMUpdateButto
70. s Standard Cart Upload command Substitute lt Count ry gt with an appropriate two letter country code from codes defined by the ISO 3166 1 standard For example a Buy Now button on your website that you coded yourself might have the following line of code bn DesignerFotos_BuyNow_WPS_US NOTE HTML button code that you create on the PayPal website includes bn variables with valid values generated by PayPal 56 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard oa HTML Variables for Individual Items HTML Variables for Individual Items HTML variables for individual items specify information about a product or service for Buy Now and Add to Cart buttons or they specify information about a contribution for Donate buttons HTML Variables for Individual Items Required or Character Name Optional Description Length amount See The price or amount of the product service or contribution description not including shipping handling or tax If this variable is omitted from Buy Now or Donate buttons buyers enter their own amount at the time of payment e Required for Add to Cart buttons e Optional for Buy Now and Donate buttons e Not used with Subscribe or Buy Gift Certificate buttons discount_amount Optional Discount amount associated with an item It must be less than the selling price of the item If you specify discount amount and discount amount is not defined then this flat amou
71. s for option prices and selections 11936 Invalid Data You cannot specify both an item price and prices for individual selections within an option 11937 Invalid Argument text box name specified is invalid Text box names must not exceed 64 characters Button Manager SOAP API April 2012 33 Button Manager API Reference BMButtonSearch API Operation Error Code Short Message Long Message Correcting This Error 11938 Invalid Argument The button code value specified is invalid 11940 Invalid Argument An option name specified is invalid Option names must not exceed 64 characters 11941 Invalid Argument An option selection value specified is invalid Option selection values must not exceed 64 characters 11942 Invalid Argument An option price value specified is invalid Make sure any punctuation marks are in the correct places 11943 Invalid Argument The button country value specified is invalid 11945 Invalid Data The button country and language code combination specified is invalid 11947 Invalid Argument The tax rate specified is invalid Make sure any punctuation marks are in the correct places and value specified is in the range 0 0 to 100 11948 Invalid Argument The amount specified is invalid Make sure any punctuation marks are in the correct places 12210 Invalid Argument The currency code value specified is invalid 13117 Invalid Argument Subtotal amount is not valid 13118 Invalid Argument Tax
72. s must match as the following sample code shows lt input type hidden name osn value pay in 4 gt lt input type hidden name option selectn value pay in 4 gt e If the button offers plan options the value attribute of the radio button for plan option n The value attributes of both elements must match as the following sample code shows lt input type radio name osn value pay in 4 gt Pay in 4 installments lt input type hidden name option selectn value pay in 4 gt option_selectn_ Required e If the button offers plan options text next to the radio name button for plan option n e If the button offers a single plan text that describes the plan features For example you might use the text Pay in 4 installments Button Manager SOAP API April 2012 69 A HTML Variables for PayPal Payments Standard HTML Variables for Recurring Payments Buttons Required or Character Name Optional Description Length option selectn Required Whether the single plan or plan option n offered by the 1 type button is paid in full in equal periods or in variable periods Allowable values are e F pay in full at checkout e E pay in equal periods beginning at checkout or sometime later e V pay in variable periods beginning at checkout option_selectn_ Required Amount of payment m am If the value of option selectn type is E the value of this variable applies to all payments in the plan option selectn Requir
73. t address override 0 lt string gt lt buttonVar gt lt optionDetails gt lt com paypal soap api OptionDetailsType gt lt optionName gt DD1 lt opt ionName gt lt optionSelectionDetails gt lt com paypal soap api OptionSelectionDetailsType gt lt optionSelection gt AAAA lt optionSelection gt lt price gt 1 55 lt price gt lt com paypal soap api OptionSelectionDetailsType gt lt com paypal soap api OptionSelectionDetailsType gt lt opt ionSelect ion gt BBBB lt opt ionSelection gt lt price gt 10 55 lt price gt lt com paypal soap api OptionSelectionDetailsType gt lt com paypal lt optionsel soap api OptionSelectionDetailsType gt lect ion gt CCCCC lt optionSelection gt lt price gt 10 55 lt price gt lt com paypal soap api OptionSelectionDetailsType gt lt optionSelectionDetails gt lt com paypal soap api OptionDetailsType gt lt com paypal soap api OptionDetailsType gt lt opt ionName gt DD2 lt opt ionName gt lt optionSelectionDetails gt lt com paypal soap api OptionSelectionDetai lt optionSelection gt XXXX lt optionSelection gt lt com paypal soap api OptionSelectionDetailsType gt lt com paypal soap api OptionSelectionDetailsType gt lt optionSelection gt ZZZZ lt optionSelection gt lt com paypal soap api OptionSelectionDetailsType gt lt optionSelectionDetails gt lt com paypal soap api OptionDetailsType gt lt
74. t applies Applicable when you use discount amount2 or discount rate2 Use this variable to specify an upper limit on the number of discounted items Valid only for Buy Now and Add to Cart buttons Description of item If this variable is omitted buyers enter their own name during checkout e Optional for Buy Now Donate Subscribe Automatic Billing Installment Plan and Add to Cart buttons e Not used with Buy Gift Certificate buttons Pass through variable for you to track product or service purchased or the contribution made The value you specify is passed back to you upon payment completion This variable is required if you want PayPal to track inventory or track profit and loss for the item the button sells Number of items If profile based shipping rates are configured with a basis of quantity the sum of quantity values is used to calculate the shipping charges for the payment PayPal appends a sequence number to identify uniquely the item in the PayPal Shopping Cart for example quantity I quantity2 and so on NOTE The value for quantity must be a positive integer Null zero or negative numbers are not allowed The cost of shipping this item If you specify shipping and shipping2 is not defined this flat amount is charged regardless of the quantity of items purchased This shipping variable is valid only for Buy Now and Add to Cart buttons Default If profile based shipping rates are configured buyers are cha
75. the merchant account Character length and limitations 127 single byte characters item number Item number or ID Character length and limitations 127 single byte alphanumeric characters le If specified it overrides the value set in the Butt onCode field For a complete list of HTML variables and complete information see HTML Variables for PayPal Payments Standard Creating a Button Using SOAP The example sets up a SOAP request message to create a button lt com paypal soap api BMCreateButtonRequestType gt lt buttonType gt lt value gt lt m value gt CART lt m value gt lt value gt lt buttonType gt lt buttonCode gt lt value gt lt m__value gt HOSTED lt m__value gt lt value gt lt buttonCode gt lt buttonSubType gt lt value gt lt m__value gt PRODUCTS lt m__value gt lt value gt lt buttonSubType gt lt buttonVar gt lt string gt business XX usbiz paypal com lt string gt lt string gt item_name Item 123 lt string gt April 2012 Button Manager SOAP API Using the Button Manager API With SOAP Creating a Button Using SOAP lt string gt item_number 1234 lt string gt lt string gt shipping 0 50 lt string gt lt string gt tax rate 2 50 lt string gt lt string gt addressl lt string gt lt string gt state lt string gt lt string gt city lt string gt lt string gt zip lt string gt lt string gt no shipping 0 lt string gt lt string g
76. ton Manager API Overview The PayPal Payments Standard previously known as Website Payments Standard Button Manager API lets you programatically create manage edit and delete PayPal Payment Standard buttons which are the same kind of buttons that you can create from the PayPal Profile Hosted buttons created by this API reside on PayPal and can use all features including inventory management however you can use this API to create code for non hosted Standard buttons as well e Button Manager Introduction e Generated Button Code e Button Hosting e Hosted Button Manipulation e Inventory Management Using Hosted Buttons e Inventory Management for Digital Downloads e Button Manager API Summary e Hosted Solution Links e Granting Third Party Permission for APIs Button Manager Introduction You should consider creating and managing your buttons with the Button Manager API when you are creating more than just a few PayPal Payment Standard buttons or when you manage buttons for others for example if you provide a shopping cart for merchants The Button Manager API enables you to manage PayPal Payment Standard buttons programatically in the same way that you can manage them on PayPal from the My Saved Buttons page of your Profile NOTE You can access your My Saved Buttons page on PayPal by choosing My Saved Buttons from the Profile s My selling tools If no buttons exist the menu item is Create New Button You can use the
77. tonStatusType Required The new status of the button It is one of the following values e DELETE the button is deleted from PayPal BMManageButtonStatus Response The response does not include any fields that are specific to the BMManageButtonStatus API operation BMManageButtonStatus Errors Error Code Short Message Long Message Correcting This Error 10001 11950 11951 11951 Internal Error Invalid Data Invalid Argument Invalid Argument Internal Error A hosted button ID must be specified The hosted button ID specified is invalid The hosted button ID specified is invalid 42 April 2012 Button Manager SOAP API Button Manager API Reference b BMSetinventory API Operation Error Code Short Message Long Message Correcting This Error 11992 Invalid Argument You do not have permissions to access this button Please check the hosted button ID and try again 11993 Invalid Argument The button status value specified is not valid BMSetinventory API Operation Use the BMSet Inventory API operation to set the inventory level and inventory management features for the specified button When you set the inventory level for a button PayPal can track inventory calculate the gross profit associated with sales send you an alert when inventory drops below a specified quantity and manage sold out conditions e BMSetInventory Request e BMSetInventory Response e BMSetInventory Errors
78. ttonSearchResultType gt Timestamp 0 1 dateTime HostedButtonID 0 1 string Ack AckCodeType ButtonType 0 1 string CorrelationID 0 1 string ItemName 0 1 string Errors 0 ErrorType gt ModifyDate 0 1 dateTime Version string Build string any BMButtonSearch Response Fields Name Description ebl ButtonSearchResult Search results ButtonSearchResult HostedButtonID xs string The hosted button ID HButtonType xs string The hosted button ID ItemName xs string The item name ModifyDate xs dateTime The date created or last changed 36 April 2012 Button Manager SOAP API Button Manager API Reference BMGetButtonDetails API Operation BMButtonSearch Errors Error Code Short Message Long Message Correcting This Error 10001 Internal Error Internal Error 11994 Search Warning You have exceeded the maximum number of buttons that can be returned Please adjust your seach parameters if required 11997 Invalid Argument A start date value must be specified 11998 Invalid Argument The start date specified is invalid 11999 Invalid Argument The end date specified is invalid BMGetButtonDetails API Operation Use the BMGetButtonDetails API operation to obtain information about a hosted PayPal Payments Standard button You can use this information to set the fields that have not changed when updating a button e BMGetButtonDetails Request e BMGetButtonDetails Respo
79. um billing limits in a text box or choose from a list of maximum billing limits that you specify Allowable values are e max limit own your button displays a text box for buyers to enter their own maximums above a minimum billing limit that you set with the min_amount variable e max limit defined your button displays a dropdown menu of product options with prices to let buyers choose their maximum billing limits The minimum monthly billing limit if you have one Valid only if set customer limit max limit own 68 April 2012 Button Manager SOAP API HTML Variables for PayPal Payments Standard Feen HTML Variables for Recurring Payments Buttons Installment Plan Buttons HTML Variables Required or Character Name Optional Description Length disp tot Optional Display the total payment amount to buyers during checkout 1 Allowable values are e y display the total e N do not display the total The default is N option_index Required e If the button offers a single plan use 0 or use a number 1 not used for option fields without prices such as size and color e If the button offers plan options the cardinal number of the option field on0 through on9 with plan payment options Include option_index if the number for the single plan or options field is not 0 option selectn Required e Ifthe button offers a single plan the value attribute ofa 8 hidden input field named osn The value attributes of both element
80. utton Buy Now Donation Subscribe Add to Cart and View Cart buttons You can also use HTML variables supported the Cart Upload command Technical HTML Variables Technical HTML variables control how PayPal responds technically when people click PayPal Payments Standard payment buttons or when third party or custom carts initiate payment processing with the Cart Upload command They also control how your buttons interact with special PayPal features Allowable Values for the cmd HTML Variable Value of cmd Description _xclick The button that the person clicked was a Buy Now button _cart For shopping cart purchases The following variables specify the kind of shopping cart button that the person clicked e add Add to Cart buttons for the PayPal Shopping Cart e display View Cart buttons for the PayPal Shopping Cart e upload The Cart Upload command for third party carts oe gift certificate The button that the person clicked was a Buy Gift Certificate button _xclick subscriptions The button that the person clicked was a Subscribe button _xclick auto billing The button that the person clicked was an Automatic Billing button _xclick payment plan The button that the person clicked was an Installment Plan button _donations The button that the person clicked was a Donate button _s xclick The button that the person clicked was protected from tampering by using encryption or the button was saved in the merchant s PayPal
81. wing values BUYNOW Buy Now button CART Add to Cart button GIFTCERTIFICATE Gift Certificate button SUBSCRIBE Subscribe button DONATE Donate button UNSUBSCRIBE Unsubscribe button VIEWCART View Cart button PAYMENTPLAN Installment Plan button since version 63 0 AUTOBILLING Automatic Billing button since version 63 0 ebl ButtonCodeType The kind of button code It is one of the following values e HOSTED A secure button stored on PayPal e ENCRYPTED An encrypted button not stored on PayPal e CLEARTEXT An unencrypted button not stored on PayPal ebl ButtonSubTypeType The use of button It is one of the following values e PRODUCTS button is used to purchase products e SERVICES button is used to purchase services xs string ID of a PayPal hosted button xs string HTML code for web pages xs string Code for email links and links in other documents that support external links xs string HTML standard button variables Button Manager SOAP API April 2012 39 Button Manager API Reference BMGetButtonDetails API Operation Option Details Fields Field Description Opt ionName OptionSelectionDetails xs string Optional The menu name ns OptionSelectionDetailsType Optional Menu items Option Selection Details Fields OptionSelection Price OptionType PaymentPeriod xs string Optional The menu item s name
82. y used with Hosted Solution and the parameters associated with this kind of button are secure Token buttons are dynamic and initiate the Hosted Solution checkout flow They have a lifetime of approximately 2 hours if not used Hosted Button Manipulation When you create a hosted button the response includes an ID that allows you to manipulate the button using the Button Manager API Do not confuse a hosted button with a button used as part of Hosted Solution which is a product that supports token encrypted and cleartext buttons With hosted buttons you can Get a list of all hosted buttons which lets you identify buttons for further programmatic manipulation Get details about a hosted button which lets you to identify the parameters and values associated with a button April 2012 Button Manager SOAP API PayPal Payments Standard Button Manager API Overview LM Inventory Management Using Hosted Buttons e Update a hosted button which lets you to change individual parameters such as price in a hosted button e Manage hosted button status currently you can only delete a button e Get and set inventory information associated with the button Inventory Management Using Hosted Buttons You can get or set the inventory level for the item associated with a hosted button You can also track inventory on options within an item such as color or size Ifyou enable inventory management for a button PayPal tracks inventory f
83. you in your merchant payment notification email Subscribers do not see this field invoice Optional User defined field which must be unique with each 127 subscription The invoice number is shown to subscribers with the other details of their payments Button Manager SOAP API April 2012 67 A HTML Variables for PayPal Payments Standard HTML Variables for Recurring Payments Buttons Required or Character Name Optional Description Length modify Optional Modification behavior 1 Allowable values are e O allows subscribers only to sign up for new subscriptions e 1 allows subscribers to sign up for new subscriptions and modify their current subscriptions e 2 allows subscribers to modify only their current subscriptions The default value is 0 usr_manage Optional Set to 1 to have PayPal generate usernames and initial 1 passwords for subscribers Automatic Billing Button HTML Variables Required or Character Name Optional Description Length max_text Optional A description of the automatic billing plan The button set_customer_li Required mit min_amount Optional creation tool uses the same value that you enter in the Description field Your button passes the description to PayPal to augment the item name in authorization notices and transaction details If you write the HTML code for your button manually the value of max_text and the text above the button can differ Specify whether to let buyers enter maxim

PayPal Website Payments Standard - 2012 - Button Manager API (SOAP) User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents