PayPalCommerceButtonInitializeOptions.md

@bigcommerce/checkout-sdk

---

@bigcommerce/checkout-sdk / PayPalCommerceButtonInitializeOptions

Interface: PayPalCommerceButtonInitializeOptions

A set of options that are required to initialize PayPalCommerce in cart or product details page.

When PayPalCommerce is initialized, an PayPalCommerce button will be inserted into the DOM. When a customer clicks on it, it will trigger Apple sheet.

Properties

buyNowInitializeOptions?

optional buyNowInitializeOptions?: PayPalBuyNowInitializeOptions_2

The options that are required to initialize Buy Now functionality.

---

currencyCode?

optional currencyCode?: string

The option that used to initialize a PayPal script with provided currency code.

---

style?

optional style?: PayPalButtonStyleOptions_2

A set of styling options for the checkout button.

Methods

onComplete()?

optional onComplete(): void

A callback that gets called when payment complete on paypal side.

Returns

void

---

onEligibilityFailure()?

optional onEligibilityFailure(): void

A callback that gets called when PayPal SDK restricts to render PayPal component.

Returns

void