Skip to content

Latest commit

 

History

History
120 lines (68 loc) · 3.05 KB

BraintreePaypalButtonInitializeOptions.md

File metadata and controls

120 lines (68 loc) · 3.05 KB

@bigcommerce/checkout-sdk / BraintreePaypalButtonInitializeOptions

Interface: BraintreePaypalButtonInitializeOptions

Table of contents

Properties

Methods

Properties

buyNowInitializeOptions

Optional buyNowInitializeOptions: Object

The options that are required to initialize Buy Now functionality.

Type declaration

Name Type
getBuyNowCartRequestBody? () => void | BuyNowCartRequestBody

currencyCode

Optional currencyCode: string

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


messagingContainerId

Optional messagingContainerId: string

The ID of a container which the messaging should be inserted.


shippingAddress

Optional shippingAddress: null | Address

Address to be used for shipping. If not provided, it will use the first saved address from the active customer.


style

Optional style: Pick<PaypalStyleOptions, "color" | "layout" | "size" | "label" | "shape" | "tagline" | "fundingicons" | "height">

A set of styling options for the checkout button.

Methods

onAuthorizeError

Optional onAuthorizeError(error): void

A callback that gets called if unable to authorize and tokenize payment.

Parameters

Name Type Description
error BraintreeError_2 | StandardError The error object describing the failure.

Returns

void


onError

Optional onError(error): void

A callback that gets called on any error instead of submit payment or authorization errors.

Parameters

Name Type Description
error BraintreeError_2 | StandardError The error object describing the failure.

Returns

void


onPaymentError

Optional onPaymentError(error): void

A callback that gets called if unable to submit payment.

Parameters

Name Type Description
error BraintreeError_2 | StandardError The error object describing the failure.

Returns

void