@bigcommerce/checkout-sdk 1.244.2 → 1.246.0

package/docs/README.md

@@ -337,6 +337,7 @@
 * [WithCheckoutcomiDealInstrument](interfaces/withcheckoutcomidealinstrument.md)
 * [WithDocumentInstrument](interfaces/withdocumentinstrument.md)
 * [WithMollieIssuerInstrument](interfaces/withmollieissuerinstrument.md)
+* [WorldpayPaymentInitializeOptions](interfaces/worldpaypaymentinitializeoptions.md)
 * [ZipCodeElementOptions](interfaces/zipcodeelementoptions.md)
 
 ### Type aliases

package/docs/interfaces/paymentinitializeoptions.md

@@ -55,6 +55,7 @@ current checkout flow.
 * [stripeupe](paymentinitializeoptions.md#optional-stripeupe)
 * [stripev3](paymentinitializeoptions.md#optional-stripev3)
 * [timeout](paymentinitializeoptions.md#optional-timeout)
+* [worldpay](paymentinitializeoptions.md#optional-worldpay)
 
 ## Properties
 
@@ -390,3 +391,12 @@ ___
 Provide this option if you want to cancel or time out the request. If the
 timeout object completes before the request, the request will be
 cancelled.
+
+___
+
+### `Optional` worldpay
+
+• **worldpay**? : *[WorldpayPaymentInitializeOptions](worldpaypaymentinitializeoptions.md)*
+
+The options that are required to initialize the Worldpay payment method.
+They can be omitted unless you need to support Worldpay.

package/docs/interfaces/worldpaypaymentinitializeoptions.md

@@ -0,0 +1,39 @@
+[@bigcommerce/checkout-sdk](../README.md) › [WorldpayPaymentInitializeOptions](worldpaypaymentinitializeoptions.md)
+
+# Interface: WorldpayPaymentInitializeOptions
+
+## Hierarchy
+
+* **WorldpayPaymentInitializeOptions**
+
+## Index
+
+### Methods
+
+* [onLoad](worldpaypaymentinitializeoptions.md#onload)
+
+## Methods
+
+###  onLoad
+
+▸ **onLoad**(`iframe`: HTMLIFrameElement, `cancel`: function): *void*
+
+A callback that gets called when the iframe is ready to be added to the
+current page. It is responsible for determining where the iframe should
+be inserted in the DOM.
+
+**Parameters:**
+
+▪ **iframe**: *HTMLIFrameElement*
+
+The iframe element containing the payment web page
+provided by the strategy.
+
+▪ **cancel**: *function*
+
+A function, when called, will cancel the payment
+process and remove the iframe.
+
+▸ (): *void*
+
+**Returns:** *void*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigcommerce/checkout-sdk",
-  "version": "1.244.2",
+  "version": "1.246.0",
   "description": "BigCommerce Checkout JavaScript SDK",
   "license": "MIT",
   "main": "dist/checkout-sdk.js",