Integrating Your Website Using HTML
HTML Variables
HTML Variables
The table below lists the PayPal Pro HTML variables you can use to send in additional transaction information along with your web request. For a list of HTML variables that you can use to customise the look and feel of your payment page, refer to
Table 3.1, “HTML
Variables for Look and Feel of Payment Page
.
N
OTE
: The values you pass must not contain any of these special characters (){}<>\";
N
OTE
: Some merchants are required to pass billing information with every transaction. It is recommended that you test your integration first, particularly if you plan to use iFrame, to determine if the billing information fields are required.
Variable address1 address2
T ABLE 2.1 HTML Variables for Settings of Payment Page address_override billing_address1 billing_address2 billing_city billing_country billing_first_name billing_last_name billing_state billing_zip
Description
Street name of shipping address. (1 of 2 fields).
Street name of shipping address. (2 of 2 fields).
The payer is shown the passed-in address but cannot edit it. This variable is overridden if there are errors in the address. The allowable values are true/false. Default is false.
Street name of the billing address. (1 of 2 fields).
Street name of the billing address. (2 of 2 fields).
City name of the billing address.
Country code of the billing address.
First name of person the item is being billed to.
Last name of person the item is being billed to.
State name of the billing address.
Zip code of the billing address.
Required
No
No
No
Conditional
No
Conditional
Conditional
Conditional
Conditional
Conditional
Conditional
bn business buyer_email
Identifies the source that built the code for the button.
Format - <Company>_<Service>_<Product>_<Country>
Your PayPal account email address or your PayPal ID
(Secure Merchant ID) associated with your PayPal account. It is recommended that you use your PayPal ID, which can be found on the top section of the Profile page on PayPal.com
Email address of the buyer.
No
Yes
No
17
18
Integrating Your Website Using HTML
HTML Variables
Variable cancel_return cbt city country currency_code custom first_name handling invoice last_name lc night_phone_a night_phone_b night_phone_c notify_url
T ABLE 2.1 HTML Variables for Settings of Payment Page (Continued) paymentaction
Description
The browser will be redirected to this URL if the buyer clicks “Return to Merchant” link. Be sure to enter the complete URL, including http:// or https://.
Sets the text for the “Return to Merchant” link on the
PayPal confirmation page. For business accounts, the return button displays your business name in the place of the word “Merchant” by default.
City name of shipping address.
Country name of shipping address.
The currency of the payment. The default is USD.
Pass through variable never presented to the payer.
First name of person the item is being shipped to.
Handling charged. This amount is added to subtotal
for the total amount.
Required
No
No
No
No
No
No
No
No
Order number in the merchant’s ordering/invoice system. No
Last name of person the item is being shipped to.
No
The language of the login or sign-up page.
The area code of the U.S. phone number, or the country code of the phone number outside the U.S. This prepopulates the buyer’s home phone number.
No
No
No The three-digit prefix for U.S. phone numbers, or the entire non-U.S. phone number for numbers outside the
U.S., excluding the country code. This pre-populates the buyer’s home phone number.
N
OTE
: Use this variable for non-US numbers.
The four-digit phone number for U.S. phone numbers.
This pre-populates the buyer’s home phone number.
The URL to which PayPal posts information about the transaction in the form of Instant Payment Notification. Be sure to enter the complete URL, including http:// or https://.
Indicates whether the transaction is for payment on a final sale or an authorisation for a final sale (to be captured later).
Allowable Values: - authorization or sale
Default Value - sale
No
No
Yes
Integrating Your Website Using HTML
HTML Variables
Variable return shipping state subtotal tax zip
T ABLE 2.1 HTML Variables for Settings of Payment Page (Continued)
Description
The URL to which the buyer’s browser is redirected to after completing the payment. Be sure to enter the complete URL, including http:// or https://.
Shipping charged. This amount is added to subtotal
for the total amount.
State of the shipping address.
Amount charged for the transaction. If shipping, handling, and taxes are not specified, this is the total amount charged.
Taxes charged. This amount is added to subtotal
for the total amount.
Postal code of the shipping address.
Required
No
No
No
Yes
No
No
19
20
Integrating Your Website Using HTML
HTML Variables
