Skip to content

Latest commit

 

History

History
107 lines (61 loc) · 2.14 KB

StripeUPEShippingInitializeOptions.md

File metadata and controls

107 lines (61 loc) · 2.14 KB

@bigcommerce/checkout-sdk / StripeUPEShippingInitializeOptions

Interface: StripeUPEShippingInitializeOptions

A set of options that are required to initialize the shipping step of checkout in order to support StripeUpe.

When StripeUpe is initialized, an iframe will be inserted into the DOM. The iframe has a list of shipping addresses for the customer to choose from.

Table of contents

Properties

Methods

Properties

availableCountries

availableCountries: string

Available countries configured on BC shipping setup.


container

Optional container: string

The ID of a container which the stripe iframe should be inserted.


gatewayId

gatewayId: string

The identifier of the payment provider providing the payment method. This option is only required if the provider offers multiple payment options. i.e.: Stripeupe and Klarna.


methodId

methodId: string

The identifier of the payment method.

Methods

getStripeState

getStripeState(country, state): string

get the state code needed for shipping stripe element

Parameters

Name Type
country string
state string

Returns

string


getStyles

Optional getStyles(): Object

get styles from store theme

Returns

Object


onChangeShipping

onChangeShipping(shipping): void

A callback that gets called whenever the Stripe Link Shipping Element's object is completed.

Parameters

Name Type
shipping StripeEventType

Returns

void