@bigcommerce/checkout-sdk 1.273.0 → 1.274.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 +12 -0
- package/dist/checkout-button.d.ts +114 -91
- 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 +470 -437
- 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 +28 -3
- package/docs/classes/CheckoutButtonInitializer.md +1 -1
- package/docs/classes/CheckoutService.md +2 -2
- package/docs/interfaces/ApplePayButtonInitializeOptions_2.md +38 -0
- package/docs/interfaces/{CheckoutButtonInitializeOptions.md → BaseCheckoutButtonInitializeOptions.md} +25 -25
- 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
package/docs/README.md
CHANGED
|
@@ -83,15 +83,19 @@
|
|
|
83
83
|
- [AmazonPayV2ShippingInitializeOptions](interfaces/AmazonPayV2ShippingInitializeOptions.md)
|
|
84
84
|
- [AmazonPayWidgetError](interfaces/AmazonPayWidgetError.md)
|
|
85
85
|
- [ApplePayButtonInitializeOptions](interfaces/ApplePayButtonInitializeOptions.md)
|
|
86
|
+
- [ApplePayButtonInitializeOptions_2](interfaces/ApplePayButtonInitializeOptions_2.md)
|
|
86
87
|
- [ApplePayCustomerInitializeOptions](interfaces/ApplePayCustomerInitializeOptions.md)
|
|
87
88
|
- [ApplePayPaymentInitializeOptions](interfaces/ApplePayPaymentInitializeOptions.md)
|
|
88
89
|
- [BankInstrument](interfaces/BankInstrument.md)
|
|
89
90
|
- [Banner](interfaces/Banner.md)
|
|
90
91
|
- [BaseAccountInstrument](interfaces/BaseAccountInstrument.md)
|
|
92
|
+
- [BaseCheckoutButtonInitializeOptions](interfaces/BaseCheckoutButtonInitializeOptions.md)
|
|
93
|
+
- [BaseCustomerInitializeOptions](interfaces/BaseCustomerInitializeOptions.md)
|
|
91
94
|
- [BaseElementOptions](interfaces/BaseElementOptions.md)
|
|
92
95
|
- [BaseElementOptions_2](interfaces/BaseElementOptions_2.md)
|
|
93
96
|
- [BaseIndividualElementOptions](interfaces/BaseIndividualElementOptions.md)
|
|
94
97
|
- [BaseInstrument](interfaces/BaseInstrument.md)
|
|
98
|
+
- [BasePaymentInitializeOptions](interfaces/BasePaymentInitializeOptions.md)
|
|
95
99
|
- [BillingAddress](interfaces/BillingAddress.md)
|
|
96
100
|
- [BillingAddressRequestBody](interfaces/BillingAddressRequestBody.md)
|
|
97
101
|
- [BlockElementStyles](interfaces/BlockElementStyles.md)
|
|
@@ -141,7 +145,6 @@
|
|
|
141
145
|
- [CheckableInputStyles](interfaces/CheckableInputStyles.md)
|
|
142
146
|
- [ChecklistStyles](interfaces/ChecklistStyles.md)
|
|
143
147
|
- [Checkout](interfaces/Checkout.md)
|
|
144
|
-
- [CheckoutButtonInitializeOptions](interfaces/CheckoutButtonInitializeOptions.md)
|
|
145
148
|
- [CheckoutButtonInitializerOptions](interfaces/CheckoutButtonInitializerOptions.md)
|
|
146
149
|
- [CheckoutButtonOptions](interfaces/CheckoutButtonOptions.md)
|
|
147
150
|
- [CheckoutButtonSelectors](interfaces/CheckoutButtonSelectors.md)
|
|
@@ -178,7 +181,6 @@
|
|
|
178
181
|
- [CustomerAddress](interfaces/CustomerAddress.md)
|
|
179
182
|
- [CustomerCredentials](interfaces/CustomerCredentials.md)
|
|
180
183
|
- [CustomerGroup](interfaces/CustomerGroup.md)
|
|
181
|
-
- [CustomerInitializeOptions](interfaces/CustomerInitializeOptions.md)
|
|
182
184
|
- [CustomerPasswordRequirements](interfaces/CustomerPasswordRequirements.md)
|
|
183
185
|
- [CustomerRequestOptions](interfaces/CustomerRequestOptions.md)
|
|
184
186
|
- [DigitalItem](interfaces/DigitalItem.md)
|
|
@@ -268,7 +270,6 @@
|
|
|
268
270
|
- [OrderShippingConsignment](interfaces/OrderShippingConsignment.md)
|
|
269
271
|
- [PasswordRequirements](interfaces/PasswordRequirements.md)
|
|
270
272
|
- [PayPalInstrument](interfaces/PayPalInstrument.md)
|
|
271
|
-
- [PaymentInitializeOptions](interfaces/PaymentInitializeOptions.md)
|
|
272
273
|
- [PaymentMethod](interfaces/PaymentMethod.md)
|
|
273
274
|
- [PaymentMethodConfig](interfaces/PaymentMethodConfig.md)
|
|
274
275
|
- [PaymentRequestOptions](interfaces/PaymentRequestOptions.md)
|
|
@@ -345,6 +346,9 @@
|
|
|
345
346
|
- [WechatState](interfaces/WechatState.md)
|
|
346
347
|
- [WechatState_2](interfaces/WechatState_2.md)
|
|
347
348
|
- [WithAccountCreation](interfaces/WithAccountCreation.md)
|
|
349
|
+
- [WithApplePayButtonInitializeOptions](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
350
|
+
- [WithApplePayCustomerInitializeOptions](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
351
|
+
- [WithApplePayPaymentInitializeOptions](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
348
352
|
- [WithCheckoutcomFawryInstrument](interfaces/WithCheckoutcomFawryInstrument.md)
|
|
349
353
|
- [WithCheckoutcomSEPAInstrument](interfaces/WithCheckoutcomSEPAInstrument.md)
|
|
350
354
|
- [WithCheckoutcomiDealInstrument](interfaces/WithCheckoutcomiDealInstrument.md)
|
|
@@ -365,11 +369,13 @@
|
|
|
365
369
|
- [BraintreeFormFieldEnterEventData](README.md#braintreeformfieldentereventdata)
|
|
366
370
|
- [BraintreeFormFieldFocusEventData](README.md#braintreeformfieldfocuseventdata)
|
|
367
371
|
- [BraintreeFormFieldStyles](README.md#braintreeformfieldstyles)
|
|
372
|
+
- [CheckoutButtonInitializeOptions](README.md#checkoutbuttoninitializeoptions)
|
|
368
373
|
- [CheckoutIncludeParam](README.md#checkoutincludeparam)
|
|
369
374
|
- [ComparableCheckout](README.md#comparablecheckout)
|
|
370
375
|
- [ConsignmentAssignmentRequestBody](README.md#consignmentassignmentrequestbody)
|
|
371
376
|
- [ConsignmentsRequestBody](README.md#consignmentsrequestbody)
|
|
372
377
|
- [CustomerAddressRequestBody](README.md#customeraddressrequestbody)
|
|
378
|
+
- [CustomerInitializeOptions](README.md#customerinitializeoptions)
|
|
373
379
|
- [FlashMessageType](README.md#flashmessagetype)
|
|
374
380
|
- [FormFieldFieldType](README.md#formfieldfieldtype)
|
|
375
381
|
- [FormFieldType](README.md#formfieldtype)
|
|
@@ -388,6 +394,7 @@
|
|
|
388
394
|
- [Omit](README.md#omit)
|
|
389
395
|
- [OrderPaymentInstrument](README.md#orderpaymentinstrument)
|
|
390
396
|
- [OrderPayments](README.md#orderpayments)
|
|
397
|
+
- [PaymentInitializeOptions](README.md#paymentinitializeoptions)
|
|
391
398
|
- [PaymentInstrument](README.md#paymentinstrument)
|
|
392
399
|
- [PaypalCommerceFormFieldBlurEventData](README.md#paypalcommerceformfieldblureventdata)
|
|
393
400
|
- [PaypalCommerceFormFieldEnterEventData](README.md#paypalcommerceformfieldentereventdata)
|
|
@@ -470,6 +477,12 @@ ___
|
|
|
470
477
|
|
|
471
478
|
___
|
|
472
479
|
|
|
480
|
+
### CheckoutButtonInitializeOptions
|
|
481
|
+
|
|
482
|
+
Ƭ **CheckoutButtonInitializeOptions**: [`BaseCheckoutButtonInitializeOptions`](interfaces/BaseCheckoutButtonInitializeOptions.md) & [`WithApplePayButtonInitializeOptions`](interfaces/WithApplePayButtonInitializeOptions.md)
|
|
483
|
+
|
|
484
|
+
___
|
|
485
|
+
|
|
473
486
|
### CheckoutIncludeParam
|
|
474
487
|
|
|
475
488
|
Ƭ **CheckoutIncludeParam**: { [key in CheckoutIncludes]?: boolean }
|
|
@@ -500,6 +513,12 @@ ___
|
|
|
500
513
|
|
|
501
514
|
___
|
|
502
515
|
|
|
516
|
+
### CustomerInitializeOptions
|
|
517
|
+
|
|
518
|
+
Ƭ **CustomerInitializeOptions**: [`BaseCustomerInitializeOptions`](interfaces/BaseCustomerInitializeOptions.md) & [`WithApplePayCustomerInitializeOptions`](interfaces/WithApplePayCustomerInitializeOptions.md)
|
|
519
|
+
|
|
520
|
+
___
|
|
521
|
+
|
|
503
522
|
### FlashMessageType
|
|
504
523
|
|
|
505
524
|
Ƭ **FlashMessageType**: ``"error"`` \| ``"info"`` \| ``"warning"`` \| ``"success"``
|
|
@@ -615,6 +634,12 @@ ___
|
|
|
615
634
|
|
|
616
635
|
___
|
|
617
636
|
|
|
637
|
+
### PaymentInitializeOptions
|
|
638
|
+
|
|
639
|
+
Ƭ **PaymentInitializeOptions**: [`BasePaymentInitializeOptions`](interfaces/BasePaymentInitializeOptions.md) & [`WithApplePayPaymentInitializeOptions`](interfaces/WithApplePayPaymentInitializeOptions.md)
|
|
640
|
+
|
|
641
|
+
___
|
|
642
|
+
|
|
618
643
|
### PaymentInstrument
|
|
619
644
|
|
|
620
645
|
Ƭ **PaymentInstrument**: [`CardInstrument`](interfaces/CardInstrument.md) \| [`AccountInstrument`](README.md#accountinstrument)
|
|
@@ -95,7 +95,7 @@ initializer.initializeButton({
|
|
|
95
95
|
|
|
96
96
|
| Name | Type | Description |
|
|
97
97
|
| :------ | :------ | :------ |
|
|
98
|
-
| `options` | [`CheckoutButtonInitializeOptions`](../
|
|
98
|
+
| `options` | [`CheckoutButtonInitializeOptions`](../README.md#checkoutbuttoninitializeoptions) | Options for initializing the checkout button. |
|
|
99
99
|
|
|
100
100
|
#### Returns
|
|
101
101
|
|
|
@@ -661,7 +661,7 @@ await service.initializeCustomer({
|
|
|
661
661
|
|
|
662
662
|
| Name | Type | Description |
|
|
663
663
|
| :------ | :------ | :------ |
|
|
664
|
-
| `options?` | [`CustomerInitializeOptions`](../
|
|
664
|
+
| `options?` | [`CustomerInitializeOptions`](../README.md#customerinitializeoptions) | Options for initializing the customer step of checkout. |
|
|
665
665
|
|
|
666
666
|
#### Returns
|
|
667
667
|
|
|
@@ -695,7 +695,7 @@ await service.initializePayment({
|
|
|
695
695
|
|
|
696
696
|
| Name | Type | Description |
|
|
697
697
|
| :------ | :------ | :------ |
|
|
698
|
-
| `options` | [`PaymentInitializeOptions`](../
|
|
698
|
+
| `options` | [`PaymentInitializeOptions`](../README.md#paymentinitializeoptions) | Options for initializing the payment step of checkout. |
|
|
699
699
|
|
|
700
700
|
#### Returns
|
|
701
701
|
|
|
@@ -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,39 +1,39 @@
|
|
|
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
|
|
|
@@ -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.
|