partners

Customize Checkout Button

Important: PayPal for Partners is a limited-release solution at this time. It is available to select partners for approved use cases. For more information, reach out to your PayPal account manager.

You can customize the look and feel of your smart payment button.

Set or change locale

To specify the button language, set locale to a supported locale using the locale parameter:

Option Value Type Description
locale Supported locales String OPTIONAL
The locale code of the country and language to display on the button.
Default: en_US

For example:

  • locale: 'en_US' displays PayPal Checkout
  • locale: 'de_DE' displays PayPal Zur Kasse

Button styles

To define the color, shape, size and label of the button, use the button style parameters.

Option Type Description
style Object Optional
Style options for the button, including color, shape, size, and label.

Color

Set the style.color option to one of these values:

Value Description Button
gold Recommended
People around the world know us for the color gold and research confirms it. Extensive testing determined just the right shade and shape that help increase conversion. Use it on your website to leverage PayPal’s recognition and preference.
blue First alternative
If gold does not work for your site, try the PayPal blue button. Research shows that people know it is our brand color, which provides a halo of trust and security to your experience.
silver
white
Second alternatives
If gold or blue does not work for your site design or aesthetic, try the silver or white buttons. Because these colors are a bit recessive and less capable of drawing people’s attention, we recommend these button colors as a second alternative.

black Third alternative
If your website demands a monochromatic button experience, try the black button. Because black is a common website color and less capable of drawing people's attention, we recommend this button as a third alternative.

Shape

Set the style.shape option to one of these values:

Value Description Button
pill Recommended
Whenever possible, use the pill-shaped button. Its unique and powerful shape signifies PayPal in people’s minds.
rect Use the rectangular button as an alternative for media such as mobile where pill-shaped buttons might pose design challenges.

Size

Set the style.size option to one of these values:

Value Dimensions Description Button
small 150 pixels by 25 pixels Use to match the size of other small buttons on the page.
medium 250 pixels by 35 pixels Use to match the size of other medium buttons on the page.
large 350 pixels by 40 pixels Use to match the size of other large buttons on the page.
responsive Dynamic Recommended. Matches the width of the container element, with the height decided dynamically based on width. Minimum width is 100px, maximum width is 500px. responsive button

Set the style.height option to one of these values:

Value Dimensions Description Button
small 25 - 55 pixels Use to match the height of other small buttons on the page.
medium 35 - 55 pixels Use to match the height of other medium buttons on the page.
large 30 - 55 pixels Use to match the height of other large buttons on the page.

Label

Set the style.label option to one of these values:

Value Description Button
checkout Displays the PayPal Checkout button.
Default: checkout
pay Displays the Pay With PayPal button and initializes the checkout flow.
buynow Displays the Buy Now button and initializes the checkout flow. The default Buy Now button is unbranded. To include PayPal branding, set branding: true.
paypal Displays the generic PayPal button and initializes the checkout flow. This button contains only the PayPal brand logo.
installment Displays the PayPal Installment button and offers a specified number of payments during a payment installment period.
Note: The installment feature is available only in these locales: en_MX, es_MX, en_BR, pt_BR
Set style.installmentperiod to set the number of payments during the installment period:
  • en_BR, pt_BR: 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12
  • en_MX, es_MX: 3, 6, 9, 12

Tagline

Set the style.tagline to false to disable the tagline text:

Value Description Button
true Display tagline text
Default.
false Disable tagline text.

Funding methods

Currently, PayPal for Partners supports using a PayPal button only. Venmo and PayPal Credit options are not available.

Feedback