@bigcommerce/checkout-sdk / 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.
• availableCountries: string
Available countries configured on BC shipping setup.
• Optional
container: string
The ID of a container which the stripe iframe should be inserted.
• 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: string
The identifier of the payment method.
▸ getStripeState(country
, state
): string
get the state code needed for shipping stripe element
Name | Type |
---|---|
country |
string |
state |
string |
string
▸ Optional
getStyles(): Object
get styles from store theme
Object
▸ onChangeShipping(shipping
): void
A callback that gets called whenever the Stripe Link Shipping Element's object is completed.
Name | Type |
---|---|
shipping |
StripeEventType |
void