Button Manager API (NVP) Last updated: April 2012
Button Manager NVP API Document Number: 10089.en_US-201204 © 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.
Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Chapter 1 PayPal Payments Standard Button Manager API Overview . 7 Button Manager Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Generated Button Code . . . . . . . . . . . . . . . . . . .
Contents BMUpdateButton Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 BMUpdateButton Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 BMButtonSearch API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 BMButtonSearch Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 BMButtonSearch Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 BMButtonSearch Errors . . . . . . . . . . . . . .
Preface This document describes the Button Manager API for NVP. 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 (NVP). 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.
Revision History 6 April 2012 Button Manager NVP API
1 PayPal Payments Standard Button 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.
1 PayPal Payments Standard Button Manager API Overview Generated Button Code Subscribe and Unsubscribe Pay Now (Hosted Sole Solution only) Installment Plan 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.
PayPal Payments Standard Button Manager API Overview Generated Button Code 1 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:
PayPal Payments Standard Button Manager API Overview Inventory Management Using Hosted Buttons Update a hosted button, which lets 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 1 Inventory Management Using Hosted Buttons You can get or set the inventory level for the item associated with a hosted button.
1 PayPal Payments Standard Button Manager API Overview Button Manager API Summary 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. Specifying download keys with NVP The following example shows how you might create several keys using the BMSetButtonInventory API operation: METHOD=BMSetInventory ...
PayPal Payments Standard Button Manager API Overview Granting Third-Party Permission for APIs 1 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.
1 14 PayPal Payments Standard Button Manager API Overview Granting Third-Party Permission for APIs April 2012 Button Manager NVP API
2 Using the Button Manager API With NVP These examples show basic Button Manager API capabilities. The examples show how to create buttons and set inventory levels.
2 Using the Button Manager API With NVP Creating a Button Using NVP HTML Variable Notes 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 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.
Using the Button Manager API With NVP Offering Multiple Payment Option Subscriptions Using NVP 2 OPTION1NAME=Size L_OPTION1SELECT0=Small L_OPTION1SELECT1=Large BUTTONIMAGE=reg ... 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_BUTTONVAR0, and such), enable you to specify the same HTML variables as you ordinarily do using PayPal Payments Standard.
2 Using the Button Manager API With NVP Offering Automatic Billing Using NVP L_OPTION1TOTALBILLINGCYCLES0 value=2 L_OPTION0SELECT2 value="Third" OPTION2TYPE value="VARIABLE" L_OPTION2AMOUNT0 value="33.12" L_OPTION2BILLINGFREQUENCY0 value=1 L_OPTION2BILLINGPERIOD0 value=Month L_OPTION2TOTALBILLINGCYCLES0 value=1 L_OPTION2AMOUNT1 value="32.34" L_OPTION2BILLINGFREQUENCY1 value=2 L_OPTION2BILLINGPERIOD1 value=Month L_OPTION2TOTALBILLINGCYCLES1 value=1 L_OPTION2AMOUNT2 value="31.
Using the Button Manager API With NVP Tracking Inventory for Menu Items Using NVP 2 Automatic billing in which you specify the choices ... BUTTONTYPE value= AUTOBILLING OPTION0NAME value= "Item-234" L_OPTION0PRICE0 value= "12.30" L_OPTION0PRICE1 value= "14.30" L_OPTION0PRICE2 value= "15.30" L_OPTION0PRICE3 value= "16.30" ... Automatic billing in which you specify the minimum amount ... BUTTONTYPE value=AUTOBILLING L_BUTTONVAR0 value="item_name=Item-123" L_BUTTONVAR0 value="min_amount=12.34" ...
2 Using the Button Manager API With NVP Using the Button Manager API With Hosted Solution Checkout Using the Button Manager API With Hosted Solution Checkout The example shows the NVP parameters for creating a link to initiate the Hosted Solution checkout flow. This example also creates a Pay Now button that can by used on your review page to initiate the Hosted Solution checkout flow. ...
Using the Button Manager API With NVP Using the Button Manager API With Hosted Solution Checkout 2 L_BUTTONVAR39=address_override=0 L_BUTTONVAR40=cpp_header_image=Red L_BUTTONVAR41=logoText=MartWall L_BUTTONVAR42=logoImage=http://i2.martwallimages.com/wmlogo.
2 Using the Button Manager API With NVP Using the Button Manager API With Hosted Solution Checkout When your customer clicks the button, he or she is redirected to the Hosted Solution payment flow. Like the line, he button is live for approximately two hours. NOT E : 22 The PayPal Hosted Solution page displays a button identified as Pay Now to continue the checkout flow. The Pay Now button on the PayPal page is is different than the Pay Now button created by the BMCreateButton API operation.
3 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.
3 Button Manager API Reference BMCreateButton API Operation BMCreateButton Request Fields Field Description METHOD (Required) BMCreateButton BUTTONCODE (Optional) The kind of button code to create.
Button Manager API Reference BMCreateButton API Operation 3 Option Selection Details Fields 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_OPTION0PRICEx (Optional) The price associated with the first menu item It is a list of variables for each OPTION0NAME, in which x is a digit between 0 and 9, inclusive N O TE : OPTIONnTYPE If you specify a price, you cannot set a button variable to amount.
3 Button Manager API Reference BMCreateButton API Operation L_OPTIONnTAXAMOUNTx (Optional) The tax amount to bill for the cycle, in addition to the base amount. It is a list of variables for each OPTION0NAME, in which x is a digit between 0 and 4, inclusive Button Language Options The button language must be compatible with the country identified by the country code.
Button Manager API Reference BMCreateButton API Operation Country 3 Button Language Options Switzerland United States de - German; default fr - French en - English 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.
3 28 Button Manager API Reference BMCreateButton API Operation Error Code Short Message Long Message 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.
Button Manager API Reference BMUpdateButton API Operation Error Code Short Message Long Message 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. 3 Correcting This Error...
3 Button Manager API Reference BMUpdateButton API Operation Field Description BUTTONTYPE (Required) The kind of button you want to update. It is one of the following 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.
Button Manager API Reference BMUpdateButton API Operation Field Description BUTTONIMAGEURL xs:string (Optional) The button’s URL N O TE : 3 Specify either the kind of button image or the URL. BUYNOWTEXT (Optional) The button text for a Buy Now button. It is one of the following values: BUYNOW - button text is Buy Now; default PAYNOW - button text is Pay Now SUBSCRIBETEXT (Optional) The button text for a Subscribe button.
3 Button Manager API Reference BMUpdateButton API Operation Installment Details L_OPTIONnBILLINGPERIODx (Optional) The installment cycle unit, which is one of the following values: NoBillingPeriodType - None (default) Day Week SemiMonth Month Year It is a list of variables for each OPTIONnNAME, in which x is a digit between 0 and 4, inclusive L_OPTIONnBILLINGPFREQUEN CYx (Optional) The installment cycle frequency in units, e.g.
Button Manager API Reference BMUpdateButton API Operation Country 3 Button Language Options Canada China (worldwide) France Germany Hong Kong Italy Japan Mexico Netherlands Poland Spain Switzerland United States en - English; default fr - French en - English; default zh - Chinese fr - French; default en - English de - German; default en - English zh - Chinese; default en - English it - Italian; default en - English ja -
3 Button Manager API Reference BMUpdateButton API Operation BMUpdateButton Response Fields Field Description WEBSITECODE HTML code for web pages EMAILLINK Code for email links and links in other documents that support external links HOSTEDBUTTONID ID of a PayPal hosted button BMUpdateButton Errors 34 Error Code Short Message Long Message 10001 Internal Error Internal Error 11923 Invalid Argument The button image value specified is invalid.
Button Manager API Reference BMButtonSearch API Operation Error Code Short Message Long Message 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.
3 Button Manager API Reference BMButtonSearch API Operation BMButtonSearch Request BMButtonSearch Response 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. The value must be in UTC/GMT format; for example, 2009-08-24T05:38:48Z.
Button Manager API Reference BMGetButtonDetails API Operation 3 BMButtonSearch Errors Error Code Short Message Long Message 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.
3 Button Manager API Reference BMGetButtonDetails API Operation BMGetButtonDetails Response The response fields contain all non-inventory information related to the button. BMGetButtonDetails Response Fields Field Description BUTTONTYPE The kind of button.
Button Manager API Reference BMGetButtonDetails API Operation 3 Option Selection Details Fields Field Description 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_OPTION0PRICEx (Optional) The price associated with the first menu item It is a list of variables for each OPTION0NAME, in which x is a digit between 0 and 9, inclusive N O TE : OPTIONnTYPE If you specify a price, you cannot set a button vari
3 Button Manager API Reference BMManageButtonStatus API Operation Field Description L_OPTIONnSHIPPINGAMOUNTx (Optional) The shipping amount to bill for the cycle, in addition to the base amount. It is a list of variables for each OPTION0NAME, in which x is a digit between 0 and 4, inclusive L_OPTIONnTAXAMOUNTx (Optional) The tax amount to bill for the cycle, in addition to the base amount.
Button Manager API Reference BMSetInventory API Operation 3 BMManageButtonStatus Request The request specifies the hosted button’s ID and the status you want to set the button to. BMManageButtonStatus Request Fields Field Description METHOD (Required) BMManageButtonStatus HOSTEDBUTTONID (Required) The ID of the hosted button whose status you want to change. BUTTONSTATUS (Required) The new status of the button.
3 Button Manager API Reference BMSetInventory API Operation BMSetInventory Request BMSetInventory Response BMSetInventory Errors BMSetInventory Request The request specifies inventory values related to a hosted button as well as inventory values that are specific to each menu item. BMSetInventory Request Fields Field Description METHOD (Required) BMSetInventory HOSTEDBUTTONID (Required) The ID of the hosted button whose inventory you want to set.
Button Manager API Reference BMSetInventory API Operation Field Description APPENDDIGITALDOWNLOADKEY S (Optional) Whether to append download keys: 0 - do not append keys (default) 1 - append keys N O TE : L_DIGITALDOWNLOADKEYSn 3 If you do not append the download keys, unused keys will be replaced.. (Optional) One or more digital download keys, up to a maximum of 1,000 keys. The variable n in the field name is a number between 0 and 999, inclusive, that specifies the key.
3 Button Manager API Reference BMSetInventory API Operation 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.
Button Manager API Reference BMSetInventory API Operation Error Code Short Message Long Message 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.
3 46 Button Manager API Reference BMSetInventory API Operation Error Code Short Message Long Message 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.
Button Manager API Reference BMGetInventory API Operation 3 BMGetInventory API Operation Use the BMGetInventory 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 BMGetInventory to obtain field values before calling BMSetInventory to change the inventory levels.
3 Button Manager API Reference BMGetInventory API Operation Field Description TRACKPNL Whether to track the gross profit associated with inventory changes. It is one of the following values: 0 - do not track the gross profit 1 - track the gross profit N O TE : 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. OPTIONNAMEINDEX Option index, which identifies the button.
Button Manager API Reference BMGetInventory API Operation Field Description L_OPTIONQTYDELTAn Not used It is 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.
3 50 Button Manager API Reference BMGetInventory API Operation April 2012 Button Manager NVP API
A HTML Variables for PayPal Payments Standard You can use all variables supported for your button: 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.
A HTML Variables for PayPal Payments Standard Technical HTML Variables HTML Variables for Special PayPal Features Name Required or Optional notify_url Optional The URL to which PayPal posts information about the payment, in the form of Instant Payment Notification messages. 255 hosted_button_i d See description. Required for buttons that have been saved in PayPal accounts; otherwise, not allowed. The identifier of a button that was saved in a merchant’s PayPal account.
HTML Variables for PayPal Payments Standard HTML Variables for Individual Items A H T M L Va r i a b l e s f o r I n d i v i d u a l I t e m s 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 Name Required or Optional Description amount See description.
A HTML Variables for PayPal Payments Standard HTML Variables for Individual Items Name Required or Optional 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. item_name See description. Description of item.
HTML Variables for PayPal Payments Standard HTML Variables for Individual Items Name Required or Optional 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.
A HTML Variables for PayPal Payments Standard HTML Variables for Individual Items Name Required or Optional os0 Optional Character Length 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 200character limit. NOT E : See description. The option field on0 must also be defined.
HTML Variables for PayPal Payments Standard HTML Variables for Individual Items Name option_index Required or Optional See description. Description A Character Length The cardinal number of the option field, on0 through on9, that has product options with different prices for each option. Include option_index if the option field with prices is not on0.
A HTML Variables for PayPal Payments Standard HTML Variables for Payment Transactions Name Required or Optional option_select1 Optional Character Length Description For priced options, the value of the second option selection of the on0 dropdown menu. For example: 64 ... ...
HTML Variables for PayPal Payments Standard HTML Variables for Shopping Carts A HTML Variables for Payment Transactions Required or Optional Name Description Character Length address_ override Optional 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. 1 currency_code Optional The currency of the payment.
A HTML Variables for PayPal Payments Standard HTML Variables for Shopping Carts HTML Variables for Shopping Carts Name add Required or Optional Description See description. Add an item to the PayPal Shopping Cart. This variable must be set as follows: Character Length 1 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.
HTML Variables for PayPal Payments Standard HTML Variables for Recurring Payments Buttons Name Required or Optional 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.
A HTML Variables for PayPal Payments Standard HTML Variables for Recurring Payments Buttons Installment Plan buttons HTML variables for recurring payments buttons set terms for different kinds of PayPal automatic payment plans. Subscribe Button HTML Variables 62 Name Required or Optional 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.
HTML Variables for PayPal Payments Standard HTML Variables for Recurring Payments Buttons Name Required or Optional t3 Required Regular subscription units of duration. Allowable values are: 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 Y – for years; allowable range for p3 is 1 to 5 1 src Optional Recurring payments.
A HTML Variables for PayPal Payments Standard HTML Variables for Recurring Payments Buttons Name Required or Optional modify Optional Character Length Description Modification behavior. Allowable values are: 0 – allows subscribers only to sign up for new subscriptions 1 – allows subscribers to sign up for new subscriptions and modify their current subscriptions 2 – allows subscribers to modify only their current subscriptions 1 The default value is 0.
HTML Variables for PayPal Payments Standard HTML Variables for Recurring Payments Buttons A Installment Plan Buttons HTML Variables Name Required or Optional disp_tot Optional Description Display the total payment amount to buyers during checkout Allowable values are: Y – display the total N – do not display the total Character Length 1 The default is N.
A HTML Variables for PayPal Payments Standard HTML Variables for Recurring Payments Buttons Name 66 Required or Optional Character Length Description option_selectn_ type Required Whether the single plan or plan option n offered by the button is paid in full, in equal periods, or in variable periods Allowable values are: F – pay in full, at checkout E – pay in equal periods, beginning at checkout or sometime later V – pay in variable periods, beginning at checkout option_selectn_ am Require
HTML Variables for PayPal Payments Standard HTML Variables for Displaying PayPal Checkout Pages A H T M L Va r i a b l e s f o r D i s p l a y i n g P a y P a l C h e c k o u t P a g e s HTML variables for displaying PayPal checkout pages control how the pages appear and function. HTML Variables for Displaying PayPal Checkout Pages Name Required or Optional page_style Optional Description The custom payment page style for checkout pages.
A HTML Variables for PayPal Payments Standard HTML Variables for Displaying PayPal Checkout Pages Name Required or Optional Character Length Description cpp_ headerback_ color Optional The background color for the header of the checkout page. 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. 6 cpp_ headerborder_co lor Optional The border color around the header of the checkout page.
HTML Variables for PayPal Payments Standard HTML Variables for Displaying PayPal Checkout Pages Name Required or Optional no_note Optional Description Do not prompt buyers to include a note with their payments. Allowable values are: 0 – provide a text box and prompt for the note 1 – hide the text box and the prompt A Character Length 1 The default is 0. cn Optional Label that appears above the note field. This value is not saved and does not appear in any of your notifications.
A HTML Variables for PayPal Payments Standard HTML Variables for Filling Out PayPal Checkout Pages Automatically Name Required or Optional cbt Optional Sets the text for the Return to Merchant button on the 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.
HTML Variables for PayPal Payments Standard HTML Variables for the Instant Update API Name Required or Optional lc Optional Sets the language for the billing information/log-in page 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.
A HTML Variables for PayPal Payments Standard HTML Variables for the Instant Update API HTML Variables to Set Up an Instant Update Payment Name Required or Optional Description Character Length callback_url Required The URL of your Instant Update callback server 1024 callback_timeou t Required The timeout in seconds for callback responses from your Instant Update callback server.
HTML Variables for PayPal Payments Standard HTML Variables for the Instant Update API Required or Optional Name Description fallback_insura nce_option_offe red Optional Indicates that insurance is offered. PayPal ignores this HTML variable if fallback_insurance_amount is omitted or the value is 0 or less. Allowable values are: 1 – insurance is offered 0 – insurance is not offered fallback_insura nce_amount Optional Insurance amount to use as a fallback, if the callback response times out.
A 74 HTML Variables for PayPal Payments Standard HTML Variables for the Instant Update API Name Required or Optional length_unit Optional Character Length Description 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.
