@bigcommerce/checkout-sdk 1.271.2 → 1.271.3

package/docs/interfaces/PaymentInitializeOptions.md

@@ -0,0 +1,406 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaymentInitializeOptions
+
+# Interface: PaymentInitializeOptions
+
+A set of options that are required to initialize the payment step of the
+current checkout flow.
+
+## Hierarchy
+
+- [`PaymentRequestOptions`](PaymentRequestOptions.md)
+
+  ↳ **`PaymentInitializeOptions`**
+
+## Table of contents
+
+### Properties
+
+- [adyenv2](PaymentInitializeOptions.md#adyenv2)
+- [adyenv3](PaymentInitializeOptions.md#adyenv3)
+- [amazon](PaymentInitializeOptions.md#amazon)
+- [amazonpay](PaymentInitializeOptions.md#amazonpay)
+- [applepay](PaymentInitializeOptions.md#applepay)
+- [bluesnapv2](PaymentInitializeOptions.md#bluesnapv2)
+- [bolt](PaymentInitializeOptions.md#bolt)
+- [braintree](PaymentInitializeOptions.md#braintree)
+- [braintreevisacheckout](PaymentInitializeOptions.md#braintreevisacheckout)
+- [chasepay](PaymentInitializeOptions.md#chasepay)
+- [creditCard](PaymentInitializeOptions.md#creditcard)
+- [digitalriver](PaymentInitializeOptions.md#digitalriver)
+- [gatewayId](PaymentInitializeOptions.md#gatewayid)
+- [googlepayadyenv2](PaymentInitializeOptions.md#googlepayadyenv2)
+- [googlepayadyenv3](PaymentInitializeOptions.md#googlepayadyenv3)
+- [googlepayauthorizenet](PaymentInitializeOptions.md#googlepayauthorizenet)
+- [googlepaybraintree](PaymentInitializeOptions.md#googlepaybraintree)
+- [googlepaycheckoutcom](PaymentInitializeOptions.md#googlepaycheckoutcom)
+- [googlepaycybersourcev2](PaymentInitializeOptions.md#googlepaycybersourcev2)
+- [googlepayorbital](PaymentInitializeOptions.md#googlepayorbital)
+- [googlepaystripe](PaymentInitializeOptions.md#googlepaystripe)
+- [googlepaystripeupe](PaymentInitializeOptions.md#googlepaystripeupe)
+- [klarna](PaymentInitializeOptions.md#klarna)
+- [klarnav2](PaymentInitializeOptions.md#klarnav2)
+- [masterpass](PaymentInitializeOptions.md#masterpass)
+- [methodId](PaymentInitializeOptions.md#methodid)
+- [mollie](PaymentInitializeOptions.md#mollie)
+- [moneris](PaymentInitializeOptions.md#moneris)
+- [opy](PaymentInitializeOptions.md#opy)
+- [params](PaymentInitializeOptions.md#params)
+- [paypalcommerce](PaymentInitializeOptions.md#paypalcommerce)
+- [paypalexpress](PaymentInitializeOptions.md#paypalexpress)
+- [square](PaymentInitializeOptions.md#square)
+- [stripeupe](PaymentInitializeOptions.md#stripeupe)
+- [stripev3](PaymentInitializeOptions.md#stripev3)
+- [timeout](PaymentInitializeOptions.md#timeout)
+- [worldpay](PaymentInitializeOptions.md#worldpay)
+
+## Properties
+
+### adyenv2
+
+• `Optional` **adyenv2**: [`AdyenV2PaymentInitializeOptions`](AdyenV2PaymentInitializeOptions.md)
+
+The options that are required to initialize the AdyenV2 payment
+method. They can be omitted unless you need to support AdyenV2.
+
+___
+
+### adyenv3
+
+• `Optional` **adyenv3**: [`AdyenV3PaymentInitializeOptions`](AdyenV3PaymentInitializeOptions.md)
+
+The options that are required to initialize the AdyenV3 payment
+method. They can be omitted unless you need to support AdyenV3.
+
+___
+
+### amazon
+
+• `Optional` **amazon**: [`AmazonPayPaymentInitializeOptions`](AmazonPayPaymentInitializeOptions.md)
+
+The options that are required to initialize the Amazon Pay payment
+method. They can be omitted unless you need to support AmazonPay.
+
+___
+
+### amazonpay
+
+• `Optional` **amazonpay**: [`AmazonPayV2PaymentInitializeOptions`](AmazonPayV2PaymentInitializeOptions.md)
+
+The options that are required to initialize the AmazonPayV2 payment
+method. They can be omitted unless you need to support AmazonPayV2.
+
+___
+
+### applepay
+
+• `Optional` **applepay**: [`ApplePayPaymentInitializeOptions`](ApplePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the Apple Pay payment
+method. They can be omitted unless you need to support AmazonPay.
+
+___
+
+### bluesnapv2
+
+• `Optional` **bluesnapv2**: [`BlueSnapV2PaymentInitializeOptions`](BlueSnapV2PaymentInitializeOptions.md)
+
+The options that are required to initialize the BlueSnapV2 payment method.
+They can be omitted unless you need to support BlueSnapV2.
+
+___
+
+### bolt
+
+• `Optional` **bolt**: [`BoltPaymentInitializeOptions`](BoltPaymentInitializeOptions.md)
+
+The options that allow Bolt to load the client script and handle the checkout.
+They can be omitted if Bolt's full checkout take over is intended.
+
+___
+
+### braintree
+
+• `Optional` **braintree**: [`BraintreePaymentInitializeOptions`](BraintreePaymentInitializeOptions.md)
+
+The options that are required to initialize the Braintree payment method.
+They can be omitted unless you need to support Braintree.
+
+___
+
+### braintreevisacheckout
+
+• `Optional` **braintreevisacheckout**: [`BraintreeVisaCheckoutPaymentInitializeOptions`](BraintreeVisaCheckoutPaymentInitializeOptions.md)
+
+The options that are required to initialize the Visa Checkout payment
+method provided by Braintree. They can be omitted unless you need to
+support Visa Checkout.
+
+___
+
+### chasepay
+
+• `Optional` **chasepay**: [`ChasePayInitializeOptions`](ChasePayInitializeOptions.md)
+
+The options that are required to initialize the Chasepay payment method.
+They can be omitted unless you need to support Chasepay.
+
+___
+
+### creditCard
+
+• `Optional` **creditCard**: [`CreditCardPaymentInitializeOptions`](CreditCardPaymentInitializeOptions.md)
+
+**`alpha`**
+Please note that this option is currently in an early stage of
+development. Therefore the API is unstable and not ready for public
+consumption.
+
+___
+
+### digitalriver
+
+• `Optional` **digitalriver**: [`DigitalRiverPaymentInitializeOptions`](DigitalRiverPaymentInitializeOptions.md)
+
+The options that are required to initialize the Digital River payment method.
+They can be omitted unless you need to support Digital River.
+
+___
+
+### gatewayId
+
+• `Optional` **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.: Adyen and Klarna.
+
+#### Inherited from
+
+[PaymentRequestOptions](PaymentRequestOptions.md).[gatewayId](PaymentRequestOptions.md#gatewayid)
+
+___
+
+### googlepayadyenv2
+
+• `Optional` **googlepayadyenv2**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Authorize.Net
+payment method. They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepayadyenv3
+
+• `Optional` **googlepayadyenv3**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Authorize.Net
+payment method. They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepayauthorizenet
+
+• `Optional` **googlepayauthorizenet**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Authorize.Net
+payment method. They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaybraintree
+
+• `Optional` **googlepaybraintree**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Braintree payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaycheckoutcom
+
+• `Optional` **googlepaycheckoutcom**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Checkout.com payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaycybersourcev2
+
+• `Optional` **googlepaycybersourcev2**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay CybersourceV2 payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepayorbital
+
+• `Optional` **googlepayorbital**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaystripe
+
+• `Optional` **googlepaystripe**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Stripe payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### googlepaystripeupe
+
+• `Optional` **googlepaystripeupe**: [`GooglePayPaymentInitializeOptions`](GooglePayPaymentInitializeOptions.md)
+
+The options that are required to initialize the GooglePay Stripe payment method.
+They can be omitted unless you need to support GooglePay.
+
+___
+
+### klarna
+
+• `Optional` **klarna**: [`KlarnaPaymentInitializeOptions`](KlarnaPaymentInitializeOptions.md)
+
+The options that are required to initialize the Klarna payment method.
+They can be omitted unless you need to support Klarna.
+
+___
+
+### klarnav2
+
+• `Optional` **klarnav2**: [`KlarnaV2PaymentInitializeOptions`](KlarnaV2PaymentInitializeOptions.md)
+
+The options that are required to initialize the KlarnaV2 payment method.
+They can be omitted unless you need to support KlarnaV2.
+
+___
+
+### masterpass
+
+• `Optional` **masterpass**: [`MasterpassPaymentInitializeOptions`](MasterpassPaymentInitializeOptions.md)
+
+The options that are required to initialize the Masterpass payment method.
+They can be omitted unless you need to support Masterpass.
+
+___
+
+### methodId
+
+• **methodId**: `string`
+
+The identifier of the payment method.
+
+#### Inherited from
+
+[PaymentRequestOptions](PaymentRequestOptions.md).[methodId](PaymentRequestOptions.md#methodid)
+
+___
+
+### mollie
+
+• `Optional` **mollie**: [`MolliePaymentInitializeOptions`](MolliePaymentInitializeOptions.md)
+
+The options that are required to initialize the Mollie payment method.
+They can be omitted unless you need to support Mollie.
+
+___
+
+### moneris
+
+• `Optional` **moneris**: [`MonerisPaymentInitializeOptions`](MonerisPaymentInitializeOptions.md)
+
+The options that are required to initialize the Moneris payment method.
+They can be omitted unless you need to support Moneris.
+
+___
+
+### opy
+
+• `Optional` **opy**: [`OpyPaymentInitializeOptions`](OpyPaymentInitializeOptions.md)
+
+The options that are required to initialize the Opy payment
+method. They can be omitted unless you need to support Opy.
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[PaymentRequestOptions](PaymentRequestOptions.md).[params](PaymentRequestOptions.md#params)
+
+___
+
+### paypalcommerce
+
+• `Optional` **paypalcommerce**: [`PaypalCommercePaymentInitializeOptions`](PaypalCommercePaymentInitializeOptions.md) \| [`PaypalCommerceCreditCardPaymentInitializeOptions`](PaypalCommerceCreditCardPaymentInitializeOptions.md)
+
+The options that are required to initialize the PayPal Commerce payment method.
+They can be omitted unless you need to support PayPal Commerce.
+
+___
+
+### paypalexpress
+
+• `Optional` **paypalexpress**: [`PaypalExpressPaymentInitializeOptions`](PaypalExpressPaymentInitializeOptions.md)
+
+The options that are required to initialize the PayPal Express payment method.
+They can be omitted unless you need to support PayPal Express.
+
+___
+
+### square
+
+• `Optional` **square**: [`SquarePaymentInitializeOptions`](SquarePaymentInitializeOptions.md)
+
+The options that are required to initialize the Square payment method.
+They can be omitted unless you need to support Square.
+
+___
+
+### stripeupe
+
+• `Optional` **stripeupe**: [`StripeUPEPaymentInitializeOptions`](StripeUPEPaymentInitializeOptions.md)
+
+The options that are required to initialize the StripeUPE payment method.
+They can be omitted unless you need to support StripeUPE.
+
+___
+
+### stripev3
+
+• `Optional` **stripev3**: [`StripeV3PaymentInitializeOptions`](StripeV3PaymentInitializeOptions.md)
+
+The options that are required to initialize the Stripe payment method.
+They can be omitted unless you need to support StripeV3.
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `default`
+
+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.
+
+#### Inherited from
+
+[PaymentRequestOptions](PaymentRequestOptions.md).[timeout](PaymentRequestOptions.md#timeout)
+
+___
+
+### worldpay
+
+• `Optional` **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/PaymentMethod.md

@@ -0,0 +1,98 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaymentMethod
+
+# Interface: PaymentMethod<T\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+
+## Table of contents
+
+### Properties
+
+- [clientToken](PaymentMethod.md#clienttoken)
+- [config](PaymentMethod.md#config)
+- [gateway](PaymentMethod.md#gateway)
+- [id](PaymentMethod.md#id)
+- [initializationData](PaymentMethod.md#initializationdata)
+- [initializationStrategy](PaymentMethod.md#initializationstrategy)
+- [logoUrl](PaymentMethod.md#logourl)
+- [method](PaymentMethod.md#method)
+- [nonce](PaymentMethod.md#nonce)
+- [returnUrl](PaymentMethod.md#returnurl)
+- [supportedCards](PaymentMethod.md#supportedcards)
+- [type](PaymentMethod.md#type)
+
+## Properties
+
+### clientToken
+
+• `Optional` **clientToken**: `string`
+
+___
+
+### config
+
+• **config**: [`PaymentMethodConfig`](PaymentMethodConfig.md)
+
+___
+
+### gateway
+
+• `Optional` **gateway**: `string`
+
+___
+
+### id
+
+• **id**: `string`
+
+___
+
+### initializationData
+
+• `Optional` **initializationData**: `T`
+
+___
+
+### initializationStrategy
+
+• `Optional` **initializationStrategy**: [`InitializationStrategy`](InitializationStrategy.md)
+
+___
+
+### logoUrl
+
+• `Optional` **logoUrl**: `string`
+
+___
+
+### method
+
+• **method**: `string`
+
+___
+
+### nonce
+
+• `Optional` **nonce**: `string`
+
+___
+
+### returnUrl
+
+• `Optional` **returnUrl**: `string`
+
+___
+
+### supportedCards
+
+• **supportedCards**: `string`[]
+
+___
+
+### type
+
+• **type**: `string`

package/docs/interfaces/PaymentMethodConfig.md

@@ -0,0 +1,120 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaymentMethodConfig
+
+# Interface: PaymentMethodConfig
+
+## Table of contents
+
+### Properties
+
+- [cardCode](PaymentMethodConfig.md#cardcode)
+- [displayName](PaymentMethodConfig.md#displayname)
+- [enablePaypal](PaymentMethodConfig.md#enablepaypal)
+- [hasDefaultStoredInstrument](PaymentMethodConfig.md#hasdefaultstoredinstrument)
+- [helpText](PaymentMethodConfig.md#helptext)
+- [is3dsEnabled](PaymentMethodConfig.md#is3dsenabled)
+- [isHostedFormEnabled](PaymentMethodConfig.md#ishostedformenabled)
+- [isVaultingCvvEnabled](PaymentMethodConfig.md#isvaultingcvvenabled)
+- [isVaultingEnabled](PaymentMethodConfig.md#isvaultingenabled)
+- [isVisaCheckoutEnabled](PaymentMethodConfig.md#isvisacheckoutenabled)
+- [logo](PaymentMethodConfig.md#logo)
+- [merchantId](PaymentMethodConfig.md#merchantid)
+- [redirectUrl](PaymentMethodConfig.md#redirecturl)
+- [requireCustomerCode](PaymentMethodConfig.md#requirecustomercode)
+- [returnUrl](PaymentMethodConfig.md#returnurl)
+- [testMode](PaymentMethodConfig.md#testmode)
+
+## Properties
+
+### cardCode
+
+• `Optional` **cardCode**: `boolean`
+
+___
+
+### displayName
+
+• `Optional` **displayName**: `string`
+
+___
+
+### enablePaypal
+
+• `Optional` **enablePaypal**: `boolean`
+
+___
+
+### hasDefaultStoredInstrument
+
+• `Optional` **hasDefaultStoredInstrument**: `boolean`
+
+___
+
+### helpText
+
+• `Optional` **helpText**: `string`
+
+___
+
+### is3dsEnabled
+
+• `Optional` **is3dsEnabled**: `boolean`
+
+___
+
+### isHostedFormEnabled
+
+• `Optional` **isHostedFormEnabled**: `boolean`
+
+___
+
+### isVaultingCvvEnabled
+
+• `Optional` **isVaultingCvvEnabled**: `boolean`
+
+___
+
+### isVaultingEnabled
+
+• `Optional` **isVaultingEnabled**: `boolean`
+
+___
+
+### isVisaCheckoutEnabled
+
+• `Optional` **isVisaCheckoutEnabled**: `boolean`
+
+___
+
+### logo
+
+• `Optional` **logo**: `string`
+
+___
+
+### merchantId
+
+• `Optional` **merchantId**: `string`
+
+___
+
+### redirectUrl
+
+• `Optional` **redirectUrl**: `string`
+
+___
+
+### requireCustomerCode
+
+• `Optional` **requireCustomerCode**: `boolean`
+
+___
+
+### returnUrl
+
+• `Optional` **returnUrl**: `string`
+
+___
+
+### testMode
+
+• `Optional` **testMode**: `boolean`

package/docs/interfaces/PaymentRequestOptions.md

@@ -0,0 +1,67 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaymentRequestOptions
+
+# Interface: PaymentRequestOptions
+
+The set of options for configuring any requests related to the payment step of
+the current checkout flow.
+
+## Hierarchy
+
+- [`RequestOptions`](RequestOptions.md)
+
+  ↳ **`PaymentRequestOptions`**
+
+  ↳↳ [`PaymentInitializeOptions`](PaymentInitializeOptions.md)
+
+## Table of contents
+
+### Properties
+
+- [gatewayId](PaymentRequestOptions.md#gatewayid)
+- [methodId](PaymentRequestOptions.md#methodid)
+- [params](PaymentRequestOptions.md#params)
+- [timeout](PaymentRequestOptions.md#timeout)
+
+## Properties
+
+### gatewayId
+
+• `Optional` **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.: Adyen and Klarna.
+
+___
+
+### methodId
+
+• **methodId**: `string`
+
+The identifier of the payment method.
+
+___
+
+### params
+
+• `Optional` **params**: `Object`
+
+The parameters of the request, if required.
+
+#### Inherited from
+
+[RequestOptions](RequestOptions.md).[params](RequestOptions.md#params)
+
+___
+
+### timeout
+
+• `Optional` **timeout**: `default`
+
+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.
+
+#### Inherited from
+
+[RequestOptions](RequestOptions.md).[timeout](RequestOptions.md#timeout)

package/docs/interfaces/PaymentSettings.md

@@ -0,0 +1,22 @@
+[@bigcommerce/checkout-sdk](../README.md) / PaymentSettings
+
+# Interface: PaymentSettings
+
+## Table of contents
+
+### Properties
+
+- [bigpayBaseUrl](PaymentSettings.md#bigpaybaseurl)
+- [clientSidePaymentProviders](PaymentSettings.md#clientsidepaymentproviders)
+
+## Properties
+
+### bigpayBaseUrl
+
+• **bigpayBaseUrl**: `string`
+
+___
+
+### clientSidePaymentProviders
+
+• **clientSidePaymentProviders**: `string`[]