Express Checkout WebElement Options

Parameters

ParameterRequired/OptionalTypeDescription
typerequiredstringAlways "expressCheckout".
optionsoptionalobjectInitialization Options

options

ParameterRequired/OptionalTypeDescription
layoutoptionalstring or objectSpecifies the grid-like layout for buttons in the Express Checkout Element.

The values can be:
"horizontal": Arrange buttons in a single horizontal row.
"vertical": Arrange buttons in a single vertical column.
{ maxColumns: 1, maxRows: 2}: Custom Layout - Use maxColumns and maxRows for a grid layout.

maxColumns: Maximum number of columns for button layout. Default: 0 (unlimited).
maxRows: Maximum number of rows for button layout. Default: 0 (unlimited).
buttonTypeoptionalobjectSets the preferred button type to display for each wallet.
buttonThemeoptionalobjectSets the preferred button type to display for each wallet.
buttonHeightoptionalintegerSets the preferred button height of all buttons.

Defaults to 45px. The allowed range is from 40px to 55px.
paymentMethodOrderoptionalarrayDefines the order in which the buttons are displayed.

For example, to show Apple Pay first, add apple_pay first in the array:
['apple_pay', 'google_pay']
walletsoptionalobject Sets the display behavior for each wallet.

buttonType

ParameterRequired/OptionalTypeDescription
googlePayoptionalstringGoogle Pay's button type. The values are: "book" | "buy" | "checkout" | "donate" | "order" | "pay" | "plain" | "subscribe"

The default is "buy".
applePayoptionalstringApple Pay's button type. The values are: "add-money" | "book" | "buy" | "check-out" | "contribute" | "donate" | "order" | "plain" | "reload" | "rent" | "subscribe" | "support" | "tip" | "top-up"

The default is "buy".

buttonTheme

ParameterRequired/OptionalTypeDescription
googlePayoptionalstringGoogle Pay's button theme. The values are: "black" | "white"
applePayoptionalstringApple Pay's button theme. The values are: "black" | "white" | "white-outline"

wallets

ParameterRequired/OptionalTypeDescription
googlePayoptionalstringWhether you want to show Google Pay as an option or not. The values are: "auto" | "never"
applePayoptionalstringWhether you want to show Apple Pay as an option or not. The values are: "auto" | "never"
emailRequiredoptionalbooleanCollects the email address of the user.
phoneNumberRequiredoptionalbooleanCollects the phone number of the user.