PayPal Button Manager API (NVP)
PayPal Button Manager API (NVP) PayPal Button Manager API (NVP)
AHTML Variables for PayPal Payments StandardHTML Variables for the Instant Update APIHTML Variables to Set Up an Instant Update PaymentNameRequiredorOptionalDescriptionCharacterLengthcallback_url Required The URL of your Instant Update callback server 1024callback_timeoutRequiredThe timeout in seconds for callback responses from yourInstant Update callback server. After exceeding the timeout,PayPal uses the fallback values on the Review Your Paymentpage for tax, shipping, and insurance.Allowable values are 1-6. PayPal recommends the value 3.1IMPORTANT: Use values other than 3 only when instructedto do so by your PayPal representative..callback_versionOptionalThe version of the Instant Update API that your callbackserver uses. The default is the current version.fallback_tax_amountOptionalTax amount to use as a fallback, if the callback responsetimes outfallback_shipping_option_name_xRequiredName and label of shipping option x to use as a fallback, ifthe callback response times out. For example, “Express 2days”. You can include a maximum of 10 shipping optionsas fallbacks. Substitute x with ordinal numbers, starting with0.Iinclude 1 instance of this variable, with its index (x) set to 0.If you include just 1 instance, includefallback_shipping_option_is_default_x with itsindex (x) set to 0 and its value set to 1.Allowable values for x are 0-9.50fallback_shipping_option_amount_xRequiredShipping amount for option x to use as a fallback, if theresponse times out.Allowable values for x are 0-9.fallback_shipping_option_is_default_xRequiredIndicates that shipping option x is the default and should beselected in the dropdown menu as a fallback, if the responsetimes out.Only one shipping option can be the default for buyers.Check that you set 1 instance only offallback_shipping_option_is_default_x to thevalue 1.Allowable values are:• 1 – shipping option x is the default shipping option• 0 – shipping option x is not the default shipping optionAllowable values for x are 0-9.172 April 2012 Button Manager NVP API
HTML Variables for PayPal Payments StandardHTML Variables for the Instant Update APIANameRequiredorOptionalDescriptionCharacterLengthfallback_insurance_option_offeredOptionalIndicates that insurance is offered. PayPal ignores thisHTML variable if fallback_insurance_amount isomitted or the value is 0 or less.Allowable values are:• 1 – insurance is offered• 0 – insurance is not offered1fallback_insurance_amountOptionalInsurance amount to use as a fallback, if the callbackresponse times out. Include thefallback_insurance_option_offered HTMLvariable if you specify an insurance amount. The fallbackinsurance amount applies to all shipping options that youspecify.Instant Update Variables for Dimensions of Individual Items: Shipping charges arecalculated sometimes by using the dimensions of individual items in the shopping cart. Includethe following optional dimensional variables below in the Cart Upload command to providethe information to your callback server.HTML Variables to Set Up an Instant Update Payment for Dimension-Based Shipping ChargesNameRequiredorOptionalDescriptionCharacterLengthheight_x Optional Height of item x in the shopping cart.Allowable values are positive integers.height_unit Optional Unit of measure for the values specified by the height_xvalues.Allowable values are any values that you choose to provide.PayPal passes the value to your callback server in callbackrequests.width_x Optional Width of item x in the shopping cart.Allowable values are positive integers.width_unit Optional Unit of measure for the value specified by width_xAllowable values are any values that you choose to provide.PayPal passes the value to your callback server in callbackrequests.length_x Optional Length of item x in the shopping cart.Allowable values are positive integers.Button Manager NVP API April 2012 73
- Page 21 and 22: Using the Button Manager API With N
- Page 23 and 24: 3Button Manager API ReferenceThe Bu
- Page 25 and 26: Button Manager API ReferenceBMCreat
- Page 27 and 28: Button Manager API ReferenceBMCreat
- Page 29 and 30: Button Manager API ReferenceBMUpdat
- Page 31 and 32: Button Manager API ReferenceBMUpdat
- Page 33 and 34: Button Manager API ReferenceBMUpdat
- Page 35 and 36: Button Manager API ReferenceBMButto
- Page 37 and 38: Button Manager API ReferenceBMGetBu
- Page 39 and 40: Button Manager API ReferenceBMGetBu
- Page 41 and 42: Button Manager API ReferenceBMSetIn
- Page 43 and 44: Button Manager API ReferenceBMSetIn
- Page 45 and 46: Button Manager API ReferenceBMSetIn
- Page 47 and 48: Button Manager API ReferenceBMGetIn
- Page 49 and 50: Button Manager API ReferenceBMGetIn
- Page 51 and 52: AHTML Variables for PayPalPayments
- Page 53 and 54: HTML Variables for PayPal Payments
- Page 55 and 56: HTML Variables for PayPal Payments
- Page 57 and 58: HTML Variables for PayPal Payments
- Page 59 and 60: HTML Variables for PayPal Payments
- Page 61 and 62: HTML Variables for PayPal Payments
- Page 63 and 64: HTML Variables for PayPal Payments
- Page 65 and 66: HTML Variables for PayPal Payments
- Page 67 and 68: HTML Variables for PayPal Payments
- Page 69 and 70: HTML Variables for PayPal Payments
- Page 71: HTML Variables for PayPal Payments
HTML Variables for <strong>PayPal</strong> Payments StandardHTML Variables for the Instant Update <strong>API</strong>ANameRequiredorOptionalDescriptionCharacterLengthfallback_insurance_option_offeredOptionalIndicates that insurance is offered. <strong>PayPal</strong> ignores thisHTML variable if fallback_insurance_amount isomitted or the value is 0 or less.Allowable values are:• 1 – insurance is offered• 0 – insurance is not offered1fallback_insurance_amountOptionalInsurance amount to use as a fallback, if the callbackresponse times out. Include thefallback_insurance_option_offered HTMLvariable if you specify an insurance amount. The fallbackinsurance amount applies to all shipping options that youspecify.Instant Update Variables for Dimensions of Individual Items: Shipping charges arecalculated sometimes by using the dimensions of individual items in the shopping cart. Includethe following optional dimensional variables below in the Cart Upload command to providethe information to your callback server.HTML Variables to Set Up an Instant Update Payment for Dimension-Based Shipping ChargesNameRequiredorOptionalDescriptionCharacterLengthheight_x Optional Height of item x in the shopping cart.Allowable values are positive integers.height_unit Optional Unit of measure for the values specified by the height_xvalues.Allowable values are any values that you choose to provide.<strong>PayPal</strong> passes the value to your callback server in callbackrequests.width_x Optional Width of item x in the shopping cart.Allowable values are positive integers.width_unit Optional Unit of measure for the value specified by width_xAllowable values are any values that you choose to provide.<strong>PayPal</strong> passes the value to your callback server in callbackrequests.length_x Optional Length of item x in the shopping cart.Allowable values are positive integers.<strong>Button</strong> <strong>Manager</strong> <strong>NVP</strong> <strong>API</strong> April 2012 73
Change language