Skip to content

Latest commit

 

History

History
84 lines (49 loc) · 2.23 KB

amazonpaypaymentinitializeoptions.md

File metadata and controls

84 lines (49 loc) · 2.23 KB

@bigcommerce/checkout-sdkAmazonPayPaymentInitializeOptions

Interface: AmazonPayPaymentInitializeOptions

A set of options that are required to initialize the Amazon Pay payment method.

When AmazonPay is initialized, a widget will be inserted into the DOM. The widget has a list of payment options for the customer to choose from.

Hierarchy

  • AmazonPayPaymentInitializeOptions

Index

Properties

Methods

Properties

container

container: string

The ID of a container which the payment widget should insert into.

Methods

Optional onError

onError(error: AmazonPayWidgetError | StandardError): void

A callback that gets called if unable to initialize the widget or select one of the payment options.

Parameters:

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

Returns: void


Optional onPaymentSelect

onPaymentSelect(reference: AmazonPayOrderReference): void

A callback that gets called when the customer selects one of the payment options provided by the widget.

Parameters:

Name Type Description
reference AmazonPayOrderReference The order reference provided by Amazon.

Returns: void


Optional onReady

onReady(reference: AmazonPayOrderReference): void

A callback that gets called when the widget is loaded and ready to be interacted with.

Parameters:

Name Type Description
reference AmazonPayOrderReference The order reference provided by Amazon.

Returns: void