Home

PayPal Website Payments Standard - 2009 - Button Manager API (NVP) User Guide

1. NOTE A corresponding option selection in osO must also be set e Optional for Buy Now and Add to Cart buttons e Not used with Donate Subscribe or Buy Gift Certificate buttons HTML Variables for Payment Transactions HTML variables for payment transactions provide information about entire transactions regardless of the individual items involved with the payment You can use these variables with Add to Cart buttons and the Cart Upload command June 2009 Button Manager NVP API HTML Variables for Website Payments Standard E HTML Variables for Payment Transactions HTML Variables for Payment Transactions Required or Character Name Optional Description Length address _ Optional 1 The address specified in prepopulation variables overrides the 1 override PayPal member s stored address The payer is shown the passed in address but cannot edit it No address is shown if the address is not valid such as missing required fields like country or is not included at all currency _ Optional The currency of the payment The default is USD 3 code custom Optional Passthrough variable never presented to the payer 256 Default No variable is passed back to you handling Optional Handling charges This is not quantity specific The same handling cost applies regardless of the number of items on the order Default No handling charges are included invoice Optional Passthrough variable you can use to identify your in
2. 16 June 2009 Button Manager NVP API Button Manager API Reference The Button Manager API enables you to programatically create edit and delete Website Payment 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 button maintenance and inventory management are only supported for hosted buttons e BMCreateButton API Operation MUpdateButton API Operation MButtonSearch API Operation MCreateButton 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 Website Payments Standard button You an create either a button that is hosted on PayPal or a non hosted button e BMCreateButton Request e 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 five menu items each of which can include up to 10 possible selections BMCreateButton Request Fields Field Description METHOD Required BMCreateButton Button Manager NVP API June 2009 17 Button Manager API Reference BMCreateButton API Operation Field Description BUTTONCODE BUTTONTYPE BUTTONSUBTYPE L
3. Optional The menu item s name It is a list of variables for each OPTIONNNAME in which x is a digit between 0 and 9 inclusive Optional The price associated with the first menu item It is a list of variables for each OPTIONONAME in which x is a digit between 0 and 9 inclusive NOTE If you specify a price you cannot set a button variable to amount BMGetButtonDetails Errors Error Code Short Message Long Message Correcting This Error 10001 11950 11951 11951 11992 Internal Error Invalid Data Invalid Argument 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 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 32 The request specifies the hosted button s ID and the status to which you want to set the button June 2009 Button Manager NVP API Button Manager API Reference BMSetInventory API Operation BMManageButtonStatus Request Fields Field Description METHOD Required BMManageButto
4. 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 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 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 wit
5. e 28 BMButtonSearch Errors 1 2 a 29 Button Manager NVP API June 2009 all Contents BMGetButtonDetails API Operation 2000220 eee 29 BMGetButtonDetails Request 0 000 eo 29 BMGetButtonDetails Response 22 2000 ee eee 30 BMGetButtonDetails Errors s e e sia a rietan edema 32 BMManageButtonStatus API Operation 2 aa e 32 BMManageButtonStatus Request 2 2 0 e e 32 BMManageButtonStatus Response 2 0 ee 33 BMManageButtonStatus Errors ooa aa uo 33 BMSetinventory API Operation 2 2 o 33 BMSetinventory Request a 34 BMSetinventory Response aoaaa a 35 BMSetinventory Errors lt ses ser carau aa a a a a 36 BMGetlnventory API Operation 2 0 0 a 38 BMGetlnventory Request aaou a a 38 BMGetlnventory Response aaau a 39 BMGetlnventory Errors aaau a 40 Chapter A HTML Variables for Website Payments Standard 41 Technical HTML Variables e eq sa wahoe aG a e o 41 HTML Variables for Individual Items 0 o ee 42 HTML Variables for Payment Transactions 0 0002 4 48 HTML Variables for Shopping Carts o 50 HTML Variables for Subscribe Buttons 2 2 0 2 00000 o 2 ee 52 HTML Variables for Displaying PayPal Checkout Pages 4 55 HTML Variables for Prepopulating PayPal Checkout Pages 58
6. 4 June 2009 Button Manager NVP API Preface This document describes the Button Manager API for NVP Intended Audience This document is intended for merchants and developers implementing Website Payment Standard buttons using an API Revision History Revision history for Website Payments Standard Button Manager API NVP TABLE P 1 Revision History Date Description 06 03 09 Added HTML Variable appendix and updated for version 57 0 03 31 09 Initial draft Button Manager NVP API June 2009 Na Revision History 6 June 2009 Button Manager NVP API Website Payments Standard Button Manager API Overview The Website Payments Standard Button Manager API allows you to programatically create manage edit and delete Website 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 Website Payment 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 Button Manager API Summary 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
7. BUTTONVARN L TEXTBOXn BUTTONIMAGE BUTTONIMAG EURL 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 button not stored on PayPal default for Unsubscribe button 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 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 Optional HTML standard button variables which are described in HTML Variables for Website Payments Standard 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 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 Optional The
8. Invalid Argument Invalid Argument Invalid Argument Invalid Data The buy now button text specified is invalid The email or merchant ID specified is invalid A cart button must have an item name and amount specified A gift certificate button must have a valid shopping URL specified The subscription button text specified is invalid You must specify a corresponding number of entries for option names and selections You cannot skip index numbers for option selections Option selections must be specified sequentially You must specify the same number of entries for option prices and selections You cannot specify both an item price and prices for individual selections within an option A text box name specified is invalid Text box names must not exceed 64 characters The button code value specified is invalid An option name specified is invalid Option names must not exceed 64 characters An option selection value specified is invalid Option selection values must not exceed 64 characters An option price value specified is invalid Make sure any punctuation marks are in the correct places The button country value specified is invalid The button country and language code combination specified is invalid Button Manager NVP API June 2009 27 Button Manager API Reference BMButtonSearch API Operation Error Code Short Message Long Message Correcting This Error 11947 Invalid
9. Items Required or Name Optional Description Character Length os0 Optional osl Optional option index See description Option selection of the buyer for the first option field on0 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 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 amountoO 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 Subscribe and Add to Cart 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 sele
10. inventory tracking on an item by item basis and also by option such as color or size within the item June 2009 Button Manager NVP API Website Payments Standard Button Manager API Overview Button Manager API Summary You are alerted by e mail if the inventory on hand 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 to which your buyer s browser is redirected if the item is sold out Additionally you can 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 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 BMGetInventory Obtain the inventory levels associated with a button BMSet Inventory Specify the inventory levels associated with a button 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 t
11. pixel gif width 1 height 1 gt lt form gt When you display a web page with this code this button appears Color Red 1000 Size Small v add to Can PayPal generated code for a link would be as follows https www sandbox paypal com cgi bin webscr cmd s xclickghosted button id 19218 For a link PayPal does not generate code for options Button Hosting Buttons that you can view on the My Saved Buttons page of your PayPal profile are called hosted buttons because they reside on PayPal The API can create three kinds of buttons hosted encrypted and clear text Button Manager NVP API June 2009 9 10 Website Payments Standard Button Manager API Overview Hosted Button Manipulation e 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 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 regards 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 only use an encrypted button if a hosted button cannot be used Clear
12. redirected to a PayPal web page HTML Variables for Prepopulating PayPal Checkout Pages HTML variables for prepopulating PayPal checkout pages let you specify information about the payer HTML Variables for Prepopulating Checkout Pages With Payer Information Required or Character Name Optional Description Length address 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 first name Optional First name 32 last_name Optional Last name 64 le Optional Sets the payer s language for the billing information log in page 2 only The default is US charset Optional Sets the character encoding for the billing information log in 21 page for the information you send to PayPal in your HTML button code and for the information that PayPal returns to you as a result of checkout processes initiated by the payment button The default is based on the character encoding settings in your account profile night_ Optional The area code for U S phone numbers or the country code for See phone a phone numbers outside the U S This will prepopulate the payer s description home phone number June 2009 Button Manager NVP API HTML Variables for Website Payments Standard HTML Variables for Prepopulating PayPal Checkout Pages Required or Character Name Optional Description Length night _ Optional The three digit prefix f
13. response fields contain all non inventory information related to the button BMGetButtonDetails Response Fields Field Description BUTTONTYPE BUTTONCODE BUTTONSUBTYPE HOSTEDBUTTONID W EBSITECODE EMATLLINK L BUTTONVARN TEXTBOXN The kind of button 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 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 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 ID of a PayPal hosted button HTML code for web pages Code for email links and links in other documents that support external links HTML standard button variables which are described in HTML Variables for Website Payments Standard It is a list of variables in which n is a digit between 0 and 9 inclusive Character length and limitations 63 single byte alphanumeric characters each xs string Text description for a menu item It is a list of variab
14. 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 Button Manager NVP API June 2009 21 a Button Manager API Reference BMUpdateButton API Operation Error Code Short Message Long Message Correcting This Error 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 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
15. 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 BMUpdateButton API Operation Use the BMUpdateButton API operation to modify a Website Payments Standard button that is hosted on PayPal This operation replaces all fields in the specified button therefore you must specify a value fore each field you want to include for the button whether or not it changed e BMUpdateButton Request e BMUpdateButton Response e BMUpdateButton Errors 22 June 2009 Button Manager NVP API Button Manager API Reference E BMUpdateButton 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 BMUpdateButton Request Fields Field Description METHOD Required BMUpdateButton HOSTEDBUTTONID Required The ID of the hosted button you want to modify BUTTONTYPE Required The kind of button you want to update 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 NOTE You cannot change the kind of button after the button has been created BUTTONCODE Optional The kind of button code to create
16. 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 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 BUTTONCODE field For a complete list of HTML variables and complete information see HTML Variables for Website Payments Standard Creating a Button Using NVP The example shows the NVP parameters for creating a hosted Add to Cart button of the standard size The button is also associated with menu items 14 June 2009 Button Manager NVP API Using the Button Manager API aa Tracking Inventory for Menu Items Using NVP amp BUTTONCODE HOSTED amp BUTTONTY PE CART L_BUTTONVARO business merchant abc com L_BUTTONVARI item name Wireless 20Mouse L BUTTONVAR2 amount 10 50 L_BUTTONVAR3 no_shipping 1 L_BUTTONVAR4 currency code USD L BUTT
17. 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 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 Specifically you can Get a list of all hosted buttons defined which allows you to obtain a list of all your buttons for further programatic manipulation Get details about a hosted button which allows you to identify the parameters and values associated with a button Update a hosted button which allows you to change individual parameters such as price in a hosted button Manage hosted button status currently you can only delete a button Get and set inventory information associated with the button Inventory Management Using Hosted Buttons If you use hosted buttons you can set inventory values for the item associated with the button and get inventory values for the item You can also track inventory on options within an item such as color size and so on If you enable inventory management for a button PayPal tracks inventory for you and also lets your buyer know whether the item is sold out You can specify
18. 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_rate2 to take effect Valid only for Buy Now and Add to Cart buttons discount_num Optional Number of additional quantities of the item to which the discount 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 Button Manager NVP API June 2009 43 fa HTML Variables for Website Payments Standard HTML Variables for Individual Items Name Required or Optional Character Description Length item name item number quantity shipping shipping2 tax tax rate See description Optional Optional Optional Optional Optional Optional Description of item If omitted payers enter their own name 127 at the time of payment e Optional for Buy Now Donate Subscribe and Add to Cart buttons e Not used with Buy Gift Certificate buttons Pass through variable for you to track product or service 127 purchased or the contribution made The value you specify passed back to you upon payment completion 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 transaction PayPal appends a sequence number to uniquely identify the item i
19. 4 June 2009 Button Manager NVP API HTML Variables for Website Payments Standard a HTML Variables for Individual Items Required or Character Name Optional Description Length 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 are configured with a basis of weight the sum of weight values is used to calculate the shipping charges for the transaction weight unit Optional The unit of measure if weight is specified Allowable values e lbs e kgs The defaults is Lbs on0 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 Subscribe and Add to Cart 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 7option field names 6 with Subscribe buttons by incrementing the option name index on0 through on6 e Optional for Buy Now Subscribe and Add to Cart buttons e Not used with Donate or Buy Gift Certificate buttons Button Manager NVP API June 2009 45 fa HTML Variables for Website Payments Standard HTML Variables for Individual
20. 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 The following example shows the PayPal code to display a hosted Add to Cart button for a wireless mouse June 2009 Button Manager NVP API Website Payments Standard Button Manager API Overview ES Button Hosting lt form target paypal action https www sandbox paypal com cgi bin webscr method post gt lt input type 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 0s1 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 lt input type hidden name currency code value USD gt 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
21. 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 BMButtonSearch API Operation Use the BMButtonSearch API operation to obtain a list of your hosted Website Payments Standard buttons e BMButtonSearch Request e BMButtonSearch Response e BMButtonSearch Errors BMButtonSearch Request The request contains optional fields that are not currently used All hosted buttons are automatically requested BMButtonSearch Request Fields Field Description METHOD Required BMButtonSearch STARTDATE Required Starting date for the search such as 12 01 09 ENDDATE Optional Ending date for the search such as 12 31 09 BMButtonSearch Response The response contains a list of all hosted buttons and their associated characteristics BMButtonSearch Response Fields 28 June 2009 Button Manager NVP API Button Manager API Reference E BMGetButtonDetails API Operation HOSTEDBUTTONIDN L BUTTONTYPEN y IT EMNAMEN L MODIFYDATEN The hosted button ID It is a list of variables in which n is a digit between 0 and 9 inclusive The hosted button ID It is a list of variables in which n is a digit between 0 and 9 inclusive The item name It is a list o
22. I Operation L OPTIONNSELECTX L OPTIONOPRICEX Optional The menu item s name It is a list of variables for each OPTIONNNAME in which x is a digit between 0 and 9 inclusive Optional The price associated with the first menu item It is a list of variables for each OPTIONONAME in which x is a digit between 0 and 9 inclusive NOTE If you specify a price you cannot set a button variable to 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 s 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 June 2009 Button Manager NVP API 25 26 Button Manager API Reference BMUpdateButton API Operation Country Button Language Options Poland e pl Polish default e en English Spain e es Spanish default e en English Switzerlan
23. 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 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 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 L BUTTONVARN Optional HTML standard button variables which are described in HTML Variables for Website Payments Standard 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 Button Manager NVP API June 2009 23 24 Button Manager API Reference BMUpdateButton API Operation Field Description L TEXTBOXN BUTTON IMAGE BUTTONIMAGEURL BUYNOWTEXT SUBSCRIBETEXT BUTTONCOUNTRY BUTTONLANGUAGE xs string Optional Text description for a menu item It is a list of variables in which n is a
24. L on your site that ur payment page Default The browser is redirected to a PayPal web page Return method The FORM MI ETHOD used to send data to the URL specified by the return variable after payment completion Allowable values e 0 all shopping cart transactions use the GET method e 1 the payer s browser is redirected to the return URL by the GET method and no transaction variables are sent e 2 the payer s browser is redirected to the return URL by the POST method and all transaction variables are also posted The default is 0 NOTE The rm variable take is also set s effect only if the return variable 2 90 1 024 1 Button Manager NVP API June 2009 57 58 HTML Variables for Website Payments Standard HTML Variables for Prepopulating PayPal Checkout Pages Required or Character Name Optional Description Length cbt Optional Sets the text for the Return to Merchant button on the PayPal 60 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 return variable must also be set cancel _ Optional A URL to which the payer s browser is redirected if payment is 1 024 return cancelled for example a URL on your website that displays a Payment Canceled page Default The browser is
25. ONVARS no_note 1 OPTIONONAME Color OPTIONOSELECTO Red L OPTIONOSELECT1 Blue L_OPTIONOSELECT2 Green L OPTIONOPRICEO 10 00 L OPTIONOPRICE1 8 00 L OPTIONOPRICE2 12 00 OPTIONINAME Size L OPTION1SELECTO Small L OPTIONISELECTI Large amp BUTTONIMAGE reg K O The button includes menus that allow you to specify the color and size Each color is associated with a specific price The button variables L_BUTTONVARO and such enable you to specify the same HTML variables as you ordinarily do using Website Payments Standard for information see HTML Variables for Website Payments Standard Tracking Inventory for Menu Items Using NVP The example shows the NVP parameters that enable tracking of inventory and profit and loss for three kinds of product whose option number specifies the position in the drop down menu for the option Button Manager NVP API June 2009 15 frame Using the Button Manager API Tracking Inventory for Menu Items Using NVP TRACKINV 1 TRACKPNL 1 OPTIONINDEX 0 L_OPTIONNUMBERO 1001 L OPTIONQTYO 100 L OPTIONALERTO 5 L OPTIONCOSTO 4 50 E INUMBER1 1002 L_OPTIONQTY1 200 L_OPTIONALERT1 5 L OPTIONCOST1 5 50 L_OPTIONNUMBER2 1003 QTY2 150 L OPTIONALERT2 5 COST2 5 00 amp SOLDOUTURL http mysoldoutpage com DMN MM MM MM OM MM SS SM E O U A L O Z
26. OPTIONSELECTN Optional The menu item s name in a dropdown menu It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L_OPTIONQTYDELTAN 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 It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L_OPTIONALERTN Optional The quantity of the option associated with this menu item below which PayPal sends you an email notification It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L_OPTIONCOSTnN Optional The cost of the option associated with this menu item It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive 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 consists of a transaction ID BMSetInventory Response Fields Field Description TRANSACTIONID Transaction ID Button Manager NVP API June 2009 35 a Button Manager API Reference BMSetInventory API Operation BMSetInventory Errors 36 Error Code Short Message Long Message Correcting This Error
27. PI Operation BMSetInventory Request The request specifies inventory values related to a hosted button as well as inventory values that are specific to each menu item associated with the button BMSetinventory Request Fields Field Description METHOD HOST TRACKINV TRACKPNL EDBUTTONID OPTIONINDEX SOLDOUTURL Required BMSetInventory Required The ID of the hosted button whose inventory you want to set 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 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 BMSetInventory 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 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
28. PayPal Website Payments Standard Button Manager API NVP For Professional Use Only Currently only available in English A usage Professional Uniquement Disponible en Anglais uniquement pour l instant Last updated June 2009 Button Manager NVP API Document Number 10089 en_US 200906 2009 PayPal Inc All rights reserved PayPal is a registered trademark of PayPal Inc The PayPal logo is a trademark of PayPal Inc Other trademarks and brands are the property of their respective owners The information in this document belongs to PayPal Inc It may not be used reproduced or disclosed without the written approval of PayPal Inc PayPal Europe Ltd is authorised and regulated by the Financial Services Authority in the United Kingdom as an electronic money institution PayPal FSA Register Number 226056 Notice of non liability PayPal Inc is providing the information in this document to you AS IS with all faults PayPal Inc makes no warranties of any kind whether express implied or statutory with respect to the information contained herein PayPal Inc assumes no liability for damages whether direct or indirect caused by errors or omissions or resulting from the use of this document or the information contained in this document or resulting from the application or use of the product or service described herein PayPal Inc reserves the right to make changes to any information herein without further notice Co
29. PayPal Shopping Cart e display View Cart buttons for the PayPal Shopping Cart e upload The Cart Upload command for third party carts _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 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 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 transaction in the form of Instant Payment Notification messages hosted_button Required for The identifier of a button that was saved in a merchant s See id buttons that PayPal account Allowable values are assigned by PayPal description have been when payments buttons are first created and saved saved in PayPal merchants PayPal accounts Sas NOTE A merchant s PayPal account can have a maximum AS not of 1 000 saved payment buttons allowed 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 42 June 2009 Button Manager NVP API HTML Variables for Website Payments Standard E HTML Variables for Individual Items HTML Variables for Individua
30. Website 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 Website 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 Selling Preferences column If no buttons have been created the menu item is Create New Button You can use the API to create the following types of Website Payment Standard buttons e Buy Now e Add to Cart and View Cart e Donate e Buy Gift Certificate e Subscribe and Unsubscribe The following buttons are some of those that you can create using the Button Manager API Button Manager NVP API June 2009 Website Payments Standard Button Manager API Overview Generated Button Code Generated Button Code When you create a button PayPal responds by providing code that you can paste into your web page or document PayPal generates code that you can use for the button which 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 buttons that can be created are available to merchants in every country for example German merchants cannot use Subscribe buttons even though they can be created through the
31. ariables that you can use e Technical HTML Variables on page 41 e HTML Variables for Individual Items on page 42 e HTML Variables for Payment Transactions on page 48 e HTML Variables for Shopping Carts on page 50 e HTML Variables for Subscribe Buttons on page 52 e HTML Variables for Displaying PayPal Checkout Pages on page 55 e HTML Variables for Prepopulating PayPal Checkout Pages on page 58 Technical HTML Variables Technical HTML variables control how PayPal responds technically when people click Buy Now Donation Subscribe Add to Cart and View Cart 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 Button Manager NVP API June 2009 41 fa HTML Variables for Website Payments Standard HTML Variables for Individual Items Allowable Values for the cmd HTML Variable Value of cmd Description _xclick The button that the person clicked was a Buy Now button _ donations The button that the person clicked was a Donate button _xclick subscriptions The button that the person clicked was a Subscribe button _oe gift certificate The button that the person clicked was a Buy Gift Certificate button _ cart For shopping cart purchases these additional variables specify the kind of shopping cart button that the person clicked e add Add to Cart buttons for the
32. bscribers with the other details of their transactions modify Optional Modification behavior Allowable values 1 e 0 allows subscribers to only create new subscriptions e 1 allows subscribers to modify their current subscriptions or sign up for new ones e 2 allows subscribers to only modify their current subscriptions The default value is 0 usr manage Optional Set to 1 to have PayPal generate usernames and initial passwords 1 for subscribers 54 June 2009 Button Manager NVP API HTML Variables for Website Payments Standard a 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 Button Manager NVP API June 2009 55 HTML Variables for Website Payments Standard HTML Variables for Displaying PayPal Checkout Pages HTML Variables for Displaying PayPal Checkout Pages 56 Required or Character Name Optional Description Length page style Optional The custom payment page style for checkout pages Allowable 30 values e paypal use the PayPal page style e primary use the page style that you 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
33. ctions as dropdown menus and up to 2 option selections as test boxes NOTE A corresponding option field on0 through on6 must defined e Optional for Buy Now Subscribe and Add to Cart buttons e Not used with Donate or Buy Gift Certificate buttons The cardinal number of the option field on0 through on9 that has product options with different prices for each option You must include option_index if the option field with prices is not on0 e Optional for Buy Now and Add to Cart buttons e Not used with Donate Subscribe or Buy Gift Certificate buttons Default 0 64 or 200 See description 64 or 200 See description 46 June 2009 Button Manager NVP API HTML Variables for Website Payments Standard E HTML Variables for Individual Items Required or Character Name Optional Description Length 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 next sample code shows lt option value small gt smal1 10 00 lt option gt lt input type hidden name option select0 value small gt e Optional for Buy Now and Add to Cart buttons e Not used with Donate Subscribe or Buy Gift Certificate buttons option amount0 Optional For priced options the amount that you want to charge for the 64 first option selection of the on0 dropdown menu Use only numeric values the currency is taken from the curre
34. d e de German default United States e fr French en English 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 BMUpdateButton Response Fields Field Description WEBSITECODE HTML code for web pages EMATLLINK Code for email links and links in other documents that support external links HOSTEDBUTTONID 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 June 2009 Button Manager NVP API Button Manager API Reference E BMUpdateButton API Operation Error Code Short Message Long Message Correcting This Error 11927 11928 11929 11930 11931 11932 11933 11934 11936 11937 11938 11940 11941 11942 11943 11945 Invalid Argument Invalid Argument Invalid Data Invalid Data Invalid Argument Invalid Data Invalid Data Invalid Data Invalid Data Invalid Argument Invalid Argument Invalid Argument
35. digit between 0 and 1 inclusive 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 xs string Optional The button s URL NOTE Specify either the kind of button image or the URL 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 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 Optional The country in which the transaction occurs See Country Codes for a list of country codes By default it is the merchant s country of registration with PayPal 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 IONNNAME Optional The menu name It is one or more variables in which n is a digit between 0 and 4 inclusive for hosted buttons otherwise it is a digit between 0 and 9 inclusive June 2009 Button Manager NVP API Button Manager API Reference E BMUpdateButton AP
36. eger value in the allowable range for the units of duration that you specify with t1 el See Trial period 1 units of duration Required if you specify al 1 description Allowable values e D for days allowable range for p1 is 1 to 90 e W for weeks allowable range for p1 is 1 to 52 e M for months allowable range for p1 is 1 to 24 e Y for years allowable range for p1 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 an 2 description integer value in the allowable range for the units of duration that you specify with t2 t2 See Trial period 2 units of duration Allowable values 1 description 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 allowable 2 range for the units of duration that you specify with t3 t3 Required Regular subscription units of duration Allowable values 1 D for days allowable range for p3 is 1 to 90 W for weeks allowable range for p3 is 1 to 52 M for months allowable range for p3 is 1 to 24 e e e e Y for years allowable range for p3 is 1 to 5 Button Manager NVP API June 2009 53 fa HTML Variables for Website Paymen
37. f variables in which n is a digit between 0 and 9 inclusive The date created or last changed It is a list of variables in which n is a digit between 0 and 9 inclusive BMButtonSearch Errors Error Code Short Message Long Message Correcting This Error 10001 11994 11997 11998 11999 Internal Error Search Warning Invalid Argument Invalid Argument Invalid Argument Internal Error You have exceeded the maximum number of buttons that can be returned Please adjust your seach parameters if required A start date value must be specified The start date specified is invalid The end date specified is invalid BMGetButtonDetails API Operation Use the BMGetButtonDetails API operation to obtain information about a hosted Website 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 Response e BMUpdateButton Errors BMGetButtonDetails Request The request consists of only the ID of the hosted button whose details you want to obtain Button Manager NVP API June 2009 29 Button Manager API Reference BMGetButtonDetails API Operation BMGetButtonDetails Request Fields Field Description METHOD Required BMGetButtonDetails HOSTEDBUTTONID Required The ID of the hosted button whose details you want to obtain BMGetButtonDetails Response The
38. hin an individual button June 2009 Button Manager NVP API Button Manager API Reference E BMSetInventory API Operation Error Code Short Message Long Message Correcting This Error 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 11975 Invalid Data The number of option quantity or option quantity delta values specified is greater than the number of option selections in the saved button 11976 Invalid Data You must specify either option quantity or option quantity delta values with a valid integer value 11977 Invalid Data An option quantity or option quantity delta value must not be specified when TrackInv is 0 11978 Invalid Argument Item alert must be specified as a positive integer 11979 Invalid Argument Item alert must not be specified when TrackInv is 0 11980 Invalid Data The number of option alert values specified is greater than the number of option selections in the saved button 11981 Invalid Argumen
39. image url Optional The URL of the 150x50 pixel image displayed as your logo in the 1 024 upper left corner of the PayPal checkout pages Default Your business name if you have a Business account or your email address if you have Premier or Personal account 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 GHD Optional The background color for the header of the checkout page 6 headerback_ Valid value is case insensitive six character HTML hexadecimal color color code in ASCII GHD Optional The border color around the header of the checkout page The 6 headerborder border is a 2 pixel perimeter around the header space which has _ color a maximum size of 750 pixels wide by 90 pixels high Valid value is case insensitive six character HTML hexadecimal color code in ASCII cpp _payflow Optional The background color for the checkout page below the header 6 color Valid value 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 cs Optional The background color of the checkout page Allowable values 1 e 0 background color is white e 1 background color is black The default is 0 June 2009 Button Ma
40. ive for hosted buttons otherwise it is a digit between 0 and 9 inclusive L OPTIONNSELECTX Optional The menu item s name It is a list of variables for each OPTIONNNAME in which x is a digit between 0 and 9 inclusive L OPTIONOPRICEX Optional The price associated with the first menu item It is a list of variables for each OPTIONONAME in which x is a digit between 0 and 9 inclusive NOTE If you specify a price you cannot set a button variable to 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 Button Manager NVP API June 2009 19 20 Button Manager API Reference BMCreateButton API Operation Country Button Language Options 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 Spai
41. kind of button image It is one of the following values e REG regular default unless a button URL is specified 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 xs string Optional The button s URL NOTE Specify either the kind of button image or the URL 18 June 2009 Button Manager NVP API Button Manager API Reference E BMCreateButton API Operation Field Description BUYNOWTEXT 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 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 Optional The country in which the transaction occurs See Country Codes for a list of country codes By default 1t 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 OPTIONNNAME Optional The menu name It is one or more variables in which n is a digit between 0 and 4 inclus
42. l 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 omitted from Buy Now or Donate buttons payers 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_amount2 is not defined then this flat amount 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
43. length and limitations 127 single byte alphanumeric characters Item Tracking Details Fields LT EMNUMBE IT IT EMOTY R LTA EMOTY DE Optional The ID for an item associated with this button 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 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 34 June 2009 Button Manager NVP API Button Manager API Reference E BMSetInventory API Operation ITEMALERT Optional The quantity of the item associated with this button below which PayPal sends you an email notification ITEMCOST Optional The cost of the item associated with this button Option Tracking Details Fields L OPTIONNUMBERN Optional The menu item s ID for an option in a dropdown menu It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L OPTIONOTYn 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 It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L
44. les in which n is a digit between 0 and 2 inclusive 30 June 2009 Button Manager NVP API Button Manager API Reference E BMGetButtonDetails API Operation Field Description BUTTONIMAG The kind of button image It is one of the following values e REG regular e SML small e CC credit card logos El BUTTONIMAGEURL xs string The button s URL BUYNOWTEXT The button text for a Buy Now button It is one of the following values e BUYNOW button text is Buy Now e PAYNOW button text is Pay Now SUBSCRIBETEXT 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 BUTTONCOUNTRY The country in which the transaction occurs See Country Codes for a list of country codes By default it is the merchant s country of registration with PayPal BUTTONLANGUAGE xs string The languange in which to display the button text Character length and limitations 2 single byte alphanumeric characters Option Details Fields Field Description OPT IONNNAME Optional The menu name It is one or more variables in which n is a digit between 0 and 4 inclusive for hosted buttons otherwise it is a digit between 0 and 9 inclusive Button Manager NVP API June 2009 31 a Button Manager API Reference BMManageButtonStatus API Operation L OPTIONNSELECTX L OPTIONOPRICEX
45. n e es Spanish default e en English Switzerland e de German default e fr French e en English United States e en English default e fr French e es Spanish e 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 June 2009 Button Manager NVP API Button Manager API Reference BMCreateButton API Operation BMCreateButton Response Fields Field Description WEBSITECODE HTML code for web pages EMATLLINK Code for email links and links in other documents that support external links HOSTEDBUTTONID ID of a PayPal hosted button 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 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
46. n the PayPal Shopping Cart e g quantityl quantity2 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 shipping is not defined this flat amount is charged regardless of the quantity of items purchased This use of the shipping variable is valid only for Buy Now and Add to Cart buttons Default If profile based shipping rates are configured buyers are charged an amount according to the shipping methods they choose The cost of shipping each additional unit of this item If omitted and profile based shipping rates are configured buyers are charged an amount according to the shipping methods they choose Valid only for Buy Now and Add to Cart buttons Transaction based tax override variable Set this to a flat tax amount to apply to the transaction 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 Transaction based tax override variable Set this to a 6 percentage that will be applied to amount multiplied 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 4
47. nStatus HOSTEDBUTTONID Required The ID of the hosted button whose status you want to change BUTTONSTATUS 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 API operation BMManageButtonStatus Errors BMManageButtonStatus Eade 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 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 Button Manager NVP API BMSetinventory API Operation Use the BMSet Inventory API operation to set the inventory le management features for the specified button When you set the vel and inventory 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 s BMSetInventory Request s BMSetInventory Response e BMSetInventory Errors June 2009 33 a Button Manager API Reference BMSetInventory A
48. nager NVP API HTML Variables for Website Payments Standard a HTML Variables for Displaying PayPal Checkout Pages Name Required or Optional Description Character Length le no_note cn no_ shipping return rm Optional Optional Optional Optional Optional Optional The language of the login or sign up page that subscribers see when they click the Subscribe button If unspecified the language is determined by a PayPal cookie in the subscriber s browser If there is no PayPal English For allowable values see cookie the default language is U S Do not prompt payers to include a note with their payments Allowable values e U provide a text box and prompt for the note e hide the text box and the prompt The default is 0 Label that appears above the and will not appear in any of note field This value is not saved your notifications If 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 Do not prompt payers for shipping address Allowable values e 0 prompt for an address but do not require one e 1 do not prompt for an address e 2 prompt for an address and require one The default is 0 The URL to which the payer completing the payment for displays a Thank you for yo s browser is redirected after example a UR
49. ncy code variable For example lt option value small gt small 10 00 lt input type hidden name option amount0 lt option gt value 10 00 gt e Optional for Buy Now and Add to Cart buttons e Not used with Donate Subscribe or Buy Gift Certificate buttons option select1 Optional For priced options the value of the second option selection of 64 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 ten option selections by incrementing the option selection index option select0 through option select9 NOTE A corresponding option selection in osO must also be set e Optional for Buy Now and Add to Cart buttons e Not used with Donate Subscribe or Buy Gift Certificate buttons Button Manager NVP API June 2009 47 48 HTML Variables for Website Payments Standard HTML Variables for Payment Transactions Required or Character Name Optional Description Length option amount1 Optional For priced options the amount that you want to charge for the 64 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 amountl value 15 00 gt p You can specify a maximum of ten option amounts by incrementing the option amount index option amount 0 through option amount9
50. ntents Preface 2 ee ee ee ee ee ee oa D Intended ALIENTO xs m aa a2 ds we od Be wh ee deo a eR Pee A ew 5 Revision Histoly2 3 saa kak Be awd eee AAA 5 Chapter 1 Website Payments Standard Button Manager API Overview 7 Button Manager Introduction sa o e 7 Generated Button Code a 8 Button Hosting RR o e be R R a eee 9 Hosted Button Manipulation 0 2000002 ee ee 10 Inventory Management Using Hosted Buttons 0 e 10 Button Manager API Summary o 11 Granting Third Party Permission for APIS 0 e e e 11 Chapter 2 Using the Button Manager API 13 Specifying HTML Variables e 13 Creating a Button Using NVP 2 2 0 0 o 14 Tracking Inventory for Menu Items Using NVP 0 0200004 15 Chapter 3 Button Manager API Reference 17 BMCreateButton API Operation o e 17 BMCreateButton Request o 17 BMCreateButton Response e 20 BMCreateButton Errors 2 2 o 21 BMUpdateButton API Operation 0 22000 eee eee 22 BMUpdateButton Request 02222 eee ee eee 23 BMUpdateButton Response 000220 eee ee ee 26 BMUpdateButton Errors 2 220 26 BMButtonSearch API Operation o 28 BMButtonSearch Request 0 0000 eee ee 28 BMButtonSearch Response
51. ntory levels s BMGetInventory Request s BMGetInventory Response s BMGetInventory Errors BMGetinventory Request The hosted button ID identifies the button whose inventory you want to track BMGetlInventory Request Fields Field Description METHOD Required BMGet Inventory HOSTEDBUTTONID Required The ID of the hosted button whose inventory information you want to obtain 38 June 2009 Button Manager NVP API Button Manager API Reference E BMGetInventory API Operation BMGetinventory Response The response fields contain inventory information related to the button BMGetInventory Response Fields Field Description HOSTEDBUTTONID The ID of the hosted button whose inventory you want to set TRACKINV 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 TRACKPNL 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 BMSetInventory OPTIONINDEX 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 limi
52. o execute Button Manager API operations for you To grant third party permissions 1 Log in to your PayPal account Select My Account Profile Click API Access from the Profile Summary Click Grant API Permission Click to Configure a custom API authorization Enter your Partner API Username as specified by your shopping cart or third party S E H oe os Click to check each Button Manager API to which you want to provide access Button Manager NVP API June 2009 11 12 Website Payments Standard Button Manager API Overview Granting Third Party Permission for APIs 8 Click Submit C BMManageButtonStatus C 8MCreateButton C 8MUpdateButton 7 8MSetinventory C BMGetInventory C BMButtonSearch C BMGetButtonDetails June 2009 Button Manager NVP API Using the Button Manager API 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 NVP e Tracking Inventory for Menu Items Using NVP 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 Website Payments Standard button Although you can use the L_BUTTONVARn field to specify any HTML variables some variables are commonly used in specific ways The following table provides additional information abou
53. or U S phone numbers or the entire See phone b phone number for phone numbers outside the U S excluding description country code This will prepopulate the payer s home phone number night_ Optional The four digit phone number for U S phone numbers This will See phone c prepopulate the payer s home phone number description state Optional State use Official U S Postal Service Abbreviations 2 zip Optional Postal code 32 Button Manager NVP API June 2009 59 a HTML Variables for Website Payments Standard HTML Variables for Prepopulating PayPal Checkout Pages 60 June 2009 Button Manager NVP API
54. ription 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 precedence amount Required Price of the item or the total price of all items in the shopping cart 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 to be 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 with 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 Displa
55. s a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L_OPTIONALERTN The quantity of the option associated with this menu item below which PayPal sends you an email notification It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L_OPTIONCOSTn The cost of the option associated with this menu item It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive 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 40 June 2009 Button Manager NVP API HTML Variables for Website Payments Standard This appendix provides reference information for all HTML variables supported for use with Buy Now Donation Subscribe Add to Cart and View Cart buttons as well as HTML variables supported the Cart Upload command Read the following topics to learn about the kinds of HTML v
56. t Option alert values must be specified as a positive integer 11982 Invalid Argument Option alert values cannot be specified when TrackInv is 0 11983 Invalid Argument Item cost value must be specified when tracking profit amp loss by item 11984 Invalid Argument The item cost value specified is invalid Button Manager NVP API June 2009 37 a Button Manager API Reference BMGetInventory API Operation Error Code Short Message Long Message Correcting This Error 11985 Invalid Argument An item cost value cannot be specified when TrackPnl is 0 11986 Invalid Data The number of option cost values specified is greater than the number of option selections in the saved button 11987 Invalid Argument Option cost values must be specified when tracking profit amp loss by option 11988 Invalid Argument An option cost value specified is invalid 11989 Invalid Argument An option cost value cannot be specified when TrackPnl is 0 11990 Invalid Argument The sold out URL specified is invalid 11992 Invalid Argument You do not have permissions to access this button Please check the hosted button ID and try again 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 inve
57. t 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 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 NVP API June 2009 13 me Using the Button Manager API Creating a Button Using NVP HTML Variable Notes no_ note Must be specified for Subscribe buttons Enables a subscriber to not be prompted to include a note with the
58. tations single byte alphanumeric character SOLDOUTURL 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 Item Tracking Details Fields ITEMNUMBER The ID for an item associated with this button ITEMOTY The current inventory level of the item associated with this button ITEMOTYDELTA Not used ITEMALERT The quantity of the item associated with this button below which PayPal sends you an email notification ITEMCOST The cost of the item associated with this button Button Manager NVP API June 2009 39 ar Button Manager API Reference BMGetInventory API Operation Option Tracking Details Fields L OPTIONNUMBERN The menu item s ID for an option in a dropdown menu It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L OPTIONQOTYn The current inventory level of the option associated with this menu item It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L OPTIONSELECTN The menu item s name in a dropdown menu It is a list of variables for each menu item in which n is a digit between 0 and 9 inclusive L OPTIONOTYDELTAN Not used It i
59. te that buyers return to when they click the Continue Shopping button on the PayPal Shopping Cart page upload See Upload the contents of a third party shopping cart or a custom 1 description shopping cart This variable must be set as follows upload 1 The alternatives are the add 1 variable and the display 1 variable which are used with the PayPal Shopping Cart HTML Variables for Subscribe Buttons HTML variables for Subscribe buttons set the terms of subscriptions and their recurring payments 52 June 2009 Button Manager NVP API HTML Variables for Website Payments Standard E HTML Variables for Subscribe Buttons HTML Variables for Subscribe Buttons 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 maximum 127 characters If you are collecting aggregate payments this can include a summary of all items purchased tracking numbers or generic terms such as subscription If omitted customer will see a field in which they have the option of entering an Item Name currency co Optional The currency of prices for trial periods and the subscription The 2 de 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 an 2 description int
60. ts Standard HTML Variables for Subscribe Buttons Required or Character Name Optional Description Length src Optional Recurring payments Subscription payments recur 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 e 0 subscription payments do not recur e subscription payments recur The default is 0 srt Optional Recurring times Number of times that subscription payments 1 recur Specify an integer above 1 Valid only if you specify src 1 sra Optional Reattempt on failure If a recurring payment fails PayPal attempts 1 to collect the payment two more times before canceling the subscription Allowable values e 0 do not reattempt failed recurring payments e 1 reattempt failed recurring payments before canceling The default is 0 no_ note Required Do not prompt payers 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 and set it to 1 custom Optional User defined field which will be passed through the system and 255 returned in your merchant payment notification email This field will not be shown to your subscribers invoice Optional User defined field which must be unique with each subscription 127 The invoice number will be shown to su
61. voice number 127 for this purchase Default No variable is passed back to you shipping Optional The cost of shipping the entire order contained in third party shopping carts This use of the shipping variable is valid only for the Cart Upload command Default If profile based shipping rates are configured buyers are charged an amount according to the shipping methods they choose tax cart Optional Cart wide tax overriding any individual item tax X value weight cart Optional If profile based shipping rates are configured with a basis of weight PayPal uses this value to calculate the shipping charges for the transaction This value overrides the weight values of individual items weight unit Optional The unit of measure if weight cart is specified Allowable values e lbs e kgs The default value is lbs Button Manager NVP API June 2009 49 fa HTML Variables for Website Payments Standard HTML Variables for Shopping Carts 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 50 June 2009 Button Manager NVP API HTML Variables for Website Payments Standard a HTML Variables for Shopping Carts HTMLVariables for Shopping Carts Required Characte Name or Optional Description r Length add See Add an item to the PayPal Shopping Cart 1 desc
62. y 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 an item to the PayPal Shopping Cart If both add and display are specified display takes precedence Button Manager NVP API June 2009 51 fa HTML Variables for Website Payments Standard HTML Variables for Subscribe Buttons Required Characte Name or Optional Description r Length handling cart Optional Single handling fee to be 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 Required Name of the item or a name for the entire Shopping Cart paymentaction Optional Indicates whether the transaction is payment on a final sale or an authorization for a final sale to be captured later Allowable values 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 transaction without placing a hold on the PayPal account IMPORTANT If you set paymentaction to order you must use the Authorization amp Capture API to authorize and capture the transaction payments The merchant tools on the PayPal websitel let you capture payments only for authorizations not for orders shopping url Optional The URL of the page on the merchant websi

PayPal Website Payments Standard - 2009 - Button Manager API (NVP) User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents