HTML Variables for Website Payments Standard 4

HTML Variables for Displaying PayPal Checkout Pages

HTML variables for displaying PayPal checkout pages control how the pages appear and function.

Table 7. HTML Variables for Displaying PayPal Checkout Pages

Name	Required or Optional	Description	Character Length
page_style	Optional	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.	30
image_url	Optional	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 Premier or Personal account.	1,024
cpp_header_ image	Optional	The image at the top left of the checkout page. The image's maximum size is 750 pixels wide by 90 pixels high. PayPal recommends that you provide an image that is stored only on a secure (https) server. For more information, see Co-Branding the PayPal Checkout Pages.	No limit
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.	6
cpp_ headerborder_color	Optional	The border color around the header of the checkout page. The border is a 2-pixel perimeter around the header space, which has a maximum size of 750 pixels wide by 90 pixels high. Valid value is case-insensitive six-character HTML hexadecimal color code in ASCII.	6
cpp_payflow_ color	Optional	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.	6
cs	Optional	The background color of the checkout page. Allowable values: 0 – background color is white 1 – background color is black The default is 0.	1
lc	Optional	The language of the login or sign-up page that subscribers see when they click the Subscribe button. If unspecified, the language is determined by a PayPal cookie in the subscriber's browser. If there is no PayPal cookie, the default language is U.S. English. For allowable values, see .	2
no_note	Optional	Do not prompt payers to include a note with their payments. Allowable values: 0 – provide a text box and prompt for the note 1 – hide the text box and the prompt The default is 0.	1
cn	Optional	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".	90
no_shipping	Optional	Do not prompt payers for shipping address. Allowable values: 0 – prompt for an address, but do not require one 1 – do not prompt for an address 2 – prompt for an address, and require one The default is 0.	1
return	Optional	The URL to which the payer'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.	1,024
rm	Optional	Return method. The FORM METHOD used to send data to the URL specified by the return variable after payment completion. Allowable values: 0 – all shopping cart transactions use the GET method 1 – the payer's browser is redirected to the return URL by the GET method, and no transaction variables are sent 2 – the payer's browser is redirected to the return URL by the POST method, and all transaction variables are also posted The default is 0. Note: The rm variable takes effect only if the return variable is also set.	1
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. Note: The return variable must also be set.	60
cancel_ return	Optional	A URL to which the payer'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.	1,024

H