@bigcommerce/checkout-sdk 1.272.3 → 1.275.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -0
- package/dist/checkout-button.d.ts +168 -101
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.js.map +1 -1
- package/dist/checkout-button.umd.js +1 -1
- package/dist/checkout-button.umd.js.map +1 -1
- package/dist/checkout-sdk.d.ts +562 -453
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.js.map +1 -1
- package/dist/checkout-sdk.umd.js +1 -1
- package/dist/checkout-sdk.umd.js.map +1 -1
- package/dist/hosted-form.js.map +1 -1
- package/dist/hosted-form.umd.js.map +1 -1
- package/docs/README.md +44 -4
- package/docs/classes/CheckoutButtonInitializer.md +1 -1
- package/docs/classes/CheckoutService.md +2 -2
- package/docs/enums/AdyenV2CardFields.md +29 -0
- package/docs/enums/AdyenV3CardFields.md +29 -0
- package/docs/enums/AmazonPayV2ButtonColor.md +29 -0
- package/docs/interfaces/AdyenComponentEvents.md +2 -2
- package/docs/interfaces/AdyenComponentEvents_2.md +2 -2
- package/docs/interfaces/AdyenCreditCardComponentOptions.md +2 -2
- package/docs/interfaces/AdyenV2PaymentInitializeOptions.md +2 -2
- package/docs/interfaces/AdyenV2ValidationState.md +57 -0
- package/docs/interfaces/AdyenV3CreditCardComponentOptions.md +2 -2
- package/docs/interfaces/AdyenV3PaymentInitializeOptions.md +2 -2
- package/docs/interfaces/AdyenV3ValidationState.md +57 -0
- package/docs/interfaces/AmazonPayV2ButtonConfig.md +80 -0
- package/docs/interfaces/AmazonPayV2ButtonParams.md +45 -1
- package/docs/interfaces/AmazonPayV2CheckoutSessionConfig.md +36 -0
- package/docs/interfaces/AmazonPayV2NewButtonParams.md +125 -0
- package/docs/interfaces/ApplePayButtonInitializeOptions_2.md +38 -0
- package/docs/interfaces/{CheckoutButtonInitializeOptions.md → BaseCheckoutButtonInitializeOptions.md} +26 -26
- package/docs/interfaces/{CustomerInitializeOptions.md → BaseCustomerInitializeOptions.md} +21 -31
- package/docs/interfaces/{PaymentInitializeOptions.md → BasePaymentInitializeOptions.md} +39 -49
- package/docs/interfaces/CheckoutButtonOptions.md +1 -1
- package/docs/interfaces/CustomerRequestOptions.md +1 -1
- package/docs/interfaces/PaymentRequestOptions.md +1 -1
- package/docs/interfaces/WithApplePayButtonInitializeOptions.md +15 -0
- package/docs/interfaces/WithApplePayCustomerInitializeOptions.md +18 -0
- package/docs/interfaces/WithApplePayPaymentInitializeOptions.md +18 -0
- package/package.json +1 -1
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2CheckoutSessionConfig
|
|
2
|
+
|
|
3
|
+
# Interface: AmazonPayV2CheckoutSessionConfig
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [payloadJSON](AmazonPayV2CheckoutSessionConfig.md#payloadjson)
|
|
10
|
+
- [publicKeyId](AmazonPayV2CheckoutSessionConfig.md#publickeyid)
|
|
11
|
+
- [signature](AmazonPayV2CheckoutSessionConfig.md#signature)
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### payloadJSON
|
|
16
|
+
|
|
17
|
+
• **payloadJSON**: `string`
|
|
18
|
+
|
|
19
|
+
A payload that Amazon Pay will use to create a Checkout Session object.
|
|
20
|
+
|
|
21
|
+
___
|
|
22
|
+
|
|
23
|
+
### publicKeyId
|
|
24
|
+
|
|
25
|
+
• `Optional` **publicKeyId**: `string`
|
|
26
|
+
|
|
27
|
+
Credential provided by Amazon Pay. You do not have to set this parameter
|
|
28
|
+
if your `publicKeyId` has an environment prefix.
|
|
29
|
+
|
|
30
|
+
___
|
|
31
|
+
|
|
32
|
+
### signature
|
|
33
|
+
|
|
34
|
+
• **signature**: `string`
|
|
35
|
+
|
|
36
|
+
Payload's signature.
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / AmazonPayV2NewButtonParams
|
|
2
|
+
|
|
3
|
+
# Interface: AmazonPayV2NewButtonParams
|
|
4
|
+
|
|
5
|
+
## Hierarchy
|
|
6
|
+
|
|
7
|
+
- [`AmazonPayV2ButtonConfig`](AmazonPayV2ButtonConfig.md)
|
|
8
|
+
|
|
9
|
+
↳ **`AmazonPayV2NewButtonParams`**
|
|
10
|
+
|
|
11
|
+
## Table of contents
|
|
12
|
+
|
|
13
|
+
### Properties
|
|
14
|
+
|
|
15
|
+
- [buttonColor](AmazonPayV2NewButtonParams.md#buttoncolor)
|
|
16
|
+
- [checkoutLanguage](AmazonPayV2NewButtonParams.md#checkoutlanguage)
|
|
17
|
+
- [createCheckoutSessionConfig](AmazonPayV2NewButtonParams.md#createcheckoutsessionconfig)
|
|
18
|
+
- [ledgerCurrency](AmazonPayV2NewButtonParams.md#ledgercurrency)
|
|
19
|
+
- [merchantId](AmazonPayV2NewButtonParams.md#merchantid)
|
|
20
|
+
- [placement](AmazonPayV2NewButtonParams.md#placement)
|
|
21
|
+
- [productType](AmazonPayV2NewButtonParams.md#producttype)
|
|
22
|
+
- [publicKeyId](AmazonPayV2NewButtonParams.md#publickeyid)
|
|
23
|
+
- [sandbox](AmazonPayV2NewButtonParams.md#sandbox)
|
|
24
|
+
|
|
25
|
+
## Properties
|
|
26
|
+
|
|
27
|
+
### buttonColor
|
|
28
|
+
|
|
29
|
+
• `Optional` **buttonColor**: [`Gold`](../enums/AmazonPayV2ButtonColor.md#gold) \| [`LightGray`](../enums/AmazonPayV2ButtonColor.md#lightgray) \| [`DarkGray`](../enums/AmazonPayV2ButtonColor.md#darkgray)
|
|
30
|
+
|
|
31
|
+
Color of the Amazon Pay button.
|
|
32
|
+
|
|
33
|
+
#### Inherited from
|
|
34
|
+
|
|
35
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[buttonColor](AmazonPayV2ButtonConfig.md#buttoncolor)
|
|
36
|
+
|
|
37
|
+
___
|
|
38
|
+
|
|
39
|
+
### checkoutLanguage
|
|
40
|
+
|
|
41
|
+
• `Optional` **checkoutLanguage**: [`en_US`](../enums/AmazonPayV2CheckoutLanguage.md#en_us) \| [`en_GB`](../enums/AmazonPayV2CheckoutLanguage.md#en_gb) \| [`de_DE`](../enums/AmazonPayV2CheckoutLanguage.md#de_de) \| [`fr_FR`](../enums/AmazonPayV2CheckoutLanguage.md#fr_fr) \| [`it_IT`](../enums/AmazonPayV2CheckoutLanguage.md#it_it) \| [`es_ES`](../enums/AmazonPayV2CheckoutLanguage.md#es_es) \| [`ja_JP`](../enums/AmazonPayV2CheckoutLanguage.md#ja_jp)
|
|
42
|
+
|
|
43
|
+
Language used to render the button and text on Amazon Pay hosted pages.
|
|
44
|
+
|
|
45
|
+
#### Inherited from
|
|
46
|
+
|
|
47
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[checkoutLanguage](AmazonPayV2ButtonConfig.md#checkoutlanguage)
|
|
48
|
+
|
|
49
|
+
___
|
|
50
|
+
|
|
51
|
+
### createCheckoutSessionConfig
|
|
52
|
+
|
|
53
|
+
• **createCheckoutSessionConfig**: [`AmazonPayV2CheckoutSessionConfig`](AmazonPayV2CheckoutSessionConfig.md)
|
|
54
|
+
|
|
55
|
+
Create Checkout Session configuration.
|
|
56
|
+
|
|
57
|
+
___
|
|
58
|
+
|
|
59
|
+
### ledgerCurrency
|
|
60
|
+
|
|
61
|
+
• **ledgerCurrency**: [`AmazonPayV2LedgerCurrency`](../enums/AmazonPayV2LedgerCurrency.md)
|
|
62
|
+
|
|
63
|
+
Ledger currency provided during registration for the given merchant identifier.
|
|
64
|
+
|
|
65
|
+
#### Inherited from
|
|
66
|
+
|
|
67
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[ledgerCurrency](AmazonPayV2ButtonConfig.md#ledgercurrency)
|
|
68
|
+
|
|
69
|
+
___
|
|
70
|
+
|
|
71
|
+
### merchantId
|
|
72
|
+
|
|
73
|
+
• **merchantId**: `string`
|
|
74
|
+
|
|
75
|
+
Amazon Pay merchant account identifier.
|
|
76
|
+
|
|
77
|
+
#### Inherited from
|
|
78
|
+
|
|
79
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[merchantId](AmazonPayV2ButtonConfig.md#merchantid)
|
|
80
|
+
|
|
81
|
+
___
|
|
82
|
+
|
|
83
|
+
### placement
|
|
84
|
+
|
|
85
|
+
• **placement**: [`AmazonPayV2Placement`](../enums/AmazonPayV2Placement.md)
|
|
86
|
+
|
|
87
|
+
Placement of the Amazon Pay button on your website.
|
|
88
|
+
|
|
89
|
+
#### Inherited from
|
|
90
|
+
|
|
91
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[placement](AmazonPayV2ButtonConfig.md#placement)
|
|
92
|
+
|
|
93
|
+
___
|
|
94
|
+
|
|
95
|
+
### productType
|
|
96
|
+
|
|
97
|
+
• `Optional` **productType**: [`PayAndShip`](../enums/AmazonPayV2PayOptions.md#payandship) \| [`PayOnly`](../enums/AmazonPayV2PayOptions.md#payonly)
|
|
98
|
+
|
|
99
|
+
Product type selected for checkout. Default is 'PayAndShip'.
|
|
100
|
+
|
|
101
|
+
#### Inherited from
|
|
102
|
+
|
|
103
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[productType](AmazonPayV2ButtonConfig.md#producttype)
|
|
104
|
+
|
|
105
|
+
___
|
|
106
|
+
|
|
107
|
+
### publicKeyId
|
|
108
|
+
|
|
109
|
+
• `Optional` **publicKeyId**: `string`
|
|
110
|
+
|
|
111
|
+
Credential provided by Amazon Pay. You must also set the `sandbox`
|
|
112
|
+
parameter if your `publicKeyId` does not have an environment prefix.
|
|
113
|
+
|
|
114
|
+
___
|
|
115
|
+
|
|
116
|
+
### sandbox
|
|
117
|
+
|
|
118
|
+
• `Optional` **sandbox**: `boolean`
|
|
119
|
+
|
|
120
|
+
Sets button to Sandbox environment. You do not have to set this parameter
|
|
121
|
+
if your `publicKeyId` has an environment prefix. Default is false.
|
|
122
|
+
|
|
123
|
+
#### Inherited from
|
|
124
|
+
|
|
125
|
+
[AmazonPayV2ButtonConfig](AmazonPayV2ButtonConfig.md).[sandbox](AmazonPayV2ButtonConfig.md#sandbox)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / ApplePayButtonInitializeOptions_2
|
|
2
|
+
|
|
3
|
+
# Interface: ApplePayButtonInitializeOptions\_2
|
|
4
|
+
|
|
5
|
+
A set of options that are required to initialize ApplePay in cart.
|
|
6
|
+
|
|
7
|
+
When ApplePay is initialized, an ApplePay button will be inserted into the
|
|
8
|
+
DOM. When a customer clicks on it, it will trigger Apple sheet.
|
|
9
|
+
|
|
10
|
+
## Table of contents
|
|
11
|
+
|
|
12
|
+
### Properties
|
|
13
|
+
|
|
14
|
+
- [buttonClassName](ApplePayButtonInitializeOptions_2.md#buttonclassname)
|
|
15
|
+
|
|
16
|
+
### Methods
|
|
17
|
+
|
|
18
|
+
- [onPaymentAuthorize](ApplePayButtonInitializeOptions_2.md#onpaymentauthorize)
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
### buttonClassName
|
|
23
|
+
|
|
24
|
+
• `Optional` **buttonClassName**: `string`
|
|
25
|
+
|
|
26
|
+
The class name of the ApplePay button style.
|
|
27
|
+
|
|
28
|
+
## Methods
|
|
29
|
+
|
|
30
|
+
### onPaymentAuthorize
|
|
31
|
+
|
|
32
|
+
▸ **onPaymentAuthorize**(): `void`
|
|
33
|
+
|
|
34
|
+
A callback that gets called when a payment is successfully completed.
|
|
35
|
+
|
|
36
|
+
#### Returns
|
|
37
|
+
|
|
38
|
+
`void`
|
|
@@ -1,45 +1,45 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) /
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BaseCheckoutButtonInitializeOptions
|
|
2
2
|
|
|
3
|
-
# Interface:
|
|
3
|
+
# Interface: BaseCheckoutButtonInitializeOptions
|
|
4
4
|
|
|
5
5
|
## Hierarchy
|
|
6
6
|
|
|
7
7
|
- [`CheckoutButtonOptions`](CheckoutButtonOptions.md)
|
|
8
8
|
|
|
9
|
-
↳ **`
|
|
9
|
+
↳ **`BaseCheckoutButtonInitializeOptions`**
|
|
10
10
|
|
|
11
11
|
## Table of contents
|
|
12
12
|
|
|
13
13
|
### Properties
|
|
14
14
|
|
|
15
|
-
- [amazonpay](
|
|
16
|
-
- [applepay](
|
|
17
|
-
- [braintreepaypal](
|
|
18
|
-
- [braintreepaypalcredit](
|
|
19
|
-
- [braintreevenmo](
|
|
20
|
-
- [containerId](
|
|
21
|
-
- [googlepayadyenv2](
|
|
22
|
-
- [googlepayadyenv3](
|
|
23
|
-
- [googlepayauthorizenet](
|
|
24
|
-
- [googlepaybraintree](
|
|
25
|
-
- [googlepaycheckoutcom](
|
|
26
|
-
- [googlepaycybersourcev2](
|
|
27
|
-
- [googlepayorbital](
|
|
28
|
-
- [googlepaystripe](
|
|
29
|
-
- [googlepaystripeupe](
|
|
30
|
-
- [methodId](
|
|
31
|
-
- [params](
|
|
32
|
-
- [paypal](
|
|
33
|
-
- [paypalCommerce](
|
|
34
|
-
- [paypalcommercealternativemethods](
|
|
35
|
-
- [paypalcommercevenmo](
|
|
36
|
-
- [timeout](
|
|
15
|
+
- [amazonpay](BaseCheckoutButtonInitializeOptions.md#amazonpay)
|
|
16
|
+
- [applepay](BaseCheckoutButtonInitializeOptions.md#applepay)
|
|
17
|
+
- [braintreepaypal](BaseCheckoutButtonInitializeOptions.md#braintreepaypal)
|
|
18
|
+
- [braintreepaypalcredit](BaseCheckoutButtonInitializeOptions.md#braintreepaypalcredit)
|
|
19
|
+
- [braintreevenmo](BaseCheckoutButtonInitializeOptions.md#braintreevenmo)
|
|
20
|
+
- [containerId](BaseCheckoutButtonInitializeOptions.md#containerid)
|
|
21
|
+
- [googlepayadyenv2](BaseCheckoutButtonInitializeOptions.md#googlepayadyenv2)
|
|
22
|
+
- [googlepayadyenv3](BaseCheckoutButtonInitializeOptions.md#googlepayadyenv3)
|
|
23
|
+
- [googlepayauthorizenet](BaseCheckoutButtonInitializeOptions.md#googlepayauthorizenet)
|
|
24
|
+
- [googlepaybraintree](BaseCheckoutButtonInitializeOptions.md#googlepaybraintree)
|
|
25
|
+
- [googlepaycheckoutcom](BaseCheckoutButtonInitializeOptions.md#googlepaycheckoutcom)
|
|
26
|
+
- [googlepaycybersourcev2](BaseCheckoutButtonInitializeOptions.md#googlepaycybersourcev2)
|
|
27
|
+
- [googlepayorbital](BaseCheckoutButtonInitializeOptions.md#googlepayorbital)
|
|
28
|
+
- [googlepaystripe](BaseCheckoutButtonInitializeOptions.md#googlepaystripe)
|
|
29
|
+
- [googlepaystripeupe](BaseCheckoutButtonInitializeOptions.md#googlepaystripeupe)
|
|
30
|
+
- [methodId](BaseCheckoutButtonInitializeOptions.md#methodid)
|
|
31
|
+
- [params](BaseCheckoutButtonInitializeOptions.md#params)
|
|
32
|
+
- [paypal](BaseCheckoutButtonInitializeOptions.md#paypal)
|
|
33
|
+
- [paypalCommerce](BaseCheckoutButtonInitializeOptions.md#paypalcommerce)
|
|
34
|
+
- [paypalcommercealternativemethods](BaseCheckoutButtonInitializeOptions.md#paypalcommercealternativemethods)
|
|
35
|
+
- [paypalcommercevenmo](BaseCheckoutButtonInitializeOptions.md#paypalcommercevenmo)
|
|
36
|
+
- [timeout](BaseCheckoutButtonInitializeOptions.md#timeout)
|
|
37
37
|
|
|
38
38
|
## Properties
|
|
39
39
|
|
|
40
40
|
### amazonpay
|
|
41
41
|
|
|
42
|
-
• `Optional` **amazonpay**: [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md)
|
|
42
|
+
• `Optional` **amazonpay**: [`AmazonPayV2ButtonParams`](AmazonPayV2ButtonParams.md) \| [`AmazonPayV2NewButtonParams`](AmazonPayV2NewButtonParams.md)
|
|
43
43
|
|
|
44
44
|
The options that are required to facilitate AmazonPayV2. They can be
|
|
45
45
|
omitted unless you need to support AmazonPayV2.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) /
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BaseCustomerInitializeOptions
|
|
2
2
|
|
|
3
|
-
# Interface:
|
|
3
|
+
# Interface: BaseCustomerInitializeOptions
|
|
4
4
|
|
|
5
5
|
A set of options that are required to initialize the customer step of the
|
|
6
6
|
current checkout flow.
|
|
@@ -14,31 +14,30 @@ information in order to initialize the customer step of checkout.
|
|
|
14
14
|
|
|
15
15
|
- [`CustomerRequestOptions`](CustomerRequestOptions.md)
|
|
16
16
|
|
|
17
|
-
↳ **`
|
|
17
|
+
↳ **`BaseCustomerInitializeOptions`**
|
|
18
18
|
|
|
19
19
|
## Table of contents
|
|
20
20
|
|
|
21
21
|
### Properties
|
|
22
22
|
|
|
23
|
-
- [amazon](
|
|
24
|
-
- [amazonpay](
|
|
25
|
-
- [
|
|
26
|
-
- [
|
|
27
|
-
- [
|
|
28
|
-
- [
|
|
29
|
-
- [
|
|
30
|
-
- [
|
|
31
|
-
- [
|
|
32
|
-
- [
|
|
33
|
-
- [
|
|
34
|
-
- [
|
|
35
|
-
- [
|
|
36
|
-
- [
|
|
37
|
-
- [
|
|
38
|
-
- [
|
|
39
|
-
- [
|
|
40
|
-
- [
|
|
41
|
-
- [timeout](CustomerInitializeOptions.md#timeout)
|
|
23
|
+
- [amazon](BaseCustomerInitializeOptions.md#amazon)
|
|
24
|
+
- [amazonpay](BaseCustomerInitializeOptions.md#amazonpay)
|
|
25
|
+
- [bolt](BaseCustomerInitializeOptions.md#bolt)
|
|
26
|
+
- [braintreevisacheckout](BaseCustomerInitializeOptions.md#braintreevisacheckout)
|
|
27
|
+
- [chasepay](BaseCustomerInitializeOptions.md#chasepay)
|
|
28
|
+
- [googlepayadyenv2](BaseCustomerInitializeOptions.md#googlepayadyenv2)
|
|
29
|
+
- [googlepayadyenv3](BaseCustomerInitializeOptions.md#googlepayadyenv3)
|
|
30
|
+
- [googlepayauthorizenet](BaseCustomerInitializeOptions.md#googlepayauthorizenet)
|
|
31
|
+
- [googlepaybraintree](BaseCustomerInitializeOptions.md#googlepaybraintree)
|
|
32
|
+
- [googlepaycheckoutcom](BaseCustomerInitializeOptions.md#googlepaycheckoutcom)
|
|
33
|
+
- [googlepaycybersourcev2](BaseCustomerInitializeOptions.md#googlepaycybersourcev2)
|
|
34
|
+
- [googlepayorbital](BaseCustomerInitializeOptions.md#googlepayorbital)
|
|
35
|
+
- [googlepaystripe](BaseCustomerInitializeOptions.md#googlepaystripe)
|
|
36
|
+
- [googlepaystripeupe](BaseCustomerInitializeOptions.md#googlepaystripeupe)
|
|
37
|
+
- [masterpass](BaseCustomerInitializeOptions.md#masterpass)
|
|
38
|
+
- [methodId](BaseCustomerInitializeOptions.md#methodid)
|
|
39
|
+
- [params](BaseCustomerInitializeOptions.md#params)
|
|
40
|
+
- [timeout](BaseCustomerInitializeOptions.md#timeout)
|
|
42
41
|
|
|
43
42
|
## Properties
|
|
44
43
|
|
|
@@ -60,15 +59,6 @@ when using AmazonPayV2.
|
|
|
60
59
|
|
|
61
60
|
___
|
|
62
61
|
|
|
63
|
-
### applepay
|
|
64
|
-
|
|
65
|
-
• `Optional` **applepay**: [`ApplePayCustomerInitializeOptions`](ApplePayCustomerInitializeOptions.md)
|
|
66
|
-
|
|
67
|
-
The options that are required to initialize the customer step of checkout
|
|
68
|
-
when using ApplePay.
|
|
69
|
-
|
|
70
|
-
___
|
|
71
|
-
|
|
72
62
|
### bolt
|
|
73
63
|
|
|
74
64
|
• `Optional` **bolt**: [`BoltCustomerInitializeOptions`](BoltCustomerInitializeOptions.md)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
[@bigcommerce/checkout-sdk](../README.md) /
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / BasePaymentInitializeOptions
|
|
2
2
|
|
|
3
|
-
# Interface:
|
|
3
|
+
# Interface: BasePaymentInitializeOptions
|
|
4
4
|
|
|
5
5
|
A set of options that are required to initialize the payment step of the
|
|
6
6
|
current checkout flow.
|
|
@@ -9,49 +9,48 @@ current checkout flow.
|
|
|
9
9
|
|
|
10
10
|
- [`PaymentRequestOptions`](PaymentRequestOptions.md)
|
|
11
11
|
|
|
12
|
-
↳ **`
|
|
12
|
+
↳ **`BasePaymentInitializeOptions`**
|
|
13
13
|
|
|
14
14
|
## Table of contents
|
|
15
15
|
|
|
16
16
|
### Properties
|
|
17
17
|
|
|
18
|
-
- [adyenv2](
|
|
19
|
-
- [adyenv3](
|
|
20
|
-
- [amazon](
|
|
21
|
-
- [amazonpay](
|
|
22
|
-
- [
|
|
23
|
-
- [
|
|
24
|
-
- [
|
|
25
|
-
- [
|
|
26
|
-
- [
|
|
27
|
-
- [
|
|
28
|
-
- [
|
|
29
|
-
- [
|
|
30
|
-
- [
|
|
31
|
-
- [
|
|
32
|
-
- [
|
|
33
|
-
- [
|
|
34
|
-
- [
|
|
35
|
-
- [
|
|
36
|
-
- [
|
|
37
|
-
- [
|
|
38
|
-
- [
|
|
39
|
-
- [
|
|
40
|
-
- [
|
|
41
|
-
- [
|
|
42
|
-
- [
|
|
43
|
-
- [
|
|
44
|
-
- [
|
|
45
|
-
- [
|
|
46
|
-
- [
|
|
47
|
-
- [
|
|
48
|
-
- [
|
|
49
|
-
- [
|
|
50
|
-
- [
|
|
51
|
-
- [
|
|
52
|
-
- [
|
|
53
|
-
- [
|
|
54
|
-
- [worldpay](PaymentInitializeOptions.md#worldpay)
|
|
18
|
+
- [adyenv2](BasePaymentInitializeOptions.md#adyenv2)
|
|
19
|
+
- [adyenv3](BasePaymentInitializeOptions.md#adyenv3)
|
|
20
|
+
- [amazon](BasePaymentInitializeOptions.md#amazon)
|
|
21
|
+
- [amazonpay](BasePaymentInitializeOptions.md#amazonpay)
|
|
22
|
+
- [bluesnapv2](BasePaymentInitializeOptions.md#bluesnapv2)
|
|
23
|
+
- [bolt](BasePaymentInitializeOptions.md#bolt)
|
|
24
|
+
- [braintree](BasePaymentInitializeOptions.md#braintree)
|
|
25
|
+
- [braintreevisacheckout](BasePaymentInitializeOptions.md#braintreevisacheckout)
|
|
26
|
+
- [chasepay](BasePaymentInitializeOptions.md#chasepay)
|
|
27
|
+
- [creditCard](BasePaymentInitializeOptions.md#creditcard)
|
|
28
|
+
- [digitalriver](BasePaymentInitializeOptions.md#digitalriver)
|
|
29
|
+
- [gatewayId](BasePaymentInitializeOptions.md#gatewayid)
|
|
30
|
+
- [googlepayadyenv2](BasePaymentInitializeOptions.md#googlepayadyenv2)
|
|
31
|
+
- [googlepayadyenv3](BasePaymentInitializeOptions.md#googlepayadyenv3)
|
|
32
|
+
- [googlepayauthorizenet](BasePaymentInitializeOptions.md#googlepayauthorizenet)
|
|
33
|
+
- [googlepaybraintree](BasePaymentInitializeOptions.md#googlepaybraintree)
|
|
34
|
+
- [googlepaycheckoutcom](BasePaymentInitializeOptions.md#googlepaycheckoutcom)
|
|
35
|
+
- [googlepaycybersourcev2](BasePaymentInitializeOptions.md#googlepaycybersourcev2)
|
|
36
|
+
- [googlepayorbital](BasePaymentInitializeOptions.md#googlepayorbital)
|
|
37
|
+
- [googlepaystripe](BasePaymentInitializeOptions.md#googlepaystripe)
|
|
38
|
+
- [googlepaystripeupe](BasePaymentInitializeOptions.md#googlepaystripeupe)
|
|
39
|
+
- [klarna](BasePaymentInitializeOptions.md#klarna)
|
|
40
|
+
- [klarnav2](BasePaymentInitializeOptions.md#klarnav2)
|
|
41
|
+
- [masterpass](BasePaymentInitializeOptions.md#masterpass)
|
|
42
|
+
- [methodId](BasePaymentInitializeOptions.md#methodid)
|
|
43
|
+
- [mollie](BasePaymentInitializeOptions.md#mollie)
|
|
44
|
+
- [moneris](BasePaymentInitializeOptions.md#moneris)
|
|
45
|
+
- [opy](BasePaymentInitializeOptions.md#opy)
|
|
46
|
+
- [params](BasePaymentInitializeOptions.md#params)
|
|
47
|
+
- [paypalcommerce](BasePaymentInitializeOptions.md#paypalcommerce)
|
|
48
|
+
- [paypalexpress](BasePaymentInitializeOptions.md#paypalexpress)
|
|
49
|
+
- [square](BasePaymentInitializeOptions.md#square)
|
|
50
|
+
- [stripeupe](BasePaymentInitializeOptions.md#stripeupe)
|
|
51
|
+
- [stripev3](BasePaymentInitializeOptions.md#stripev3)
|
|
52
|
+
- [timeout](BasePaymentInitializeOptions.md#timeout)
|
|
53
|
+
- [worldpay](BasePaymentInitializeOptions.md#worldpay)
|
|
55
54
|
|
|
56
55
|
## Properties
|
|
57
56
|
|
|
@@ -91,15 +90,6 @@ method. They can be omitted unless you need to support AmazonPayV2.
|
|
|
91
90
|
|
|
92
91
|
___
|
|
93
92
|
|
|
94
|
-
### applepay
|
|
95
|
-
|
|
96
|
-
• `Optional` **applepay**: [`ApplePayPaymentInitializeOptions`](ApplePayPaymentInitializeOptions.md)
|
|
97
|
-
|
|
98
|
-
The options that are required to initialize the Apple Pay payment
|
|
99
|
-
method. They can be omitted unless you need to support AmazonPay.
|
|
100
|
-
|
|
101
|
-
___
|
|
102
|
-
|
|
103
93
|
### bluesnapv2
|
|
104
94
|
|
|
105
95
|
• `Optional` **bluesnapv2**: [`BlueSnapV2PaymentInitializeOptions`](BlueSnapV2PaymentInitializeOptions.md)
|
|
@@ -10,7 +10,7 @@ The set of options for configuring the checkout button.
|
|
|
10
10
|
|
|
11
11
|
↳ **`CheckoutButtonOptions`**
|
|
12
12
|
|
|
13
|
-
↳↳ [`
|
|
13
|
+
↳↳ [`BaseCheckoutButtonInitializeOptions`](BaseCheckoutButtonInitializeOptions.md)
|
|
14
14
|
|
|
15
15
|
## Table of contents
|
|
16
16
|
|
|
@@ -15,7 +15,7 @@ flow for signing in or out a customer. Otherwise, these options are not required
|
|
|
15
15
|
|
|
16
16
|
↳ **`CustomerRequestOptions`**
|
|
17
17
|
|
|
18
|
-
↳↳ [`
|
|
18
|
+
↳↳ [`BaseCustomerInitializeOptions`](BaseCustomerInitializeOptions.md)
|
|
19
19
|
|
|
20
20
|
↳↳ [`ExecutePaymentMethodCheckoutOptions`](ExecutePaymentMethodCheckoutOptions.md)
|
|
21
21
|
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / WithApplePayButtonInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: WithApplePayButtonInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [applepay](WithApplePayButtonInitializeOptions.md#applepay)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### applepay
|
|
14
|
+
|
|
15
|
+
• `Optional` **applepay**: [`ApplePayButtonInitializeOptions_2`](ApplePayButtonInitializeOptions_2.md)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / WithApplePayCustomerInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: WithApplePayCustomerInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [applepay](WithApplePayCustomerInitializeOptions.md#applepay)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### applepay
|
|
14
|
+
|
|
15
|
+
• `Optional` **applepay**: [`ApplePayCustomerInitializeOptions`](ApplePayCustomerInitializeOptions.md)
|
|
16
|
+
|
|
17
|
+
The options that are required to initialize the customer step of checkout
|
|
18
|
+
when using ApplePay.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) / WithApplePayPaymentInitializeOptions
|
|
2
|
+
|
|
3
|
+
# Interface: WithApplePayPaymentInitializeOptions
|
|
4
|
+
|
|
5
|
+
## Table of contents
|
|
6
|
+
|
|
7
|
+
### Properties
|
|
8
|
+
|
|
9
|
+
- [applepay](WithApplePayPaymentInitializeOptions.md#applepay)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### applepay
|
|
14
|
+
|
|
15
|
+
• `Optional` **applepay**: [`ApplePayPaymentInitializeOptions`](ApplePayPaymentInitializeOptions.md)
|
|
16
|
+
|
|
17
|
+
The options that are required to initialize the Apple Pay payment
|
|
18
|
+
method. They can be omitted unless you need to support Apple Pay.
|