language
Choose a language for your button image here.  |
|
|
|
image
Enter the URL of your button image here. |
|
|
|
cmd
This variable tells PayPal what type of button this is.
Possible values:
_xclick = Buy Now Button
_donations = Donate Button
_xclick-subscriptions = Subscribe Button
_subscr-find = Unsubscribe Button
_oe-gift-certificate = Gift Certificate Button
_cart = Add to Cart or View Cart Button
_s-xclick = A saved or encrypted button |
|
|
|
add
Must be set to 1 for Add to Cart buttons. |
|
|
|
business
This variable tells PayPal the e-mail address or
13-character Merchant ID of the recipient.
Max length: 127 characters |
|
|
|
item_name
This variable tells PayPal the name of the item being
sold. If omitted, buyers enter their own item name.
Max length: 127 characters |
|
|
|
amount
This variable tells PayPal the amount of the item.
This does not including shipping, handling, or tax. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
button_subtype
This variable tells PayPal what the button is being used for.
Possible values:
products = Button is being used to purchase products
(default for Buy Now and Add to Cart buttons)
services = Button is being used to purchase services |
|
|
|
shopping_url
The URL of the page on the merchant website that buyers
return to when they click the Continue Shopping button on
the PayPal Shopping Cart page. |
|
|
|
item_number
This is a passthrough variable used only by the seller.
This usually contains the item number of the item.
Max length: 127 characters |
|
|
|
custom
This is a passthrough variable used only by the seller.
This can contain any extra information you would like.
Max length: 256 characters |
|
|
|
invoice
This is a passthrough variable used only by the seller.
This usually contains the invoice ID of the payment.
Max length: 127 characters |
|
|
|
quantity
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
in the PayPal Shopping Cart (e.g., quantity1, quantity2).
The value for quantity must be a positive integer. |
|
|
|
shipping
The cost of shipping this item. If you specify shipping and
shipping2 is not defined, this flat amount is charged regardless
of the quantity of items purchased. Default: If profile-based
shipping rates are configured, buyers are charged an amount
according to the shipping methods they choose. |
|
|
|
shipping2
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. |
|
|
|
handling
Handling charges. This is not quantity-specific. The same handling
cost applies, regardless of the number of items on the order. |
|
|
|
handling_cart
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. |
|
|
|
tax
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. |
|
|
|
tax_rate
Transaction-based tax override variable. Set this to a
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.
Default: Profile tax settings, if any, apply. |
|
|
|
tax_cart
Cart-wide tax, overriding any individual item tax_x value. |
|
|
|
weight
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_cart
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
The unit of measure if weight or weight_cart is specified.
lbs = The product is weighed in pounds
kgs = The product is weighed in kilograms
The default value is lbs. |
|
|
|
discount_amount
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. |
|
|
|
discount_amount2
Discount amount associated with each additional quantity of
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. |
|
|
|
discount_rate
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. |
|
|
|
discount_rate2
Discount rate (percentage) associated with each additional
quantity of the item. It must be equal to or less 100. A
discount_rate must also be specified as greater than or
equal to 0 for discount_rate2 to take effect. |
|
|
|
discount_num
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. |
|
|
|
cbt (Change Button Text)
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.
Note: The return variable must also be set.
Max length: 60 |
|
|
|
return
The URL to which the buyer's browser is redirected after
completing the payment; for example, a URL on your site
that displays a "Thank you for your payment" page.
Default: The browser is redirected to a PayPal web page.
Max length: 1024 characters |
|
|
|
cancel_return
A URL to which the buyer's browser is redirected if
payment is cancelled; for example, a URL on your
website that displays a "Payment Canceled" page.
Default: The browser is redirected to a PayPal web page.
Max length: 1024 characters |
|
|
|
rm (Return Method)
The form method used to send data to the URL specified
by the return variable after payment completion.
Allowable values:
0 (default) = all shopping cart transactions use the GET method
1 = the buyer's browser is redirected to the return URL by the
GET method, and no transaction variables are sent
2 = the buyer's browser is redirected to the return URL by the
POST method, and all transaction variables are also posted
The rm variable takes effect only if the return variable is also set. |
|
|
|
notify_url
The URL to which PayPal posts information about the transaction,
in the form of Instant Payment Notification messages.
Max length: 255 characters |
|
|
|
no_shipping
Do not prompt buyers for shipping address.
Allowable values:
0 (default) = prompt for an address, but do not require one
1 = do not prompt for an address
2 = prompt for an address, and require one |
|
|
|
no_note
Do not prompt buyers to include a note with their payments.
Allowable values:
0 (default) = provide a text box and prompt for the note
1 = hide the text box and the prompt |
|
|
|
cn (Change Note)
Label that appears above the note field. This value is not
saved and will not appear in any of 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.
Max length: 90 |
|
|
|
page_style
The custom payment page style for checkout pages.
Allowable values:
paypal = use the PayPal page style
primary = use the page style that you marked as primary
in your account profile
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.
Max length: 30 |
|
|
|
image_url
The URL of the 150x50-pixel image displayed as your
logo in the 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
a Premier or Personal account.
Max length: 1024 characters |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
cpp_payflow_color
The background color for the checkout page below the header.
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.
Max length: 6 |
|
|
|
cs (Color Switch)
Switches the background color of the checkout page.
Allowable values:
0 (default) = background color is white
1 = background color is black |
|
|
|
option_index
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. Default: 0 |
|
|
|
on0 (Option Name 0)
The name of your first option.
Max length: 64 characters |
|
|
|
os0 (Option Selection 0)
The value of your first option.
Max length: 64 chars (dropdown) or 200 chars (textbox) |
|
|
|
on1 (Option Name 1)
The name of your second option.
Max length: 64 characters |
|
|
|
os1 (Option Selection 1)
The value of your second option.
Max length: 64 chars (dropdown) or 200 chars (textbox) |
|
|
|
on2 (Option Name 2)
The name of your third option.
Max length: 64 characters |
|
|
|
os2 (Option Selection 2)
The value of your third option.
Max length: 64 chars (dropdown) or 200 chars (textbox) |
|
|
|
on3 (Option Name 3)
The name of your fourth option.
Max length: 64 characters |
|
|
|
os3 (Option Selection 3)
The value of your fourth option.
Max length: 64 chars (dropdown) or 200 chars (textbox) |
|
|
|
on4 (Option Name 4)
The name of your fifth option.
Max length: 64 characters |
|
|
|
os4 (Option Selection 4)
The value of your fifth option.
Max length: 64 chars (dropdown) or 200 chars (textbox) |
|
|
|
on5 (Option Name 5)
The name of your sixth option.
Max length: 64 characters |
|
|
|
os5 (Option Selection 5)
The value of your sixth option.
Max length: 64 chars (dropdown) or 200 chars (textbox) |
|
|
|
on6 (Option Name 6)
The name of your seventh option.
Max length: 64 characters |
|
|
|
os6 (Option Selection 6)
The value of your seventh option.
Max length: 64 chars (dropdown) or 200 chars (textbox) |
|
|
|
option_select0
For priced options, a mirror copy of the VALUE
attribute of the 1st option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount0
For priced options, the amount you want to charge
for the 1st option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_select1
For priced options, a mirror copy of the VALUE
attribute of the 2nd option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount1
For priced options, the amount you want to charge
for the 2nd option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_select2
For priced options, a mirror copy of the VALUE
attribute of the 3rd option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount2
For priced options, the amount you want to charge
for the 3rd option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_select3
For priced options, a mirror copy of the VALUE
attribute of the 4th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount3
For priced options, the amount you want to charge
for the 4th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_select4
For priced options, a mirror copy of the VALUE
attribute of the 5th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount4
For priced options, the amount you want to charge
for the 5th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_select5
For priced options, a mirror copy of the VALUE
attribute of the 6th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount5
For priced options, the amount you want to charge
for the 6th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_select6
For priced options, a mirror copy of the VALUE
attribute of the 7th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount6
For priced options, the amount you want to charge
for the 7th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_select7
For priced options, a mirror copy of the VALUE
attribute of the 8th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount7
For priced options, the amount you want to charge
for the 8th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_select8
For priced options, a mirror copy of the VALUE
attribute of the 9th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount8
For priced options, the amount you want to charge
for the 9th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_select9
For priced options, a mirror copy of the VALUE
attribute of the 10th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
option_amount9
For priced options, the amount you want to charge
for the 10th option in the on0 dropdown.
Max length: 64 characters |
|
|
|
address_override
If you've already collected the buyer's shipping address
set this variable to 1 and fill in their address using the
address variables below. This will override the buyer's
stored address with PayPal. The buyer is shown the
passed-in address but cannot edit it. |
|
|
|
address1
Overrides line 1 of the buyer's street address.
Max length: 100 |
|
|
|
address2
Overrides line 2 of the buyer's street address.
Max length: 100 |
|
|
|
city
Overrides the buyer's city.
Max length: 40 |
|
|
|
|
|
|
|
email
Overrides the buyer's e-mail address.
Max length: 127 |
|
|
|
first_name
Overrides the buyer's first name.
Max length: 32 |
|
|
|
last_name
Overrides the buyer's last name.
Max length: 64 |
|
|
|
night_phone_a
The area code for U.S. phone numbers, or the country
code for phone numbers outside the U.S. This will
prepopulate the buyer's home phone number. |
|
|
|
night_phone_b
The three-digit prefix for U.S. phone numbers, or the
entire phone number for phone numbers outside the
U.S., excluding country code. This will prepopulate
the buyer's home phone number. |
|
|
|
night_phone_c
The four-digit phone number for U.S. phone numbers.
This will prepopulate the buyer's home phone number. |
|
|
|
|
|
|
|
zip
Overrides the buyer's ZIP/Postal code.
Max length: 32 |
|
|
|
mrb (Merchant Referral Bonus)
If you want to participate in the PayPal Merchant Referral Bonus
Program, enter your 13-character PayPal Merchant ID here.
Note: This variable is undocumented. |
|
|
|