PayPal Button Manager API (NVP)
PayPal Button Manager API (NVP) PayPal Button Manager API (NVP)
AHTML Variables for PayPal Payments StandardHTML Variables for Individual ItemsNameRequiredorOptionalDescriptionCharacterLengthdiscount_num Optional Number of additional quantities of the item to which thediscount applies.Applicable when you use discount_amount2 ordiscount_rate2. Use this variable to specify an upper limit onthe number of discounted items.Valid only for Buy Now and Add to Cart buttons.item_nameSeedescription.Description of item. If this variable is omitted, buyers entertheir own name during checkout.• Optional for Buy Now, Donate, Subscribe, AutomaticBilling, Installment Plan, and Add to Cart buttons• Not used with Buy Gift Certificate buttons127item_numberSeedescription.Pass-through variable for you to track product or servicepurchased or the contribution made. The value you specify ispassed back to you upon payment completion. This variableis required if you want PayPal to track inventory or trackprofit and loss for the item the button sells.127quantity Optional Number of items. If profile-based shipping rates areconfigured with a basis of quantity, the sum of quantityvalues is used to calculate the shipping charges for thepayment. PayPal appends a sequence number to identifyuniquely the item in the PayPal Shopping Cart, for example,quantity1, quantity2, and so on.NOTE: The value for quantity must be a positive integer.Null, zero, or negative numbers are not allowed.shipping Optional The cost of shipping this item. If you specify shipping andshipping2 is not defined, this flat amount is chargedregardless of the quantity of items purchased.This shipping variable is valid only for Buy Now and Addto Cart buttons.Default – If profile-based shipping rates are configured,buyers are charged an amount according to the shippingmethods they choose.shipping2 Optional The cost of shipping each additional unit of this item. If thisvariable is omitted and profile-based shipping rates areconfigured, buyers are charged an amount according to theshipping methods they choose.This shipping variable is valid only for Buy Now and Addto Cart buttons.54 April 2012 Button Manager NVP API
HTML Variables for PayPal Payments StandardHTML Variables for Individual ItemsANameRequiredorOptionalDescriptionCharacterLengthtax Optional Transaction-based tax override variable. Set this variable to aflat tax amount to apply to the payment regardless of thebuyer’s location. This value overrides any tax settings set inyour account profile. Valid only for Buy Now and Add toCart buttons. Default – Profile tax settings, if any, apply.tax_rate Optional Transaction-based tax override variable. Set this variable to apercentage that applies to the amount multiplied by thequantity selected during checkout. This value overrides anytax settings set in your account profile. Allowable values arenumbers 0.001 through 100. Valid only for Buy Now andAdd to Cart buttons. Default – Profile tax settings, if any,apply.6undefined_quantityOptional1 – allows buyers to specify the quantity.• Optional for Buy Now buttons• Not used with other buttons1weight Optional Weight of items. If profile-based shipping rates areconfigured with a basis of weight, the sum of weight valuesis used to calculate the shipping charges for the payment.Allowable values are decimals numbers, with 2 significantdigits to the right of the decimal point.weight_unit Optional The unit of measure if weight is specified.Allowable values are:• lbs• kgsThe default is lbs.on0 Optional First option field name and label. The os0 variable containsthe corresponding value for this option field. For example, ifon0 is size, os0 could be large.• Optional for Buy Now, Add to Cart, Subscribe,Automatic Billing, and Installment Plan buttons• Not used with Donate or Buy Gift Certificate buttonson1 Optional Second option field name and label. The os1 variablecontains the corresponding value for this option field. Forexample, if on1 is color then os1 could be blue.You can specify a maximum of 7 option field names (6 withSubscribe buttons) by incrementing the option name index(on0 through on6).• Optional for Buy Now, Add to Cart, Subscribe,Automatic Billing, and Installment Plan buttons• Not used with Donate or Buy Gift Certificate buttons6464Button Manager NVP API April 2012 55
- Page 3 and 4: ContentsPreface . . . . . . . . . .
- Page 5 and 6: PrefaceThis document describes the
- Page 7 and 8: 1PayPal Payments StandardButton Man
- Page 9 and 10: PayPal Payments Standard Button Man
- Page 11 and 12: PayPal Payments Standard Button Man
- Page 13 and 14: PayPal Payments Standard Button Man
- Page 15 and 16: 2Using the Button Manager APIWith N
- Page 17 and 18: Using the Button Manager API With N
- Page 19 and 20: Using the Button Manager API With N
- 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: 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 and 72: HTML Variables for PayPal Payments
- Page 73 and 74: HTML Variables for PayPal Payments
AHTML Variables for <strong>PayPal</strong> Payments StandardHTML Variables for Individual ItemsNameRequiredorOptionalDescriptionCharacterLengthdiscount_num Optional Number of additional quantities of the item to which thediscount applies.Applicable when you use discount_amount2 ordiscount_rate2. Use this variable to specify an upper limit onthe number of discounted items.Valid only for Buy Now and Add to Cart buttons.item_nameSeedescription.Description of item. If this variable is omitted, buyers entertheir own name during checkout.• Optional for Buy Now, Donate, Subscribe, AutomaticBilling, Installment Plan, and Add to Cart buttons• Not used with Buy Gift Certificate buttons127item_numberSeedescription.Pass-through variable for you to track product or servicepurchased or the contribution made. The value you specify ispassed back to you upon payment completion. This variableis required if you want <strong>PayPal</strong> to track inventory or trackprofit and loss for the item the button sells.127quantity Optional Number of items. If profile-based shipping rates areconfigured with a basis of quantity, the sum of quantityvalues is used to calculate the shipping charges for thepayment. <strong>PayPal</strong> appends a sequence number to identifyuniquely the item in the <strong>PayPal</strong> Shopping Cart, for example,quantity1, quantity2, and so on.NOTE: The value for quantity must be a positive integer.Null, zero, or negative numbers are not allowed.shipping Optional The cost of shipping this item. If you specify shipping andshipping2 is not defined, this flat amount is chargedregardless of the quantity of items purchased.This shipping variable is valid only for Buy Now and Addto Cart buttons.Default – If profile-based shipping rates are configured,buyers are charged an amount according to the shippingmethods they choose.shipping2 Optional The cost of shipping each additional unit of this item. If thisvariable is omitted and profile-based shipping rates areconfigured, buyers are charged an amount according to theshipping methods they choose.This shipping variable is valid only for Buy Now and Addto Cart buttons.54 April 2012 <strong>Button</strong> <strong>Manager</strong> <strong>NVP</strong> <strong>API</strong>
Change language