@bigcommerce/checkout-sdk 1.217.0 → 1.218.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 +7 -0
- package/dist/checkout-button.js +1 -1
- package/dist/checkout-button.js.map +1 -1
- package/dist/checkout-button.umd.js +2 -2
- package/dist/checkout-button.umd.js.map +1 -1
- package/dist/checkout-sdk.d.ts +36 -0
- package/dist/checkout-sdk.js +1 -1
- package/dist/checkout-sdk.js.map +1 -1
- package/dist/checkout-sdk.umd.js +5 -5
- package/dist/checkout-sdk.umd.js.map +1 -1
- package/docs/README.md +1 -0
- package/docs/interfaces/opypaymentinitializeoptions.md +44 -0
- package/docs/interfaces/paymentinitializeoptions.md +10 -0
- package/package.json +1 -1
package/docs/README.md
CHANGED
|
@@ -225,6 +225,7 @@
|
|
|
225
225
|
* [NonceGenerationError](interfaces/noncegenerationerror.md)
|
|
226
226
|
* [NonceInstrument](interfaces/nonceinstrument.md)
|
|
227
227
|
* [OptionsResponse](interfaces/optionsresponse.md)
|
|
228
|
+
* [OpyPaymentInitializeOptions](interfaces/opypaymentinitializeoptions.md)
|
|
228
229
|
* [Order](interfaces/order.md)
|
|
229
230
|
* [OrderConsignment](interfaces/orderconsignment.md)
|
|
230
231
|
* [OrderPayment](interfaces/orderpayment.md)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
[@bigcommerce/checkout-sdk](../README.md) › [OpyPaymentInitializeOptions](opypaymentinitializeoptions.md)
|
|
2
|
+
|
|
3
|
+
# Interface: OpyPaymentInitializeOptions
|
|
4
|
+
|
|
5
|
+
A set of options that are required to initialize the payment step of
|
|
6
|
+
checkout in order to support Opy.
|
|
7
|
+
|
|
8
|
+
When Opy is initialized, a widget will be inserted into the DOM. The
|
|
9
|
+
widget will open a modal that will show more information about Opy when
|
|
10
|
+
clicking it.
|
|
11
|
+
|
|
12
|
+
**`example`**
|
|
13
|
+
|
|
14
|
+
```html
|
|
15
|
+
<!-- This is where the Opy widget will be inserted -->
|
|
16
|
+
<div id="opy-widget"></div>
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
```js
|
|
20
|
+
service.initializePayment({
|
|
21
|
+
methodId: 'opy',
|
|
22
|
+
opy: {
|
|
23
|
+
containerId: 'opy-widget',
|
|
24
|
+
},
|
|
25
|
+
});
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Hierarchy
|
|
29
|
+
|
|
30
|
+
* **OpyPaymentInitializeOptions**
|
|
31
|
+
|
|
32
|
+
## Index
|
|
33
|
+
|
|
34
|
+
### Properties
|
|
35
|
+
|
|
36
|
+
* [containerId](opypaymentinitializeoptions.md#containerid)
|
|
37
|
+
|
|
38
|
+
## Properties
|
|
39
|
+
|
|
40
|
+
### containerId
|
|
41
|
+
|
|
42
|
+
• **containerId**: *string*
|
|
43
|
+
|
|
44
|
+
The ID of a container which the payment widget should insert into.
|
|
@@ -44,6 +44,7 @@ current checkout flow.
|
|
|
44
44
|
* [methodId](paymentinitializeoptions.md#methodid)
|
|
45
45
|
* [mollie](paymentinitializeoptions.md#optional-mollie)
|
|
46
46
|
* [moneris](paymentinitializeoptions.md#optional-moneris)
|
|
47
|
+
* [opy](paymentinitializeoptions.md#optional-opy)
|
|
47
48
|
* [params](paymentinitializeoptions.md#optional-params)
|
|
48
49
|
* [paypalcommerce](paymentinitializeoptions.md#optional-paypalcommerce)
|
|
49
50
|
* [paypalexpress](paymentinitializeoptions.md#optional-paypalexpress)
|
|
@@ -286,6 +287,15 @@ They can be omitted unless you need to support Moneris.
|
|
|
286
287
|
|
|
287
288
|
___
|
|
288
289
|
|
|
290
|
+
### `Optional` opy
|
|
291
|
+
|
|
292
|
+
• **opy**? : *[OpyPaymentInitializeOptions](opypaymentinitializeoptions.md)*
|
|
293
|
+
|
|
294
|
+
The options that are required to initialize the Opy payment
|
|
295
|
+
method. They can be omitted unless you need to support Opy.
|
|
296
|
+
|
|
297
|
+
___
|
|
298
|
+
|
|
289
299
|
### `Optional` params
|
|
290
300
|
|
|
291
301
|
• **params**? : *TParams*
|