@paydock/client-sdk 1.11.12-beta → 1.11.13-beta
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/README.md +767 -756
- package/bundles/widget.umd.js +96 -24
- package/bundles/widget.umd.min.js +1 -1
- package/lib/checkout-button/afterpay-checkout-button.d.ts +15 -0
- package/lib/checkout-button/afterpay-checkout-button.js +26 -1
- package/lib/checkout-button/afterpay-checkout-button.js.map +1 -1
- package/lib/checkout-button/afterpay.runner.d.ts +4 -4
- package/lib/checkout-button/afterpay.runner.js +4 -5
- package/lib/checkout-button/afterpay.runner.js.map +1 -1
- package/lib/checkout-button/checkout-button.d.ts +2 -1
- package/lib/checkout-button/checkout-button.js +4 -1
- package/lib/checkout-button/checkout-button.js.map +1 -1
- package/lib/checkout-button/index.d.ts +1 -3
- package/lib/checkout-button/index.js +1 -3
- package/lib/checkout-button/index.js.map +1 -1
- package/lib/checkout-button/runner.d.ts +4 -3
- package/lib/checkout-button/runner.js +1 -1
- package/lib/checkout-button/runner.js.map +1 -1
- package/lib/components/param.d.ts +1 -3
- package/lib/components/param.js +0 -4
- package/lib/components/param.js.map +1 -1
- package/lib/helper/browser.d.ts +4 -0
- package/lib/helper/browser.js +24 -0
- package/lib/helper/browser.js.map +1 -1
- package/lib/helper/url.d.ts +1 -0
- package/lib/helper/url.js +3 -0
- package/lib/helper/url.js.map +1 -1
- package/lib/wallet-buttons/apple.wallet-service.js +13 -2
- package/lib/wallet-buttons/apple.wallet-service.js.map +1 -1
- package/lib/wallet-buttons/google.wallet-service.js +5 -7
- package/lib/wallet-buttons/google.wallet-service.js.map +1 -1
- package/lib/widget/configuration.d.ts +1 -3
- package/lib/widget/configuration.js +1 -3
- package/lib/widget/configuration.js.map +1 -1
- package/lib/widget/html-multi-widget.d.ts +1 -2
- package/lib/widget/html-multi-widget.js +1 -2
- package/lib/widget/html-multi-widget.js.map +1 -1
- package/lib/widget/html-widget.d.ts +1 -3
- package/lib/widget/html-widget.js +1 -3
- package/lib/widget/html-widget.js.map +1 -1
- package/package.json +4 -1
- package/slate.md +17 -17
package/README.md
CHANGED
|
@@ -233,16 +233,16 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
233
233
|
## Classes
|
|
234
234
|
|
|
235
235
|
<dl>
|
|
236
|
-
<dt><a href="#
|
|
236
|
+
<dt><a href="#w_HtmlWidget">HtmlWidget</a> ⇐ <code><a href="#w_HtmlMultiWidget">HtmlMultiWidget</a></code></dt>
|
|
237
237
|
<dd><p>Class Widget include method for working on html and include extended by HtmlMultiWidget methods</p>
|
|
238
238
|
</dd>
|
|
239
|
-
<dt><a href="#
|
|
239
|
+
<dt><a href="#w_HtmlMultiWidget">HtmlMultiWidget</a> ⇐ <code><a href="#w_MultiWidget">MultiWidget</a></code></dt>
|
|
240
240
|
<dd><p>Class HtmlMultiWidget include method for working with html</p>
|
|
241
241
|
</dd>
|
|
242
|
-
<dt><a href="#
|
|
242
|
+
<dt><a href="#w_Configuration">Configuration</a></dt>
|
|
243
243
|
<dd><p>Class Configuration include methods for creating configuration token</p>
|
|
244
244
|
</dd>
|
|
245
|
-
<dt><a href="#
|
|
245
|
+
<dt><a href="#w_MultiWidget">MultiWidget</a></dt>
|
|
246
246
|
<dd><p>Class MultiWidget include method for for creating iframe url</p>
|
|
247
247
|
</dd>
|
|
248
248
|
</dl>
|
|
@@ -250,40 +250,40 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
250
250
|
## Constants
|
|
251
251
|
|
|
252
252
|
<dl>
|
|
253
|
-
<dt><a href="#
|
|
253
|
+
<dt><a href="#w_EVENT">EVENT</a> : <code>object</code></dt>
|
|
254
254
|
<dd><p>List of available event's name</p>
|
|
255
255
|
</dd>
|
|
256
|
-
<dt><a href="#
|
|
256
|
+
<dt><a href="#w_VAULT_DISPLAY_EVENT">VAULT_DISPLAY_EVENT</a> : <code>object</code></dt>
|
|
257
257
|
<dd><p>List of available event's name</p>
|
|
258
258
|
</dd>
|
|
259
|
-
<dt><a href="#
|
|
259
|
+
<dt><a href="#w_PAYMENT_TYPE">PAYMENT_TYPE</a> : <code>object</code></dt>
|
|
260
260
|
<dd><p>List of available payment source types</p>
|
|
261
261
|
</dd>
|
|
262
|
-
<dt><a href="#
|
|
262
|
+
<dt><a href="#w_PURPOSE">PURPOSE</a> : <code>object</code></dt>
|
|
263
263
|
<dd><p>Purposes</p>
|
|
264
264
|
</dd>
|
|
265
|
-
<dt><a href="#
|
|
265
|
+
<dt><a href="#w_FORM_FIELD">FORM_FIELD</a> : <code>object</code></dt>
|
|
266
266
|
<dd><p>Current constant include available type of fields which can be included to widget</p>
|
|
267
267
|
</dd>
|
|
268
|
-
<dt><a href="#
|
|
268
|
+
<dt><a href="#w_STYLE">STYLE</a> : <code>object</code></dt>
|
|
269
269
|
<dd><p>List of available style params for widget</p>
|
|
270
270
|
</dd>
|
|
271
|
-
<dt><a href="#
|
|
271
|
+
<dt><a href="#w_TEXT">TEXT</a> : <code>object</code></dt>
|
|
272
272
|
<dd><p>List of available text item params for widget</p>
|
|
273
273
|
</dd>
|
|
274
|
-
<dt><a href="#
|
|
274
|
+
<dt><a href="#w_ELEMENT">ELEMENT</a> : <code>object</code></dt>
|
|
275
275
|
<dd><p>List of available params for hide elements</p>
|
|
276
276
|
</dd>
|
|
277
|
-
<dt><a href="#
|
|
277
|
+
<dt><a href="#w_SUPPORTED_CARD_TYPES">SUPPORTED_CARD_TYPES</a> : <code>object</code></dt>
|
|
278
278
|
<dd><p>The list of available parameters for showing card icons</p>
|
|
279
279
|
</dd>
|
|
280
|
-
<dt><a href="#
|
|
280
|
+
<dt><a href="#w_STYLABLE_ELEMENT">STYLABLE_ELEMENT</a> : <code>object</code></dt>
|
|
281
281
|
<dd><p>Current constant include available type of element for styling</p>
|
|
282
282
|
</dd>
|
|
283
|
-
<dt><a href="#
|
|
283
|
+
<dt><a href="#w_STYLABLE_ELEMENT_STATE">STYLABLE_ELEMENT_STATE</a> : <code>object</code></dt>
|
|
284
284
|
<dd><p>Current constant include available states of element for styling</p>
|
|
285
285
|
</dd>
|
|
286
|
-
<dt><a href="#
|
|
286
|
+
<dt><a href="#w_TRIGGER">TRIGGER</a> : <code>object</code></dt>
|
|
287
287
|
<dd><p>List of available triggers</p>
|
|
288
288
|
</dd>
|
|
289
289
|
</dl>
|
|
@@ -291,51 +291,51 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
291
291
|
## Interfaces
|
|
292
292
|
|
|
293
293
|
<dl>
|
|
294
|
-
<dt><a href="#
|
|
294
|
+
<dt><a href="#w_IFormValidation">IFormValidation</a></dt>
|
|
295
295
|
<dd><p>Interface of data from validation event.</p>
|
|
296
296
|
</dd>
|
|
297
|
-
<dt><a href="#
|
|
297
|
+
<dt><a href="#w_IEventMetaData">IEventMetaData</a></dt>
|
|
298
298
|
<dd><p>Interface of data from event.</p>
|
|
299
299
|
</dd>
|
|
300
|
-
<dt><a href="#
|
|
300
|
+
<dt><a href="#w_IEventAfterLoadData">IEventAfterLoadData</a></dt>
|
|
301
301
|
<dd><p>Interface of data from event.</p>
|
|
302
302
|
</dd>
|
|
303
|
-
<dt><a href="#
|
|
303
|
+
<dt><a href="#w_IEventFinishData">IEventFinishData</a></dt>
|
|
304
304
|
<dd><p>Interface of data from event.</p>
|
|
305
305
|
</dd>
|
|
306
|
-
<dt><a href="#
|
|
306
|
+
<dt><a href="#w_IPayPalMeta">IPayPalMeta</a></dt>
|
|
307
307
|
<dd><p>Interface for PayPal checkout meta information</p>
|
|
308
308
|
</dd>
|
|
309
|
-
<dt><a href="#
|
|
309
|
+
<dt><a href="#w_IBamboraMeta">IBamboraMeta</a></dt>
|
|
310
310
|
<dd><p>Interface for Bamboora meta information</p>
|
|
311
311
|
</dd>
|
|
312
|
-
<dt><a href="#
|
|
312
|
+
<dt><a href="#w_IStyles">IStyles</a></dt>
|
|
313
313
|
<dd><p>Interface for classes that represent widget's styles.</p>
|
|
314
314
|
</dd>
|
|
315
|
-
<dt><a href="#
|
|
315
|
+
<dt><a href="#w_ITexts">ITexts</a></dt>
|
|
316
316
|
<dd><p>Interface for classes that represent widget's text.</p>
|
|
317
317
|
</dd>
|
|
318
|
-
<dt><a href="#
|
|
318
|
+
<dt><a href="#w_IElementStyleInput">IElementStyleInput</a></dt>
|
|
319
319
|
<dd><p>Interface for styling input element.</p>
|
|
320
320
|
</dd>
|
|
321
|
-
<dt><a href="#
|
|
321
|
+
<dt><a href="#w_IElementStyleSubmitButton">IElementStyleSubmitButton</a></dt>
|
|
322
322
|
<dd><p>Interface for styling submit_button element.</p>
|
|
323
323
|
</dd>
|
|
324
|
-
<dt><a href="#
|
|
324
|
+
<dt><a href="#w_IElementStyleLabel">IElementStyleLabel</a></dt>
|
|
325
325
|
<dd><p>Interface for styling label element.</p>
|
|
326
326
|
</dd>
|
|
327
|
-
<dt><a href="#
|
|
327
|
+
<dt><a href="#w_IElementStyleTitle">IElementStyleTitle</a></dt>
|
|
328
328
|
<dd><p>Interface for styling title element.</p>
|
|
329
329
|
</dd>
|
|
330
|
-
<dt><a href="#
|
|
330
|
+
<dt><a href="#w_IElementStyleTitleDescription">IElementStyleTitleDescription</a></dt>
|
|
331
331
|
<dd><p>Interface for styling title_description element.</p>
|
|
332
332
|
</dd>
|
|
333
|
-
<dt><a href="#
|
|
333
|
+
<dt><a href="#w_ITriggerData">ITriggerData</a></dt>
|
|
334
334
|
<dd><p>Interface for classes that represent a trigger data.</p>
|
|
335
335
|
</dd>
|
|
336
336
|
</dl>
|
|
337
337
|
|
|
338
|
-
<a name="w_IFormValidation" id="w_IFormValidation"
|
|
338
|
+
<a name="w_IFormValidation" id="w_IFormValidation"></a>
|
|
339
339
|
|
|
340
340
|
## IFormValidation
|
|
341
341
|
Interface of data from validation event.
|
|
@@ -353,7 +353,7 @@ Interface of data from validation event.
|
|
|
353
353
|
| [invalid_showed_fields] | <code>array</code> | List of fields on which the error is already displayed |
|
|
354
354
|
| [validators] | <code>array</code> | List of validators with fields |
|
|
355
355
|
|
|
356
|
-
<a name="w_IEventMetaData" id="w_IEventMetaData"
|
|
356
|
+
<a name="w_IEventMetaData" id="w_IEventMetaData"></a>
|
|
357
357
|
|
|
358
358
|
## IEventMetaData
|
|
359
359
|
Interface of data from event.
|
|
@@ -375,7 +375,7 @@ Interface of data from event.
|
|
|
375
375
|
| [account_name] | <code>string</code> | Bank account account name |
|
|
376
376
|
| [account_number] | <code>string</code> | Bank account account number |
|
|
377
377
|
|
|
378
|
-
<a name="w_IEventAfterLoadData" id="w_IEventAfterLoadData"
|
|
378
|
+
<a name="w_IEventAfterLoadData" id="w_IEventAfterLoadData"></a>
|
|
379
379
|
|
|
380
380
|
## IEventAfterLoadData
|
|
381
381
|
Interface of data from event.
|
|
@@ -389,7 +389,7 @@ Interface of data from event.
|
|
|
389
389
|
| message_source | <code>string</code> | System variable. Event source |
|
|
390
390
|
| [ref_id] | <code>string</code> | Custom value for identify result of processed operation |
|
|
391
391
|
|
|
392
|
-
<a name="w_IEventFinishData" id="w_IEventFinishData"
|
|
392
|
+
<a name="w_IEventFinishData" id="w_IEventFinishData"></a>
|
|
393
393
|
|
|
394
394
|
## IEventFinishData
|
|
395
395
|
Interface of data from event.
|
|
@@ -404,7 +404,7 @@ Interface of data from event.
|
|
|
404
404
|
| [ref_id] | <code>string</code> | Custom value for identify result of processed operation |
|
|
405
405
|
| payment_source | <code>string</code> | One time token. Result from this endpoint [API docs](https://docs.paydock.com/#tokens) |
|
|
406
406
|
|
|
407
|
-
<a name="w_IPayPalMeta" id="w_IPayPalMeta"
|
|
407
|
+
<a name="w_IPayPalMeta" id="w_IPayPalMeta"></a>
|
|
408
408
|
|
|
409
409
|
## IPayPalMeta
|
|
410
410
|
Interface for PayPal checkout meta information
|
|
@@ -431,7 +431,7 @@ Interface for PayPal checkout meta information
|
|
|
431
431
|
| [phone] | <code>string</code> | The consumer’s phone number in E.164 international notation (Example: +12345678901) |
|
|
432
432
|
| [hide_shipping_address] | <code>boolean</code> | Determines whether PayPal displays shipping address fields on the PayPal pages |
|
|
433
433
|
|
|
434
|
-
<a name="w_IBamboraMeta" id="w_IBamboraMeta"
|
|
434
|
+
<a name="w_IBamboraMeta" id="w_IBamboraMeta"></a>
|
|
435
435
|
|
|
436
436
|
## IBamboraMeta
|
|
437
437
|
Interface for Bamboora meta information
|
|
@@ -443,7 +443,7 @@ Interface for Bamboora meta information
|
|
|
443
443
|
| [customer_storage_number] | <code>string</code> | Customer storage number |
|
|
444
444
|
| [tokenise_algorithm] | <code>number</code> | Tokenise algorithm |
|
|
445
445
|
|
|
446
|
-
<a name="w_IStyles" id="w_IStyles"
|
|
446
|
+
<a name="w_IStyles" id="w_IStyles"></a>
|
|
447
447
|
|
|
448
448
|
## IStyles
|
|
449
449
|
Interface for classes that represent widget's styles.
|
|
@@ -461,7 +461,7 @@ Interface for classes that represent widget's styles.
|
|
|
461
461
|
| [font_size] | <code>string</code> |
|
|
462
462
|
| [font_family] | <code>string</code> |
|
|
463
463
|
|
|
464
|
-
<a name="w_ITexts" id="w_ITexts"
|
|
464
|
+
<a name="w_ITexts" id="w_ITexts"></a>
|
|
465
465
|
|
|
466
466
|
## ITexts
|
|
467
467
|
Interface for classes that represent widget's text.
|
|
@@ -482,7 +482,7 @@ Interface for classes that represent widget's text.
|
|
|
482
482
|
| [submit_button] | <code>string</code> |
|
|
483
483
|
| [submit_button_processing] | <code>string</code> |
|
|
484
484
|
|
|
485
|
-
<a name="w_IElementStyleInput" id="w_IElementStyleInput"
|
|
485
|
+
<a name="w_IElementStyleInput" id="w_IElementStyleInput"></a>
|
|
486
486
|
|
|
487
487
|
## IElementStyleInput
|
|
488
488
|
Interface for styling input element.
|
|
@@ -505,7 +505,7 @@ Interface for styling input element.
|
|
|
505
505
|
| [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) |
|
|
506
506
|
| [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) |
|
|
507
507
|
|
|
508
|
-
<a name="w_IElementStyleSubmitButton" id="w_IElementStyleSubmitButton"
|
|
508
|
+
<a name="w_IElementStyleSubmitButton" id="w_IElementStyleSubmitButton"></a>
|
|
509
509
|
|
|
510
510
|
## IElementStyleSubmitButton
|
|
511
511
|
Interface for styling submit_button element.
|
|
@@ -528,7 +528,7 @@ Interface for styling submit_button element.
|
|
|
528
528
|
| [font_weight] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight) |
|
|
529
529
|
| [opacity] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/opacity) |
|
|
530
530
|
|
|
531
|
-
<a name="w_IElementStyleLabel" id="w_IElementStyleLabel"
|
|
531
|
+
<a name="w_IElementStyleLabel" id="w_IElementStyleLabel"></a>
|
|
532
532
|
|
|
533
533
|
## IElementStyleLabel
|
|
534
534
|
Interface for styling label element.
|
|
@@ -546,7 +546,7 @@ Interface for styling label element.
|
|
|
546
546
|
| [padding] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/padding) |
|
|
547
547
|
| [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) |
|
|
548
548
|
|
|
549
|
-
<a name="w_IElementStyleTitle" id="w_IElementStyleTitle"
|
|
549
|
+
<a name="w_IElementStyleTitle" id="w_IElementStyleTitle"></a>
|
|
550
550
|
|
|
551
551
|
## IElementStyleTitle
|
|
552
552
|
Interface for styling title element.
|
|
@@ -565,7 +565,7 @@ Interface for styling title element.
|
|
|
565
565
|
| [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) |
|
|
566
566
|
| ['text-align',] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) |
|
|
567
567
|
|
|
568
|
-
<a name="w_IElementStyleTitleDescription" id="w_IElementStyleTitleDescription"
|
|
568
|
+
<a name="w_IElementStyleTitleDescription" id="w_IElementStyleTitleDescription"></a>
|
|
569
569
|
|
|
570
570
|
## IElementStyleTitleDescription
|
|
571
571
|
Interface for styling title_description element.
|
|
@@ -584,7 +584,7 @@ Interface for styling title_description element.
|
|
|
584
584
|
| [margin] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/margin) |
|
|
585
585
|
| ['text-align',] | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/text-align) |
|
|
586
586
|
|
|
587
|
-
<a name="w_ITriggerData" id="w_ITriggerData"
|
|
587
|
+
<a name="w_ITriggerData" id="w_ITriggerData"></a>
|
|
588
588
|
|
|
589
589
|
## ITriggerData
|
|
590
590
|
Interface for classes that represent a trigger data.
|
|
@@ -598,57 +598,57 @@ Interface for classes that represent a trigger data.
|
|
|
598
598
|
| [elements] | <code>string</code> |
|
|
599
599
|
| [form_values] | <code>string</code> |
|
|
600
600
|
|
|
601
|
-
<a name="w_HtmlWidget" id="w_HtmlWidget"
|
|
601
|
+
<a name="w_HtmlWidget" id="w_HtmlWidget"></a>
|
|
602
602
|
|
|
603
|
-
## HtmlWidget ⇐ [<code>HtmlMultiWidget</code>](#
|
|
603
|
+
## HtmlWidget ⇐ [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
604
604
|
Class Widget include method for working on html and include extended by HtmlMultiWidget methods
|
|
605
605
|
|
|
606
606
|
**Kind**: global class
|
|
607
|
-
**Extends**: [<code>HtmlMultiWidget</code>](#
|
|
608
|
-
|
|
609
|
-
* [HtmlWidget](#
|
|
610
|
-
* [new exports.HtmlWidget(selector, publicKey, [gatewayID], [paymentType], [purpose])](#
|
|
611
|
-
* [.setWebHookDestination(url)](#
|
|
612
|
-
* [.setSuccessRedirectUrl(url)](#
|
|
613
|
-
* [.setErrorRedirectUrl(url)](#
|
|
614
|
-
* [.setFormFields(fields)](#
|
|
615
|
-
* [.setFormElements(elements)](#
|
|
616
|
-
* [.setMeta(object)](#
|
|
617
|
-
* [.load()](#
|
|
618
|
-
* [.on(eventName, [cb])](#
|
|
619
|
-
* [.trigger(triggers, data)](#
|
|
620
|
-
* [.getValidationState()](#
|
|
621
|
-
* [.isValidForm()](#
|
|
622
|
-
* [.isInvalidField(field)](#
|
|
623
|
-
* [.isFieldErrorShowed(field)](#
|
|
624
|
-
* [.isInvalidFieldByValidator(field, validator)](#
|
|
625
|
-
* [.hide([saveSize])](#
|
|
626
|
-
* [.show()](#
|
|
627
|
-
* [.reload()](#
|
|
628
|
-
* [.hideElements(elements)](#
|
|
629
|
-
* [.showElements(elements)](#
|
|
630
|
-
* [.updateFormValues(fieldValues)](#
|
|
631
|
-
* [.onFinishInsert(selector, dataType)](#
|
|
632
|
-
* [.interceptSubmitForm(selector)](#
|
|
633
|
-
* [.useCheckoutAutoSubmit()](#
|
|
634
|
-
* [.useAutoResize()](#
|
|
635
|
-
* [.setStyles(fields)](#
|
|
636
|
-
* [.usePhoneCountryMask([options])](#
|
|
637
|
-
* [.setTexts(fields)](#
|
|
638
|
-
* [.setElementStyle(element, [state], styles)](#
|
|
639
|
-
* [.setFormValues(fieldValues)](#
|
|
640
|
-
* [.setFormLabels(fieldLabels)](#
|
|
641
|
-
* [.setFormPlaceholders(fieldPlaceholders)](#
|
|
642
|
-
* [.setIcons()](#
|
|
643
|
-
* [.setHiddenElements(elements)](#
|
|
644
|
-
* [.setRefId(refId)](#
|
|
645
|
-
* [.useGatewayFieldValidation()](#
|
|
646
|
-
* [.setSupportedCardIcons(elements, validateCardNumberInput)](#
|
|
647
|
-
* [.setEnv(env, [alias])](#
|
|
648
|
-
* [.loadIFrameUrl()](#
|
|
649
|
-
* [.setLanguage(code)](#
|
|
650
|
-
|
|
651
|
-
<a name="w_new_HtmlWidget_new" id="w_new_HtmlWidget_new"
|
|
607
|
+
**Extends**: [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget), [<code>MultiWidget</code>](#w_MultiWidget)
|
|
608
|
+
|
|
609
|
+
* [HtmlWidget](#w_HtmlWidget) ⇐ [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
610
|
+
* [new exports.HtmlWidget(selector, publicKey, [gatewayID], [paymentType], [purpose])](#w_new_HtmlWidget_new)
|
|
611
|
+
* [.setWebHookDestination(url)](#w_HtmlWidget+setWebHookDestination)
|
|
612
|
+
* [.setSuccessRedirectUrl(url)](#w_HtmlWidget+setSuccessRedirectUrl)
|
|
613
|
+
* [.setErrorRedirectUrl(url)](#w_HtmlWidget+setErrorRedirectUrl)
|
|
614
|
+
* [.setFormFields(fields)](#w_HtmlWidget+setFormFields)
|
|
615
|
+
* [.setFormElements(elements)](#w_HtmlWidget+setFormElements)
|
|
616
|
+
* [.setMeta(object)](#w_HtmlWidget+setMeta)
|
|
617
|
+
* [.load()](#w_HtmlMultiWidget+load)
|
|
618
|
+
* [.on(eventName, [cb])](#w_HtmlMultiWidget+on) ⇒ <code>Promise.<(IEventData\|IEventMetaData\|IEventFinishData\|IFormValidation)></code> \| <code>void</code>
|
|
619
|
+
* [.trigger(triggers, data)](#w_HtmlMultiWidget+trigger)
|
|
620
|
+
* [.getValidationState()](#w_HtmlMultiWidget+getValidationState) ⇒ [<code>IFormValidation</code>](#w_IFormValidation)
|
|
621
|
+
* [.isValidForm()](#w_HtmlMultiWidget+isValidForm) ⇒ <code>boolean</code>
|
|
622
|
+
* [.isInvalidField(field)](#w_HtmlMultiWidget+isInvalidField) ⇒ <code>boolean</code>
|
|
623
|
+
* [.isFieldErrorShowed(field)](#w_HtmlMultiWidget+isFieldErrorShowed) ⇒ <code>boolean</code>
|
|
624
|
+
* [.isInvalidFieldByValidator(field, validator)](#w_HtmlMultiWidget+isInvalidFieldByValidator) ⇒ <code>boolean</code>
|
|
625
|
+
* [.hide([saveSize])](#w_HtmlMultiWidget+hide)
|
|
626
|
+
* [.show()](#w_HtmlMultiWidget+show)
|
|
627
|
+
* [.reload()](#w_HtmlMultiWidget+reload)
|
|
628
|
+
* [.hideElements(elements)](#w_HtmlMultiWidget+hideElements)
|
|
629
|
+
* [.showElements(elements)](#w_HtmlMultiWidget+showElements)
|
|
630
|
+
* [.updateFormValues(fieldValues)](#w_HtmlMultiWidget+updateFormValues)
|
|
631
|
+
* [.onFinishInsert(selector, dataType)](#w_HtmlMultiWidget+onFinishInsert)
|
|
632
|
+
* [.interceptSubmitForm(selector)](#w_HtmlMultiWidget+interceptSubmitForm)
|
|
633
|
+
* [.useCheckoutAutoSubmit()](#w_HtmlMultiWidget+useCheckoutAutoSubmit)
|
|
634
|
+
* [.useAutoResize()](#w_HtmlMultiWidget+useAutoResize)
|
|
635
|
+
* [.setStyles(fields)](#w_MultiWidget+setStyles)
|
|
636
|
+
* [.usePhoneCountryMask([options])](#w_MultiWidget+usePhoneCountryMask)
|
|
637
|
+
* [.setTexts(fields)](#w_MultiWidget+setTexts)
|
|
638
|
+
* [.setElementStyle(element, [state], styles)](#w_MultiWidget+setElementStyle)
|
|
639
|
+
* [.setFormValues(fieldValues)](#w_MultiWidget+setFormValues)
|
|
640
|
+
* [.setFormLabels(fieldLabels)](#w_MultiWidget+setFormLabels)
|
|
641
|
+
* [.setFormPlaceholders(fieldPlaceholders)](#w_MultiWidget+setFormPlaceholders)
|
|
642
|
+
* [.setIcons()](#w_MultiWidget+setIcons)
|
|
643
|
+
* [.setHiddenElements(elements)](#w_MultiWidget+setHiddenElements)
|
|
644
|
+
* [.setRefId(refId)](#w_MultiWidget+setRefId)
|
|
645
|
+
* [.useGatewayFieldValidation()](#w_MultiWidget+useGatewayFieldValidation)
|
|
646
|
+
* [.setSupportedCardIcons(elements, validateCardNumberInput)](#w_MultiWidget+setSupportedCardIcons)
|
|
647
|
+
* [.setEnv(env, [alias])](#w_MultiWidget+setEnv)
|
|
648
|
+
* [.loadIFrameUrl()](#w_MultiWidget+loadIFrameUrl)
|
|
649
|
+
* [.setLanguage(code)](#w_MultiWidget+setLanguage)
|
|
650
|
+
|
|
651
|
+
<a name="w_new_HtmlWidget_new" id="w_new_HtmlWidget_new"></a>
|
|
652
652
|
|
|
653
653
|
### new exports.HtmlWidget(selector, publicKey, [gatewayID], [paymentType], [purpose])
|
|
654
654
|
|
|
@@ -656,7 +656,7 @@ Class Widget include method for working on html and include extended by HtmlMult
|
|
|
656
656
|
| --- | --- | --- | --- |
|
|
657
657
|
| selector | <code>string</code> | | Selector of html element. Container for widget |
|
|
658
658
|
| publicKey | <code>string</code> | | PayDock users public key |
|
|
659
|
-
| [gatewayID] | <code>string</code> | <code>"default"</code> | ID of a gateway connected to PayDock. By default or if put 'default', it will use the selected default gateway
|
|
659
|
+
| [gatewayID] | <code>string</code> | <code>"default"</code> | ID of a gateway connected to PayDock. By default or if put 'default', it will use the selected default gateway |
|
|
660
660
|
| [paymentType] | <code>string</code> | <code>"card"</code> | Type of payment source which shows in widget form. Available parameters : “card”, “bank_account”. |
|
|
661
661
|
| [purpose] | <code>string</code> | <code>"payment_source"</code> | Purpose of widget form. Available parameters: ‘payment_source’, ‘card_payment_source_with_cvv’, ‘card_payment_source_without_cvv’ |
|
|
662
662
|
|
|
@@ -666,16 +666,14 @@ Class Widget include method for working on html and include extended by HtmlMult
|
|
|
666
666
|
var widget = new HtmlWidget('#widget', 'publicKey', 'gatewayID'); // short
|
|
667
667
|
|
|
668
668
|
var widget = new HtmlWidget('#widget', 'publicKey', 'gatewayID', 'bank_account', 'payment_source'); // extend
|
|
669
|
-
|
|
670
|
-
var widget = new HtmlWidget('#widget', 'publicKey', 'not_configured'); // without gateway
|
|
671
669
|
```
|
|
672
|
-
<a name="w_HtmlWidget+setWebHookDestination" id="w_HtmlWidget+setWebHookDestination"
|
|
670
|
+
<a name="w_HtmlWidget+setWebHookDestination" id="w_HtmlWidget+setWebHookDestination"></a>
|
|
673
671
|
|
|
674
672
|
### htmlWidget.setWebHookDestination(url)
|
|
675
673
|
Destination, where customer will receive all successful responses.
|
|
676
674
|
Response will contain “data” object with “payment_source” or other parameters, in depending on 'purpose'
|
|
677
675
|
|
|
678
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
676
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
679
677
|
|
|
680
678
|
| Param | Type | Description |
|
|
681
679
|
| --- | --- | --- |
|
|
@@ -686,12 +684,12 @@ Response will contain “data” object with “payment_source” or other param
|
|
|
686
684
|
```javascript
|
|
687
685
|
widget.setWebHookDestination('http://google.com');
|
|
688
686
|
```
|
|
689
|
-
<a name="w_HtmlWidget+setSuccessRedirectUrl" id="w_HtmlWidget+setSuccessRedirectUrl"
|
|
687
|
+
<a name="w_HtmlWidget+setSuccessRedirectUrl" id="w_HtmlWidget+setSuccessRedirectUrl"></a>
|
|
690
688
|
|
|
691
689
|
### htmlWidget.setSuccessRedirectUrl(url)
|
|
692
690
|
URL to which the Customer will be redirected to after the success finish
|
|
693
691
|
|
|
694
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
692
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
695
693
|
|
|
696
694
|
| Param | Type |
|
|
697
695
|
| --- | --- |
|
|
@@ -702,12 +700,12 @@ URL to which the Customer will be redirected to after the success finish
|
|
|
702
700
|
```javascript
|
|
703
701
|
widget.setSuccessRedirectUrl('google.com/search?q=success');
|
|
704
702
|
```
|
|
705
|
-
<a name="w_HtmlWidget+setErrorRedirectUrl" id="w_HtmlWidget+setErrorRedirectUrl"
|
|
703
|
+
<a name="w_HtmlWidget+setErrorRedirectUrl" id="w_HtmlWidget+setErrorRedirectUrl"></a>
|
|
706
704
|
|
|
707
705
|
### htmlWidget.setErrorRedirectUrl(url)
|
|
708
706
|
URL to which the Customer will be redirected to if an error is triggered in the process of operation
|
|
709
707
|
|
|
710
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
708
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
711
709
|
|
|
712
710
|
| Param | Type |
|
|
713
711
|
| --- | --- |
|
|
@@ -718,35 +716,35 @@ URL to which the Customer will be redirected to if an error is triggered in the
|
|
|
718
716
|
```javascript
|
|
719
717
|
widget.setErrorRedirectUrl('google.com/search?q=error');
|
|
720
718
|
```
|
|
721
|
-
<a name="w_HtmlWidget+setFormFields" id="w_HtmlWidget+setFormFields"
|
|
719
|
+
<a name="w_HtmlWidget+setFormFields" id="w_HtmlWidget+setFormFields"></a>
|
|
722
720
|
|
|
723
721
|
### htmlWidget.setFormFields(fields)
|
|
724
722
|
Set list with widget form field, which will be shown in form. Also you can set the required validation for these fields
|
|
725
723
|
|
|
726
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
724
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
727
725
|
|
|
728
726
|
| Param | Type | Description |
|
|
729
727
|
| --- | --- | --- |
|
|
730
|
-
| fields | <code>[ 'Array' ].<string></code> | name of fields which can be shown in a widget. If after a name of a field, you put “*”, this field will be required on client-side. (For validation, you can specify any fields, even those that are shown by default: card_number, expiration, etc... ) [FORM_FIELD](#
|
|
728
|
+
| fields | <code>[ 'Array' ].<string></code> | name of fields which can be shown in a widget. If after a name of a field, you put “*”, this field will be required on client-side. (For validation, you can specify any fields, even those that are shown by default: card_number, expiration, etc... ) [FORM_FIELD](#w_FORM_FIELD) |
|
|
731
729
|
|
|
732
730
|
**Example**
|
|
733
731
|
|
|
734
732
|
```javascript
|
|
735
733
|
widget.setFormFields(['phone', 'email', 'first_name*']);
|
|
736
734
|
```
|
|
737
|
-
<a name="w_HtmlWidget+setFormElements" id="w_HtmlWidget+setFormElements"
|
|
735
|
+
<a name="w_HtmlWidget+setFormElements" id="w_HtmlWidget+setFormElements"></a>
|
|
738
736
|
|
|
739
737
|
### htmlWidget.setFormElements(elements)
|
|
740
738
|
The method to set the full configuration for the all specific form elements (visibility, required, label, placeholder, value)
|
|
741
739
|
You can also use the other method for the partial configuration like: setFormFields, setFormValues, setFormPlaceholder, setFormLabel
|
|
742
740
|
|
|
743
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
744
|
-
**Overrides**: [<code>setFormElements</code>](#
|
|
741
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
742
|
+
**Overrides**: [<code>setFormElements</code>](#w_MultiWidget+setFormElements)
|
|
745
743
|
|
|
746
744
|
| Param | Type | Description |
|
|
747
745
|
| --- | --- | --- |
|
|
748
746
|
| elements | <code>[ 'Array' ].<Object></code> | List of elements |
|
|
749
|
-
| elements[].field | <code>string</code> | Field name of element. If after a name of a field, you put “*”, this field will be required on client-side. (For validation, you can specify any fields, even those that are shown by default: card_number, expiration, etc... ) [FORM_FIELD](#
|
|
747
|
+
| elements[].field | <code>string</code> | Field name of element. If after a name of a field, you put “*”, this field will be required on client-side. (For validation, you can specify any fields, even those that are shown by default: card_number, expiration, etc... ) [FORM_FIELD](#w_FORM_FIELD) |
|
|
750
748
|
| elements[].placeholder | <code>string</code> | Set custom placeholders in form fields |
|
|
751
749
|
| elements[].label | <code>string</code> | Set a custom labels near the form field |
|
|
752
750
|
| elements[].value | <code>string</code> | Set predefined values for the form field |
|
|
@@ -769,16 +767,16 @@ widget.setFormElements([
|
|
|
769
767
|
},
|
|
770
768
|
])
|
|
771
769
|
```
|
|
772
|
-
<a name="w_HtmlWidget+setMeta" id="w_HtmlWidget+setMeta"
|
|
770
|
+
<a name="w_HtmlWidget+setMeta" id="w_HtmlWidget+setMeta"></a>
|
|
773
771
|
|
|
774
772
|
### htmlWidget.setMeta(object)
|
|
775
773
|
The method to set meta information for the checkout page
|
|
776
774
|
|
|
777
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
775
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
778
776
|
|
|
779
777
|
| Param | Type | Description |
|
|
780
778
|
| --- | --- | --- |
|
|
781
|
-
| object | [<code>IPayPalMeta</code>](#
|
|
779
|
+
| object | [<code>IPayPalMeta</code>](#w_IPayPalMeta) \| [<code>IBamboraMeta</code>](#w_IBamboraMeta) | data which can be shown on checkout page [IPayPalMeta](#w_IPayPalMeta) [IBamboraMeta](#w_IBamboraMeta) |
|
|
782
780
|
|
|
783
781
|
**Example**
|
|
784
782
|
|
|
@@ -789,22 +787,22 @@ config.setMeta({
|
|
|
789
787
|
email: 'wault@paydock.com'
|
|
790
788
|
});
|
|
791
789
|
```
|
|
792
|
-
<a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load"
|
|
790
|
+
<a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load"></a>
|
|
793
791
|
|
|
794
792
|
### htmlWidget.load()
|
|
795
793
|
The final method to beginning, the load process of widget to html
|
|
796
794
|
|
|
797
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
798
|
-
<a name="w_HtmlMultiWidget+on" id="w_HtmlMultiWidget+on"
|
|
795
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
796
|
+
<a name="w_HtmlMultiWidget+on" id="w_HtmlMultiWidget+on"></a>
|
|
799
797
|
|
|
800
798
|
### htmlWidget.on(eventName, [cb]) ⇒ <code>Promise.<(IEventData\|IEventMetaData\|IEventFinishData\|IFormValidation)></code> \| <code>void</code>
|
|
801
799
|
Listen to events of widget
|
|
802
800
|
|
|
803
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
801
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
804
802
|
|
|
805
803
|
| Param | Type | Description |
|
|
806
804
|
| --- | --- | --- |
|
|
807
|
-
| eventName | <code>string</code> | Available event names [EVENT](#
|
|
805
|
+
| eventName | <code>string</code> | Available event names [EVENT](#w_EVENT) |
|
|
808
806
|
| [cb] | <code>listener</code> | |
|
|
809
807
|
|
|
810
808
|
**Example**
|
|
@@ -818,62 +816,62 @@ widget.on('form_submit', function (data) {
|
|
|
818
816
|
console.log(data);
|
|
819
817
|
});
|
|
820
818
|
```
|
|
821
|
-
<a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger"
|
|
819
|
+
<a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger"></a>
|
|
822
820
|
|
|
823
821
|
### htmlWidget.trigger(triggers, data)
|
|
824
822
|
This callback will be called for every trigger
|
|
825
823
|
|
|
826
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
824
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
827
825
|
|
|
828
826
|
| Param | Type | Description |
|
|
829
827
|
| --- | --- | --- |
|
|
830
828
|
| triggers | <code>triggerName</code> | submit_form, tab |
|
|
831
|
-
| data | [<code>ITriggerData</code>](#
|
|
829
|
+
| data | [<code>ITriggerData</code>](#w_ITriggerData) | which will be sending to widget |
|
|
832
830
|
|
|
833
|
-
<a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState"
|
|
831
|
+
<a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState"></a>
|
|
834
832
|
|
|
835
|
-
### htmlWidget.getValidationState() ⇒ [<code>IFormValidation</code>](#
|
|
833
|
+
### htmlWidget.getValidationState() ⇒ [<code>IFormValidation</code>](#w_IFormValidation)
|
|
836
834
|
Using this method you can get validation state information
|
|
837
835
|
|
|
838
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
839
|
-
**Returns**: [<code>IFormValidation</code>](#
|
|
840
|
-
<a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm"
|
|
836
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
837
|
+
**Returns**: [<code>IFormValidation</code>](#w_IFormValidation) - Form validation object
|
|
838
|
+
<a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm"></a>
|
|
841
839
|
|
|
842
840
|
### htmlWidget.isValidForm() ⇒ <code>boolean</code>
|
|
843
841
|
Using this method you can check if the form is valid
|
|
844
842
|
|
|
845
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
843
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
846
844
|
**Returns**: <code>boolean</code> - Form is valid
|
|
847
|
-
<a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField"
|
|
845
|
+
<a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField"></a>
|
|
848
846
|
|
|
849
847
|
### htmlWidget.isInvalidField(field) ⇒ <code>boolean</code>
|
|
850
848
|
Using this method you can check if a specific form field is invalid
|
|
851
849
|
|
|
852
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
850
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
853
851
|
**Returns**: <code>boolean</code> - Field is invalid
|
|
854
852
|
|
|
855
853
|
| Param | Type | Description |
|
|
856
854
|
| --- | --- | --- |
|
|
857
855
|
| field | <code>string</code> | Field name |
|
|
858
856
|
|
|
859
|
-
<a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed"
|
|
857
|
+
<a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed"></a>
|
|
860
858
|
|
|
861
859
|
### htmlWidget.isFieldErrorShowed(field) ⇒ <code>boolean</code>
|
|
862
860
|
Using this method you can check if an error is displayed on a specific field
|
|
863
861
|
|
|
864
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
862
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
865
863
|
**Returns**: <code>boolean</code> - Error is showed on field
|
|
866
864
|
|
|
867
865
|
| Param | Type | Description |
|
|
868
866
|
| --- | --- | --- |
|
|
869
867
|
| field | <code>string</code> | Field name |
|
|
870
868
|
|
|
871
|
-
<a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator"
|
|
869
|
+
<a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator"></a>
|
|
872
870
|
|
|
873
871
|
### htmlWidget.isInvalidFieldByValidator(field, validator) ⇒ <code>boolean</code>
|
|
874
872
|
Using this method you can check if a specific field is invalid
|
|
875
873
|
|
|
876
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
874
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
877
875
|
**Returns**: <code>boolean</code> - Field is invalid by validator
|
|
878
876
|
|
|
879
877
|
| Param | Type | Description |
|
|
@@ -881,46 +879,46 @@ Using this method you can check if a specific field is invalid
|
|
|
881
879
|
| field | <code>string</code> | Field name |
|
|
882
880
|
| validator | <code>string</code> | Validator name. Available validators: `required, cardNumberValidator, expireDateValidation` |
|
|
883
881
|
|
|
884
|
-
<a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide"
|
|
882
|
+
<a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide"></a>
|
|
885
883
|
|
|
886
884
|
### htmlWidget.hide([saveSize])
|
|
887
885
|
Using this method you can hide widget after load
|
|
888
886
|
|
|
889
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
887
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
890
888
|
|
|
891
889
|
| Param | Type | Default | Description |
|
|
892
890
|
| --- | --- | --- | --- |
|
|
893
891
|
| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size |
|
|
894
892
|
|
|
895
|
-
<a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show"
|
|
893
|
+
<a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show"></a>
|
|
896
894
|
|
|
897
895
|
### htmlWidget.show()
|
|
898
896
|
Using this method you can show widget after using hide method
|
|
899
897
|
|
|
900
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
901
|
-
<a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload"
|
|
898
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
899
|
+
<a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload"></a>
|
|
902
900
|
|
|
903
901
|
### htmlWidget.reload()
|
|
904
902
|
Using this method you can reload widget
|
|
905
903
|
|
|
906
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
907
|
-
<a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements"
|
|
904
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
905
|
+
<a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements"></a>
|
|
908
906
|
|
|
909
907
|
### htmlWidget.hideElements(elements)
|
|
910
908
|
Using this method you can hide any elements inside widget
|
|
911
909
|
|
|
912
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
910
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
913
911
|
|
|
914
912
|
| Param | Type | Description |
|
|
915
913
|
| --- | --- | --- |
|
|
916
|
-
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#
|
|
914
|
+
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#w_ELEMENT) || [FORM_FIELD](#w_FORM_FIELD) |
|
|
917
915
|
|
|
918
916
|
**Example**
|
|
919
917
|
|
|
920
918
|
```javascript
|
|
921
919
|
widget.hideElements(['submit_button', 'email']);
|
|
922
920
|
```
|
|
923
|
-
<a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements"
|
|
921
|
+
<a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements"></a>
|
|
924
922
|
|
|
925
923
|
### htmlWidget.showElements(elements)
|
|
926
924
|
Using this method you can show any elements inside widget
|
|
@@ -928,18 +926,18 @@ Using this method you can show any elements inside widget
|
|
|
928
926
|
* @example
|
|
929
927
|
widget.showElements(['submit_button', 'email']);
|
|
930
928
|
|
|
931
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
929
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
932
930
|
|
|
933
931
|
| Param | Type | Description |
|
|
934
932
|
| --- | --- | --- |
|
|
935
|
-
| elements | <code>[ 'Array' ].<string></code> | list of element which can be showed [ELEMENT](#
|
|
933
|
+
| elements | <code>[ 'Array' ].<string></code> | list of element which can be showed [ELEMENT](#w_ELEMENT) || [FORM_FIELD](#w_FORM_FIELD) |
|
|
936
934
|
|
|
937
|
-
<a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues"
|
|
935
|
+
<a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues"></a>
|
|
938
936
|
|
|
939
937
|
### htmlWidget.updateFormValues(fieldValues)
|
|
940
938
|
Method for update values for form fields inside the widget
|
|
941
939
|
|
|
942
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
940
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
943
941
|
|
|
944
942
|
| Param | Type | Description |
|
|
945
943
|
| --- | --- | --- |
|
|
@@ -953,26 +951,26 @@ widget.updateFormValues({
|
|
|
953
951
|
card_name: 'Houston'
|
|
954
952
|
});
|
|
955
953
|
```
|
|
956
|
-
<a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert"
|
|
954
|
+
<a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert"></a>
|
|
957
955
|
|
|
958
956
|
### htmlWidget.onFinishInsert(selector, dataType)
|
|
959
957
|
After finish event of widget, data (dataType) will be insert to input (selector)
|
|
960
958
|
|
|
961
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
959
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
962
960
|
|
|
963
961
|
| Param | Type | Description |
|
|
964
962
|
| --- | --- | --- |
|
|
965
963
|
| selector | <code>string</code> | css selector . [] # |
|
|
966
964
|
| dataType | <code>string</code> | data type of IEventData object. |
|
|
967
965
|
|
|
968
|
-
<a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm"
|
|
966
|
+
<a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm"></a>
|
|
969
967
|
|
|
970
968
|
### htmlWidget.interceptSubmitForm(selector)
|
|
971
969
|
Widget will intercept submit of your form for processing widget
|
|
972
970
|
|
|
973
971
|
Process: click by submit button in your form --> submit widget ---> submit your form
|
|
974
972
|
|
|
975
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
973
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
976
974
|
**Note**: submit button in widget will be hidden.
|
|
977
975
|
|
|
978
976
|
| Param | Type | Description |
|
|
@@ -992,33 +990,33 @@ Process: click by submit button in your form --> submit widget ---> submit your
|
|
|
992
990
|
widget.interceptSubmitForm('#myForm');
|
|
993
991
|
</script>
|
|
994
992
|
```
|
|
995
|
-
<a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit"
|
|
993
|
+
<a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit"></a>
|
|
996
994
|
|
|
997
995
|
### htmlWidget.useCheckoutAutoSubmit()
|
|
998
996
|
This method hides a submit button and automatically execute form submit
|
|
999
997
|
|
|
1000
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1001
|
-
<a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize"
|
|
998
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
999
|
+
<a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize"></a>
|
|
1002
1000
|
|
|
1003
1001
|
### htmlWidget.useAutoResize()
|
|
1004
1002
|
Use this method for resize iFrame according content height
|
|
1005
1003
|
|
|
1006
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1004
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1007
1005
|
**Example**
|
|
1008
1006
|
|
|
1009
1007
|
```javascript
|
|
1010
1008
|
widget.useAutoResize();
|
|
1011
1009
|
```
|
|
1012
|
-
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles"
|
|
1010
|
+
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles"></a>
|
|
1013
1011
|
|
|
1014
1012
|
### htmlWidget.setStyles(fields)
|
|
1015
1013
|
Object contain styles for widget
|
|
1016
1014
|
|
|
1017
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1015
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1018
1016
|
|
|
1019
1017
|
| Param | Type | Description |
|
|
1020
1018
|
| --- | --- | --- |
|
|
1021
|
-
| fields | [<code>IStyles</code>](#
|
|
1019
|
+
| fields | [<code>IStyles</code>](#w_IStyles) | name of styles which can be shown in widget [STYLE](#w_STYLE) |
|
|
1022
1020
|
|
|
1023
1021
|
**Example**
|
|
1024
1022
|
|
|
@@ -1032,12 +1030,12 @@ widget.setStyles({
|
|
|
1032
1030
|
fort_family: 'fantasy'
|
|
1033
1031
|
});
|
|
1034
1032
|
```
|
|
1035
|
-
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask"
|
|
1033
|
+
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask"></a>
|
|
1036
1034
|
|
|
1037
1035
|
### htmlWidget.usePhoneCountryMask([options])
|
|
1038
1036
|
Method to set a country code mask for the phone input.
|
|
1039
1037
|
|
|
1040
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1038
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1041
1039
|
|
|
1042
1040
|
| Param | Type | Description |
|
|
1043
1041
|
| --- | --- | --- |
|
|
@@ -1060,16 +1058,16 @@ widget.usePhoneCountryMask({
|
|
|
1060
1058
|
only_countries: ['au', 'gb', 'us', 'ua']
|
|
1061
1059
|
});
|
|
1062
1060
|
```
|
|
1063
|
-
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts"
|
|
1061
|
+
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts"></a>
|
|
1064
1062
|
|
|
1065
1063
|
### htmlWidget.setTexts(fields)
|
|
1066
1064
|
Method for set different texts inside the widget
|
|
1067
1065
|
|
|
1068
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1066
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1069
1067
|
|
|
1070
1068
|
| Param | Type | Description |
|
|
1071
1069
|
| --- | --- | --- |
|
|
1072
|
-
| fields | [<code>ITexts</code>](#
|
|
1070
|
+
| fields | [<code>ITexts</code>](#w_ITexts) | name of text items which can be shown in widget [TEXT](#w_TEXT) |
|
|
1073
1071
|
|
|
1074
1072
|
**Example**
|
|
1075
1073
|
|
|
@@ -1082,18 +1080,18 @@ widget.setTexts({
|
|
|
1082
1080
|
submit_button_processing: 'Load...',
|
|
1083
1081
|
});
|
|
1084
1082
|
```
|
|
1085
|
-
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle"
|
|
1083
|
+
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle"></a>
|
|
1086
1084
|
|
|
1087
1085
|
### htmlWidget.setElementStyle(element, [state], styles)
|
|
1088
1086
|
Method for set styles for different elements and states
|
|
1089
1087
|
|
|
1090
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1088
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1091
1089
|
|
|
1092
1090
|
| Param | Type | Description |
|
|
1093
1091
|
| --- | --- | --- |
|
|
1094
|
-
| element | <code>string</code> | type of element for styling. These elements are available [STYLABLE_ELEMENT](#
|
|
1095
|
-
| [state] | <code>string</code> | state of element for styling. These states are available [STYLABLE_ELEMENT_STATE](#
|
|
1096
|
-
| styles | [<code>IElementStyleInput</code>](#
|
|
1092
|
+
| element | <code>string</code> | type of element for styling. These elements are available [STYLABLE_ELEMENT](#w_STYLABLE_ELEMENT) |
|
|
1093
|
+
| [state] | <code>string</code> | state of element for styling. These states are available [STYLABLE_ELEMENT_STATE](#w_STYLABLE_ELEMENT_STATE) |
|
|
1094
|
+
| styles | [<code>IElementStyleInput</code>](#w_IElementStyleInput) \| [<code>IElementStyleSubmitButton</code>](#w_IElementStyleSubmitButton) \| [<code>IElementStyleLabel</code>](#w_IElementStyleLabel) \| [<code>IElementStyleTitle</code>](#w_IElementStyleTitle) \| [<code>IElementStyleTitleDescription</code>](#w_IElementStyleTitleDescription) | styles list |
|
|
1097
1095
|
|
|
1098
1096
|
**Example**
|
|
1099
1097
|
|
|
@@ -1110,16 +1108,16 @@ widget.setElementStyle('input', 'error', {
|
|
|
1110
1108
|
border: 'red solid 1px'
|
|
1111
1109
|
});
|
|
1112
1110
|
```
|
|
1113
|
-
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues"
|
|
1111
|
+
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues"></a>
|
|
1114
1112
|
|
|
1115
1113
|
### htmlWidget.setFormValues(fieldValues)
|
|
1116
1114
|
The method to set the predefined values for the form fields inside the widget
|
|
1117
1115
|
|
|
1118
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1116
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1119
1117
|
|
|
1120
1118
|
| Param | Type | Description |
|
|
1121
1119
|
| --- | --- | --- |
|
|
1122
|
-
| fieldValues | <code>Object</code> | Key of object is one of [FORM_FIELD](#
|
|
1120
|
+
| fieldValues | <code>Object</code> | Key of object is one of [FORM_FIELD](#w_FORM_FIELD), The object value is what we are expecting |
|
|
1123
1121
|
|
|
1124
1122
|
**Example**
|
|
1125
1123
|
|
|
@@ -1129,16 +1127,16 @@ widget.setFormValues({
|
|
|
1129
1127
|
card_name: 'Houston'
|
|
1130
1128
|
});
|
|
1131
1129
|
```
|
|
1132
|
-
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels"
|
|
1130
|
+
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels"></a>
|
|
1133
1131
|
|
|
1134
1132
|
### htmlWidget.setFormLabels(fieldLabels)
|
|
1135
1133
|
The method to set custom form field labels
|
|
1136
1134
|
|
|
1137
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1135
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1138
1136
|
|
|
1139
1137
|
| Param | Type | Description |
|
|
1140
1138
|
| --- | --- | --- |
|
|
1141
|
-
| fieldLabels | <code>Object</code> | Key of object is one of [FORM_FIELD](#
|
|
1139
|
+
| fieldLabels | <code>Object</code> | Key of object is one of [FORM_FIELD](#w_FORM_FIELD), The object value is what we are expecting |
|
|
1142
1140
|
|
|
1143
1141
|
**Example**
|
|
1144
1142
|
|
|
@@ -1148,16 +1146,16 @@ widget.setFormPlaceholders({
|
|
|
1148
1146
|
email: 'Email For Receipt'
|
|
1149
1147
|
})
|
|
1150
1148
|
```
|
|
1151
|
-
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders"
|
|
1149
|
+
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders"></a>
|
|
1152
1150
|
|
|
1153
1151
|
### htmlWidget.setFormPlaceholders(fieldPlaceholders)
|
|
1154
1152
|
The method to set custom form fields placeholders
|
|
1155
1153
|
|
|
1156
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1154
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1157
1155
|
|
|
1158
1156
|
| Param | Type | Description |
|
|
1159
1157
|
| --- | --- | --- |
|
|
1160
|
-
| fieldPlaceholders | <code>Object</code> | Key of object is one of [FORM_FIELD](#
|
|
1158
|
+
| fieldPlaceholders | <code>Object</code> | Key of object is one of [FORM_FIELD](#w_FORM_FIELD), Value of object is expected placeholder |
|
|
1161
1159
|
|
|
1162
1160
|
**Example**
|
|
1163
1161
|
|
|
@@ -1167,38 +1165,38 @@ widget.setFormPlaceholders({
|
|
|
1167
1165
|
email: 'Input your email, like test@example.com'
|
|
1168
1166
|
})
|
|
1169
1167
|
```
|
|
1170
|
-
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons"
|
|
1168
|
+
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons"></a>
|
|
1171
1169
|
|
|
1172
1170
|
### htmlWidget.setIcons()
|
|
1173
1171
|
The method to change the widget icons
|
|
1174
1172
|
|
|
1175
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1173
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1176
1174
|
**Todo**
|
|
1177
1175
|
|
|
1178
1176
|
- [ ] DEPRECATED
|
|
1179
1177
|
|
|
1180
|
-
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements"
|
|
1178
|
+
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements"></a>
|
|
1181
1179
|
|
|
1182
1180
|
### htmlWidget.setHiddenElements(elements)
|
|
1183
1181
|
Using this method you can set hidden elements inside widget
|
|
1184
1182
|
|
|
1185
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1183
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1186
1184
|
|
|
1187
1185
|
| Param | Type | Description |
|
|
1188
1186
|
| --- | --- | --- |
|
|
1189
|
-
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#
|
|
1187
|
+
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#w_ELEMENT) || [FORM_FIELD](#w_FORM_FIELD) |
|
|
1190
1188
|
|
|
1191
1189
|
**Example**
|
|
1192
1190
|
|
|
1193
1191
|
```javascript
|
|
1194
1192
|
widget.setHiddenElements(['submit_button', 'email']);
|
|
1195
1193
|
```
|
|
1196
|
-
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId"
|
|
1194
|
+
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId"></a>
|
|
1197
1195
|
|
|
1198
1196
|
### htmlWidget.setRefId(refId)
|
|
1199
1197
|
Current method can set custom ID to identify the data in the future
|
|
1200
1198
|
|
|
1201
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1199
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1202
1200
|
|
|
1203
1201
|
| Param | Type | Description |
|
|
1204
1202
|
| --- | --- | --- |
|
|
@@ -1209,27 +1207,27 @@ Current method can set custom ID to identify the data in the future
|
|
|
1209
1207
|
```javascript
|
|
1210
1208
|
widget.setRefId('id');
|
|
1211
1209
|
```
|
|
1212
|
-
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation"
|
|
1210
|
+
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation"></a>
|
|
1213
1211
|
|
|
1214
1212
|
### htmlWidget.useGatewayFieldValidation()
|
|
1215
1213
|
Current method can add visual validation from gateway to widget's form fields
|
|
1216
1214
|
|
|
1217
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1215
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1218
1216
|
**Example**
|
|
1219
1217
|
|
|
1220
1218
|
```javascript
|
|
1221
1219
|
widget.useGatewayFieldValidation();
|
|
1222
1220
|
```
|
|
1223
|
-
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons"
|
|
1221
|
+
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons"></a>
|
|
1224
1222
|
|
|
1225
1223
|
### htmlWidget.setSupportedCardIcons(elements, validateCardNumberInput)
|
|
1226
1224
|
Current method can set icons of supported card types
|
|
1227
1225
|
|
|
1228
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1226
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1229
1227
|
|
|
1230
1228
|
| Param | Type | Description |
|
|
1231
1229
|
| --- | --- | --- |
|
|
1232
|
-
| elements | <code>[ 'Array' ].<string></code> | [SUPPORTED_CARD_TYPES](#
|
|
1230
|
+
| elements | <code>[ 'Array' ].<string></code> | [SUPPORTED_CARD_TYPES](#w_SUPPORTED_CARD_TYPES) |
|
|
1233
1231
|
| validateCardNumberInput | <code>boolean</code> | [validateCardNumberInput=false] - using this param you allow validation for card number input on supported card types |
|
|
1234
1232
|
|
|
1235
1233
|
**Example**
|
|
@@ -1237,13 +1235,13 @@ Current method can set icons of supported card types
|
|
|
1237
1235
|
```javascript
|
|
1238
1236
|
widget.setSupportedCardIcons(['mastercard', 'visa'], validateCardNumberInput);
|
|
1239
1237
|
```
|
|
1240
|
-
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv"
|
|
1238
|
+
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv"></a>
|
|
1241
1239
|
|
|
1242
1240
|
### htmlWidget.setEnv(env, [alias])
|
|
1243
1241
|
Current method can change environment. By default environment = sandbox.
|
|
1244
1242
|
Also we can change domain alias for this environment. By default domain_alias = paydock.com
|
|
1245
1243
|
|
|
1246
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1244
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1247
1245
|
|
|
1248
1246
|
| Param | Type | Description |
|
|
1249
1247
|
| --- | --- | --- |
|
|
@@ -1255,12 +1253,12 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
1255
1253
|
```javascript
|
|
1256
1254
|
widget.setEnv('production', 'paydock.com');
|
|
1257
1255
|
```
|
|
1258
|
-
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl"
|
|
1256
|
+
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl"></a>
|
|
1259
1257
|
|
|
1260
1258
|
### htmlWidget.loadIFrameUrl()
|
|
1261
1259
|
Method for creating iframe url
|
|
1262
1260
|
|
|
1263
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1261
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1264
1262
|
**Example**
|
|
1265
1263
|
|
|
1266
1264
|
```javascript
|
|
@@ -1270,12 +1268,12 @@ widget.loadIFrameUrl(function (url) {
|
|
|
1270
1268
|
console.log(errors);
|
|
1271
1269
|
});
|
|
1272
1270
|
```
|
|
1273
|
-
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage"
|
|
1271
|
+
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage"></a>
|
|
1274
1272
|
|
|
1275
1273
|
### htmlWidget.setLanguage(code)
|
|
1276
1274
|
Method for setting a custom language code
|
|
1277
1275
|
|
|
1278
|
-
**Kind**: instance method of [<code>HtmlWidget</code>](#
|
|
1276
|
+
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1279
1277
|
|
|
1280
1278
|
| Param | Type | Description |
|
|
1281
1279
|
| --- | --- | --- |
|
|
@@ -1286,52 +1284,52 @@ Method for setting a custom language code
|
|
|
1286
1284
|
```javascript
|
|
1287
1285
|
config.setLanguage('en');
|
|
1288
1286
|
```
|
|
1289
|
-
<a name="w_HtmlMultiWidget" id="w_HtmlMultiWidget"
|
|
1287
|
+
<a name="w_HtmlMultiWidget" id="w_HtmlMultiWidget"></a>
|
|
1290
1288
|
|
|
1291
|
-
## HtmlMultiWidget ⇐ [<code>MultiWidget</code>](#
|
|
1289
|
+
## HtmlMultiWidget ⇐ [<code>MultiWidget</code>](#w_MultiWidget)
|
|
1292
1290
|
Class HtmlMultiWidget include method for working with html
|
|
1293
1291
|
|
|
1294
1292
|
**Kind**: global class
|
|
1295
|
-
**Extends**: [<code>MultiWidget</code>](#
|
|
1296
|
-
|
|
1297
|
-
* [HtmlMultiWidget](#
|
|
1298
|
-
* [new exports.HtmlMultiWidget(selector, publicKey, conf)](#
|
|
1299
|
-
* [.load()](#
|
|
1300
|
-
* [.on(eventName, [cb])](#
|
|
1301
|
-
* [.trigger(triggers, data)](#
|
|
1302
|
-
* [.getValidationState()](#
|
|
1303
|
-
* [.isValidForm()](#
|
|
1304
|
-
* [.isInvalidField(field)](#
|
|
1305
|
-
* [.isFieldErrorShowed(field)](#
|
|
1306
|
-
* [.isInvalidFieldByValidator(field, validator)](#
|
|
1307
|
-
* [.hide([saveSize])](#
|
|
1308
|
-
* [.show()](#
|
|
1309
|
-
* [.reload()](#
|
|
1310
|
-
* [.hideElements(elements)](#
|
|
1311
|
-
* [.showElements(elements)](#
|
|
1312
|
-
* [.updateFormValues(fieldValues)](#
|
|
1313
|
-
* [.onFinishInsert(selector, dataType)](#
|
|
1314
|
-
* [.interceptSubmitForm(selector)](#
|
|
1315
|
-
* [.useCheckoutAutoSubmit()](#
|
|
1316
|
-
* [.useAutoResize()](#
|
|
1317
|
-
* [.setStyles(fields)](#
|
|
1318
|
-
* [.usePhoneCountryMask([options])](#
|
|
1319
|
-
* [.setTexts(fields)](#
|
|
1320
|
-
* [.setElementStyle(element, [state], styles)](#
|
|
1321
|
-
* [.setFormValues(fieldValues)](#
|
|
1322
|
-
* [.setFormLabels(fieldLabels)](#
|
|
1323
|
-
* [.setFormPlaceholders(fieldPlaceholders)](#
|
|
1324
|
-
* [.setFormElements(elements)](#
|
|
1325
|
-
* [.setIcons()](#
|
|
1326
|
-
* [.setHiddenElements(elements)](#
|
|
1327
|
-
* [.setRefId(refId)](#
|
|
1328
|
-
* [.useGatewayFieldValidation()](#
|
|
1329
|
-
* [.setSupportedCardIcons(elements, validateCardNumberInput)](#
|
|
1330
|
-
* [.setEnv(env, [alias])](#
|
|
1331
|
-
* [.loadIFrameUrl()](#
|
|
1332
|
-
* [.setLanguage(code)](#
|
|
1333
|
-
|
|
1334
|
-
<a name="w_new_HtmlMultiWidget_new" id="w_new_HtmlMultiWidget_new"
|
|
1293
|
+
**Extends**: [<code>MultiWidget</code>](#w_MultiWidget)
|
|
1294
|
+
|
|
1295
|
+
* [HtmlMultiWidget](#w_HtmlMultiWidget) ⇐ [<code>MultiWidget</code>](#w_MultiWidget)
|
|
1296
|
+
* [new exports.HtmlMultiWidget(selector, publicKey, conf)](#w_new_HtmlMultiWidget_new)
|
|
1297
|
+
* [.load()](#w_HtmlMultiWidget+load)
|
|
1298
|
+
* [.on(eventName, [cb])](#w_HtmlMultiWidget+on) ⇒ <code>Promise.<(IEventData\|IEventMetaData\|IEventFinishData\|IFormValidation)></code> \| <code>void</code>
|
|
1299
|
+
* [.trigger(triggers, data)](#w_HtmlMultiWidget+trigger)
|
|
1300
|
+
* [.getValidationState()](#w_HtmlMultiWidget+getValidationState) ⇒ [<code>IFormValidation</code>](#w_IFormValidation)
|
|
1301
|
+
* [.isValidForm()](#w_HtmlMultiWidget+isValidForm) ⇒ <code>boolean</code>
|
|
1302
|
+
* [.isInvalidField(field)](#w_HtmlMultiWidget+isInvalidField) ⇒ <code>boolean</code>
|
|
1303
|
+
* [.isFieldErrorShowed(field)](#w_HtmlMultiWidget+isFieldErrorShowed) ⇒ <code>boolean</code>
|
|
1304
|
+
* [.isInvalidFieldByValidator(field, validator)](#w_HtmlMultiWidget+isInvalidFieldByValidator) ⇒ <code>boolean</code>
|
|
1305
|
+
* [.hide([saveSize])](#w_HtmlMultiWidget+hide)
|
|
1306
|
+
* [.show()](#w_HtmlMultiWidget+show)
|
|
1307
|
+
* [.reload()](#w_HtmlMultiWidget+reload)
|
|
1308
|
+
* [.hideElements(elements)](#w_HtmlMultiWidget+hideElements)
|
|
1309
|
+
* [.showElements(elements)](#w_HtmlMultiWidget+showElements)
|
|
1310
|
+
* [.updateFormValues(fieldValues)](#w_HtmlMultiWidget+updateFormValues)
|
|
1311
|
+
* [.onFinishInsert(selector, dataType)](#w_HtmlMultiWidget+onFinishInsert)
|
|
1312
|
+
* [.interceptSubmitForm(selector)](#w_HtmlMultiWidget+interceptSubmitForm)
|
|
1313
|
+
* [.useCheckoutAutoSubmit()](#w_HtmlMultiWidget+useCheckoutAutoSubmit)
|
|
1314
|
+
* [.useAutoResize()](#w_HtmlMultiWidget+useAutoResize)
|
|
1315
|
+
* [.setStyles(fields)](#w_MultiWidget+setStyles)
|
|
1316
|
+
* [.usePhoneCountryMask([options])](#w_MultiWidget+usePhoneCountryMask)
|
|
1317
|
+
* [.setTexts(fields)](#w_MultiWidget+setTexts)
|
|
1318
|
+
* [.setElementStyle(element, [state], styles)](#w_MultiWidget+setElementStyle)
|
|
1319
|
+
* [.setFormValues(fieldValues)](#w_MultiWidget+setFormValues)
|
|
1320
|
+
* [.setFormLabels(fieldLabels)](#w_MultiWidget+setFormLabels)
|
|
1321
|
+
* [.setFormPlaceholders(fieldPlaceholders)](#w_MultiWidget+setFormPlaceholders)
|
|
1322
|
+
* [.setFormElements(elements)](#w_MultiWidget+setFormElements)
|
|
1323
|
+
* [.setIcons()](#w_MultiWidget+setIcons)
|
|
1324
|
+
* [.setHiddenElements(elements)](#w_MultiWidget+setHiddenElements)
|
|
1325
|
+
* [.setRefId(refId)](#w_MultiWidget+setRefId)
|
|
1326
|
+
* [.useGatewayFieldValidation()](#w_MultiWidget+useGatewayFieldValidation)
|
|
1327
|
+
* [.setSupportedCardIcons(elements, validateCardNumberInput)](#w_MultiWidget+setSupportedCardIcons)
|
|
1328
|
+
* [.setEnv(env, [alias])](#w_MultiWidget+setEnv)
|
|
1329
|
+
* [.loadIFrameUrl()](#w_MultiWidget+loadIFrameUrl)
|
|
1330
|
+
* [.setLanguage(code)](#w_MultiWidget+setLanguage)
|
|
1331
|
+
|
|
1332
|
+
<a name="w_new_HtmlMultiWidget_new" id="w_new_HtmlMultiWidget_new"></a>
|
|
1335
1333
|
|
|
1336
1334
|
### new exports.HtmlMultiWidget(selector, publicKey, conf)
|
|
1337
1335
|
|
|
@@ -1339,7 +1337,7 @@ Class HtmlMultiWidget include method for working with html
|
|
|
1339
1337
|
| --- | --- | --- |
|
|
1340
1338
|
| selector | <code>string</code> | Selector of html element. Container for widget |
|
|
1341
1339
|
| publicKey | <code>string</code> | PayDock users public key |
|
|
1342
|
-
| conf | [<code>Configuration</code>](#
|
|
1340
|
+
| conf | [<code>Configuration</code>](#w_Configuration) \| <code>string</code> \| [<code>Array.<Configuration></code>](#w_Configuration) \| <code>Array.<string></code> | exemplar[s] Configuration class OR configuration token |
|
|
1343
1341
|
|
|
1344
1342
|
**Example**
|
|
1345
1343
|
|
|
@@ -1351,28 +1349,27 @@ var widget = new MultiWidget('#widget', 'publicKey',['configurationToken', 'conf
|
|
|
1351
1349
|
var widget = new MultiWidget('#widget', 'publicKey', new Configuration('gatewayId')); With Configuration
|
|
1352
1350
|
|
|
1353
1351
|
var widget = new MultiWidget('#widget', 'publicKey',[ With Configurations
|
|
1354
|
-
Configuration()
|
|
1355
|
-
Configuration('not_configured'), // without gateway,
|
|
1352
|
+
Configuration() // default gateway_id,
|
|
1356
1353
|
Configuration('gatewayId'),
|
|
1357
1354
|
Configuration('gatewayId', 'bank_account')
|
|
1358
1355
|
]);
|
|
1359
1356
|
```
|
|
1360
|
-
<a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load"
|
|
1357
|
+
<a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load"></a>
|
|
1361
1358
|
|
|
1362
1359
|
### htmlMultiWidget.load()
|
|
1363
1360
|
The final method to beginning, the load process of widget to html
|
|
1364
1361
|
|
|
1365
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1366
|
-
<a name="w_HtmlMultiWidget+on" id="w_HtmlMultiWidget+on"
|
|
1362
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1363
|
+
<a name="w_HtmlMultiWidget+on" id="w_HtmlMultiWidget+on"></a>
|
|
1367
1364
|
|
|
1368
1365
|
### htmlMultiWidget.on(eventName, [cb]) ⇒ <code>Promise.<(IEventData\|IEventMetaData\|IEventFinishData\|IFormValidation)></code> \| <code>void</code>
|
|
1369
1366
|
Listen to events of widget
|
|
1370
1367
|
|
|
1371
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1368
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1372
1369
|
|
|
1373
1370
|
| Param | Type | Description |
|
|
1374
1371
|
| --- | --- | --- |
|
|
1375
|
-
| eventName | <code>string</code> | Available event names [EVENT](#
|
|
1372
|
+
| eventName | <code>string</code> | Available event names [EVENT](#w_EVENT) |
|
|
1376
1373
|
| [cb] | <code>listener</code> | |
|
|
1377
1374
|
|
|
1378
1375
|
**Example**
|
|
@@ -1386,62 +1383,62 @@ widget.on('form_submit', function (data) {
|
|
|
1386
1383
|
console.log(data);
|
|
1387
1384
|
});
|
|
1388
1385
|
```
|
|
1389
|
-
<a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger"
|
|
1386
|
+
<a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger"></a>
|
|
1390
1387
|
|
|
1391
1388
|
### htmlMultiWidget.trigger(triggers, data)
|
|
1392
1389
|
This callback will be called for every trigger
|
|
1393
1390
|
|
|
1394
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1391
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1395
1392
|
|
|
1396
1393
|
| Param | Type | Description |
|
|
1397
1394
|
| --- | --- | --- |
|
|
1398
1395
|
| triggers | <code>triggerName</code> | submit_form, tab |
|
|
1399
|
-
| data | [<code>ITriggerData</code>](#
|
|
1396
|
+
| data | [<code>ITriggerData</code>](#w_ITriggerData) | which will be sending to widget |
|
|
1400
1397
|
|
|
1401
|
-
<a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState"
|
|
1398
|
+
<a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState"></a>
|
|
1402
1399
|
|
|
1403
|
-
### htmlMultiWidget.getValidationState() ⇒ [<code>IFormValidation</code>](#
|
|
1400
|
+
### htmlMultiWidget.getValidationState() ⇒ [<code>IFormValidation</code>](#w_IFormValidation)
|
|
1404
1401
|
Using this method you can get validation state information
|
|
1405
1402
|
|
|
1406
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1407
|
-
**Returns**: [<code>IFormValidation</code>](#
|
|
1408
|
-
<a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm"
|
|
1403
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1404
|
+
**Returns**: [<code>IFormValidation</code>](#w_IFormValidation) - Form validation object
|
|
1405
|
+
<a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm"></a>
|
|
1409
1406
|
|
|
1410
1407
|
### htmlMultiWidget.isValidForm() ⇒ <code>boolean</code>
|
|
1411
1408
|
Using this method you can check if the form is valid
|
|
1412
1409
|
|
|
1413
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1410
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1414
1411
|
**Returns**: <code>boolean</code> - Form is valid
|
|
1415
|
-
<a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField"
|
|
1412
|
+
<a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField"></a>
|
|
1416
1413
|
|
|
1417
1414
|
### htmlMultiWidget.isInvalidField(field) ⇒ <code>boolean</code>
|
|
1418
1415
|
Using this method you can check if a specific form field is invalid
|
|
1419
1416
|
|
|
1420
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1417
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1421
1418
|
**Returns**: <code>boolean</code> - Field is invalid
|
|
1422
1419
|
|
|
1423
1420
|
| Param | Type | Description |
|
|
1424
1421
|
| --- | --- | --- |
|
|
1425
1422
|
| field | <code>string</code> | Field name |
|
|
1426
1423
|
|
|
1427
|
-
<a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed"
|
|
1424
|
+
<a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed"></a>
|
|
1428
1425
|
|
|
1429
1426
|
### htmlMultiWidget.isFieldErrorShowed(field) ⇒ <code>boolean</code>
|
|
1430
1427
|
Using this method you can check if an error is displayed on a specific field
|
|
1431
1428
|
|
|
1432
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1429
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1433
1430
|
**Returns**: <code>boolean</code> - Error is showed on field
|
|
1434
1431
|
|
|
1435
1432
|
| Param | Type | Description |
|
|
1436
1433
|
| --- | --- | --- |
|
|
1437
1434
|
| field | <code>string</code> | Field name |
|
|
1438
1435
|
|
|
1439
|
-
<a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator"
|
|
1436
|
+
<a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator"></a>
|
|
1440
1437
|
|
|
1441
1438
|
### htmlMultiWidget.isInvalidFieldByValidator(field, validator) ⇒ <code>boolean</code>
|
|
1442
1439
|
Using this method you can check if a specific field is invalid
|
|
1443
1440
|
|
|
1444
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1441
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1445
1442
|
**Returns**: <code>boolean</code> - Field is invalid by validator
|
|
1446
1443
|
|
|
1447
1444
|
| Param | Type | Description |
|
|
@@ -1449,46 +1446,46 @@ Using this method you can check if a specific field is invalid
|
|
|
1449
1446
|
| field | <code>string</code> | Field name |
|
|
1450
1447
|
| validator | <code>string</code> | Validator name. Available validators: `required, cardNumberValidator, expireDateValidation` |
|
|
1451
1448
|
|
|
1452
|
-
<a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide"
|
|
1449
|
+
<a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide"></a>
|
|
1453
1450
|
|
|
1454
1451
|
### htmlMultiWidget.hide([saveSize])
|
|
1455
1452
|
Using this method you can hide widget after load
|
|
1456
1453
|
|
|
1457
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1454
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1458
1455
|
|
|
1459
1456
|
| Param | Type | Default | Description |
|
|
1460
1457
|
| --- | --- | --- | --- |
|
|
1461
1458
|
| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size |
|
|
1462
1459
|
|
|
1463
|
-
<a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show"
|
|
1460
|
+
<a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show"></a>
|
|
1464
1461
|
|
|
1465
1462
|
### htmlMultiWidget.show()
|
|
1466
1463
|
Using this method you can show widget after using hide method
|
|
1467
1464
|
|
|
1468
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1469
|
-
<a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload"
|
|
1465
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1466
|
+
<a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload"></a>
|
|
1470
1467
|
|
|
1471
1468
|
### htmlMultiWidget.reload()
|
|
1472
1469
|
Using this method you can reload widget
|
|
1473
1470
|
|
|
1474
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1475
|
-
<a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements"
|
|
1471
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1472
|
+
<a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements"></a>
|
|
1476
1473
|
|
|
1477
1474
|
### htmlMultiWidget.hideElements(elements)
|
|
1478
1475
|
Using this method you can hide any elements inside widget
|
|
1479
1476
|
|
|
1480
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1477
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1481
1478
|
|
|
1482
1479
|
| Param | Type | Description |
|
|
1483
1480
|
| --- | --- | --- |
|
|
1484
|
-
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#
|
|
1481
|
+
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#w_ELEMENT) || [FORM_FIELD](#w_FORM_FIELD) |
|
|
1485
1482
|
|
|
1486
1483
|
**Example**
|
|
1487
1484
|
|
|
1488
1485
|
```javascript
|
|
1489
1486
|
widget.hideElements(['submit_button', 'email']);
|
|
1490
1487
|
```
|
|
1491
|
-
<a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements"
|
|
1488
|
+
<a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements"></a>
|
|
1492
1489
|
|
|
1493
1490
|
### htmlMultiWidget.showElements(elements)
|
|
1494
1491
|
Using this method you can show any elements inside widget
|
|
@@ -1496,18 +1493,18 @@ Using this method you can show any elements inside widget
|
|
|
1496
1493
|
* @example
|
|
1497
1494
|
widget.showElements(['submit_button', 'email']);
|
|
1498
1495
|
|
|
1499
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1496
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1500
1497
|
|
|
1501
1498
|
| Param | Type | Description |
|
|
1502
1499
|
| --- | --- | --- |
|
|
1503
|
-
| elements | <code>[ 'Array' ].<string></code> | list of element which can be showed [ELEMENT](#
|
|
1500
|
+
| elements | <code>[ 'Array' ].<string></code> | list of element which can be showed [ELEMENT](#w_ELEMENT) || [FORM_FIELD](#w_FORM_FIELD) |
|
|
1504
1501
|
|
|
1505
|
-
<a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues"
|
|
1502
|
+
<a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues"></a>
|
|
1506
1503
|
|
|
1507
1504
|
### htmlMultiWidget.updateFormValues(fieldValues)
|
|
1508
1505
|
Method for update values for form fields inside the widget
|
|
1509
1506
|
|
|
1510
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1507
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1511
1508
|
|
|
1512
1509
|
| Param | Type | Description |
|
|
1513
1510
|
| --- | --- | --- |
|
|
@@ -1521,26 +1518,26 @@ widget.updateFormValues({
|
|
|
1521
1518
|
card_name: 'Houston'
|
|
1522
1519
|
});
|
|
1523
1520
|
```
|
|
1524
|
-
<a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert"
|
|
1521
|
+
<a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert"></a>
|
|
1525
1522
|
|
|
1526
1523
|
### htmlMultiWidget.onFinishInsert(selector, dataType)
|
|
1527
1524
|
After finish event of widget, data (dataType) will be insert to input (selector)
|
|
1528
1525
|
|
|
1529
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1526
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1530
1527
|
|
|
1531
1528
|
| Param | Type | Description |
|
|
1532
1529
|
| --- | --- | --- |
|
|
1533
1530
|
| selector | <code>string</code> | css selector . [] # |
|
|
1534
1531
|
| dataType | <code>string</code> | data type of IEventData object. |
|
|
1535
1532
|
|
|
1536
|
-
<a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm"
|
|
1533
|
+
<a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm"></a>
|
|
1537
1534
|
|
|
1538
1535
|
### htmlMultiWidget.interceptSubmitForm(selector)
|
|
1539
1536
|
Widget will intercept submit of your form for processing widget
|
|
1540
1537
|
|
|
1541
1538
|
Process: click by submit button in your form --> submit widget ---> submit your form
|
|
1542
1539
|
|
|
1543
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1540
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1544
1541
|
**Note**: submit button in widget will be hidden.
|
|
1545
1542
|
|
|
1546
1543
|
| Param | Type | Description |
|
|
@@ -1560,33 +1557,33 @@ Process: click by submit button in your form --> submit widget ---> submit your
|
|
|
1560
1557
|
widget.interceptSubmitForm('#myForm');
|
|
1561
1558
|
</script>
|
|
1562
1559
|
```
|
|
1563
|
-
<a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit"
|
|
1560
|
+
<a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit"></a>
|
|
1564
1561
|
|
|
1565
1562
|
### htmlMultiWidget.useCheckoutAutoSubmit()
|
|
1566
1563
|
This method hides a submit button and automatically execute form submit
|
|
1567
1564
|
|
|
1568
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1569
|
-
<a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize"
|
|
1565
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1566
|
+
<a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize"></a>
|
|
1570
1567
|
|
|
1571
1568
|
### htmlMultiWidget.useAutoResize()
|
|
1572
1569
|
Use this method for resize iFrame according content height
|
|
1573
1570
|
|
|
1574
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1571
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1575
1572
|
**Example**
|
|
1576
1573
|
|
|
1577
1574
|
```javascript
|
|
1578
1575
|
widget.useAutoResize();
|
|
1579
1576
|
```
|
|
1580
|
-
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles"
|
|
1577
|
+
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles"></a>
|
|
1581
1578
|
|
|
1582
1579
|
### htmlMultiWidget.setStyles(fields)
|
|
1583
1580
|
Object contain styles for widget
|
|
1584
1581
|
|
|
1585
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1582
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1586
1583
|
|
|
1587
1584
|
| Param | Type | Description |
|
|
1588
1585
|
| --- | --- | --- |
|
|
1589
|
-
| fields | [<code>IStyles</code>](#
|
|
1586
|
+
| fields | [<code>IStyles</code>](#w_IStyles) | name of styles which can be shown in widget [STYLE](#w_STYLE) |
|
|
1590
1587
|
|
|
1591
1588
|
**Example**
|
|
1592
1589
|
|
|
@@ -1600,12 +1597,12 @@ widget.setStyles({
|
|
|
1600
1597
|
fort_family: 'fantasy'
|
|
1601
1598
|
});
|
|
1602
1599
|
```
|
|
1603
|
-
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask"
|
|
1600
|
+
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask"></a>
|
|
1604
1601
|
|
|
1605
1602
|
### htmlMultiWidget.usePhoneCountryMask([options])
|
|
1606
1603
|
Method to set a country code mask for the phone input.
|
|
1607
1604
|
|
|
1608
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1605
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1609
1606
|
|
|
1610
1607
|
| Param | Type | Description |
|
|
1611
1608
|
| --- | --- | --- |
|
|
@@ -1628,16 +1625,16 @@ widget.usePhoneCountryMask({
|
|
|
1628
1625
|
only_countries: ['au', 'gb', 'us', 'ua']
|
|
1629
1626
|
});
|
|
1630
1627
|
```
|
|
1631
|
-
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts"
|
|
1628
|
+
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts"></a>
|
|
1632
1629
|
|
|
1633
1630
|
### htmlMultiWidget.setTexts(fields)
|
|
1634
1631
|
Method for set different texts inside the widget
|
|
1635
1632
|
|
|
1636
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1633
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1637
1634
|
|
|
1638
1635
|
| Param | Type | Description |
|
|
1639
1636
|
| --- | --- | --- |
|
|
1640
|
-
| fields | [<code>ITexts</code>](#
|
|
1637
|
+
| fields | [<code>ITexts</code>](#w_ITexts) | name of text items which can be shown in widget [TEXT](#w_TEXT) |
|
|
1641
1638
|
|
|
1642
1639
|
**Example**
|
|
1643
1640
|
|
|
@@ -1650,18 +1647,18 @@ widget.setTexts({
|
|
|
1650
1647
|
submit_button_processing: 'Load...',
|
|
1651
1648
|
});
|
|
1652
1649
|
```
|
|
1653
|
-
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle"
|
|
1650
|
+
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle"></a>
|
|
1654
1651
|
|
|
1655
1652
|
### htmlMultiWidget.setElementStyle(element, [state], styles)
|
|
1656
1653
|
Method for set styles for different elements and states
|
|
1657
1654
|
|
|
1658
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1655
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1659
1656
|
|
|
1660
1657
|
| Param | Type | Description |
|
|
1661
1658
|
| --- | --- | --- |
|
|
1662
|
-
| element | <code>string</code> | type of element for styling. These elements are available [STYLABLE_ELEMENT](#
|
|
1663
|
-
| [state] | <code>string</code> | state of element for styling. These states are available [STYLABLE_ELEMENT_STATE](#
|
|
1664
|
-
| styles | [<code>IElementStyleInput</code>](#
|
|
1659
|
+
| element | <code>string</code> | type of element for styling. These elements are available [STYLABLE_ELEMENT](#w_STYLABLE_ELEMENT) |
|
|
1660
|
+
| [state] | <code>string</code> | state of element for styling. These states are available [STYLABLE_ELEMENT_STATE](#w_STYLABLE_ELEMENT_STATE) |
|
|
1661
|
+
| styles | [<code>IElementStyleInput</code>](#w_IElementStyleInput) \| [<code>IElementStyleSubmitButton</code>](#w_IElementStyleSubmitButton) \| [<code>IElementStyleLabel</code>](#w_IElementStyleLabel) \| [<code>IElementStyleTitle</code>](#w_IElementStyleTitle) \| [<code>IElementStyleTitleDescription</code>](#w_IElementStyleTitleDescription) | styles list |
|
|
1665
1662
|
|
|
1666
1663
|
**Example**
|
|
1667
1664
|
|
|
@@ -1678,16 +1675,16 @@ widget.setElementStyle('input', 'error', {
|
|
|
1678
1675
|
border: 'red solid 1px'
|
|
1679
1676
|
});
|
|
1680
1677
|
```
|
|
1681
|
-
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues"
|
|
1678
|
+
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues"></a>
|
|
1682
1679
|
|
|
1683
1680
|
### htmlMultiWidget.setFormValues(fieldValues)
|
|
1684
1681
|
The method to set the predefined values for the form fields inside the widget
|
|
1685
1682
|
|
|
1686
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1683
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1687
1684
|
|
|
1688
1685
|
| Param | Type | Description |
|
|
1689
1686
|
| --- | --- | --- |
|
|
1690
|
-
| fieldValues | <code>Object</code> | Key of object is one of [FORM_FIELD](#
|
|
1687
|
+
| fieldValues | <code>Object</code> | Key of object is one of [FORM_FIELD](#w_FORM_FIELD), The object value is what we are expecting |
|
|
1691
1688
|
|
|
1692
1689
|
**Example**
|
|
1693
1690
|
|
|
@@ -1697,16 +1694,16 @@ widget.setFormValues({
|
|
|
1697
1694
|
card_name: 'Houston'
|
|
1698
1695
|
});
|
|
1699
1696
|
```
|
|
1700
|
-
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels"
|
|
1697
|
+
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels"></a>
|
|
1701
1698
|
|
|
1702
1699
|
### htmlMultiWidget.setFormLabels(fieldLabels)
|
|
1703
1700
|
The method to set custom form field labels
|
|
1704
1701
|
|
|
1705
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1702
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1706
1703
|
|
|
1707
1704
|
| Param | Type | Description |
|
|
1708
1705
|
| --- | --- | --- |
|
|
1709
|
-
| fieldLabels | <code>Object</code> | Key of object is one of [FORM_FIELD](#
|
|
1706
|
+
| fieldLabels | <code>Object</code> | Key of object is one of [FORM_FIELD](#w_FORM_FIELD), The object value is what we are expecting |
|
|
1710
1707
|
|
|
1711
1708
|
**Example**
|
|
1712
1709
|
|
|
@@ -1716,16 +1713,16 @@ widget.setFormPlaceholders({
|
|
|
1716
1713
|
email: 'Email For Receipt'
|
|
1717
1714
|
})
|
|
1718
1715
|
```
|
|
1719
|
-
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders"
|
|
1716
|
+
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders"></a>
|
|
1720
1717
|
|
|
1721
1718
|
### htmlMultiWidget.setFormPlaceholders(fieldPlaceholders)
|
|
1722
1719
|
The method to set custom form fields placeholders
|
|
1723
1720
|
|
|
1724
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1721
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1725
1722
|
|
|
1726
1723
|
| Param | Type | Description |
|
|
1727
1724
|
| --- | --- | --- |
|
|
1728
|
-
| fieldPlaceholders | <code>Object</code> | Key of object is one of [FORM_FIELD](#
|
|
1725
|
+
| fieldPlaceholders | <code>Object</code> | Key of object is one of [FORM_FIELD](#w_FORM_FIELD), Value of object is expected placeholder |
|
|
1729
1726
|
|
|
1730
1727
|
**Example**
|
|
1731
1728
|
|
|
@@ -1735,18 +1732,18 @@ widget.setFormPlaceholders({
|
|
|
1735
1732
|
email: 'Input your email, like test@example.com'
|
|
1736
1733
|
})
|
|
1737
1734
|
```
|
|
1738
|
-
<a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements"
|
|
1735
|
+
<a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements"></a>
|
|
1739
1736
|
|
|
1740
1737
|
### htmlMultiWidget.setFormElements(elements)
|
|
1741
1738
|
The method to set the full configuration for the all specific form elements (label, placeholder, value)
|
|
1742
1739
|
You can also use the other method for the partial configuration like: setFormValues, setFormPlaceholder, setFormLabel
|
|
1743
1740
|
|
|
1744
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1741
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1745
1742
|
|
|
1746
1743
|
| Param | Type | Description |
|
|
1747
1744
|
| --- | --- | --- |
|
|
1748
1745
|
| elements | <code>string</code> | The list of elements |
|
|
1749
|
-
| elements[].field | <code>string</code> | Field name of the element [FORM_FIELD](#
|
|
1746
|
+
| elements[].field | <code>string</code> | Field name of the element [FORM_FIELD](#w_FORM_FIELD) |
|
|
1750
1747
|
| elements[].placeholder | <code>string</code> | Set custom form field placeholder |
|
|
1751
1748
|
| elements[].label | <code>string</code> | Set custom labels near form field |
|
|
1752
1749
|
| elements[].value | <code>string</code> | Set predefined values for the form field |
|
|
@@ -1769,38 +1766,38 @@ widget.setFormElements([
|
|
|
1769
1766
|
},
|
|
1770
1767
|
])
|
|
1771
1768
|
```
|
|
1772
|
-
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons"
|
|
1769
|
+
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons"></a>
|
|
1773
1770
|
|
|
1774
1771
|
### htmlMultiWidget.setIcons()
|
|
1775
1772
|
The method to change the widget icons
|
|
1776
1773
|
|
|
1777
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1774
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1778
1775
|
**Todo**
|
|
1779
1776
|
|
|
1780
1777
|
- [ ] DEPRECATED
|
|
1781
1778
|
|
|
1782
|
-
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements"
|
|
1779
|
+
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements"></a>
|
|
1783
1780
|
|
|
1784
1781
|
### htmlMultiWidget.setHiddenElements(elements)
|
|
1785
1782
|
Using this method you can set hidden elements inside widget
|
|
1786
1783
|
|
|
1787
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1784
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1788
1785
|
|
|
1789
1786
|
| Param | Type | Description |
|
|
1790
1787
|
| --- | --- | --- |
|
|
1791
|
-
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#
|
|
1788
|
+
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#w_ELEMENT) || [FORM_FIELD](#w_FORM_FIELD) |
|
|
1792
1789
|
|
|
1793
1790
|
**Example**
|
|
1794
1791
|
|
|
1795
1792
|
```javascript
|
|
1796
1793
|
widget.setHiddenElements(['submit_button', 'email']);
|
|
1797
1794
|
```
|
|
1798
|
-
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId"
|
|
1795
|
+
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId"></a>
|
|
1799
1796
|
|
|
1800
1797
|
### htmlMultiWidget.setRefId(refId)
|
|
1801
1798
|
Current method can set custom ID to identify the data in the future
|
|
1802
1799
|
|
|
1803
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1800
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1804
1801
|
|
|
1805
1802
|
| Param | Type | Description |
|
|
1806
1803
|
| --- | --- | --- |
|
|
@@ -1811,27 +1808,27 @@ Current method can set custom ID to identify the data in the future
|
|
|
1811
1808
|
```javascript
|
|
1812
1809
|
widget.setRefId('id');
|
|
1813
1810
|
```
|
|
1814
|
-
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation"
|
|
1811
|
+
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation"></a>
|
|
1815
1812
|
|
|
1816
1813
|
### htmlMultiWidget.useGatewayFieldValidation()
|
|
1817
1814
|
Current method can add visual validation from gateway to widget's form fields
|
|
1818
1815
|
|
|
1819
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1816
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1820
1817
|
**Example**
|
|
1821
1818
|
|
|
1822
1819
|
```javascript
|
|
1823
1820
|
widget.useGatewayFieldValidation();
|
|
1824
1821
|
```
|
|
1825
|
-
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons"
|
|
1822
|
+
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons"></a>
|
|
1826
1823
|
|
|
1827
1824
|
### htmlMultiWidget.setSupportedCardIcons(elements, validateCardNumberInput)
|
|
1828
1825
|
Current method can set icons of supported card types
|
|
1829
1826
|
|
|
1830
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1827
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1831
1828
|
|
|
1832
1829
|
| Param | Type | Description |
|
|
1833
1830
|
| --- | --- | --- |
|
|
1834
|
-
| elements | <code>[ 'Array' ].<string></code> | [SUPPORTED_CARD_TYPES](#
|
|
1831
|
+
| elements | <code>[ 'Array' ].<string></code> | [SUPPORTED_CARD_TYPES](#w_SUPPORTED_CARD_TYPES) |
|
|
1835
1832
|
| validateCardNumberInput | <code>boolean</code> | [validateCardNumberInput=false] - using this param you allow validation for card number input on supported card types |
|
|
1836
1833
|
|
|
1837
1834
|
**Example**
|
|
@@ -1839,13 +1836,13 @@ Current method can set icons of supported card types
|
|
|
1839
1836
|
```javascript
|
|
1840
1837
|
widget.setSupportedCardIcons(['mastercard', 'visa'], validateCardNumberInput);
|
|
1841
1838
|
```
|
|
1842
|
-
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv"
|
|
1839
|
+
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv"></a>
|
|
1843
1840
|
|
|
1844
1841
|
### htmlMultiWidget.setEnv(env, [alias])
|
|
1845
1842
|
Current method can change environment. By default environment = sandbox.
|
|
1846
1843
|
Also we can change domain alias for this environment. By default domain_alias = paydock.com
|
|
1847
1844
|
|
|
1848
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1845
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1849
1846
|
|
|
1850
1847
|
| Param | Type | Description |
|
|
1851
1848
|
| --- | --- | --- |
|
|
@@ -1857,12 +1854,12 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
1857
1854
|
```javascript
|
|
1858
1855
|
widget.setEnv('production', 'paydock.com');
|
|
1859
1856
|
```
|
|
1860
|
-
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl"
|
|
1857
|
+
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl"></a>
|
|
1861
1858
|
|
|
1862
1859
|
### htmlMultiWidget.loadIFrameUrl()
|
|
1863
1860
|
Method for creating iframe url
|
|
1864
1861
|
|
|
1865
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1862
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1866
1863
|
**Example**
|
|
1867
1864
|
|
|
1868
1865
|
```javascript
|
|
@@ -1872,12 +1869,12 @@ widget.loadIFrameUrl(function (url) {
|
|
|
1872
1869
|
console.log(errors);
|
|
1873
1870
|
});
|
|
1874
1871
|
```
|
|
1875
|
-
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage"
|
|
1872
|
+
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage"></a>
|
|
1876
1873
|
|
|
1877
1874
|
### htmlMultiWidget.setLanguage(code)
|
|
1878
1875
|
Method for setting a custom language code
|
|
1879
1876
|
|
|
1880
|
-
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#
|
|
1877
|
+
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1881
1878
|
|
|
1882
1879
|
| Param | Type | Description |
|
|
1883
1880
|
| --- | --- | --- |
|
|
@@ -1888,33 +1885,33 @@ Method for setting a custom language code
|
|
|
1888
1885
|
```javascript
|
|
1889
1886
|
config.setLanguage('en');
|
|
1890
1887
|
```
|
|
1891
|
-
<a name="w_Configuration" id="w_Configuration"
|
|
1888
|
+
<a name="w_Configuration" id="w_Configuration"></a>
|
|
1892
1889
|
|
|
1893
1890
|
## Configuration
|
|
1894
1891
|
Class Configuration include methods for creating configuration token
|
|
1895
1892
|
|
|
1896
1893
|
**Kind**: global class
|
|
1897
1894
|
|
|
1898
|
-
* [Configuration](#
|
|
1899
|
-
* [new exports.Configuration([gatewayID], paymentType, purpose)](#
|
|
1900
|
-
* [.setWebHookDestination(url)](#
|
|
1901
|
-
* [.setSuccessRedirectUrl(url)](#
|
|
1902
|
-
* [.setErrorRedirectUrl(url)](#
|
|
1903
|
-
* [.setFormFields(fields)](#
|
|
1904
|
-
* [.setMeta(object)](#
|
|
1905
|
-
* [.setEnv(env, [alias])](#
|
|
1906
|
-
* [.setLabel(label)](#
|
|
1907
|
-
* [.createToken(accessToken, cb, errorCb)](#
|
|
1895
|
+
* [Configuration](#w_Configuration)
|
|
1896
|
+
* [new exports.Configuration([gatewayID], paymentType, purpose)](#w_new_Configuration_new)
|
|
1897
|
+
* [.setWebHookDestination(url)](#w_Configuration+setWebHookDestination)
|
|
1898
|
+
* [.setSuccessRedirectUrl(url)](#w_Configuration+setSuccessRedirectUrl)
|
|
1899
|
+
* [.setErrorRedirectUrl(url)](#w_Configuration+setErrorRedirectUrl)
|
|
1900
|
+
* [.setFormFields(fields)](#w_Configuration+setFormFields)
|
|
1901
|
+
* [.setMeta(object)](#w_Configuration+setMeta)
|
|
1902
|
+
* [.setEnv(env, [alias])](#w_Configuration+setEnv)
|
|
1903
|
+
* [.setLabel(label)](#w_Configuration+setLabel)
|
|
1904
|
+
* [.createToken(accessToken, cb, errorCb)](#w_Configuration+createToken)
|
|
1908
1905
|
|
|
1909
|
-
<a name="w_new_Configuration_new" id="w_new_Configuration_new"
|
|
1906
|
+
<a name="w_new_Configuration_new" id="w_new_Configuration_new"></a>
|
|
1910
1907
|
|
|
1911
1908
|
### new exports.Configuration([gatewayID], paymentType, purpose)
|
|
1912
1909
|
|
|
1913
1910
|
| Param | Type | Default | Description |
|
|
1914
1911
|
| --- | --- | --- | --- |
|
|
1915
|
-
| [gatewayID] | <code>string</code> | <code>"default"</code> | gateway ID. By default or if put 'default', it will use the selected default gateway
|
|
1916
|
-
| paymentType | <code>string</code> | | Type of payment source which shows in widget form. Available parameters [PAYMENT_TYPE](#
|
|
1917
|
-
| purpose | <code>string</code> | | Param which describes payment purpose. By default uses Available parameters [PURPOSE](#
|
|
1912
|
+
| [gatewayID] | <code>string</code> | <code>"default"</code> | gateway ID. By default or if put 'default', it will use the selected default gateway |
|
|
1913
|
+
| paymentType | <code>string</code> | | Type of payment source which shows in widget form. Available parameters [PAYMENT_TYPE](#w_PAYMENT_TYPE) |
|
|
1914
|
+
| purpose | <code>string</code> | | Param which describes payment purpose. By default uses Available parameters [PURPOSE](#w_PURPOSE) |
|
|
1918
1915
|
|
|
1919
1916
|
**Example**
|
|
1920
1917
|
|
|
@@ -1922,16 +1919,14 @@ Class Configuration include methods for creating configuration token
|
|
|
1922
1919
|
var config = new Configuration('gatewayId'); // short
|
|
1923
1920
|
|
|
1924
1921
|
var config = new Configuration('gatewayId', 'bank_account', 'paymentSource'); // extend
|
|
1925
|
-
|
|
1926
|
-
var config = new Configuration('not_configured'); // without gateway
|
|
1927
1922
|
```
|
|
1928
|
-
<a name="w_Configuration+setWebHookDestination" id="w_Configuration+setWebHookDestination"
|
|
1923
|
+
<a name="w_Configuration+setWebHookDestination" id="w_Configuration+setWebHookDestination"></a>
|
|
1929
1924
|
|
|
1930
1925
|
### configuration.setWebHookDestination(url)
|
|
1931
1926
|
Destination, where customer will receive all successful responses.
|
|
1932
1927
|
Response will contain “data” object with “payment_source” or other parameters, in depending on 'purpose'
|
|
1933
1928
|
|
|
1934
|
-
**Kind**: instance method of [<code>Configuration</code>](#
|
|
1929
|
+
**Kind**: instance method of [<code>Configuration</code>](#w_Configuration)
|
|
1935
1930
|
|
|
1936
1931
|
| Param | Type | Description |
|
|
1937
1932
|
| --- | --- | --- |
|
|
@@ -1942,12 +1937,12 @@ Response will contain “data” object with “payment_source” or other param
|
|
|
1942
1937
|
```javascript
|
|
1943
1938
|
config.setWebHookDestination('http://google.com');
|
|
1944
1939
|
```
|
|
1945
|
-
<a name="w_Configuration+setSuccessRedirectUrl" id="w_Configuration+setSuccessRedirectUrl"
|
|
1940
|
+
<a name="w_Configuration+setSuccessRedirectUrl" id="w_Configuration+setSuccessRedirectUrl"></a>
|
|
1946
1941
|
|
|
1947
1942
|
### configuration.setSuccessRedirectUrl(url)
|
|
1948
1943
|
URL to which the Customer will be redirected to after the success finish
|
|
1949
1944
|
|
|
1950
|
-
**Kind**: instance method of [<code>Configuration</code>](#
|
|
1945
|
+
**Kind**: instance method of [<code>Configuration</code>](#w_Configuration)
|
|
1951
1946
|
|
|
1952
1947
|
| Param | Type |
|
|
1953
1948
|
| --- | --- |
|
|
@@ -1958,12 +1953,12 @@ URL to which the Customer will be redirected to after the success finish
|
|
|
1958
1953
|
```javascript
|
|
1959
1954
|
config.setSuccessRedirectUrl('google.com/search?q=success');
|
|
1960
1955
|
```
|
|
1961
|
-
<a name="w_Configuration+setErrorRedirectUrl" id="w_Configuration+setErrorRedirectUrl"
|
|
1956
|
+
<a name="w_Configuration+setErrorRedirectUrl" id="w_Configuration+setErrorRedirectUrl"></a>
|
|
1962
1957
|
|
|
1963
1958
|
### configuration.setErrorRedirectUrl(url)
|
|
1964
1959
|
URL to which the Customer will be redirected to if an error is triggered in the process of operation
|
|
1965
1960
|
|
|
1966
|
-
**Kind**: instance method of [<code>Configuration</code>](#
|
|
1961
|
+
**Kind**: instance method of [<code>Configuration</code>](#w_Configuration)
|
|
1967
1962
|
|
|
1968
1963
|
| Param | Type |
|
|
1969
1964
|
| --- | --- |
|
|
@@ -1974,32 +1969,32 @@ URL to which the Customer will be redirected to if an error is triggered in the
|
|
|
1974
1969
|
```javascript
|
|
1975
1970
|
config.setErrorRedirectUrl('google.com/search?q=error');
|
|
1976
1971
|
```
|
|
1977
|
-
<a name="w_Configuration+setFormFields" id="w_Configuration+setFormFields"
|
|
1972
|
+
<a name="w_Configuration+setFormFields" id="w_Configuration+setFormFields"></a>
|
|
1978
1973
|
|
|
1979
1974
|
### configuration.setFormFields(fields)
|
|
1980
1975
|
Set list with widget form field, which will be shown in form. Also you can set the required validation for these fields
|
|
1981
1976
|
|
|
1982
|
-
**Kind**: instance method of [<code>Configuration</code>](#
|
|
1977
|
+
**Kind**: instance method of [<code>Configuration</code>](#w_Configuration)
|
|
1983
1978
|
|
|
1984
1979
|
| Param | Type | Description |
|
|
1985
1980
|
| --- | --- | --- |
|
|
1986
|
-
| fields | <code>[ 'Array' ].<string></code> | name of fields which can be shown in a widget. If after a name of a field, you put “*”, this field will be required on client-side. (For validation, you can specify any fields, even those that are shown by default: card_number, expiration, etc... ) [FORM_FIELD](#
|
|
1981
|
+
| fields | <code>[ 'Array' ].<string></code> | name of fields which can be shown in a widget. If after a name of a field, you put “*”, this field will be required on client-side. (For validation, you can specify any fields, even those that are shown by default: card_number, expiration, etc... ) [FORM_FIELD](#w_FORM_FIELD) |
|
|
1987
1982
|
|
|
1988
1983
|
**Example**
|
|
1989
1984
|
|
|
1990
1985
|
```javascript
|
|
1991
1986
|
config.setFormFields(['phone', 'email', 'first_name*']);
|
|
1992
1987
|
```
|
|
1993
|
-
<a name="w_Configuration+setMeta" id="w_Configuration+setMeta"
|
|
1988
|
+
<a name="w_Configuration+setMeta" id="w_Configuration+setMeta"></a>
|
|
1994
1989
|
|
|
1995
1990
|
### configuration.setMeta(object)
|
|
1996
1991
|
Method for setting meta information for checkout page
|
|
1997
1992
|
|
|
1998
|
-
**Kind**: instance method of [<code>Configuration</code>](#
|
|
1993
|
+
**Kind**: instance method of [<code>Configuration</code>](#w_Configuration)
|
|
1999
1994
|
|
|
2000
1995
|
| Param | Type | Description |
|
|
2001
1996
|
| --- | --- | --- |
|
|
2002
|
-
| object | [<code>IPayPalMeta</code>](#
|
|
1997
|
+
| object | [<code>IPayPalMeta</code>](#w_IPayPalMeta) \| <code>IZipmoneyMeta</code> \| <code>IAfterpayMeta</code> \| [<code>IBamboraMeta</code>](#w_IBamboraMeta) | data which can be shown on checkout page [IPayPalMeta](#w_IPayPalMeta) [IZipmoneyMeta](IZipmoneyMeta) [IAfterpayMeta](IAfterpayMeta) [IBamboraMeta](#w_IBamboraMeta) |
|
|
2003
1998
|
|
|
2004
1999
|
**Example**
|
|
2005
2000
|
|
|
@@ -2010,13 +2005,13 @@ config.setMeta({
|
|
|
2010
2005
|
email: 'wault@paydock.com'
|
|
2011
2006
|
});
|
|
2012
2007
|
```
|
|
2013
|
-
<a name="w_Configuration+setEnv" id="w_Configuration+setEnv"
|
|
2008
|
+
<a name="w_Configuration+setEnv" id="w_Configuration+setEnv"></a>
|
|
2014
2009
|
|
|
2015
2010
|
### configuration.setEnv(env, [alias])
|
|
2016
2011
|
Current method can change environment. By default environment = sandbox.
|
|
2017
2012
|
Also we can change domain alias for this environment. By default domain_alias = paydock.com
|
|
2018
2013
|
|
|
2019
|
-
**Kind**: instance method of [<code>Configuration</code>](#
|
|
2014
|
+
**Kind**: instance method of [<code>Configuration</code>](#w_Configuration)
|
|
2020
2015
|
|
|
2021
2016
|
| Param | Type | Description |
|
|
2022
2017
|
| --- | --- | --- |
|
|
@@ -2028,12 +2023,12 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
2028
2023
|
```javascript
|
|
2029
2024
|
config.setEnv('production');
|
|
2030
2025
|
```
|
|
2031
|
-
<a name="w_Configuration+setLabel" id="w_Configuration+setLabel"
|
|
2026
|
+
<a name="w_Configuration+setLabel" id="w_Configuration+setLabel"></a>
|
|
2032
2027
|
|
|
2033
2028
|
### configuration.setLabel(label)
|
|
2034
2029
|
Title for tab which can be set instead of default
|
|
2035
2030
|
|
|
2036
|
-
**Kind**: instance method of [<code>Configuration</code>](#
|
|
2031
|
+
**Kind**: instance method of [<code>Configuration</code>](#w_Configuration)
|
|
2037
2032
|
|
|
2038
2033
|
| Param | Type | Description |
|
|
2039
2034
|
| --- | --- | --- |
|
|
@@ -2044,12 +2039,12 @@ Title for tab which can be set instead of default
|
|
|
2044
2039
|
```javascript
|
|
2045
2040
|
config.setLabel('custom label');
|
|
2046
2041
|
```
|
|
2047
|
-
<a name="w_Configuration+createToken" id="w_Configuration+createToken"
|
|
2042
|
+
<a name="w_Configuration+createToken" id="w_Configuration+createToken"></a>
|
|
2048
2043
|
|
|
2049
2044
|
### configuration.createToken(accessToken, cb, errorCb)
|
|
2050
2045
|
createToken - method which exactly create payment one time token
|
|
2051
2046
|
|
|
2052
|
-
**Kind**: instance method of [<code>Configuration</code>](#
|
|
2047
|
+
**Kind**: instance method of [<code>Configuration</code>](#w_Configuration)
|
|
2053
2048
|
|
|
2054
2049
|
| Param | Type | Description |
|
|
2055
2050
|
| --- | --- | --- |
|
|
@@ -2067,40 +2062,40 @@ config.createToken('582035346f65cdd57ee81192d6e5w65w4e5',
|
|
|
2067
2062
|
console.log(error);
|
|
2068
2063
|
});
|
|
2069
2064
|
```
|
|
2070
|
-
<a name="w_MultiWidget" id="w_MultiWidget"
|
|
2065
|
+
<a name="w_MultiWidget" id="w_MultiWidget"></a>
|
|
2071
2066
|
|
|
2072
2067
|
## MultiWidget
|
|
2073
2068
|
Class MultiWidget include method for for creating iframe url
|
|
2074
2069
|
|
|
2075
2070
|
**Kind**: global class
|
|
2076
2071
|
|
|
2077
|
-
* [MultiWidget](#
|
|
2078
|
-
* [new exports.MultiWidget(accessToken, conf)](#
|
|
2079
|
-
* [.setStyles(fields)](#
|
|
2080
|
-
* [.usePhoneCountryMask([options])](#
|
|
2081
|
-
* [.setTexts(fields)](#
|
|
2082
|
-
* [.setElementStyle(element, [state], styles)](#
|
|
2083
|
-
* [.setFormValues(fieldValues)](#
|
|
2084
|
-
* [.setFormLabels(fieldLabels)](#
|
|
2085
|
-
* [.setFormPlaceholders(fieldPlaceholders)](#
|
|
2086
|
-
* [.setFormElements(elements)](#
|
|
2087
|
-
* [.setIcons()](#
|
|
2088
|
-
* [.setHiddenElements(elements)](#
|
|
2089
|
-
* [.setRefId(refId)](#
|
|
2090
|
-
* [.useGatewayFieldValidation()](#
|
|
2091
|
-
* [.setSupportedCardIcons(elements, validateCardNumberInput)](#
|
|
2092
|
-
* [.setEnv(env, [alias])](#
|
|
2093
|
-
* [.loadIFrameUrl()](#
|
|
2094
|
-
* [.setLanguage(code)](#
|
|
2095
|
-
|
|
2096
|
-
<a name="w_new_MultiWidget_new" id="w_new_MultiWidget_new"
|
|
2072
|
+
* [MultiWidget](#w_MultiWidget)
|
|
2073
|
+
* [new exports.MultiWidget(accessToken, conf)](#w_new_MultiWidget_new)
|
|
2074
|
+
* [.setStyles(fields)](#w_MultiWidget+setStyles)
|
|
2075
|
+
* [.usePhoneCountryMask([options])](#w_MultiWidget+usePhoneCountryMask)
|
|
2076
|
+
* [.setTexts(fields)](#w_MultiWidget+setTexts)
|
|
2077
|
+
* [.setElementStyle(element, [state], styles)](#w_MultiWidget+setElementStyle)
|
|
2078
|
+
* [.setFormValues(fieldValues)](#w_MultiWidget+setFormValues)
|
|
2079
|
+
* [.setFormLabels(fieldLabels)](#w_MultiWidget+setFormLabels)
|
|
2080
|
+
* [.setFormPlaceholders(fieldPlaceholders)](#w_MultiWidget+setFormPlaceholders)
|
|
2081
|
+
* [.setFormElements(elements)](#w_MultiWidget+setFormElements)
|
|
2082
|
+
* [.setIcons()](#w_MultiWidget+setIcons)
|
|
2083
|
+
* [.setHiddenElements(elements)](#w_MultiWidget+setHiddenElements)
|
|
2084
|
+
* [.setRefId(refId)](#w_MultiWidget+setRefId)
|
|
2085
|
+
* [.useGatewayFieldValidation()](#w_MultiWidget+useGatewayFieldValidation)
|
|
2086
|
+
* [.setSupportedCardIcons(elements, validateCardNumberInput)](#w_MultiWidget+setSupportedCardIcons)
|
|
2087
|
+
* [.setEnv(env, [alias])](#w_MultiWidget+setEnv)
|
|
2088
|
+
* [.loadIFrameUrl()](#w_MultiWidget+loadIFrameUrl)
|
|
2089
|
+
* [.setLanguage(code)](#w_MultiWidget+setLanguage)
|
|
2090
|
+
|
|
2091
|
+
<a name="w_new_MultiWidget_new" id="w_new_MultiWidget_new"></a>
|
|
2097
2092
|
|
|
2098
2093
|
### new exports.MultiWidget(accessToken, conf)
|
|
2099
2094
|
|
|
2100
2095
|
| Param | Type | Description |
|
|
2101
2096
|
| --- | --- | --- |
|
|
2102
2097
|
| accessToken | <code>string</code> | PayDock users access token or public key |
|
|
2103
|
-
| conf | [<code>Configuration</code>](#
|
|
2098
|
+
| conf | [<code>Configuration</code>](#w_Configuration) \| <code>string</code> \| [<code>Array.<Configuration></code>](#w_Configuration) \| <code>Array.<string></code> | exemplar[s] Configuration class OR configuration token |
|
|
2104
2099
|
|
|
2105
2100
|
**Example**
|
|
2106
2101
|
|
|
@@ -2116,16 +2111,16 @@ var widget = new MultiWidget('accessToken',[ With Configurations
|
|
|
2116
2111
|
Configuration('gatewayId', 'bank_account')
|
|
2117
2112
|
]);
|
|
2118
2113
|
```
|
|
2119
|
-
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles"
|
|
2114
|
+
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles"></a>
|
|
2120
2115
|
|
|
2121
2116
|
### multiWidget.setStyles(fields)
|
|
2122
2117
|
Object contain styles for widget
|
|
2123
2118
|
|
|
2124
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2119
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2125
2120
|
|
|
2126
2121
|
| Param | Type | Description |
|
|
2127
2122
|
| --- | --- | --- |
|
|
2128
|
-
| fields | [<code>IStyles</code>](#
|
|
2123
|
+
| fields | [<code>IStyles</code>](#w_IStyles) | name of styles which can be shown in widget [STYLE](#w_STYLE) |
|
|
2129
2124
|
|
|
2130
2125
|
**Example**
|
|
2131
2126
|
|
|
@@ -2139,12 +2134,12 @@ widget.setStyles({
|
|
|
2139
2134
|
fort_family: 'fantasy'
|
|
2140
2135
|
});
|
|
2141
2136
|
```
|
|
2142
|
-
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask"
|
|
2137
|
+
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask"></a>
|
|
2143
2138
|
|
|
2144
2139
|
### multiWidget.usePhoneCountryMask([options])
|
|
2145
2140
|
Method to set a country code mask for the phone input.
|
|
2146
2141
|
|
|
2147
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2142
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2148
2143
|
|
|
2149
2144
|
| Param | Type | Description |
|
|
2150
2145
|
| --- | --- | --- |
|
|
@@ -2167,16 +2162,16 @@ widget.usePhoneCountryMask({
|
|
|
2167
2162
|
only_countries: ['au', 'gb', 'us', 'ua']
|
|
2168
2163
|
});
|
|
2169
2164
|
```
|
|
2170
|
-
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts"
|
|
2165
|
+
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts"></a>
|
|
2171
2166
|
|
|
2172
2167
|
### multiWidget.setTexts(fields)
|
|
2173
2168
|
Method for set different texts inside the widget
|
|
2174
2169
|
|
|
2175
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2170
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2176
2171
|
|
|
2177
2172
|
| Param | Type | Description |
|
|
2178
2173
|
| --- | --- | --- |
|
|
2179
|
-
| fields | [<code>ITexts</code>](#
|
|
2174
|
+
| fields | [<code>ITexts</code>](#w_ITexts) | name of text items which can be shown in widget [TEXT](#w_TEXT) |
|
|
2180
2175
|
|
|
2181
2176
|
**Example**
|
|
2182
2177
|
|
|
@@ -2189,18 +2184,18 @@ widget.setTexts({
|
|
|
2189
2184
|
submit_button_processing: 'Load...',
|
|
2190
2185
|
});
|
|
2191
2186
|
```
|
|
2192
|
-
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle"
|
|
2187
|
+
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle"></a>
|
|
2193
2188
|
|
|
2194
2189
|
### multiWidget.setElementStyle(element, [state], styles)
|
|
2195
2190
|
Method for set styles for different elements and states
|
|
2196
2191
|
|
|
2197
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2192
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2198
2193
|
|
|
2199
2194
|
| Param | Type | Description |
|
|
2200
2195
|
| --- | --- | --- |
|
|
2201
|
-
| element | <code>string</code> | type of element for styling. These elements are available [STYLABLE_ELEMENT](#
|
|
2202
|
-
| [state] | <code>string</code> | state of element for styling. These states are available [STYLABLE_ELEMENT_STATE](#
|
|
2203
|
-
| styles | [<code>IElementStyleInput</code>](#
|
|
2196
|
+
| element | <code>string</code> | type of element for styling. These elements are available [STYLABLE_ELEMENT](#w_STYLABLE_ELEMENT) |
|
|
2197
|
+
| [state] | <code>string</code> | state of element for styling. These states are available [STYLABLE_ELEMENT_STATE](#w_STYLABLE_ELEMENT_STATE) |
|
|
2198
|
+
| styles | [<code>IElementStyleInput</code>](#w_IElementStyleInput) \| [<code>IElementStyleSubmitButton</code>](#w_IElementStyleSubmitButton) \| [<code>IElementStyleLabel</code>](#w_IElementStyleLabel) \| [<code>IElementStyleTitle</code>](#w_IElementStyleTitle) \| [<code>IElementStyleTitleDescription</code>](#w_IElementStyleTitleDescription) | styles list |
|
|
2204
2199
|
|
|
2205
2200
|
**Example**
|
|
2206
2201
|
|
|
@@ -2217,16 +2212,16 @@ widget.setElementStyle('input', 'error', {
|
|
|
2217
2212
|
border: 'red solid 1px'
|
|
2218
2213
|
});
|
|
2219
2214
|
```
|
|
2220
|
-
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues"
|
|
2215
|
+
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues"></a>
|
|
2221
2216
|
|
|
2222
2217
|
### multiWidget.setFormValues(fieldValues)
|
|
2223
2218
|
The method to set the predefined values for the form fields inside the widget
|
|
2224
2219
|
|
|
2225
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2220
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2226
2221
|
|
|
2227
2222
|
| Param | Type | Description |
|
|
2228
2223
|
| --- | --- | --- |
|
|
2229
|
-
| fieldValues | <code>Object</code> | Key of object is one of [FORM_FIELD](#
|
|
2224
|
+
| fieldValues | <code>Object</code> | Key of object is one of [FORM_FIELD](#w_FORM_FIELD), The object value is what we are expecting |
|
|
2230
2225
|
|
|
2231
2226
|
**Example**
|
|
2232
2227
|
|
|
@@ -2236,16 +2231,16 @@ widget.setFormValues({
|
|
|
2236
2231
|
card_name: 'Houston'
|
|
2237
2232
|
});
|
|
2238
2233
|
```
|
|
2239
|
-
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels"
|
|
2234
|
+
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels"></a>
|
|
2240
2235
|
|
|
2241
2236
|
### multiWidget.setFormLabels(fieldLabels)
|
|
2242
2237
|
The method to set custom form field labels
|
|
2243
2238
|
|
|
2244
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2239
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2245
2240
|
|
|
2246
2241
|
| Param | Type | Description |
|
|
2247
2242
|
| --- | --- | --- |
|
|
2248
|
-
| fieldLabels | <code>Object</code> | Key of object is one of [FORM_FIELD](#
|
|
2243
|
+
| fieldLabels | <code>Object</code> | Key of object is one of [FORM_FIELD](#w_FORM_FIELD), The object value is what we are expecting |
|
|
2249
2244
|
|
|
2250
2245
|
**Example**
|
|
2251
2246
|
|
|
@@ -2255,16 +2250,16 @@ widget.setFormPlaceholders({
|
|
|
2255
2250
|
email: 'Email For Receipt'
|
|
2256
2251
|
})
|
|
2257
2252
|
```
|
|
2258
|
-
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders"
|
|
2253
|
+
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders"></a>
|
|
2259
2254
|
|
|
2260
2255
|
### multiWidget.setFormPlaceholders(fieldPlaceholders)
|
|
2261
2256
|
The method to set custom form fields placeholders
|
|
2262
2257
|
|
|
2263
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2258
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2264
2259
|
|
|
2265
2260
|
| Param | Type | Description |
|
|
2266
2261
|
| --- | --- | --- |
|
|
2267
|
-
| fieldPlaceholders | <code>Object</code> | Key of object is one of [FORM_FIELD](#
|
|
2262
|
+
| fieldPlaceholders | <code>Object</code> | Key of object is one of [FORM_FIELD](#w_FORM_FIELD), Value of object is expected placeholder |
|
|
2268
2263
|
|
|
2269
2264
|
**Example**
|
|
2270
2265
|
|
|
@@ -2274,18 +2269,18 @@ widget.setFormPlaceholders({
|
|
|
2274
2269
|
email: 'Input your email, like test@example.com'
|
|
2275
2270
|
})
|
|
2276
2271
|
```
|
|
2277
|
-
<a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements"
|
|
2272
|
+
<a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements"></a>
|
|
2278
2273
|
|
|
2279
2274
|
### multiWidget.setFormElements(elements)
|
|
2280
2275
|
The method to set the full configuration for the all specific form elements (label, placeholder, value)
|
|
2281
2276
|
You can also use the other method for the partial configuration like: setFormValues, setFormPlaceholder, setFormLabel
|
|
2282
2277
|
|
|
2283
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2278
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2284
2279
|
|
|
2285
2280
|
| Param | Type | Description |
|
|
2286
2281
|
| --- | --- | --- |
|
|
2287
2282
|
| elements | <code>string</code> | The list of elements |
|
|
2288
|
-
| elements[].field | <code>string</code> | Field name of the element [FORM_FIELD](#
|
|
2283
|
+
| elements[].field | <code>string</code> | Field name of the element [FORM_FIELD](#w_FORM_FIELD) |
|
|
2289
2284
|
| elements[].placeholder | <code>string</code> | Set custom form field placeholder |
|
|
2290
2285
|
| elements[].label | <code>string</code> | Set custom labels near form field |
|
|
2291
2286
|
| elements[].value | <code>string</code> | Set predefined values for the form field |
|
|
@@ -2308,38 +2303,38 @@ widget.setFormElements([
|
|
|
2308
2303
|
},
|
|
2309
2304
|
])
|
|
2310
2305
|
```
|
|
2311
|
-
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons"
|
|
2306
|
+
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons"></a>
|
|
2312
2307
|
|
|
2313
2308
|
### multiWidget.setIcons()
|
|
2314
2309
|
The method to change the widget icons
|
|
2315
2310
|
|
|
2316
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2311
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2317
2312
|
**Todo**
|
|
2318
2313
|
|
|
2319
2314
|
- [ ] DEPRECATED
|
|
2320
2315
|
|
|
2321
|
-
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements"
|
|
2316
|
+
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements"></a>
|
|
2322
2317
|
|
|
2323
2318
|
### multiWidget.setHiddenElements(elements)
|
|
2324
2319
|
Using this method you can set hidden elements inside widget
|
|
2325
2320
|
|
|
2326
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2321
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2327
2322
|
|
|
2328
2323
|
| Param | Type | Description |
|
|
2329
2324
|
| --- | --- | --- |
|
|
2330
|
-
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#
|
|
2325
|
+
| elements | <code>[ 'Array' ].<string></code> | list of element which can be hidden [ELEMENT](#w_ELEMENT) || [FORM_FIELD](#w_FORM_FIELD) |
|
|
2331
2326
|
|
|
2332
2327
|
**Example**
|
|
2333
2328
|
|
|
2334
2329
|
```javascript
|
|
2335
2330
|
widget.setHiddenElements(['submit_button', 'email']);
|
|
2336
2331
|
```
|
|
2337
|
-
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId"
|
|
2332
|
+
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId"></a>
|
|
2338
2333
|
|
|
2339
2334
|
### multiWidget.setRefId(refId)
|
|
2340
2335
|
Current method can set custom ID to identify the data in the future
|
|
2341
2336
|
|
|
2342
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2337
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2343
2338
|
|
|
2344
2339
|
| Param | Type | Description |
|
|
2345
2340
|
| --- | --- | --- |
|
|
@@ -2350,27 +2345,27 @@ Current method can set custom ID to identify the data in the future
|
|
|
2350
2345
|
```javascript
|
|
2351
2346
|
widget.setRefId('id');
|
|
2352
2347
|
```
|
|
2353
|
-
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation"
|
|
2348
|
+
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation"></a>
|
|
2354
2349
|
|
|
2355
2350
|
### multiWidget.useGatewayFieldValidation()
|
|
2356
2351
|
Current method can add visual validation from gateway to widget's form fields
|
|
2357
2352
|
|
|
2358
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2353
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2359
2354
|
**Example**
|
|
2360
2355
|
|
|
2361
2356
|
```javascript
|
|
2362
2357
|
widget.useGatewayFieldValidation();
|
|
2363
2358
|
```
|
|
2364
|
-
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons"
|
|
2359
|
+
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons"></a>
|
|
2365
2360
|
|
|
2366
2361
|
### multiWidget.setSupportedCardIcons(elements, validateCardNumberInput)
|
|
2367
2362
|
Current method can set icons of supported card types
|
|
2368
2363
|
|
|
2369
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2364
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2370
2365
|
|
|
2371
2366
|
| Param | Type | Description |
|
|
2372
2367
|
| --- | --- | --- |
|
|
2373
|
-
| elements | <code>[ 'Array' ].<string></code> | [SUPPORTED_CARD_TYPES](#
|
|
2368
|
+
| elements | <code>[ 'Array' ].<string></code> | [SUPPORTED_CARD_TYPES](#w_SUPPORTED_CARD_TYPES) |
|
|
2374
2369
|
| validateCardNumberInput | <code>boolean</code> | [validateCardNumberInput=false] - using this param you allow validation for card number input on supported card types |
|
|
2375
2370
|
|
|
2376
2371
|
**Example**
|
|
@@ -2378,13 +2373,13 @@ Current method can set icons of supported card types
|
|
|
2378
2373
|
```javascript
|
|
2379
2374
|
widget.setSupportedCardIcons(['mastercard', 'visa'], validateCardNumberInput);
|
|
2380
2375
|
```
|
|
2381
|
-
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv"
|
|
2376
|
+
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv"></a>
|
|
2382
2377
|
|
|
2383
2378
|
### multiWidget.setEnv(env, [alias])
|
|
2384
2379
|
Current method can change environment. By default environment = sandbox.
|
|
2385
2380
|
Also we can change domain alias for this environment. By default domain_alias = paydock.com
|
|
2386
2381
|
|
|
2387
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2382
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2388
2383
|
|
|
2389
2384
|
| Param | Type | Description |
|
|
2390
2385
|
| --- | --- | --- |
|
|
@@ -2396,12 +2391,12 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
2396
2391
|
```javascript
|
|
2397
2392
|
widget.setEnv('production', 'paydock.com');
|
|
2398
2393
|
```
|
|
2399
|
-
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl"
|
|
2394
|
+
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl"></a>
|
|
2400
2395
|
|
|
2401
2396
|
### multiWidget.loadIFrameUrl()
|
|
2402
2397
|
Method for creating iframe url
|
|
2403
2398
|
|
|
2404
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2399
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2405
2400
|
**Example**
|
|
2406
2401
|
|
|
2407
2402
|
```javascript
|
|
@@ -2411,12 +2406,12 @@ widget.loadIFrameUrl(function (url) {
|
|
|
2411
2406
|
console.log(errors);
|
|
2412
2407
|
});
|
|
2413
2408
|
```
|
|
2414
|
-
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage"
|
|
2409
|
+
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage"></a>
|
|
2415
2410
|
|
|
2416
2411
|
### multiWidget.setLanguage(code)
|
|
2417
2412
|
Method for setting a custom language code
|
|
2418
2413
|
|
|
2419
|
-
**Kind**: instance method of [<code>MultiWidget</code>](#
|
|
2414
|
+
**Kind**: instance method of [<code>MultiWidget</code>](#w_MultiWidget)
|
|
2420
2415
|
|
|
2421
2416
|
| Param | Type | Description |
|
|
2422
2417
|
| --- | --- | --- |
|
|
@@ -2427,7 +2422,7 @@ Method for setting a custom language code
|
|
|
2427
2422
|
```javascript
|
|
2428
2423
|
config.setLanguage('en');
|
|
2429
2424
|
```
|
|
2430
|
-
<a name="w_EVENT" id="w_EVENT"
|
|
2425
|
+
<a name="w_EVENT" id="w_EVENT"></a>
|
|
2431
2426
|
|
|
2432
2427
|
## EVENT : <code>object</code>
|
|
2433
2428
|
List of available event's name
|
|
@@ -2445,7 +2440,7 @@ List of available event's name
|
|
|
2445
2440
|
| META_CHANGE | <code>string</code> | <code>"metaChange"</code> |
|
|
2446
2441
|
| RESIZE | <code>string</code> | <code>"resize"</code> |
|
|
2447
2442
|
|
|
2448
|
-
<a name="w_VAULT_DISPLAY_EVENT" id="w_VAULT_DISPLAY_EVENT"
|
|
2443
|
+
<a name="w_VAULT_DISPLAY_EVENT" id="w_VAULT_DISPLAY_EVENT"></a>
|
|
2449
2444
|
|
|
2450
2445
|
## VAULT\_DISPLAY\_EVENT : <code>object</code>
|
|
2451
2446
|
List of available event's name
|
|
@@ -2463,7 +2458,7 @@ List of available event's name
|
|
|
2463
2458
|
| SYSTEM_ERROR | <code>string</code> | <code>"session_expired"</code> |
|
|
2464
2459
|
| OPERATION_FORBIDDEN | <code>string</code> | <code>"operation_forbidden"</code> |
|
|
2465
2460
|
|
|
2466
|
-
<a name="w_PAYMENT_TYPE" id="w_PAYMENT_TYPE"
|
|
2461
|
+
<a name="w_PAYMENT_TYPE" id="w_PAYMENT_TYPE"></a>
|
|
2467
2462
|
|
|
2468
2463
|
## PAYMENT\_TYPE : <code>object</code>
|
|
2469
2464
|
List of available payment source types
|
|
@@ -2476,7 +2471,7 @@ List of available payment source types
|
|
|
2476
2471
|
| BANK_ACCOUNT | <code>string</code> | <code>"bank_account"</code> |
|
|
2477
2472
|
| CHECKOUT | <code>string</code> | <code>"checkout"</code> |
|
|
2478
2473
|
|
|
2479
|
-
<a name="w_PURPOSE" id="w_PURPOSE"
|
|
2474
|
+
<a name="w_PURPOSE" id="w_PURPOSE"></a>
|
|
2480
2475
|
|
|
2481
2476
|
## PURPOSE : <code>object</code>
|
|
2482
2477
|
Purposes
|
|
@@ -2489,7 +2484,7 @@ Purposes
|
|
|
2489
2484
|
| CARD_PAYMENT_SOURCE_WITH_CVV | <code>string</code> | <code>"card_payment_source_with_cvv"</code> |
|
|
2490
2485
|
| CARD_PAYMENT_SOURCE_WITHOUT_CVV | <code>string</code> | <code>"card_payment_source_without_cvv"</code> |
|
|
2491
2486
|
|
|
2492
|
-
<a name="w_FORM_FIELD" id="w_FORM_FIELD"
|
|
2487
|
+
<a name="w_FORM_FIELD" id="w_FORM_FIELD"></a>
|
|
2493
2488
|
|
|
2494
2489
|
## FORM\_FIELD : <code>object</code>
|
|
2495
2490
|
Current constant include available type of fields which can be included to widget
|
|
@@ -2523,7 +2518,7 @@ Current constant include available type of fields which can be included to widge
|
|
|
2523
2518
|
| ADDRESS_POSTCODE | <code>string</code> | <code>"address_postcode"</code> |
|
|
2524
2519
|
| ADDRESS_COMPANY | <code>string</code> | <code>"address_company"</code> |
|
|
2525
2520
|
|
|
2526
|
-
<a name="w_STYLE" id="w_STYLE"
|
|
2521
|
+
<a name="w_STYLE" id="w_STYLE"></a>
|
|
2527
2522
|
|
|
2528
2523
|
## STYLE : <code>object</code>
|
|
2529
2524
|
List of available style params for widget
|
|
@@ -2541,7 +2536,7 @@ List of available style params for widget
|
|
|
2541
2536
|
| FONT_SIZE | <code>string</code> | <code>"font_size"</code> |
|
|
2542
2537
|
| FONT_FAMILY | <code>string</code> | <code>"font_family"</code> |
|
|
2543
2538
|
|
|
2544
|
-
<a name="w_TEXT" id="w_TEXT"
|
|
2539
|
+
<a name="w_TEXT" id="w_TEXT"></a>
|
|
2545
2540
|
|
|
2546
2541
|
## TEXT : <code>object</code>
|
|
2547
2542
|
List of available text item params for widget
|
|
@@ -2553,7 +2548,7 @@ List of available text item params for widget
|
|
|
2553
2548
|
| TITLE | <code>string</code> | <code>"title"</code> |
|
|
2554
2549
|
| FINISH | <code>string</code> | <code>"finish_text"</code> |
|
|
2555
2550
|
|
|
2556
|
-
<a name="w_ELEMENT" id="w_ELEMENT"
|
|
2551
|
+
<a name="w_ELEMENT" id="w_ELEMENT"></a>
|
|
2557
2552
|
|
|
2558
2553
|
## ELEMENT : <code>object</code>
|
|
2559
2554
|
List of available params for hide elements
|
|
@@ -2565,7 +2560,7 @@ List of available params for hide elements
|
|
|
2565
2560
|
| SUBMIT_BUTTON | <code>string</code> | <code>"submit_button"</code> |
|
|
2566
2561
|
| TABS | <code>string</code> | <code>"tabs"</code> |
|
|
2567
2562
|
|
|
2568
|
-
<a name="w_SUPPORTED_CARD_TYPES" id="w_SUPPORTED_CARD_TYPES"
|
|
2563
|
+
<a name="w_SUPPORTED_CARD_TYPES" id="w_SUPPORTED_CARD_TYPES"></a>
|
|
2569
2564
|
|
|
2570
2565
|
## SUPPORTED\_CARD\_TYPES : <code>object</code>
|
|
2571
2566
|
The list of available parameters for showing card icons
|
|
@@ -2585,7 +2580,7 @@ The list of available parameters for showing card icons
|
|
|
2585
2580
|
| VISA | <code>string</code> | <code>"visa"</code> |
|
|
2586
2581
|
| VISA_WHITE | <code>string</code> | <code>"visa_white"</code> |
|
|
2587
2582
|
|
|
2588
|
-
<a name="w_STYLABLE_ELEMENT" id="w_STYLABLE_ELEMENT"
|
|
2583
|
+
<a name="w_STYLABLE_ELEMENT" id="w_STYLABLE_ELEMENT"></a>
|
|
2589
2584
|
|
|
2590
2585
|
## STYLABLE\_ELEMENT : <code>object</code>
|
|
2591
2586
|
Current constant include available type of element for styling
|
|
@@ -2594,13 +2589,13 @@ Current constant include available type of element for styling
|
|
|
2594
2589
|
|
|
2595
2590
|
| Param | Type | Default | Description |
|
|
2596
2591
|
| --- | --- | --- | --- |
|
|
2597
|
-
| INPUT | <code>string</code> | <code>"input."</code> | These states are available: [STYLABLE_ELEMENT_STATE.ERROR](#
|
|
2598
|
-
| SUBMIT_BUTTON | <code>string</code> | <code>"submit_button"</code> | These states are available: [STYLABLE_ELEMENT_STATE.HOVER](#
|
|
2599
|
-
| LABEL | <code>string</code> | <code>"label."</code> | These styles are available [IElementStyleLabel](#
|
|
2600
|
-
| TITLE | <code>string</code> | <code>"title."</code> | These styles are available [IElementStyleTitle](#
|
|
2601
|
-
| TITLE_DESCRIPTION | <code>string</code> | <code>"title_description."</code> | These styles are available [IElementStyleTitleDescription](#
|
|
2592
|
+
| INPUT | <code>string</code> | <code>"input."</code> | These states are available: [STYLABLE_ELEMENT_STATE.ERROR](#w_STYLABLE_ELEMENT_STATE), [STYLABLE_ELEMENT_STATE.FOCUS](#w_STYLABLE_ELEMENT_STATE). These styles are available [IElementStyleInput](#w_IElementStyleInput) |
|
|
2593
|
+
| SUBMIT_BUTTON | <code>string</code> | <code>"submit_button"</code> | These states are available: [STYLABLE_ELEMENT_STATE.HOVER](#w_STYLABLE_ELEMENT_STATE). These styles are available [IElementStyleSubmitButton](#w_IElementStyleSubmitButton) |
|
|
2594
|
+
| LABEL | <code>string</code> | <code>"label."</code> | These styles are available [IElementStyleLabel](#w_IElementStyleLabel) |
|
|
2595
|
+
| TITLE | <code>string</code> | <code>"title."</code> | These styles are available [IElementStyleTitle](#w_IElementStyleTitle) |
|
|
2596
|
+
| TITLE_DESCRIPTION | <code>string</code> | <code>"title_description."</code> | These styles are available [IElementStyleTitleDescription](#w_IElementStyleTitleDescription) |
|
|
2602
2597
|
|
|
2603
|
-
<a name="w_STYLABLE_ELEMENT_STATE" id="w_STYLABLE_ELEMENT_STATE"
|
|
2598
|
+
<a name="w_STYLABLE_ELEMENT_STATE" id="w_STYLABLE_ELEMENT_STATE"></a>
|
|
2604
2599
|
|
|
2605
2600
|
## STYLABLE\_ELEMENT\_STATE : <code>object</code>
|
|
2606
2601
|
Current constant include available states of element for styling
|
|
@@ -2613,7 +2608,7 @@ Current constant include available states of element for styling
|
|
|
2613
2608
|
| FOCUS | <code>string</code> | <code>"focus"</code> | focus. This state applies to: input |
|
|
2614
2609
|
| HOVER | <code>string</code> | <code>"hover"</code> | focus. This state applies to: submit_button |
|
|
2615
2610
|
|
|
2616
|
-
<a name="w_TRIGGER" id="w_TRIGGER"
|
|
2611
|
+
<a name="w_TRIGGER" id="w_TRIGGER"></a>
|
|
2617
2612
|
|
|
2618
2613
|
## TRIGGER : <code>object</code>
|
|
2619
2614
|
List of available triggers
|
|
@@ -2764,10 +2759,10 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
2764
2759
|
## Classes
|
|
2765
2760
|
|
|
2766
2761
|
<dl>
|
|
2767
|
-
<dt><a href="#
|
|
2762
|
+
<dt><a href="#psw_HtmlPaymentSourceWidget">HtmlPaymentSourceWidget</a> ⇐ <code><a href="#psw_PaymentSourceWidget">PaymentSourceWidget</a></code></dt>
|
|
2768
2763
|
<dd><p>Class HtmlPaymentSourceWidget include method for working on html</p>
|
|
2769
2764
|
</dd>
|
|
2770
|
-
<dt><a href="#
|
|
2765
|
+
<dt><a href="#psw_PaymentSourceWidget">PaymentSourceWidget</a></dt>
|
|
2771
2766
|
<dd><p>Class PaymentSourceWidget include method for for creating iframe url</p>
|
|
2772
2767
|
</dd>
|
|
2773
2768
|
</dl>
|
|
@@ -2775,13 +2770,13 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
2775
2770
|
## Constants
|
|
2776
2771
|
|
|
2777
2772
|
<dl>
|
|
2778
|
-
<dt><a href="#
|
|
2773
|
+
<dt><a href="#psw_EVENT">EVENT</a> : <code>object</code></dt>
|
|
2779
2774
|
<dd><p>List of available event's name</p>
|
|
2780
2775
|
</dd>
|
|
2781
|
-
<dt><a href="#
|
|
2776
|
+
<dt><a href="#psw_STYLE">STYLE</a> : <code>object</code></dt>
|
|
2782
2777
|
<dd><p>List of available style params for widget</p>
|
|
2783
2778
|
</dd>
|
|
2784
|
-
<dt><a href="#
|
|
2779
|
+
<dt><a href="#psw_PAYMENT_SOURCE_TYPE">PAYMENT_SOURCE_TYPE</a> : <code>object</code></dt>
|
|
2785
2780
|
<dd><p>List of available payment source types</p>
|
|
2786
2781
|
</dd>
|
|
2787
2782
|
</dl>
|
|
@@ -2789,7 +2784,7 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
2789
2784
|
## Typedefs
|
|
2790
2785
|
|
|
2791
2786
|
<dl>
|
|
2792
|
-
<dt><a href="#
|
|
2787
|
+
<dt><a href="#psw_listener--PaymentSourceWidget">listener--PaymentSourceWidget</a> : <code>function</code></dt>
|
|
2793
2788
|
<dd><p>This callback will be called for each event in payment source widget</p>
|
|
2794
2789
|
</dd>
|
|
2795
2790
|
</dl>
|
|
@@ -2797,27 +2792,27 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
2797
2792
|
## Interfaces
|
|
2798
2793
|
|
|
2799
2794
|
<dl>
|
|
2800
|
-
<dt><a href="#
|
|
2795
|
+
<dt><a href="#psw_IEventSelectData">IEventSelectData</a></dt>
|
|
2801
2796
|
<dd><p>Interface of data from event.</p>
|
|
2802
2797
|
</dd>
|
|
2803
|
-
<dt><a href="#
|
|
2798
|
+
<dt><a href="#psw_IEventPaginationData">IEventPaginationData</a></dt>
|
|
2804
2799
|
<dd><p>Interface of data from event.</p>
|
|
2805
2800
|
</dd>
|
|
2806
|
-
<dt><a href="#
|
|
2801
|
+
<dt><a href="#psw_IEventAfterLoadData">IEventAfterLoadData</a></dt>
|
|
2807
2802
|
<dd><p>Interface of data from event.</p>
|
|
2808
2803
|
</dd>
|
|
2809
|
-
<dt><a href="#
|
|
2804
|
+
<dt><a href="#psw_IEventFinishData">IEventFinishData</a></dt>
|
|
2810
2805
|
<dd><p>Interface of data from event.</p>
|
|
2811
2806
|
</dd>
|
|
2812
|
-
<dt><a href="#
|
|
2807
|
+
<dt><a href="#psw_IEventSizeData">IEventSizeData</a></dt>
|
|
2813
2808
|
<dd><p>Interface of data from event.</p>
|
|
2814
2809
|
</dd>
|
|
2815
|
-
<dt><a href="#
|
|
2810
|
+
<dt><a href="#psw_IStyles">IStyles</a></dt>
|
|
2816
2811
|
<dd><p>Interface for classes that represent widget's styles.</p>
|
|
2817
2812
|
</dd>
|
|
2818
2813
|
</dl>
|
|
2819
2814
|
|
|
2820
|
-
<a name="psw_IEventSelectData" id="psw_IEventSelectData"
|
|
2815
|
+
<a name="psw_IEventSelectData" id="psw_IEventSelectData"></a>
|
|
2821
2816
|
|
|
2822
2817
|
## IEventSelectData
|
|
2823
2818
|
Interface of data from event.
|
|
@@ -2843,7 +2838,7 @@ Interface of data from event.
|
|
|
2843
2838
|
| [account_name] | <code>string</code> |
|
|
2844
2839
|
| [account_number] | <code>string</code> |
|
|
2845
2840
|
|
|
2846
|
-
<a name="psw_IEventPaginationData" id="psw_IEventPaginationData"
|
|
2841
|
+
<a name="psw_IEventPaginationData" id="psw_IEventPaginationData"></a>
|
|
2847
2842
|
|
|
2848
2843
|
## IEventPaginationData
|
|
2849
2844
|
Interface of data from event.
|
|
@@ -2860,7 +2855,7 @@ Interface of data from event.
|
|
|
2860
2855
|
| skip | <code>number</code> |
|
|
2861
2856
|
| limit | <code>number</code> |
|
|
2862
2857
|
|
|
2863
|
-
<a name="psw_IEventAfterLoadData" id="psw_IEventAfterLoadData"
|
|
2858
|
+
<a name="psw_IEventAfterLoadData" id="psw_IEventAfterLoadData"></a>
|
|
2864
2859
|
|
|
2865
2860
|
## IEventAfterLoadData
|
|
2866
2861
|
Interface of data from event.
|
|
@@ -2877,7 +2872,7 @@ Interface of data from event.
|
|
|
2877
2872
|
| skip | <code>number</code> | Pagination param. Skip items from first item |
|
|
2878
2873
|
| limit | <code>number</code> | Pagination param. Query limit |
|
|
2879
2874
|
|
|
2880
|
-
<a name="psw_IEventFinishData" id="psw_IEventFinishData"
|
|
2875
|
+
<a name="psw_IEventFinishData" id="psw_IEventFinishData"></a>
|
|
2881
2876
|
|
|
2882
2877
|
## IEventFinishData
|
|
2883
2878
|
Interface of data from event.
|
|
@@ -2891,7 +2886,7 @@ Interface of data from event.
|
|
|
2891
2886
|
| message_source | <code>string</code> | System variable. Event source |
|
|
2892
2887
|
| [ref_id] | <code>string</code> | Custom value for identify result of processed operation |
|
|
2893
2888
|
|
|
2894
|
-
<a name="psw_IEventSizeData" id="psw_IEventSizeData"
|
|
2889
|
+
<a name="psw_IEventSizeData" id="psw_IEventSizeData"></a>
|
|
2895
2890
|
|
|
2896
2891
|
## IEventSizeData
|
|
2897
2892
|
Interface of data from event.
|
|
@@ -2907,7 +2902,7 @@ Interface of data from event.
|
|
|
2907
2902
|
| height | <code>number</code> | Height of iFrame |
|
|
2908
2903
|
| width | <code>number</code> | Width of iFrame |
|
|
2909
2904
|
|
|
2910
|
-
<a name="psw_IStyles" id="psw_IStyles"
|
|
2905
|
+
<a name="psw_IStyles" id="psw_IStyles"></a>
|
|
2911
2906
|
|
|
2912
2907
|
## IStyles
|
|
2913
2908
|
Interface for classes that represent widget's styles.
|
|
@@ -2923,32 +2918,32 @@ Interface for classes that represent widget's styles.
|
|
|
2923
2918
|
| [font_size] | <code>string</code> |
|
|
2924
2919
|
| [icon_size] | <code>string</code> |
|
|
2925
2920
|
|
|
2926
|
-
<a name="psw_HtmlPaymentSourceWidget" id="psw_HtmlPaymentSourceWidget"
|
|
2921
|
+
<a name="psw_HtmlPaymentSourceWidget" id="psw_HtmlPaymentSourceWidget"></a>
|
|
2927
2922
|
|
|
2928
|
-
## HtmlPaymentSourceWidget ⇐ [<code>PaymentSourceWidget</code>](#
|
|
2923
|
+
## HtmlPaymentSourceWidget ⇐ [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
2929
2924
|
Class HtmlPaymentSourceWidget include method for working on html
|
|
2930
2925
|
|
|
2931
2926
|
**Kind**: global class
|
|
2932
|
-
**Extends**: [<code>PaymentSourceWidget</code>](#
|
|
2933
|
-
|
|
2934
|
-
* [HtmlPaymentSourceWidget](#
|
|
2935
|
-
* [new exports.HtmlPaymentSourceWidget(selector, publicKey, queryToken)](#
|
|
2936
|
-
* [.load()](#
|
|
2937
|
-
* [.on(eventName, cb)](#
|
|
2938
|
-
* [.hide([saveSize])](#
|
|
2939
|
-
* [.show()](#
|
|
2940
|
-
* [.reload()](#
|
|
2941
|
-
* [.onSelectInsert(selector, dataType)](#
|
|
2942
|
-
* [.setStyles(fields)](#
|
|
2943
|
-
* [.setRefId(refId)](#
|
|
2944
|
-
* [.setLimit(count)](#
|
|
2945
|
-
* [.setEnv(env, [alias])](#
|
|
2946
|
-
* [.getIFrameUrl()](#
|
|
2947
|
-
* [.filterByGatewayIds(ids)](#
|
|
2948
|
-
* [.filterByTypes(types)](#
|
|
2949
|
-
* [.setLanguage(code)](#
|
|
2950
|
-
|
|
2951
|
-
<a name="psw_new_HtmlPaymentSourceWidget_new" id="psw_new_HtmlPaymentSourceWidget_new"
|
|
2927
|
+
**Extends**: [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
2928
|
+
|
|
2929
|
+
* [HtmlPaymentSourceWidget](#psw_HtmlPaymentSourceWidget) ⇐ [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
2930
|
+
* [new exports.HtmlPaymentSourceWidget(selector, publicKey, queryToken)](#psw_new_HtmlPaymentSourceWidget_new)
|
|
2931
|
+
* [.load()](#psw_HtmlPaymentSourceWidget+load)
|
|
2932
|
+
* [.on(eventName, cb)](#psw_HtmlPaymentSourceWidget+on)
|
|
2933
|
+
* [.hide([saveSize])](#psw_HtmlPaymentSourceWidget+hide)
|
|
2934
|
+
* [.show()](#psw_HtmlPaymentSourceWidget+show)
|
|
2935
|
+
* [.reload()](#psw_HtmlPaymentSourceWidget+reload)
|
|
2936
|
+
* [.onSelectInsert(selector, dataType)](#psw_HtmlPaymentSourceWidget+onSelectInsert)
|
|
2937
|
+
* [.setStyles(fields)](#psw_PaymentSourceWidget+setStyles)
|
|
2938
|
+
* [.setRefId(refId)](#psw_PaymentSourceWidget+setRefId)
|
|
2939
|
+
* [.setLimit(count)](#psw_PaymentSourceWidget+setLimit)
|
|
2940
|
+
* [.setEnv(env, [alias])](#psw_PaymentSourceWidget+setEnv)
|
|
2941
|
+
* [.getIFrameUrl()](#psw_PaymentSourceWidget+getIFrameUrl)
|
|
2942
|
+
* [.filterByGatewayIds(ids)](#psw_PaymentSourceWidget+filterByGatewayIds)
|
|
2943
|
+
* [.filterByTypes(types)](#psw_PaymentSourceWidget+filterByTypes)
|
|
2944
|
+
* [.setLanguage(code)](#psw_PaymentSourceWidget+setLanguage)
|
|
2945
|
+
|
|
2946
|
+
<a name="psw_new_HtmlPaymentSourceWidget_new" id="psw_new_HtmlPaymentSourceWidget_new"></a>
|
|
2952
2947
|
|
|
2953
2948
|
### new exports.HtmlPaymentSourceWidget(selector, publicKey, queryToken)
|
|
2954
2949
|
|
|
@@ -2963,23 +2958,23 @@ Class HtmlPaymentSourceWidget include method for working on html
|
|
|
2963
2958
|
```javascript
|
|
2964
2959
|
* var widget = new HtmlPaymentSourceWidget('#widget', 'publicKey','queryToken');
|
|
2965
2960
|
```
|
|
2966
|
-
<a name="psw_HtmlPaymentSourceWidget+load" id="psw_HtmlPaymentSourceWidget+load"
|
|
2961
|
+
<a name="psw_HtmlPaymentSourceWidget+load" id="psw_HtmlPaymentSourceWidget+load"></a>
|
|
2967
2962
|
|
|
2968
2963
|
### htmlPaymentSourceWidget.load()
|
|
2969
2964
|
The final method to beginning, the load process of widget to html
|
|
2970
2965
|
|
|
2971
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
2972
|
-
<a name="psw_HtmlPaymentSourceWidget+on" id="psw_HtmlPaymentSourceWidget+on"
|
|
2966
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
2967
|
+
<a name="psw_HtmlPaymentSourceWidget+on" id="psw_HtmlPaymentSourceWidget+on"></a>
|
|
2973
2968
|
|
|
2974
2969
|
### htmlPaymentSourceWidget.on(eventName, cb)
|
|
2975
2970
|
Listen to events of widget
|
|
2976
2971
|
|
|
2977
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
2972
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
2978
2973
|
|
|
2979
2974
|
| Param | Type | Description |
|
|
2980
2975
|
| --- | --- | --- |
|
|
2981
|
-
| eventName | <code>string</code> | Available event names [EVENT](#
|
|
2982
|
-
| cb | [<code>listener--PaymentSourceWidget</code>](#
|
|
2976
|
+
| eventName | <code>string</code> | Available event names [EVENT](#psw_EVENT) |
|
|
2977
|
+
| cb | [<code>listener--PaymentSourceWidget</code>](#psw_listener--PaymentSourceWidget) | |
|
|
2983
2978
|
|
|
2984
2979
|
**Example**
|
|
2985
2980
|
|
|
@@ -2988,51 +2983,51 @@ widget.on('select', function (data) {
|
|
|
2988
2983
|
console.log(data);
|
|
2989
2984
|
});
|
|
2990
2985
|
```
|
|
2991
|
-
<a name="psw_HtmlPaymentSourceWidget+hide" id="psw_HtmlPaymentSourceWidget+hide"
|
|
2986
|
+
<a name="psw_HtmlPaymentSourceWidget+hide" id="psw_HtmlPaymentSourceWidget+hide"></a>
|
|
2992
2987
|
|
|
2993
2988
|
### htmlPaymentSourceWidget.hide([saveSize])
|
|
2994
2989
|
Using this method you can hide widget after load
|
|
2995
2990
|
|
|
2996
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
2991
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
2997
2992
|
|
|
2998
2993
|
| Param | Type | Default | Description |
|
|
2999
2994
|
| --- | --- | --- | --- |
|
|
3000
2995
|
| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size |
|
|
3001
2996
|
|
|
3002
|
-
<a name="psw_HtmlPaymentSourceWidget+show" id="psw_HtmlPaymentSourceWidget+show"
|
|
2997
|
+
<a name="psw_HtmlPaymentSourceWidget+show" id="psw_HtmlPaymentSourceWidget+show"></a>
|
|
3003
2998
|
|
|
3004
2999
|
### htmlPaymentSourceWidget.show()
|
|
3005
3000
|
Using this method you can show widget after using hide method
|
|
3006
3001
|
|
|
3007
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3008
|
-
<a name="psw_HtmlPaymentSourceWidget+reload" id="psw_HtmlPaymentSourceWidget+reload"
|
|
3002
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3003
|
+
<a name="psw_HtmlPaymentSourceWidget+reload" id="psw_HtmlPaymentSourceWidget+reload"></a>
|
|
3009
3004
|
|
|
3010
3005
|
### htmlPaymentSourceWidget.reload()
|
|
3011
3006
|
Using this method you can reload widget
|
|
3012
3007
|
|
|
3013
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3014
|
-
<a name="psw_HtmlPaymentSourceWidget+onSelectInsert" id="psw_HtmlPaymentSourceWidget+onSelectInsert"
|
|
3008
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3009
|
+
<a name="psw_HtmlPaymentSourceWidget+onSelectInsert" id="psw_HtmlPaymentSourceWidget+onSelectInsert"></a>
|
|
3015
3010
|
|
|
3016
3011
|
### htmlPaymentSourceWidget.onSelectInsert(selector, dataType)
|
|
3017
3012
|
After select event of widget, data (dataType) will be insert to input (selector)
|
|
3018
3013
|
|
|
3019
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3014
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3020
3015
|
|
|
3021
3016
|
| Param | Type | Description |
|
|
3022
3017
|
| --- | --- | --- |
|
|
3023
3018
|
| selector | <code>string</code> | css selector . [] # |
|
|
3024
|
-
| dataType | <code>string</code> | data type of [IEventSelectData](#
|
|
3019
|
+
| dataType | <code>string</code> | data type of [IEventSelectData](#psw_IEventSelectData). |
|
|
3025
3020
|
|
|
3026
|
-
<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles"
|
|
3021
|
+
<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles"></a>
|
|
3027
3022
|
|
|
3028
3023
|
### htmlPaymentSourceWidget.setStyles(fields)
|
|
3029
3024
|
Object contain styles for widget
|
|
3030
3025
|
|
|
3031
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3026
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3032
3027
|
|
|
3033
3028
|
| Param | Type | Description |
|
|
3034
3029
|
| --- | --- | --- |
|
|
3035
|
-
| fields | [<code>IStyles</code>](#
|
|
3030
|
+
| fields | [<code>IStyles</code>](#psw_IStyles) | name of styles which can be shown in widget [STYLE](#psw_STYLE) |
|
|
3036
3031
|
|
|
3037
3032
|
**Example**
|
|
3038
3033
|
|
|
@@ -3045,12 +3040,12 @@ widget.setStyles({
|
|
|
3045
3040
|
font_size: '20px'
|
|
3046
3041
|
});
|
|
3047
3042
|
```
|
|
3048
|
-
<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId"
|
|
3043
|
+
<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId"></a>
|
|
3049
3044
|
|
|
3050
3045
|
### htmlPaymentSourceWidget.setRefId(refId)
|
|
3051
3046
|
Current method can set custom ID to identify the data in the future
|
|
3052
3047
|
|
|
3053
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3048
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3054
3049
|
|
|
3055
3050
|
| Param | Type | Description |
|
|
3056
3051
|
| --- | --- | --- |
|
|
@@ -3061,24 +3056,24 @@ Current method can set custom ID to identify the data in the future
|
|
|
3061
3056
|
```javascript
|
|
3062
3057
|
widget.setRefId('id');
|
|
3063
3058
|
```
|
|
3064
|
-
<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit"
|
|
3059
|
+
<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit"></a>
|
|
3065
3060
|
|
|
3066
3061
|
### htmlPaymentSourceWidget.setLimit(count)
|
|
3067
3062
|
Current method can set limit for payment sources count. In case when limit sets less then general count will be shown pagination buttons prev and next.
|
|
3068
3063
|
|
|
3069
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3064
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3070
3065
|
|
|
3071
3066
|
| Param | Type | Description |
|
|
3072
3067
|
| --- | --- | --- |
|
|
3073
3068
|
| count | <code>string</code> | payment source count |
|
|
3074
3069
|
|
|
3075
|
-
<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv"
|
|
3070
|
+
<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv"></a>
|
|
3076
3071
|
|
|
3077
3072
|
### htmlPaymentSourceWidget.setEnv(env, [alias])
|
|
3078
3073
|
Current method can change environment. By default environment = sandbox
|
|
3079
3074
|
Also we can change domain alias for this environment. By default domain_alias = paydock.com
|
|
3080
3075
|
|
|
3081
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3076
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3082
3077
|
|
|
3083
3078
|
| Param | Type | Description |
|
|
3084
3079
|
| --- | --- | --- |
|
|
@@ -3090,40 +3085,40 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
3090
3085
|
```javascript
|
|
3091
3086
|
widget.setEnv('production');
|
|
3092
3087
|
```
|
|
3093
|
-
<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl"
|
|
3088
|
+
<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl"></a>
|
|
3094
3089
|
|
|
3095
3090
|
### htmlPaymentSourceWidget.getIFrameUrl()
|
|
3096
3091
|
Method for getting iframe's url
|
|
3097
3092
|
|
|
3098
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3099
|
-
<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds"
|
|
3093
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3094
|
+
<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds"></a>
|
|
3100
3095
|
|
|
3101
3096
|
### htmlPaymentSourceWidget.filterByGatewayIds(ids)
|
|
3102
3097
|
Show payment source inside widget only with requested gateway ids
|
|
3103
3098
|
|
|
3104
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3099
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3105
3100
|
|
|
3106
3101
|
| Param | Type | Description |
|
|
3107
3102
|
| --- | --- | --- |
|
|
3108
3103
|
| ids | <code>[ 'Array' ].<string></code> | List of paydock gateway_id |
|
|
3109
3104
|
|
|
3110
|
-
<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes"
|
|
3105
|
+
<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes"></a>
|
|
3111
3106
|
|
|
3112
3107
|
### htmlPaymentSourceWidget.filterByTypes(types)
|
|
3113
3108
|
Show payment source inside widget only with requested payment source types
|
|
3114
3109
|
|
|
3115
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3110
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3116
3111
|
|
|
3117
3112
|
| Param | Description |
|
|
3118
3113
|
| --- | --- |
|
|
3119
3114
|
| types | List of payment source types. Available parameters [PAYMENT_TYPE](PAYMENT_TYPE) |
|
|
3120
3115
|
|
|
3121
|
-
<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage"
|
|
3116
|
+
<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage"></a>
|
|
3122
3117
|
|
|
3123
3118
|
### htmlPaymentSourceWidget.setLanguage(code)
|
|
3124
3119
|
Method for setting a custom language code
|
|
3125
3120
|
|
|
3126
|
-
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#
|
|
3121
|
+
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3127
3122
|
|
|
3128
3123
|
| Param | Type | Description |
|
|
3129
3124
|
| --- | --- | --- |
|
|
@@ -3134,25 +3129,25 @@ Method for setting a custom language code
|
|
|
3134
3129
|
```javascript
|
|
3135
3130
|
config.setLanguage('en');
|
|
3136
3131
|
```
|
|
3137
|
-
<a name="psw_PaymentSourceWidget" id="psw_PaymentSourceWidget"
|
|
3132
|
+
<a name="psw_PaymentSourceWidget" id="psw_PaymentSourceWidget"></a>
|
|
3138
3133
|
|
|
3139
3134
|
## PaymentSourceWidget
|
|
3140
3135
|
Class PaymentSourceWidget include method for for creating iframe url
|
|
3141
3136
|
|
|
3142
3137
|
**Kind**: global class
|
|
3143
3138
|
|
|
3144
|
-
* [PaymentSourceWidget](#
|
|
3145
|
-
* [new exports.PaymentSourceWidget(publicKey, customer, [useReference])](#
|
|
3146
|
-
* [.setStyles(fields)](#
|
|
3147
|
-
* [.setRefId(refId)](#
|
|
3148
|
-
* [.setLimit(count)](#
|
|
3149
|
-
* [.setEnv(env, [alias])](#
|
|
3150
|
-
* [.getIFrameUrl()](#
|
|
3151
|
-
* [.filterByGatewayIds(ids)](#
|
|
3152
|
-
* [.filterByTypes(types)](#
|
|
3153
|
-
* [.setLanguage(code)](#
|
|
3139
|
+
* [PaymentSourceWidget](#psw_PaymentSourceWidget)
|
|
3140
|
+
* [new exports.PaymentSourceWidget(publicKey, customer, [useReference])](#psw_new_PaymentSourceWidget_new)
|
|
3141
|
+
* [.setStyles(fields)](#psw_PaymentSourceWidget+setStyles)
|
|
3142
|
+
* [.setRefId(refId)](#psw_PaymentSourceWidget+setRefId)
|
|
3143
|
+
* [.setLimit(count)](#psw_PaymentSourceWidget+setLimit)
|
|
3144
|
+
* [.setEnv(env, [alias])](#psw_PaymentSourceWidget+setEnv)
|
|
3145
|
+
* [.getIFrameUrl()](#psw_PaymentSourceWidget+getIFrameUrl)
|
|
3146
|
+
* [.filterByGatewayIds(ids)](#psw_PaymentSourceWidget+filterByGatewayIds)
|
|
3147
|
+
* [.filterByTypes(types)](#psw_PaymentSourceWidget+filterByTypes)
|
|
3148
|
+
* [.setLanguage(code)](#psw_PaymentSourceWidget+setLanguage)
|
|
3154
3149
|
|
|
3155
|
-
<a name="psw_new_PaymentSourceWidget_new" id="psw_new_PaymentSourceWidget_new"
|
|
3150
|
+
<a name="psw_new_PaymentSourceWidget_new" id="psw_new_PaymentSourceWidget_new"></a>
|
|
3156
3151
|
|
|
3157
3152
|
### new exports.PaymentSourceWidget(publicKey, customer, [useReference])
|
|
3158
3153
|
|
|
@@ -3169,16 +3164,16 @@ var widget = new PaymentSourceWidget('publicKey','customerId');
|
|
|
3169
3164
|
// or
|
|
3170
3165
|
var widget = new PaymentSourceWidget('publicKey', customerReference, true);
|
|
3171
3166
|
```
|
|
3172
|
-
<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles"
|
|
3167
|
+
<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles"></a>
|
|
3173
3168
|
|
|
3174
3169
|
### paymentSourceWidget.setStyles(fields)
|
|
3175
3170
|
Object contain styles for widget
|
|
3176
3171
|
|
|
3177
|
-
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#
|
|
3172
|
+
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
3178
3173
|
|
|
3179
3174
|
| Param | Type | Description |
|
|
3180
3175
|
| --- | --- | --- |
|
|
3181
|
-
| fields | [<code>IStyles</code>](#
|
|
3176
|
+
| fields | [<code>IStyles</code>](#psw_IStyles) | name of styles which can be shown in widget [STYLE](#psw_STYLE) |
|
|
3182
3177
|
|
|
3183
3178
|
**Example**
|
|
3184
3179
|
|
|
@@ -3191,12 +3186,12 @@ widget.setStyles({
|
|
|
3191
3186
|
font_size: '20px'
|
|
3192
3187
|
});
|
|
3193
3188
|
```
|
|
3194
|
-
<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId"
|
|
3189
|
+
<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId"></a>
|
|
3195
3190
|
|
|
3196
3191
|
### paymentSourceWidget.setRefId(refId)
|
|
3197
3192
|
Current method can set custom ID to identify the data in the future
|
|
3198
3193
|
|
|
3199
|
-
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#
|
|
3194
|
+
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
3200
3195
|
|
|
3201
3196
|
| Param | Type | Description |
|
|
3202
3197
|
| --- | --- | --- |
|
|
@@ -3207,24 +3202,24 @@ Current method can set custom ID to identify the data in the future
|
|
|
3207
3202
|
```javascript
|
|
3208
3203
|
widget.setRefId('id');
|
|
3209
3204
|
```
|
|
3210
|
-
<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit"
|
|
3205
|
+
<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit"></a>
|
|
3211
3206
|
|
|
3212
3207
|
### paymentSourceWidget.setLimit(count)
|
|
3213
3208
|
Current method can set limit for payment sources count. In case when limit sets less then general count will be shown pagination buttons prev and next.
|
|
3214
3209
|
|
|
3215
|
-
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#
|
|
3210
|
+
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
3216
3211
|
|
|
3217
3212
|
| Param | Type | Description |
|
|
3218
3213
|
| --- | --- | --- |
|
|
3219
3214
|
| count | <code>string</code> | payment source count |
|
|
3220
3215
|
|
|
3221
|
-
<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv"
|
|
3216
|
+
<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv"></a>
|
|
3222
3217
|
|
|
3223
3218
|
### paymentSourceWidget.setEnv(env, [alias])
|
|
3224
3219
|
Current method can change environment. By default environment = sandbox
|
|
3225
3220
|
Also we can change domain alias for this environment. By default domain_alias = paydock.com
|
|
3226
3221
|
|
|
3227
|
-
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#
|
|
3222
|
+
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
3228
3223
|
|
|
3229
3224
|
| Param | Type | Description |
|
|
3230
3225
|
| --- | --- | --- |
|
|
@@ -3236,40 +3231,40 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
3236
3231
|
```javascript
|
|
3237
3232
|
widget.setEnv('production');
|
|
3238
3233
|
```
|
|
3239
|
-
<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl"
|
|
3234
|
+
<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl"></a>
|
|
3240
3235
|
|
|
3241
3236
|
### paymentSourceWidget.getIFrameUrl()
|
|
3242
3237
|
Method for getting iframe's url
|
|
3243
3238
|
|
|
3244
|
-
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#
|
|
3245
|
-
<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds"
|
|
3239
|
+
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
3240
|
+
<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds"></a>
|
|
3246
3241
|
|
|
3247
3242
|
### paymentSourceWidget.filterByGatewayIds(ids)
|
|
3248
3243
|
Show payment source inside widget only with requested gateway ids
|
|
3249
3244
|
|
|
3250
|
-
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#
|
|
3245
|
+
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
3251
3246
|
|
|
3252
3247
|
| Param | Type | Description |
|
|
3253
3248
|
| --- | --- | --- |
|
|
3254
3249
|
| ids | <code>[ 'Array' ].<string></code> | List of paydock gateway_id |
|
|
3255
3250
|
|
|
3256
|
-
<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes"
|
|
3251
|
+
<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes"></a>
|
|
3257
3252
|
|
|
3258
3253
|
### paymentSourceWidget.filterByTypes(types)
|
|
3259
3254
|
Show payment source inside widget only with requested payment source types
|
|
3260
3255
|
|
|
3261
|
-
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#
|
|
3256
|
+
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
3262
3257
|
|
|
3263
3258
|
| Param | Description |
|
|
3264
3259
|
| --- | --- |
|
|
3265
3260
|
| types | List of payment source types. Available parameters [PAYMENT_TYPE](PAYMENT_TYPE) |
|
|
3266
3261
|
|
|
3267
|
-
<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage"
|
|
3262
|
+
<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage"></a>
|
|
3268
3263
|
|
|
3269
3264
|
### paymentSourceWidget.setLanguage(code)
|
|
3270
3265
|
Method for setting a custom language code
|
|
3271
3266
|
|
|
3272
|
-
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#
|
|
3267
|
+
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
3273
3268
|
|
|
3274
3269
|
| Param | Type | Description |
|
|
3275
3270
|
| --- | --- | --- |
|
|
@@ -3280,7 +3275,7 @@ Method for setting a custom language code
|
|
|
3280
3275
|
```javascript
|
|
3281
3276
|
config.setLanguage('en');
|
|
3282
3277
|
```
|
|
3283
|
-
<a name="psw_EVENT" id="psw_EVENT"
|
|
3278
|
+
<a name="psw_EVENT" id="psw_EVENT"></a>
|
|
3284
3279
|
|
|
3285
3280
|
## EVENT : <code>object</code>
|
|
3286
3281
|
List of available event's name
|
|
@@ -3298,7 +3293,7 @@ List of available event's name
|
|
|
3298
3293
|
| META_CHANGE | <code>string</code> | <code>"metaChange"</code> |
|
|
3299
3294
|
| RESIZE | <code>string</code> | <code>"resize"</code> |
|
|
3300
3295
|
|
|
3301
|
-
<a name="psw_STYLE" id="psw_STYLE"
|
|
3296
|
+
<a name="psw_STYLE" id="psw_STYLE"></a>
|
|
3302
3297
|
|
|
3303
3298
|
## STYLE : <code>object</code>
|
|
3304
3299
|
List of available style params for widget
|
|
@@ -3314,7 +3309,7 @@ List of available style params for widget
|
|
|
3314
3309
|
| ICON_SIZE | <code>string</code> | <code>"icon_size"</code> |
|
|
3315
3310
|
| FONT_SIZE | <code>string</code> | <code>"font_size"</code> |
|
|
3316
3311
|
|
|
3317
|
-
<a name="psw_PAYMENT_SOURCE_TYPE" id="psw_PAYMENT_SOURCE_TYPE"
|
|
3312
|
+
<a name="psw_PAYMENT_SOURCE_TYPE" id="psw_PAYMENT_SOURCE_TYPE"></a>
|
|
3318
3313
|
|
|
3319
3314
|
## PAYMENT\_SOURCE\_TYPE : <code>object</code>
|
|
3320
3315
|
List of available payment source types
|
|
@@ -3327,7 +3322,7 @@ List of available payment source types
|
|
|
3327
3322
|
| BANK_ACCOUNT | <code>string</code> | <code>"bank_account"</code> |
|
|
3328
3323
|
| CHECKOUT | <code>string</code> | <code>"checkout"</code> |
|
|
3329
3324
|
|
|
3330
|
-
<a name="psw_listener--PaymentSourceWidget" id="psw_listener--PaymentSourceWidget"
|
|
3325
|
+
<a name="psw_listener--PaymentSourceWidget" id="psw_listener--PaymentSourceWidget"></a>
|
|
3331
3326
|
|
|
3332
3327
|
## listener--PaymentSourceWidget : <code>function</code>
|
|
3333
3328
|
This callback will be called for each event in payment source widget
|
|
@@ -3336,7 +3331,7 @@ This callback will be called for each event in payment source widget
|
|
|
3336
3331
|
|
|
3337
3332
|
| Param | Type |
|
|
3338
3333
|
| --- | --- |
|
|
3339
|
-
| response | <code>IEventData</code> \| [<code>IEventSelectData</code>](#
|
|
3334
|
+
| response | <code>IEventData</code> \| [<code>IEventSelectData</code>](#psw_IEventSelectData) \| [<code>IEventPaginationData</code>](#psw_IEventPaginationData) \| [<code>IEventAfterLoadData</code>](#psw_IEventAfterLoadData) |
|
|
3340
3335
|
|
|
3341
3336
|
|
|
3342
3337
|
## Checkout button
|
|
@@ -3351,7 +3346,7 @@ As a result, you will be able to receive a one-time token for charges, subscript
|
|
|
3351
3346
|
|
|
3352
3347
|
|
|
3353
3348
|
## Checkout button simple example
|
|
3354
|
-
|
|
3349
|
+
|
|
3355
3350
|
### Container
|
|
3356
3351
|
|
|
3357
3352
|
```html
|
|
@@ -3371,14 +3366,14 @@ var button = new paydock.PaypalCheckoutButton('#button', 'publicKey', 'gatewayId
|
|
|
3371
3366
|
```javascript--es2015
|
|
3372
3367
|
// ES2015 | TypeScript
|
|
3373
3368
|
|
|
3374
|
-
|
|
3369
|
+
|
|
3375
3370
|
var button = new PaypalCheckoutButton('#button', 'publicKey');
|
|
3376
3371
|
```
|
|
3377
3372
|
|
|
3378
3373
|
Then write only need 1 line of code in js to initialize widget
|
|
3379
3374
|
|
|
3380
3375
|
|
|
3381
|
-
### Full example
|
|
3376
|
+
### Full example
|
|
3382
3377
|
|
|
3383
3378
|
```html
|
|
3384
3379
|
<!DOCTYPE html>
|
|
@@ -3419,7 +3414,7 @@ button.on('finish', function (data) { // Add handler of event
|
|
|
3419
3414
|
|
|
3420
3415
|
This example shows how you can use a lot of other methods to settings your button
|
|
3421
3416
|
|
|
3422
|
-
### Full Paypal example
|
|
3417
|
+
### Full Paypal example
|
|
3423
3418
|
|
|
3424
3419
|
```html
|
|
3425
3420
|
<!DOCTYPE html>
|
|
@@ -3446,16 +3441,16 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3446
3441
|
reference: '15',
|
|
3447
3442
|
first_name: 'Joshua',
|
|
3448
3443
|
last_name: 'Wood',
|
|
3449
|
-
phone: '0231049872'});
|
|
3450
|
-
|
|
3451
|
-
button.on('finish', function (data) {
|
|
3444
|
+
phone: '0231049872'});
|
|
3445
|
+
|
|
3446
|
+
button.on('finish', function (data) {
|
|
3452
3447
|
console.log('on:finish', data);
|
|
3453
3448
|
});
|
|
3454
3449
|
</script>
|
|
3455
3450
|
</body>
|
|
3456
3451
|
</html>
|
|
3457
3452
|
```
|
|
3458
|
-
### Full ZipMoney example
|
|
3453
|
+
### Full ZipMoney example
|
|
3459
3454
|
|
|
3460
3455
|
```html
|
|
3461
3456
|
<!DOCTYPE html>
|
|
@@ -3485,7 +3480,6 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3485
3480
|
"charge": {
|
|
3486
3481
|
"amount": "4",
|
|
3487
3482
|
"currency":"AUD",
|
|
3488
|
-
"shipping_type": "delivery",
|
|
3489
3483
|
"shipping_address": {
|
|
3490
3484
|
"first_name": "Joshua",
|
|
3491
3485
|
"last_name": "Wood",
|
|
@@ -3521,7 +3515,7 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3521
3515
|
}
|
|
3522
3516
|
]
|
|
3523
3517
|
},
|
|
3524
|
-
|
|
3518
|
+
|
|
3525
3519
|
"statistics": {
|
|
3526
3520
|
"account_created": "2017-05-05",
|
|
3527
3521
|
"sales_total_number": "5",
|
|
@@ -3532,9 +3526,9 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3532
3526
|
"previous_chargeback": "true",
|
|
3533
3527
|
"currency": "AUD",
|
|
3534
3528
|
"last_login": "2017-06-01"
|
|
3535
|
-
});
|
|
3536
|
-
|
|
3537
|
-
button.on('finish', function (data) {
|
|
3529
|
+
});
|
|
3530
|
+
|
|
3531
|
+
button.on('finish', function (data) {
|
|
3538
3532
|
console.log('on:finish', data);
|
|
3539
3533
|
});
|
|
3540
3534
|
</script>
|
|
@@ -3542,7 +3536,7 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3542
3536
|
</html>
|
|
3543
3537
|
```
|
|
3544
3538
|
|
|
3545
|
-
### Full Aftepay example
|
|
3539
|
+
### Full Aftepay example
|
|
3546
3540
|
|
|
3547
3541
|
```html
|
|
3548
3542
|
<!DOCTYPE html>
|
|
@@ -3561,8 +3555,9 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3561
3555
|
<script src="https://widget.paydock.com/sdk/latest/widget.umd.js" ></script>
|
|
3562
3556
|
<script>
|
|
3563
3557
|
var button = new paydock.AfterpayCheckoutButton('#button', 'publicKey', 'gatewayId');
|
|
3564
|
-
|
|
3558
|
+
|
|
3565
3559
|
button.onFinishInsert('input[name="pst"]', 'payment_source_token');
|
|
3560
|
+
button.showEnhancedTrackingProtectionPopup(true);
|
|
3566
3561
|
button.setMeta({
|
|
3567
3562
|
amount: "100",
|
|
3568
3563
|
currency: "AUD",
|
|
@@ -3578,8 +3573,8 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3578
3573
|
address_country: 'Australia',
|
|
3579
3574
|
phone: '0412345678',
|
|
3580
3575
|
});
|
|
3581
|
-
|
|
3582
|
-
button.on('finish', function (data) {
|
|
3576
|
+
|
|
3577
|
+
button.on('finish', function (data) {
|
|
3583
3578
|
console.log('on:finish', data);
|
|
3584
3579
|
});
|
|
3585
3580
|
</script>
|
|
@@ -3590,16 +3585,16 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3590
3585
|
## Classes
|
|
3591
3586
|
|
|
3592
3587
|
<dl>
|
|
3593
|
-
<dt><a href="#
|
|
3588
|
+
<dt><a href="#cb_CheckoutButton">CheckoutButton</a></dt>
|
|
3594
3589
|
<dd><p>Class CheckoutButton transform usual button into checkout</p>
|
|
3595
3590
|
</dd>
|
|
3596
|
-
<dt><a href="#
|
|
3591
|
+
<dt><a href="#cb_ZipmoneyCheckoutButton">ZipmoneyCheckoutButton</a> ⇐ <code><a href="#cb_CheckoutButton">CheckoutButton</a></code></dt>
|
|
3597
3592
|
<dd><p>Class ZipmoneyCheckoutButton is wrapper of CheckoutButton transform usual button into checkout</p>
|
|
3598
3593
|
</dd>
|
|
3599
|
-
<dt><a href="#
|
|
3594
|
+
<dt><a href="#cb_PaypalCheckoutButton">PaypalCheckoutButton</a> ⇐ <code><a href="#cb_CheckoutButton">CheckoutButton</a></code></dt>
|
|
3600
3595
|
<dd><p>Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button into checkout</p>
|
|
3601
3596
|
</dd>
|
|
3602
|
-
<dt><a href="#
|
|
3597
|
+
<dt><a href="#cb_AfterpayCheckoutButton">AfterpayCheckoutButton</a> ⇐ <code><a href="#cb_CheckoutButton">CheckoutButton</a></code></dt>
|
|
3603
3598
|
<dd><p>Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button into checkout</p>
|
|
3604
3599
|
</dd>
|
|
3605
3600
|
</dl>
|
|
@@ -3607,14 +3602,14 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3607
3602
|
## Constants
|
|
3608
3603
|
|
|
3609
3604
|
<dl>
|
|
3610
|
-
<dt><a href="#
|
|
3605
|
+
<dt><a href="#cb_CHECKOUT_BUTTON_EVENT">CHECKOUT_BUTTON_EVENT</a> : <code>object</code></dt>
|
|
3611
3606
|
<dd></dd>
|
|
3612
3607
|
</dl>
|
|
3613
3608
|
|
|
3614
3609
|
## Typedefs
|
|
3615
3610
|
|
|
3616
3611
|
<dl>
|
|
3617
|
-
<dt><a href="#
|
|
3612
|
+
<dt><a href="#cb_listener">listener</a> : <code>function</code></dt>
|
|
3618
3613
|
<dd><p>This callback will be called for each event in payment source widget</p>
|
|
3619
3614
|
</dd>
|
|
3620
3615
|
</dl>
|
|
@@ -3622,20 +3617,20 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3622
3617
|
## Interfaces
|
|
3623
3618
|
|
|
3624
3619
|
<dl>
|
|
3625
|
-
<dt><a href="#
|
|
3620
|
+
<dt><a href="#cb_IEventCheckoutFinishData">IEventCheckoutFinishData</a></dt>
|
|
3626
3621
|
<dd></dd>
|
|
3627
|
-
<dt><a href="#
|
|
3622
|
+
<dt><a href="#cb_IPayPalMeta">IPayPalMeta</a></dt>
|
|
3628
3623
|
<dd><p>Interface for PayPal checkout meta information</p>
|
|
3629
3624
|
</dd>
|
|
3630
|
-
<dt><a href="#
|
|
3625
|
+
<dt><a href="#cb_IZipmoneyMeta">IZipmoneyMeta</a></dt>
|
|
3631
3626
|
<dd><p>Interface for ZipMoney checkout meta information</p>
|
|
3632
3627
|
</dd>
|
|
3633
|
-
<dt><a href="#
|
|
3628
|
+
<dt><a href="#cb_IAfterpayMeta">IAfterpayMeta</a></dt>
|
|
3634
3629
|
<dd><p>Interface for Afterpay checkout meta information</p>
|
|
3635
3630
|
</dd>
|
|
3636
3631
|
</dl>
|
|
3637
3632
|
|
|
3638
|
-
<a name="cb_IEventCheckoutFinishData" id="cb_IEventCheckoutFinishData"
|
|
3633
|
+
<a name="cb_IEventCheckoutFinishData" id="cb_IEventCheckoutFinishData"></a>
|
|
3639
3634
|
|
|
3640
3635
|
## IEventCheckoutFinishData
|
|
3641
3636
|
**Kind**: global interface
|
|
@@ -3644,7 +3639,7 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3644
3639
|
| --- | --- |
|
|
3645
3640
|
| [payment_source_token] | <code>string</code> |
|
|
3646
3641
|
|
|
3647
|
-
<a name="cb_IPayPalMeta" id="cb_IPayPalMeta"
|
|
3642
|
+
<a name="cb_IPayPalMeta" id="cb_IPayPalMeta"></a>
|
|
3648
3643
|
|
|
3649
3644
|
## IPayPalMeta
|
|
3650
3645
|
Interface for PayPal checkout meta information
|
|
@@ -3671,7 +3666,7 @@ Interface for PayPal checkout meta information
|
|
|
3671
3666
|
| [phone] | <code>string</code> | The consumer’s phone number in E.164 international notation (Example: +12345678901) |
|
|
3672
3667
|
| [hide_shipping_address] | <code>boolean</code> | Determines whether PayPal displays shipping address fields on the PayPal pages |
|
|
3673
3668
|
|
|
3674
|
-
<a name="cb_IZipmoneyMeta" id="cb_IZipmoneyMeta"
|
|
3669
|
+
<a name="cb_IZipmoneyMeta" id="cb_IZipmoneyMeta"></a>
|
|
3675
3670
|
|
|
3676
3671
|
## IZipmoneyMeta
|
|
3677
3672
|
Interface for ZipMoney checkout meta information
|
|
@@ -3689,7 +3684,6 @@ Interface for ZipMoney checkout meta information
|
|
|
3689
3684
|
| [date_of_birth] | <code>string</code> | Date of birth name for the customer |
|
|
3690
3685
|
| charge.amount | <code>number</code> | Amount to be paid |
|
|
3691
3686
|
| [charge.currency] | <code>string</code> | Currency code |
|
|
3692
|
-
| [charge.reference] | <code>string</code> | Reference |
|
|
3693
3687
|
| charge.items | <code>array</code> | Collections of orders |
|
|
3694
3688
|
| charge.items[].name | <code>string</code> | Name of the item |
|
|
3695
3689
|
| charge.items[].amount | <code>number</code> | Amount of the item |
|
|
@@ -3698,8 +3692,7 @@ Interface for ZipMoney checkout meta information
|
|
|
3698
3692
|
| [charge.items[].reference] | <code>string</code> | reference of the item |
|
|
3699
3693
|
| [charge.items[].item_uri] | <code>string</code> | url of the item in your store |
|
|
3700
3694
|
| [charge.items[].image_url] | <code>string</code> | url of the image in your store |
|
|
3701
|
-
|
|
|
3702
|
-
| [charge.shipping_address] | <code>string</code> | Object with shipping address details |
|
|
3695
|
+
| charge.shipping_address | <code>string</code> | Object with shipping address details |
|
|
3703
3696
|
| [charge.shipping_address.first_name] | <code>string</code> | Shipping first name |
|
|
3704
3697
|
| [charge.shipping_address.last_name] | <code>string</code> | Shipping last name |
|
|
3705
3698
|
| charge.shipping_address.line1 | <code>string</code> | Shipping address line 1 |
|
|
@@ -3718,7 +3711,7 @@ Interface for ZipMoney checkout meta information
|
|
|
3718
3711
|
| charge.billing_address.postcode | <code>string</code> | Billing postcode |
|
|
3719
3712
|
| charge.billing_address.country | <code>string</code> | Billing country |
|
|
3720
3713
|
|
|
3721
|
-
<a name="cb_IAfterpayMeta" id="cb_IAfterpayMeta"
|
|
3714
|
+
<a name="cb_IAfterpayMeta" id="cb_IAfterpayMeta"></a>
|
|
3722
3715
|
|
|
3723
3716
|
## IAfterpayMeta
|
|
3724
3717
|
Interface for Afterpay checkout meta information
|
|
@@ -3740,25 +3733,25 @@ Interface for Afterpay checkout meta information
|
|
|
3740
3733
|
| [address_country] | <code>string</code> |
|
|
3741
3734
|
| [phone] | <code>string</code> |
|
|
3742
3735
|
|
|
3743
|
-
<a name="cb_CheckoutButton" id="cb_CheckoutButton"
|
|
3736
|
+
<a name="cb_CheckoutButton" id="cb_CheckoutButton"></a>
|
|
3744
3737
|
|
|
3745
3738
|
## CheckoutButton
|
|
3746
3739
|
Class CheckoutButton transform usual button into checkout
|
|
3747
3740
|
|
|
3748
3741
|
**Kind**: global class
|
|
3749
3742
|
|
|
3750
|
-
* [CheckoutButton](#
|
|
3751
|
-
* [new exports.CheckoutButton(selector, aceessToken, [gatewayId], [type])](#
|
|
3752
|
-
* [.on(eventName, cb)](#
|
|
3753
|
-
* [.close()](#
|
|
3754
|
-
* [.onFinishInsert(selector, dataType)](#
|
|
3755
|
-
* [.setMeta(meta)](#
|
|
3756
|
-
* [.setBackdropDescription(text)](#
|
|
3757
|
-
* [.setBackdropTitle(string)](#
|
|
3758
|
-
* [.setSuspendedRedirectUri(string)](#
|
|
3759
|
-
* [.turnOffBackdrop()](#
|
|
3743
|
+
* [CheckoutButton](#cb_CheckoutButton)
|
|
3744
|
+
* [new exports.CheckoutButton(selector, aceessToken, [gatewayId], [type])](#cb_new_CheckoutButton_new)
|
|
3745
|
+
* [.on(eventName, cb)](#cb_CheckoutButton+on)
|
|
3746
|
+
* [.close()](#cb_CheckoutButton+close)
|
|
3747
|
+
* [.onFinishInsert(selector, dataType)](#cb_CheckoutButton+onFinishInsert)
|
|
3748
|
+
* [.setMeta(meta)](#cb_CheckoutButton+setMeta)
|
|
3749
|
+
* [.setBackdropDescription(text)](#cb_CheckoutButton+setBackdropDescription)
|
|
3750
|
+
* [.setBackdropTitle(string)](#cb_CheckoutButton+setBackdropTitle)
|
|
3751
|
+
* [.setSuspendedRedirectUri(string)](#cb_CheckoutButton+setSuspendedRedirectUri)
|
|
3752
|
+
* [.turnOffBackdrop()](#cb_CheckoutButton+turnOffBackdrop)
|
|
3760
3753
|
|
|
3761
|
-
<a name="cb_new_CheckoutButton_new" id="cb_new_CheckoutButton_new"
|
|
3754
|
+
<a name="cb_new_CheckoutButton_new" id="cb_new_CheckoutButton_new"></a>
|
|
3762
3755
|
|
|
3763
3756
|
### new exports.CheckoutButton(selector, aceessToken, [gatewayId], [type])
|
|
3764
3757
|
|
|
@@ -3774,17 +3767,17 @@ Class CheckoutButton transform usual button into checkout
|
|
|
3774
3767
|
```javascript
|
|
3775
3768
|
var widget = new CheckoutButton('#button', 'aceessToken','gatewayId');
|
|
3776
3769
|
```
|
|
3777
|
-
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"
|
|
3770
|
+
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"></a>
|
|
3778
3771
|
|
|
3779
3772
|
### checkoutButton.on(eventName, cb)
|
|
3780
3773
|
Listen to events of widget
|
|
3781
3774
|
|
|
3782
|
-
**Kind**: instance method of [<code>CheckoutButton</code>](#
|
|
3775
|
+
**Kind**: instance method of [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3783
3776
|
|
|
3784
3777
|
| Param | Type | Description |
|
|
3785
3778
|
| --- | --- | --- |
|
|
3786
|
-
| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#
|
|
3787
|
-
| cb | [<code>listener</code>](#
|
|
3779
|
+
| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#cb_CHECKOUT_BUTTON_EVENT) |
|
|
3780
|
+
| cb | [<code>listener</code>](#cb_listener) | |
|
|
3788
3781
|
|
|
3789
3782
|
**Example**
|
|
3790
3783
|
|
|
@@ -3793,34 +3786,34 @@ widget.on('click', function () {
|
|
|
3793
3786
|
|
|
3794
3787
|
});
|
|
3795
3788
|
```
|
|
3796
|
-
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"
|
|
3789
|
+
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"></a>
|
|
3797
3790
|
|
|
3798
3791
|
### checkoutButton.close()
|
|
3799
3792
|
Close popup window forcibly
|
|
3800
3793
|
|
|
3801
|
-
**Kind**: instance method of [<code>CheckoutButton</code>](#
|
|
3802
|
-
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"
|
|
3794
|
+
**Kind**: instance method of [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3795
|
+
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"></a>
|
|
3803
3796
|
|
|
3804
3797
|
### checkoutButton.onFinishInsert(selector, dataType)
|
|
3805
3798
|
After finish event of checkout button, data (dataType) will be insert to input (selector)
|
|
3806
3799
|
|
|
3807
|
-
**Kind**: instance method of [<code>CheckoutButton</code>](#
|
|
3800
|
+
**Kind**: instance method of [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3808
3801
|
|
|
3809
3802
|
| Param | Type | Description |
|
|
3810
3803
|
| --- | --- | --- |
|
|
3811
3804
|
| selector | <code>string</code> | css selector . [] # |
|
|
3812
|
-
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#
|
|
3805
|
+
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#cb_IEventCheckoutFinishData). |
|
|
3813
3806
|
|
|
3814
|
-
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"
|
|
3807
|
+
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"></a>
|
|
3815
3808
|
|
|
3816
3809
|
### checkoutButton.setMeta(meta)
|
|
3817
3810
|
Method for setting meta information for checkout page
|
|
3818
3811
|
|
|
3819
|
-
**Kind**: instance method of [<code>CheckoutButton</code>](#
|
|
3812
|
+
**Kind**: instance method of [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3820
3813
|
|
|
3821
3814
|
| Param | Type | Description |
|
|
3822
3815
|
| --- | --- | --- |
|
|
3823
|
-
| meta | [<code>IPayPalMeta</code>](#
|
|
3816
|
+
| meta | [<code>IPayPalMeta</code>](#cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#cb_IPayPalMeta) [IZipmoneyMeta](#cb_IZipmoneyMeta) [IAfterpayMeta](#cb_IAfterpayMeta) |
|
|
3824
3817
|
|
|
3825
3818
|
**Example**
|
|
3826
3819
|
|
|
@@ -3831,12 +3824,12 @@ button.setMeta({
|
|
|
3831
3824
|
email: 'wault@paydock.com'
|
|
3832
3825
|
});
|
|
3833
3826
|
```
|
|
3834
|
-
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"
|
|
3827
|
+
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"></a>
|
|
3835
3828
|
|
|
3836
3829
|
### checkoutButton.setBackdropDescription(text)
|
|
3837
3830
|
Method for setting backdrop description
|
|
3838
3831
|
|
|
3839
|
-
**Kind**: instance method of [<code>CheckoutButton</code>](#
|
|
3832
|
+
**Kind**: instance method of [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3840
3833
|
|
|
3841
3834
|
| Param | Type | Description |
|
|
3842
3835
|
| --- | --- | --- |
|
|
@@ -3847,12 +3840,12 @@ Method for setting backdrop description
|
|
|
3847
3840
|
```javascript
|
|
3848
3841
|
button.setBackdropDescription('Custom description');
|
|
3849
3842
|
```
|
|
3850
|
-
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"
|
|
3843
|
+
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"></a>
|
|
3851
3844
|
|
|
3852
3845
|
### checkoutButton.setBackdropTitle(string)
|
|
3853
3846
|
Method for setting backdrop title
|
|
3854
3847
|
|
|
3855
|
-
**Kind**: instance method of [<code>CheckoutButton</code>](#
|
|
3848
|
+
**Kind**: instance method of [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3856
3849
|
|
|
3857
3850
|
| Param | Type | Description |
|
|
3858
3851
|
| --- | --- | --- |
|
|
@@ -3863,48 +3856,48 @@ Method for setting backdrop title
|
|
|
3863
3856
|
```javascript
|
|
3864
3857
|
button.setBackdropTitle('Custom title');
|
|
3865
3858
|
```
|
|
3866
|
-
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri"
|
|
3859
|
+
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri"></a>
|
|
3867
3860
|
|
|
3868
3861
|
### checkoutButton.setSuspendedRedirectUri(string)
|
|
3869
3862
|
Method for setting suspended redirect uri. Redirect after referred checkout
|
|
3870
3863
|
|
|
3871
|
-
**Kind**: instance method of [<code>CheckoutButton</code>](#
|
|
3864
|
+
**Kind**: instance method of [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3872
3865
|
|
|
3873
3866
|
| Param | Type | Description |
|
|
3874
3867
|
| --- | --- | --- |
|
|
3875
3868
|
| string | <code>uri</code> | uri for redirect (by default) |
|
|
3876
3869
|
|
|
3877
|
-
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"
|
|
3870
|
+
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"></a>
|
|
3878
3871
|
|
|
3879
3872
|
### checkoutButton.turnOffBackdrop()
|
|
3880
3873
|
Method for disable backdrop on the page.
|
|
3881
3874
|
|
|
3882
|
-
**Kind**: instance method of [<code>CheckoutButton</code>](#
|
|
3875
|
+
**Kind**: instance method of [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3883
3876
|
**Example**
|
|
3884
3877
|
|
|
3885
3878
|
```javascript
|
|
3886
3879
|
button.turnOffBackdrop();
|
|
3887
3880
|
```
|
|
3888
|
-
<a name="cb_ZipmoneyCheckoutButton" id="cb_ZipmoneyCheckoutButton"
|
|
3881
|
+
<a name="cb_ZipmoneyCheckoutButton" id="cb_ZipmoneyCheckoutButton"></a>
|
|
3889
3882
|
|
|
3890
|
-
## ZipmoneyCheckoutButton ⇐ [<code>CheckoutButton</code>](#
|
|
3883
|
+
## ZipmoneyCheckoutButton ⇐ [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3891
3884
|
Class ZipmoneyCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
|
|
3892
3885
|
|
|
3893
3886
|
**Kind**: global class
|
|
3894
|
-
**Extends**: [<code>CheckoutButton</code>](#
|
|
3887
|
+
**Extends**: [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3895
3888
|
|
|
3896
|
-
* [ZipmoneyCheckoutButton](#
|
|
3897
|
-
* [new exports.ZipmoneyCheckoutButton(selector, publicKey, [gatewayId])](#
|
|
3898
|
-
* [.setSuspendedRedirectUri(string)](#
|
|
3899
|
-
* [.on(eventName, cb)](#
|
|
3900
|
-
* [.close()](#
|
|
3901
|
-
* [.onFinishInsert(selector, dataType)](#
|
|
3902
|
-
* [.setMeta(meta)](#
|
|
3903
|
-
* [.setBackdropDescription(text)](#
|
|
3904
|
-
* [.setBackdropTitle(string)](#
|
|
3905
|
-
* [.turnOffBackdrop()](#
|
|
3889
|
+
* [ZipmoneyCheckoutButton](#cb_ZipmoneyCheckoutButton) ⇐ [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3890
|
+
* [new exports.ZipmoneyCheckoutButton(selector, publicKey, [gatewayId])](#cb_new_ZipmoneyCheckoutButton_new)
|
|
3891
|
+
* [.setSuspendedRedirectUri(string)](#cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri)
|
|
3892
|
+
* [.on(eventName, cb)](#cb_CheckoutButton+on)
|
|
3893
|
+
* [.close()](#cb_CheckoutButton+close)
|
|
3894
|
+
* [.onFinishInsert(selector, dataType)](#cb_CheckoutButton+onFinishInsert)
|
|
3895
|
+
* [.setMeta(meta)](#cb_CheckoutButton+setMeta)
|
|
3896
|
+
* [.setBackdropDescription(text)](#cb_CheckoutButton+setBackdropDescription)
|
|
3897
|
+
* [.setBackdropTitle(string)](#cb_CheckoutButton+setBackdropTitle)
|
|
3898
|
+
* [.turnOffBackdrop()](#cb_CheckoutButton+turnOffBackdrop)
|
|
3906
3899
|
|
|
3907
|
-
<a name="cb_new_ZipmoneyCheckoutButton_new" id="cb_new_ZipmoneyCheckoutButton_new"
|
|
3900
|
+
<a name="cb_new_ZipmoneyCheckoutButton_new" id="cb_new_ZipmoneyCheckoutButton_new"></a>
|
|
3908
3901
|
|
|
3909
3902
|
### new exports.ZipmoneyCheckoutButton(selector, publicKey, [gatewayId])
|
|
3910
3903
|
|
|
@@ -3919,7 +3912,7 @@ Class ZipmoneyCheckoutButton is wrapper of CheckoutButton transform usual button
|
|
|
3919
3912
|
```javascript
|
|
3920
3913
|
var widget = new ZipmoneyCheckoutButton('#button', 'publicKey','gatewayId');
|
|
3921
3914
|
```
|
|
3922
|
-
<a name="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri" id="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri"
|
|
3915
|
+
<a name="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri" id="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri"></a>
|
|
3923
3916
|
|
|
3924
3917
|
### zipmoneyCheckoutButton.setSuspendedRedirectUri(string)
|
|
3925
3918
|
Method for setting suspended redirect uri. Redirect after referred checkout
|
|
@@ -3928,24 +3921,24 @@ The URI is used for a redirect after the checkout is complete.
|
|
|
3928
3921
|
This can be provided, even if using in-context checkout (sdk). By default, the standard styled page will be used.
|
|
3929
3922
|
If using in-context (sdk) we will not automatically redirect to this URI.
|
|
3930
3923
|
|
|
3931
|
-
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#
|
|
3932
|
-
**Overrides**: [<code>setSuspendedRedirectUri</code>](#
|
|
3924
|
+
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#cb_ZipmoneyCheckoutButton)
|
|
3925
|
+
**Overrides**: [<code>setSuspendedRedirectUri</code>](#cb_CheckoutButton+setSuspendedRedirectUri)
|
|
3933
3926
|
|
|
3934
3927
|
| Param | Type | Description |
|
|
3935
3928
|
| --- | --- | --- |
|
|
3936
3929
|
| string | <code>uri</code> | uri for redirect (by default) |
|
|
3937
3930
|
|
|
3938
|
-
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"
|
|
3931
|
+
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"></a>
|
|
3939
3932
|
|
|
3940
3933
|
### zipmoneyCheckoutButton.on(eventName, cb)
|
|
3941
3934
|
Listen to events of widget
|
|
3942
3935
|
|
|
3943
|
-
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#
|
|
3936
|
+
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#cb_ZipmoneyCheckoutButton)
|
|
3944
3937
|
|
|
3945
3938
|
| Param | Type | Description |
|
|
3946
3939
|
| --- | --- | --- |
|
|
3947
|
-
| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#
|
|
3948
|
-
| cb | [<code>listener</code>](#
|
|
3940
|
+
| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#cb_CHECKOUT_BUTTON_EVENT) |
|
|
3941
|
+
| cb | [<code>listener</code>](#cb_listener) | |
|
|
3949
3942
|
|
|
3950
3943
|
**Example**
|
|
3951
3944
|
|
|
@@ -3954,34 +3947,34 @@ widget.on('click', function () {
|
|
|
3954
3947
|
|
|
3955
3948
|
});
|
|
3956
3949
|
```
|
|
3957
|
-
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"
|
|
3950
|
+
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"></a>
|
|
3958
3951
|
|
|
3959
3952
|
### zipmoneyCheckoutButton.close()
|
|
3960
3953
|
Close popup window forcibly
|
|
3961
3954
|
|
|
3962
|
-
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#
|
|
3963
|
-
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"
|
|
3955
|
+
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#cb_ZipmoneyCheckoutButton)
|
|
3956
|
+
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"></a>
|
|
3964
3957
|
|
|
3965
3958
|
### zipmoneyCheckoutButton.onFinishInsert(selector, dataType)
|
|
3966
3959
|
After finish event of checkout button, data (dataType) will be insert to input (selector)
|
|
3967
3960
|
|
|
3968
|
-
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#
|
|
3961
|
+
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#cb_ZipmoneyCheckoutButton)
|
|
3969
3962
|
|
|
3970
3963
|
| Param | Type | Description |
|
|
3971
3964
|
| --- | --- | --- |
|
|
3972
3965
|
| selector | <code>string</code> | css selector . [] # |
|
|
3973
|
-
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#
|
|
3966
|
+
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#cb_IEventCheckoutFinishData). |
|
|
3974
3967
|
|
|
3975
|
-
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"
|
|
3968
|
+
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"></a>
|
|
3976
3969
|
|
|
3977
3970
|
### zipmoneyCheckoutButton.setMeta(meta)
|
|
3978
3971
|
Method for setting meta information for checkout page
|
|
3979
3972
|
|
|
3980
|
-
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#
|
|
3973
|
+
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#cb_ZipmoneyCheckoutButton)
|
|
3981
3974
|
|
|
3982
3975
|
| Param | Type | Description |
|
|
3983
3976
|
| --- | --- | --- |
|
|
3984
|
-
| meta | [<code>IPayPalMeta</code>](#
|
|
3977
|
+
| meta | [<code>IPayPalMeta</code>](#cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#cb_IPayPalMeta) [IZipmoneyMeta](#cb_IZipmoneyMeta) [IAfterpayMeta](#cb_IAfterpayMeta) |
|
|
3985
3978
|
|
|
3986
3979
|
**Example**
|
|
3987
3980
|
|
|
@@ -3992,12 +3985,12 @@ button.setMeta({
|
|
|
3992
3985
|
email: 'wault@paydock.com'
|
|
3993
3986
|
});
|
|
3994
3987
|
```
|
|
3995
|
-
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"
|
|
3988
|
+
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"></a>
|
|
3996
3989
|
|
|
3997
3990
|
### zipmoneyCheckoutButton.setBackdropDescription(text)
|
|
3998
3991
|
Method for setting backdrop description
|
|
3999
3992
|
|
|
4000
|
-
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#
|
|
3993
|
+
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#cb_ZipmoneyCheckoutButton)
|
|
4001
3994
|
|
|
4002
3995
|
| Param | Type | Description |
|
|
4003
3996
|
| --- | --- | --- |
|
|
@@ -4008,12 +4001,12 @@ Method for setting backdrop description
|
|
|
4008
4001
|
```javascript
|
|
4009
4002
|
button.setBackdropDescription('Custom description');
|
|
4010
4003
|
```
|
|
4011
|
-
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"
|
|
4004
|
+
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"></a>
|
|
4012
4005
|
|
|
4013
4006
|
### zipmoneyCheckoutButton.setBackdropTitle(string)
|
|
4014
4007
|
Method for setting backdrop title
|
|
4015
4008
|
|
|
4016
|
-
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#
|
|
4009
|
+
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#cb_ZipmoneyCheckoutButton)
|
|
4017
4010
|
|
|
4018
4011
|
| Param | Type | Description |
|
|
4019
4012
|
| --- | --- | --- |
|
|
@@ -4024,37 +4017,37 @@ Method for setting backdrop title
|
|
|
4024
4017
|
```javascript
|
|
4025
4018
|
button.setBackdropTitle('Custom title');
|
|
4026
4019
|
```
|
|
4027
|
-
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"
|
|
4020
|
+
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"></a>
|
|
4028
4021
|
|
|
4029
4022
|
### zipmoneyCheckoutButton.turnOffBackdrop()
|
|
4030
4023
|
Method for disable backdrop on the page.
|
|
4031
4024
|
|
|
4032
|
-
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#
|
|
4025
|
+
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#cb_ZipmoneyCheckoutButton)
|
|
4033
4026
|
**Example**
|
|
4034
4027
|
|
|
4035
4028
|
```javascript
|
|
4036
4029
|
button.turnOffBackdrop();
|
|
4037
4030
|
```
|
|
4038
|
-
<a name="cb_PaypalCheckoutButton" id="cb_PaypalCheckoutButton"
|
|
4031
|
+
<a name="cb_PaypalCheckoutButton" id="cb_PaypalCheckoutButton"></a>
|
|
4039
4032
|
|
|
4040
|
-
## PaypalCheckoutButton ⇐ [<code>CheckoutButton</code>](#
|
|
4033
|
+
## PaypalCheckoutButton ⇐ [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
4041
4034
|
Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
|
|
4042
4035
|
|
|
4043
4036
|
**Kind**: global class
|
|
4044
|
-
**Extends**: [<code>CheckoutButton</code>](#
|
|
4037
|
+
**Extends**: [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
4045
4038
|
|
|
4046
|
-
* [PaypalCheckoutButton](#
|
|
4047
|
-
* [new exports.PaypalCheckoutButton(selector, publicKey, [gatewayId])](#
|
|
4048
|
-
* [.on(eventName, cb)](#
|
|
4049
|
-
* [.close()](#
|
|
4050
|
-
* [.onFinishInsert(selector, dataType)](#
|
|
4051
|
-
* [.setMeta(meta)](#
|
|
4052
|
-
* [.setBackdropDescription(text)](#
|
|
4053
|
-
* [.setBackdropTitle(string)](#
|
|
4054
|
-
* [.setSuspendedRedirectUri(string)](#
|
|
4055
|
-
* [.turnOffBackdrop()](#
|
|
4039
|
+
* [PaypalCheckoutButton](#cb_PaypalCheckoutButton) ⇐ [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
4040
|
+
* [new exports.PaypalCheckoutButton(selector, publicKey, [gatewayId])](#cb_new_PaypalCheckoutButton_new)
|
|
4041
|
+
* [.on(eventName, cb)](#cb_CheckoutButton+on)
|
|
4042
|
+
* [.close()](#cb_CheckoutButton+close)
|
|
4043
|
+
* [.onFinishInsert(selector, dataType)](#cb_CheckoutButton+onFinishInsert)
|
|
4044
|
+
* [.setMeta(meta)](#cb_CheckoutButton+setMeta)
|
|
4045
|
+
* [.setBackdropDescription(text)](#cb_CheckoutButton+setBackdropDescription)
|
|
4046
|
+
* [.setBackdropTitle(string)](#cb_CheckoutButton+setBackdropTitle)
|
|
4047
|
+
* [.setSuspendedRedirectUri(string)](#cb_CheckoutButton+setSuspendedRedirectUri)
|
|
4048
|
+
* [.turnOffBackdrop()](#cb_CheckoutButton+turnOffBackdrop)
|
|
4056
4049
|
|
|
4057
|
-
<a name="cb_new_PaypalCheckoutButton_new" id="cb_new_PaypalCheckoutButton_new"
|
|
4050
|
+
<a name="cb_new_PaypalCheckoutButton_new" id="cb_new_PaypalCheckoutButton_new"></a>
|
|
4058
4051
|
|
|
4059
4052
|
### new exports.PaypalCheckoutButton(selector, publicKey, [gatewayId])
|
|
4060
4053
|
|
|
@@ -4069,17 +4062,17 @@ Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button i
|
|
|
4069
4062
|
```javascript
|
|
4070
4063
|
var widget = new PaypalCheckoutButton('#button', 'publicKey','gatewayId');
|
|
4071
4064
|
```
|
|
4072
|
-
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"
|
|
4065
|
+
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"></a>
|
|
4073
4066
|
|
|
4074
4067
|
### paypalCheckoutButton.on(eventName, cb)
|
|
4075
4068
|
Listen to events of widget
|
|
4076
4069
|
|
|
4077
|
-
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#
|
|
4070
|
+
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#cb_PaypalCheckoutButton)
|
|
4078
4071
|
|
|
4079
4072
|
| Param | Type | Description |
|
|
4080
4073
|
| --- | --- | --- |
|
|
4081
|
-
| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#
|
|
4082
|
-
| cb | [<code>listener</code>](#
|
|
4074
|
+
| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#cb_CHECKOUT_BUTTON_EVENT) |
|
|
4075
|
+
| cb | [<code>listener</code>](#cb_listener) | |
|
|
4083
4076
|
|
|
4084
4077
|
**Example**
|
|
4085
4078
|
|
|
@@ -4088,34 +4081,34 @@ widget.on('click', function () {
|
|
|
4088
4081
|
|
|
4089
4082
|
});
|
|
4090
4083
|
```
|
|
4091
|
-
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"
|
|
4084
|
+
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"></a>
|
|
4092
4085
|
|
|
4093
4086
|
### paypalCheckoutButton.close()
|
|
4094
4087
|
Close popup window forcibly
|
|
4095
4088
|
|
|
4096
|
-
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#
|
|
4097
|
-
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"
|
|
4089
|
+
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#cb_PaypalCheckoutButton)
|
|
4090
|
+
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"></a>
|
|
4098
4091
|
|
|
4099
4092
|
### paypalCheckoutButton.onFinishInsert(selector, dataType)
|
|
4100
4093
|
After finish event of checkout button, data (dataType) will be insert to input (selector)
|
|
4101
4094
|
|
|
4102
|
-
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#
|
|
4095
|
+
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#cb_PaypalCheckoutButton)
|
|
4103
4096
|
|
|
4104
4097
|
| Param | Type | Description |
|
|
4105
4098
|
| --- | --- | --- |
|
|
4106
4099
|
| selector | <code>string</code> | css selector . [] # |
|
|
4107
|
-
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#
|
|
4100
|
+
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#cb_IEventCheckoutFinishData). |
|
|
4108
4101
|
|
|
4109
|
-
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"
|
|
4102
|
+
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"></a>
|
|
4110
4103
|
|
|
4111
4104
|
### paypalCheckoutButton.setMeta(meta)
|
|
4112
4105
|
Method for setting meta information for checkout page
|
|
4113
4106
|
|
|
4114
|
-
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#
|
|
4107
|
+
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#cb_PaypalCheckoutButton)
|
|
4115
4108
|
|
|
4116
4109
|
| Param | Type | Description |
|
|
4117
4110
|
| --- | --- | --- |
|
|
4118
|
-
| meta | [<code>IPayPalMeta</code>](#
|
|
4111
|
+
| meta | [<code>IPayPalMeta</code>](#cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#cb_IPayPalMeta) [IZipmoneyMeta](#cb_IZipmoneyMeta) [IAfterpayMeta](#cb_IAfterpayMeta) |
|
|
4119
4112
|
|
|
4120
4113
|
**Example**
|
|
4121
4114
|
|
|
@@ -4126,12 +4119,12 @@ button.setMeta({
|
|
|
4126
4119
|
email: 'wault@paydock.com'
|
|
4127
4120
|
});
|
|
4128
4121
|
```
|
|
4129
|
-
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"
|
|
4122
|
+
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"></a>
|
|
4130
4123
|
|
|
4131
4124
|
### paypalCheckoutButton.setBackdropDescription(text)
|
|
4132
4125
|
Method for setting backdrop description
|
|
4133
4126
|
|
|
4134
|
-
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#
|
|
4127
|
+
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#cb_PaypalCheckoutButton)
|
|
4135
4128
|
|
|
4136
4129
|
| Param | Type | Description |
|
|
4137
4130
|
| --- | --- | --- |
|
|
@@ -4142,12 +4135,12 @@ Method for setting backdrop description
|
|
|
4142
4135
|
```javascript
|
|
4143
4136
|
button.setBackdropDescription('Custom description');
|
|
4144
4137
|
```
|
|
4145
|
-
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"
|
|
4138
|
+
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"></a>
|
|
4146
4139
|
|
|
4147
4140
|
### paypalCheckoutButton.setBackdropTitle(string)
|
|
4148
4141
|
Method for setting backdrop title
|
|
4149
4142
|
|
|
4150
|
-
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#
|
|
4143
|
+
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#cb_PaypalCheckoutButton)
|
|
4151
4144
|
|
|
4152
4145
|
| Param | Type | Description |
|
|
4153
4146
|
| --- | --- | --- |
|
|
@@ -4158,48 +4151,49 @@ Method for setting backdrop title
|
|
|
4158
4151
|
```javascript
|
|
4159
4152
|
button.setBackdropTitle('Custom title');
|
|
4160
4153
|
```
|
|
4161
|
-
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri"
|
|
4154
|
+
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri"></a>
|
|
4162
4155
|
|
|
4163
4156
|
### paypalCheckoutButton.setSuspendedRedirectUri(string)
|
|
4164
4157
|
Method for setting suspended redirect uri. Redirect after referred checkout
|
|
4165
4158
|
|
|
4166
|
-
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#
|
|
4159
|
+
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#cb_PaypalCheckoutButton)
|
|
4167
4160
|
|
|
4168
4161
|
| Param | Type | Description |
|
|
4169
4162
|
| --- | --- | --- |
|
|
4170
4163
|
| string | <code>uri</code> | uri for redirect (by default) |
|
|
4171
4164
|
|
|
4172
|
-
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"
|
|
4165
|
+
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"></a>
|
|
4173
4166
|
|
|
4174
4167
|
### paypalCheckoutButton.turnOffBackdrop()
|
|
4175
4168
|
Method for disable backdrop on the page.
|
|
4176
4169
|
|
|
4177
|
-
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#
|
|
4170
|
+
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#cb_PaypalCheckoutButton)
|
|
4178
4171
|
**Example**
|
|
4179
4172
|
|
|
4180
4173
|
```javascript
|
|
4181
4174
|
button.turnOffBackdrop();
|
|
4182
4175
|
```
|
|
4183
|
-
<a name="cb_AfterpayCheckoutButton" id="cb_AfterpayCheckoutButton"
|
|
4176
|
+
<a name="cb_AfterpayCheckoutButton" id="cb_AfterpayCheckoutButton"></a>
|
|
4184
4177
|
|
|
4185
|
-
## AfterpayCheckoutButton ⇐ [<code>CheckoutButton</code>](#
|
|
4178
|
+
## AfterpayCheckoutButton ⇐ [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
4186
4179
|
Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
|
|
4187
4180
|
|
|
4188
4181
|
**Kind**: global class
|
|
4189
|
-
**Extends**: [<code>CheckoutButton</code>](#
|
|
4190
|
-
|
|
4191
|
-
* [AfterpayCheckoutButton](#
|
|
4192
|
-
* [new exports.AfterpayCheckoutButton(selector, accessToken, [gatewayId])](#
|
|
4193
|
-
* [.
|
|
4194
|
-
* [.
|
|
4195
|
-
* [.
|
|
4196
|
-
* [.
|
|
4197
|
-
* [.
|
|
4198
|
-
* [.
|
|
4199
|
-
* [.
|
|
4200
|
-
* [.
|
|
4201
|
-
|
|
4202
|
-
|
|
4182
|
+
**Extends**: [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
4183
|
+
|
|
4184
|
+
* [AfterpayCheckoutButton](#cb_AfterpayCheckoutButton) ⇐ [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
4185
|
+
* [new exports.AfterpayCheckoutButton(selector, accessToken, [gatewayId])](#cb_new_AfterpayCheckoutButton_new)
|
|
4186
|
+
* [.showEnhancedTrackingProtectionPopup(boolean)](#cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup)
|
|
4187
|
+
* [.on(eventName, cb)](#cb_CheckoutButton+on)
|
|
4188
|
+
* [.close()](#cb_CheckoutButton+close)
|
|
4189
|
+
* [.onFinishInsert(selector, dataType)](#cb_CheckoutButton+onFinishInsert)
|
|
4190
|
+
* [.setMeta(meta)](#cb_CheckoutButton+setMeta)
|
|
4191
|
+
* [.setBackdropDescription(text)](#cb_CheckoutButton+setBackdropDescription)
|
|
4192
|
+
* [.setBackdropTitle(string)](#cb_CheckoutButton+setBackdropTitle)
|
|
4193
|
+
* [.setSuspendedRedirectUri(string)](#cb_CheckoutButton+setSuspendedRedirectUri)
|
|
4194
|
+
* [.turnOffBackdrop()](#cb_CheckoutButton+turnOffBackdrop)
|
|
4195
|
+
|
|
4196
|
+
<a name="cb_new_AfterpayCheckoutButton_new" id="cb_new_AfterpayCheckoutButton_new"></a>
|
|
4203
4197
|
|
|
4204
4198
|
### new exports.AfterpayCheckoutButton(selector, accessToken, [gatewayId])
|
|
4205
4199
|
|
|
@@ -4214,17 +4208,34 @@ Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button
|
|
|
4214
4208
|
```javascript
|
|
4215
4209
|
var widget = new AfterpayCheckoutButton('#button', 'access-token','gatewayId');
|
|
4216
4210
|
```
|
|
4217
|
-
<a name="
|
|
4211
|
+
<a name="cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup" id="cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup"></a>
|
|
4212
|
+
|
|
4213
|
+
### afterpayCheckoutButton.showEnhancedTrackingProtectionPopup(boolean)
|
|
4214
|
+
Method which toggles the "Enhanced Tracking Protection" warning popup to 'on' mode.
|
|
4215
|
+
|
|
4216
|
+
This popup with a warning about "Enhanced Tracking Protection" limitations
|
|
4217
|
+
would be shown in the Mozilla Firefox browser version 100+
|
|
4218
|
+
|
|
4219
|
+
By default, the popup would not be shown, until
|
|
4220
|
+
the flag would be set to `true`
|
|
4221
|
+
|
|
4222
|
+
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4223
|
+
|
|
4224
|
+
| Param | Type | Description |
|
|
4225
|
+
| --- | --- | --- |
|
|
4226
|
+
| boolean | <code>doShow</code> | flag which toggle the popup visibility |
|
|
4227
|
+
|
|
4228
|
+
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"></a>
|
|
4218
4229
|
|
|
4219
4230
|
### afterpayCheckoutButton.on(eventName, cb)
|
|
4220
4231
|
Listen to events of widget
|
|
4221
4232
|
|
|
4222
|
-
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#
|
|
4233
|
+
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4223
4234
|
|
|
4224
4235
|
| Param | Type | Description |
|
|
4225
4236
|
| --- | --- | --- |
|
|
4226
|
-
| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#
|
|
4227
|
-
| cb | [<code>listener</code>](#
|
|
4237
|
+
| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#cb_CHECKOUT_BUTTON_EVENT) |
|
|
4238
|
+
| cb | [<code>listener</code>](#cb_listener) | |
|
|
4228
4239
|
|
|
4229
4240
|
**Example**
|
|
4230
4241
|
|
|
@@ -4233,34 +4244,34 @@ widget.on('click', function () {
|
|
|
4233
4244
|
|
|
4234
4245
|
});
|
|
4235
4246
|
```
|
|
4236
|
-
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"
|
|
4247
|
+
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"></a>
|
|
4237
4248
|
|
|
4238
4249
|
### afterpayCheckoutButton.close()
|
|
4239
4250
|
Close popup window forcibly
|
|
4240
4251
|
|
|
4241
|
-
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#
|
|
4242
|
-
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"
|
|
4252
|
+
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4253
|
+
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"></a>
|
|
4243
4254
|
|
|
4244
4255
|
### afterpayCheckoutButton.onFinishInsert(selector, dataType)
|
|
4245
4256
|
After finish event of checkout button, data (dataType) will be insert to input (selector)
|
|
4246
4257
|
|
|
4247
|
-
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#
|
|
4258
|
+
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4248
4259
|
|
|
4249
4260
|
| Param | Type | Description |
|
|
4250
4261
|
| --- | --- | --- |
|
|
4251
4262
|
| selector | <code>string</code> | css selector . [] # |
|
|
4252
|
-
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#
|
|
4263
|
+
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#cb_IEventCheckoutFinishData). |
|
|
4253
4264
|
|
|
4254
|
-
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"
|
|
4265
|
+
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"></a>
|
|
4255
4266
|
|
|
4256
4267
|
### afterpayCheckoutButton.setMeta(meta)
|
|
4257
4268
|
Method for setting meta information for checkout page
|
|
4258
4269
|
|
|
4259
|
-
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#
|
|
4270
|
+
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4260
4271
|
|
|
4261
4272
|
| Param | Type | Description |
|
|
4262
4273
|
| --- | --- | --- |
|
|
4263
|
-
| meta | [<code>IPayPalMeta</code>](#
|
|
4274
|
+
| meta | [<code>IPayPalMeta</code>](#cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#cb_IPayPalMeta) [IZipmoneyMeta](#cb_IZipmoneyMeta) [IAfterpayMeta](#cb_IAfterpayMeta) |
|
|
4264
4275
|
|
|
4265
4276
|
**Example**
|
|
4266
4277
|
|
|
@@ -4271,12 +4282,12 @@ button.setMeta({
|
|
|
4271
4282
|
email: 'wault@paydock.com'
|
|
4272
4283
|
});
|
|
4273
4284
|
```
|
|
4274
|
-
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"
|
|
4285
|
+
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"></a>
|
|
4275
4286
|
|
|
4276
4287
|
### afterpayCheckoutButton.setBackdropDescription(text)
|
|
4277
4288
|
Method for setting backdrop description
|
|
4278
4289
|
|
|
4279
|
-
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#
|
|
4290
|
+
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4280
4291
|
|
|
4281
4292
|
| Param | Type | Description |
|
|
4282
4293
|
| --- | --- | --- |
|
|
@@ -4287,12 +4298,12 @@ Method for setting backdrop description
|
|
|
4287
4298
|
```javascript
|
|
4288
4299
|
button.setBackdropDescription('Custom description');
|
|
4289
4300
|
```
|
|
4290
|
-
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"
|
|
4301
|
+
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"></a>
|
|
4291
4302
|
|
|
4292
4303
|
### afterpayCheckoutButton.setBackdropTitle(string)
|
|
4293
4304
|
Method for setting backdrop title
|
|
4294
4305
|
|
|
4295
|
-
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#
|
|
4306
|
+
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4296
4307
|
|
|
4297
4308
|
| Param | Type | Description |
|
|
4298
4309
|
| --- | --- | --- |
|
|
@@ -4303,29 +4314,29 @@ Method for setting backdrop title
|
|
|
4303
4314
|
```javascript
|
|
4304
4315
|
button.setBackdropTitle('Custom title');
|
|
4305
4316
|
```
|
|
4306
|
-
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri"
|
|
4317
|
+
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri"></a>
|
|
4307
4318
|
|
|
4308
4319
|
### afterpayCheckoutButton.setSuspendedRedirectUri(string)
|
|
4309
4320
|
Method for setting suspended redirect uri. Redirect after referred checkout
|
|
4310
4321
|
|
|
4311
|
-
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#
|
|
4322
|
+
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4312
4323
|
|
|
4313
4324
|
| Param | Type | Description |
|
|
4314
4325
|
| --- | --- | --- |
|
|
4315
4326
|
| string | <code>uri</code> | uri for redirect (by default) |
|
|
4316
4327
|
|
|
4317
|
-
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"
|
|
4328
|
+
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"></a>
|
|
4318
4329
|
|
|
4319
4330
|
### afterpayCheckoutButton.turnOffBackdrop()
|
|
4320
4331
|
Method for disable backdrop on the page.
|
|
4321
4332
|
|
|
4322
|
-
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#
|
|
4333
|
+
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4323
4334
|
**Example**
|
|
4324
4335
|
|
|
4325
4336
|
```javascript
|
|
4326
4337
|
button.turnOffBackdrop();
|
|
4327
4338
|
```
|
|
4328
|
-
<a name="cb_CHECKOUT_BUTTON_EVENT" id="cb_CHECKOUT_BUTTON_EVENT"
|
|
4339
|
+
<a name="cb_CHECKOUT_BUTTON_EVENT" id="cb_CHECKOUT_BUTTON_EVENT"></a>
|
|
4329
4340
|
|
|
4330
4341
|
## CHECKOUT\_BUTTON\_EVENT : <code>object</code>
|
|
4331
4342
|
**Kind**: global constant
|
|
@@ -4339,7 +4350,7 @@ button.turnOffBackdrop();
|
|
|
4339
4350
|
| FINISH | <code>string</code> | <code>"finish"</code> |
|
|
4340
4351
|
| CLOSE | <code>string</code> | <code>"close"</code> |
|
|
4341
4352
|
|
|
4342
|
-
<a name="cb_listener" id="cb_listener"
|
|
4353
|
+
<a name="cb_listener" id="cb_listener"></a>
|
|
4343
4354
|
|
|
4344
4355
|
## listener : <code>function</code>
|
|
4345
4356
|
This callback will be called for each event in payment source widget
|
|
@@ -4781,7 +4792,7 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
4781
4792
|
</html>
|
|
4782
4793
|
```
|
|
4783
4794
|
|
|
4784
|
-
<a name="VaultDisplayWidget" id="VaultDisplayWidget"
|
|
4795
|
+
<a name="VaultDisplayWidget" id="VaultDisplayWidget"></a>
|
|
4785
4796
|
|
|
4786
4797
|
## VaultDisplayWidget
|
|
4787
4798
|
Class VaultDisplayWidget include method for working on html
|
|
@@ -4795,7 +4806,7 @@ Class VaultDisplayWidget include method for working on html
|
|
|
4795
4806
|
* [.setStyles(fields)](#VaultDisplayWidget+setStyles)
|
|
4796
4807
|
* [.load()](#VaultDisplayWidget+load)
|
|
4797
4808
|
|
|
4798
|
-
<a name="new_VaultDisplayWidget_new" id="new_VaultDisplayWidget_new"
|
|
4809
|
+
<a name="new_VaultDisplayWidget_new" id="new_VaultDisplayWidget_new"></a>
|
|
4799
4810
|
|
|
4800
4811
|
### new exports.VaultDisplayWidget(selector, token)
|
|
4801
4812
|
|
|
@@ -4808,7 +4819,7 @@ Class VaultDisplayWidget include method for working on html
|
|
|
4808
4819
|
```js
|
|
4809
4820
|
var widget = new VaultDisplayWidget('#widget', 'token');
|
|
4810
4821
|
```
|
|
4811
|
-
<a name="VaultDisplayWidget+setEnv" id="VaultDisplayWidget+setEnv"
|
|
4822
|
+
<a name="VaultDisplayWidget+setEnv" id="VaultDisplayWidget+setEnv"></a>
|
|
4812
4823
|
|
|
4813
4824
|
### vaultDisplayWidget.setEnv(env, [alias])
|
|
4814
4825
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -4825,7 +4836,7 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
4825
4836
|
```js
|
|
4826
4837
|
widget.setEnv('production', 'paydock.com');
|
|
4827
4838
|
```
|
|
4828
|
-
<a name="VaultDisplayWidget+on" id="VaultDisplayWidget+on"
|
|
4839
|
+
<a name="VaultDisplayWidget+on" id="VaultDisplayWidget+on"></a>
|
|
4829
4840
|
|
|
4830
4841
|
### vaultDisplayWidget.on(eventName, [cb]) ⇒ <code>[ 'Promise' ].<(IEventData\|void)></code>
|
|
4831
4842
|
Listen to events of widget
|
|
@@ -4847,7 +4858,7 @@ widget.on('after_load', function (data) {
|
|
|
4847
4858
|
console.log(data);
|
|
4848
4859
|
});
|
|
4849
4860
|
```
|
|
4850
|
-
<a name="VaultDisplayWidget+setStyles" id="VaultDisplayWidget+setStyles"
|
|
4861
|
+
<a name="VaultDisplayWidget+setStyles" id="VaultDisplayWidget+setStyles"></a>
|
|
4851
4862
|
|
|
4852
4863
|
### vaultDisplayWidget.setStyles(fields)
|
|
4853
4864
|
Object contain styles for widget
|
|
@@ -4869,7 +4880,7 @@ widget.setStyles({
|
|
|
4869
4880
|
fort_family: 'fantasy'
|
|
4870
4881
|
});
|
|
4871
4882
|
```
|
|
4872
|
-
<a name="VaultDisplayWidget+load" id="VaultDisplayWidget+load"
|
|
4883
|
+
<a name="VaultDisplayWidget+load" id="VaultDisplayWidget+load"></a>
|
|
4873
4884
|
|
|
4874
4885
|
### vaultDisplayWidget.load()
|
|
4875
4886
|
The final method to beginning, the load process of widget to html
|
|
@@ -5341,7 +5352,7 @@ Also, for **ApplePay via MPGS** you can initialize the `ApplePayPaymentRequest`
|
|
|
5341
5352
|
</dd>
|
|
5342
5353
|
</dl>
|
|
5343
5354
|
|
|
5344
|
-
<a name="IWalletMeta" id="IWalletMeta"
|
|
5355
|
+
<a name="IWalletMeta" id="IWalletMeta"></a>
|
|
5345
5356
|
|
|
5346
5357
|
## IWalletMeta : <code>object</code>
|
|
5347
5358
|
Interface of data used by the wallet checkout and payment proccess.
|
|
@@ -5365,7 +5376,7 @@ Interface of data used by the wallet checkout and payment proccess.
|
|
|
5365
5376
|
| [style.button_type] | <code>object</code> | Used to select ApplePay button type (e.g: 'buy','donate', etc), check possible values at https://developer.apple.com/documentation/apple_pay_on_the_web/displaying_apple_pay_buttons_using_css. Optional for [ApplePay]. N/A for other wallets. |
|
|
5366
5377
|
| [wallets] | <code>array</code> | By default if this is not sent or empty, we will try to show either Apple Pay or Google Pay buttons. This can be limited sending the following array in this field: ['apple','google]. Optional for [Stripe, ApplePay, GooglePay]. N/A for other wallets. |
|
|
5367
5378
|
|
|
5368
|
-
<a name="IApplePayShippingOption" id="IApplePayShippingOption"
|
|
5379
|
+
<a name="IApplePayShippingOption" id="IApplePayShippingOption"></a>
|
|
5369
5380
|
|
|
5370
5381
|
## IApplePayShippingOption : <code>object</code>
|
|
5371
5382
|
Interface of Shipping Options for ApplePay
|
|
@@ -5380,7 +5391,7 @@ Interface of Shipping Options for ApplePay
|
|
|
5380
5391
|
| [detail] | <code>string</code> | Details of the Shipping Option. Required. |
|
|
5381
5392
|
| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
|
|
5382
5393
|
|
|
5383
|
-
<a name="IGooglePayShippingOption" id="IGooglePayShippingOption"
|
|
5394
|
+
<a name="IGooglePayShippingOption" id="IGooglePayShippingOption"></a>
|
|
5384
5395
|
|
|
5385
5396
|
## IGooglePayShippingOption : <code>object</code>
|
|
5386
5397
|
Interface of Shipping Options for GooglePay
|
|
@@ -5394,7 +5405,7 @@ Interface of Shipping Options for GooglePay
|
|
|
5394
5405
|
| [detail] | <code>string</code> | Details of the Shipping Option. Optional. |
|
|
5395
5406
|
| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
|
|
5396
5407
|
|
|
5397
|
-
<a name="IPayPalShippingOption" id="IPayPalShippingOption"
|
|
5408
|
+
<a name="IPayPalShippingOption" id="IPayPalShippingOption"></a>
|
|
5398
5409
|
|
|
5399
5410
|
## IPayPalShippingOption : <code>object</code>
|
|
5400
5411
|
Interface of Shipping Options for PayPal
|
|
@@ -5409,7 +5420,7 @@ Interface of Shipping Options for PayPal
|
|
|
5409
5420
|
| [currency] | <code>string</code> | Currency of the Shipping Option. Required. |
|
|
5410
5421
|
| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'SHIPPING' or 'PICKUP'. Required. |
|
|
5411
5422
|
|
|
5412
|
-
<a name="WalletButtons" id="WalletButtons"
|
|
5423
|
+
<a name="WalletButtons" id="WalletButtons"></a>
|
|
5413
5424
|
|
|
5414
5425
|
## WalletButtons
|
|
5415
5426
|
Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay™ and Apple Pay via Stripe, Flypay, Paypal)
|
|
@@ -5429,7 +5440,7 @@ Class WalletButtons to work with different E-Wallets within html (currently supp
|
|
|
5429
5440
|
* [.onPaymentInReview([handler])](#WalletButtons+onPaymentInReview)
|
|
5430
5441
|
* [.onPaymentError([handler])](#WalletButtons+onPaymentError)
|
|
5431
5442
|
|
|
5432
|
-
<a name="new_WalletButtons_new" id="new_WalletButtons_new"
|
|
5443
|
+
<a name="new_WalletButtons_new" id="new_WalletButtons_new"></a>
|
|
5433
5444
|
|
|
5434
5445
|
### new exports.WalletButtons(selector, chargeToken, object)
|
|
5435
5446
|
|
|
@@ -5443,7 +5454,7 @@ Class WalletButtons to work with different E-Wallets within html (currently supp
|
|
|
5443
5454
|
```js
|
|
5444
5455
|
var button = new WalletButtons('#wallet-buttons', 'charge-token', { amount_label: 'Total', country: 'us' });
|
|
5445
5456
|
```
|
|
5446
|
-
<a name="WalletButtons+load" id="WalletButtons+load"
|
|
5457
|
+
<a name="WalletButtons+load" id="WalletButtons+load"></a>
|
|
5447
5458
|
|
|
5448
5459
|
### walletButtons.load()
|
|
5449
5460
|
Initializes the availability checks and inserts the button if possible.
|
|
@@ -5462,7 +5473,7 @@ var button = new WalletButtons(
|
|
|
5462
5473
|
);
|
|
5463
5474
|
button.load();
|
|
5464
5475
|
```
|
|
5465
|
-
<a name="WalletButtons+update" id="WalletButtons+update"
|
|
5476
|
+
<a name="WalletButtons+update" id="WalletButtons+update"></a>
|
|
5466
5477
|
|
|
5467
5478
|
### walletButtons.update()
|
|
5468
5479
|
Triggers the update process of the wallet, if available.
|
|
@@ -5520,7 +5531,7 @@ var button = new WalletButtons(
|
|
|
5520
5531
|
});
|
|
5521
5532
|
});
|
|
5522
5533
|
```
|
|
5523
|
-
<a name="WalletButtons+setEnv" id="WalletButtons+setEnv"
|
|
5534
|
+
<a name="WalletButtons+setEnv" id="WalletButtons+setEnv"></a>
|
|
5524
5535
|
|
|
5525
5536
|
### walletButtons.setEnv(env, [alias])
|
|
5526
5537
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -5538,7 +5549,7 @@ Bear in mind that you must set an environment before calling `button.load()`.
|
|
|
5538
5549
|
```js
|
|
5539
5550
|
button.setEnv('production', 'paydock.com');
|
|
5540
5551
|
```
|
|
5541
|
-
<a name="WalletButtons+close" id="WalletButtons+close"
|
|
5552
|
+
<a name="WalletButtons+close" id="WalletButtons+close"></a>
|
|
5542
5553
|
|
|
5543
5554
|
### walletButtons.close()
|
|
5544
5555
|
Closes the checkout forcibly. Currently supported in Flypay wallet.
|
|
@@ -5548,7 +5559,7 @@ Closes the checkout forcibly. Currently supported in Flypay wallet.
|
|
|
5548
5559
|
```js
|
|
5549
5560
|
button.close();
|
|
5550
5561
|
```
|
|
5551
|
-
<a name="WalletButtons+on" id="WalletButtons+on"
|
|
5562
|
+
<a name="WalletButtons+on" id="WalletButtons+on"></a>
|
|
5552
5563
|
|
|
5553
5564
|
### walletButtons.on(eventName, [cb]) ⇒ <code>Promise.<IEventData></code> \| <code>void</code>
|
|
5554
5565
|
Listen to events of button. `unavailable` returns no data, `paymentSuccessful` returns IWalletPaymentSuccessful
|
|
@@ -5573,7 +5584,7 @@ button.on('unavailable').then(function () {
|
|
|
5573
5584
|
console.log('No button is available);
|
|
5574
5585
|
});
|
|
5575
5586
|
```
|
|
5576
|
-
<a name="WalletButtons+onUnavailable" id="WalletButtons+onUnavailable"
|
|
5587
|
+
<a name="WalletButtons+onUnavailable" id="WalletButtons+onUnavailable"></a>
|
|
5577
5588
|
|
|
5578
5589
|
### walletButtons.onUnavailable([handler])
|
|
5579
5590
|
User to subscribe to the no button available event. This method is used after loading when the button is not available.
|
|
@@ -5600,7 +5611,7 @@ button.onUnavailable().then(() => console.log('No wallet buttons available'));
|
|
|
5600
5611
|
```js
|
|
5601
5612
|
button.onUnavailable(function (data) {console.log('data.wallet :: ', data.wallet)});
|
|
5602
5613
|
```
|
|
5603
|
-
<a name="WalletButtons+onUpdate" id="WalletButtons+onUpdate"
|
|
5614
|
+
<a name="WalletButtons+onUpdate" id="WalletButtons+onUpdate"></a>
|
|
5604
5615
|
|
|
5605
5616
|
### walletButtons.onUpdate([handler])
|
|
5606
5617
|
If the wallet performs some update in the checkout process, the function passed as parameter will be called.
|
|
@@ -5623,7 +5634,7 @@ button.onUpdate((data) => {
|
|
|
5623
5634
|
```js
|
|
5624
5635
|
button.onUpdate().then((data) => throw new Error());
|
|
5625
5636
|
```
|
|
5626
|
-
<a name="WalletButtons+onPaymentSuccessful" id="WalletButtons+onPaymentSuccessful"
|
|
5637
|
+
<a name="WalletButtons+onPaymentSuccessful" id="WalletButtons+onPaymentSuccessful"></a>
|
|
5627
5638
|
|
|
5628
5639
|
### walletButtons.onPaymentSuccessful([handler])
|
|
5629
5640
|
If the payment was successful, the function passed as parameter will be called.
|
|
@@ -5645,7 +5656,7 @@ button.onPaymentSuccessful((data) => {
|
|
|
5645
5656
|
```js
|
|
5646
5657
|
button.onPaymentSuccessful().then((data) => console.log('Payment successful!'));
|
|
5647
5658
|
```
|
|
5648
|
-
<a name="WalletButtons+onPaymentInReview" id="WalletButtons+onPaymentInReview"
|
|
5659
|
+
<a name="WalletButtons+onPaymentInReview" id="WalletButtons+onPaymentInReview"></a>
|
|
5649
5660
|
|
|
5650
5661
|
### walletButtons.onPaymentInReview([handler])
|
|
5651
5662
|
If the payment was left in fraud review, the function passed as parameter will be called.
|
|
@@ -5667,7 +5678,7 @@ button.onPaymentInReview((data) => {
|
|
|
5667
5678
|
```js
|
|
5668
5679
|
button.onPaymentInReview().then((data) => console.log('Payment in fraud review'));
|
|
5669
5680
|
```
|
|
5670
|
-
<a name="WalletButtons+onPaymentError" id="WalletButtons+onPaymentError"
|
|
5681
|
+
<a name="WalletButtons+onPaymentError" id="WalletButtons+onPaymentError"></a>
|
|
5671
5682
|
|
|
5672
5683
|
### walletButtons.onPaymentError([handler])
|
|
5673
5684
|
If the payment was not successful, the function passed as parameter will be called.
|
|
@@ -5689,7 +5700,7 @@ button.onPaymentError((err) => {
|
|
|
5689
5700
|
```js
|
|
5690
5701
|
button.onPaymentError().then((err) => console.log('Payment not successful'));
|
|
5691
5702
|
```
|
|
5692
|
-
<a name="EVENT" id="EVENT"
|
|
5703
|
+
<a name="EVENT" id="EVENT"></a>
|
|
5693
5704
|
|
|
5694
5705
|
## EVENT : <code>object</code>
|
|
5695
5706
|
List of available event's name in the wallet button lifecycle
|
|
@@ -5979,7 +5990,7 @@ button.setStyles({"primary_color":"#a83232","button_text_color":"#171e9c","font_
|
|
|
5979
5990
|
</dd>
|
|
5980
5991
|
</dl>
|
|
5981
5992
|
|
|
5982
|
-
<a name="IVisaSRCMeta" id="IVisaSRCMeta"
|
|
5993
|
+
<a name="IVisaSRCMeta" id="IVisaSRCMeta"></a>
|
|
5983
5994
|
|
|
5984
5995
|
## IVisaSRCMeta : <code>object</code>
|
|
5985
5996
|
Interface of data used for the Visa Checkout.
|
|
@@ -6030,7 +6041,7 @@ Interface of data used for the Visa Checkout.
|
|
|
6030
6041
|
| [customer.payment_source.address_state] | <code>string</code> | Customer billing address state code (if applicable for the country, example "FL" for Florida). |
|
|
6031
6042
|
| [customer.payment_source.address_country] | <code>string</code> | Customer billing address country code (example "US"). |
|
|
6032
6043
|
|
|
6033
|
-
<a name="SRC" id="SRC"
|
|
6044
|
+
<a name="SRC" id="SRC"></a>
|
|
6034
6045
|
|
|
6035
6046
|
## SRC
|
|
6036
6047
|
Class SRC include methods for interacting with different secure remote commerce options such as Visa SRC
|
|
@@ -6051,7 +6062,7 @@ Class SRC include methods for interacting with different secure remote commerce
|
|
|
6051
6062
|
* [.reload()](#SRC+reload)
|
|
6052
6063
|
* [.useAutoResize()](#SRC+useAutoResize)
|
|
6053
6064
|
|
|
6054
|
-
<a name="new_SRC_new" id="new_SRC_new"
|
|
6065
|
+
<a name="new_SRC_new" id="new_SRC_new"></a>
|
|
6055
6066
|
|
|
6056
6067
|
### new exports.SRC(button_selector, iframe_selector, service_id, public_key_or_access_token, meta)
|
|
6057
6068
|
|
|
@@ -6067,7 +6078,7 @@ Class SRC include methods for interacting with different secure remote commerce
|
|
|
6067
6078
|
```js
|
|
6068
6079
|
var SRC = new SRC('#checkoutButton', '#checkoutIframe', 'service_id', 'public_key', {});
|
|
6069
6080
|
```
|
|
6070
|
-
<a name="SRC+setStyles" id="SRC+setStyles"
|
|
6081
|
+
<a name="SRC+setStyles" id="SRC+setStyles"></a>
|
|
6071
6082
|
|
|
6072
6083
|
### srC.setStyles(fields)
|
|
6073
6084
|
Object contain styles for widget - call before `.load()`.
|
|
@@ -6087,13 +6098,13 @@ widget.setStyles({
|
|
|
6087
6098
|
card_schemes: ['visa']
|
|
6088
6099
|
});
|
|
6089
6100
|
```
|
|
6090
|
-
<a name="SRC+load" id="SRC+load"
|
|
6101
|
+
<a name="SRC+load" id="SRC+load"></a>
|
|
6091
6102
|
|
|
6092
6103
|
### srC.load()
|
|
6093
6104
|
The final method after configuring the SRC to start the load process of SRC checkout
|
|
6094
6105
|
|
|
6095
6106
|
**Kind**: instance method of [<code>SRC</code>](#SRC)
|
|
6096
|
-
<a name="SRC+setEnv" id="SRC+setEnv"
|
|
6107
|
+
<a name="SRC+setEnv" id="SRC+setEnv"></a>
|
|
6097
6108
|
|
|
6098
6109
|
### srC.setEnv(env, [alias])
|
|
6099
6110
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -6110,7 +6121,7 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
6110
6121
|
```js
|
|
6111
6122
|
SRC.setEnv('production');
|
|
6112
6123
|
```
|
|
6113
|
-
<a name="SRC+getEnv" id="SRC+getEnv"
|
|
6124
|
+
<a name="SRC+getEnv" id="SRC+getEnv"></a>
|
|
6114
6125
|
|
|
6115
6126
|
### srC.getEnv()
|
|
6116
6127
|
Method to read the current environment
|
|
@@ -6120,7 +6131,7 @@ Method to read the current environment
|
|
|
6120
6131
|
```js
|
|
6121
6132
|
SRC.getEnv();
|
|
6122
6133
|
```
|
|
6123
|
-
<a name="SRC+on" id="SRC+on"
|
|
6134
|
+
<a name="SRC+on" id="SRC+on"></a>
|
|
6124
6135
|
|
|
6125
6136
|
### srC.on(eventName, [cb]) ⇒ <code>Promise.<any></code> \| <code>void</code>
|
|
6126
6137
|
Listen to events of SRC
|
|
@@ -6142,7 +6153,7 @@ SRC.on('checkoutCompleted').then(function (token) {
|
|
|
6142
6153
|
console.log(token);
|
|
6143
6154
|
});
|
|
6144
6155
|
```
|
|
6145
|
-
<a name="SRC+hideButton" id="SRC+hideButton"
|
|
6156
|
+
<a name="SRC+hideButton" id="SRC+hideButton"></a>
|
|
6146
6157
|
|
|
6147
6158
|
### srC.hideButton([saveSize])
|
|
6148
6159
|
Using this method you can hide button
|
|
@@ -6157,7 +6168,7 @@ Using this method you can hide button
|
|
|
6157
6168
|
```js
|
|
6158
6169
|
SRC.hideButton();
|
|
6159
6170
|
```
|
|
6160
|
-
<a name="SRC+showButton" id="SRC+showButton"
|
|
6171
|
+
<a name="SRC+showButton" id="SRC+showButton"></a>
|
|
6161
6172
|
|
|
6162
6173
|
### srC.showButton()
|
|
6163
6174
|
Using this method you can show the SRC button after using hideButton method
|
|
@@ -6167,7 +6178,7 @@ Using this method you can show the SRC button after using hideButton method
|
|
|
6167
6178
|
```js
|
|
6168
6179
|
SRC.showButton();
|
|
6169
6180
|
```
|
|
6170
|
-
<a name="SRC+hideCheckout" id="SRC+hideCheckout"
|
|
6181
|
+
<a name="SRC+hideCheckout" id="SRC+hideCheckout"></a>
|
|
6171
6182
|
|
|
6172
6183
|
### srC.hideCheckout([saveSize])
|
|
6173
6184
|
Using this method you can hide checkout after load and button click
|
|
@@ -6182,7 +6193,7 @@ Using this method you can hide checkout after load and button click
|
|
|
6182
6193
|
```js
|
|
6183
6194
|
SRC.hideCheckout();
|
|
6184
6195
|
```
|
|
6185
|
-
<a name="SRC+showCheckout" id="SRC+showCheckout"
|
|
6196
|
+
<a name="SRC+showCheckout" id="SRC+showCheckout"></a>
|
|
6186
6197
|
|
|
6187
6198
|
### srC.showCheckout()
|
|
6188
6199
|
Using this method you can show checkout after using hideCheckout method
|
|
@@ -6192,7 +6203,7 @@ Using this method you can show checkout after using hideCheckout method
|
|
|
6192
6203
|
```js
|
|
6193
6204
|
SRC.showCheckout()
|
|
6194
6205
|
```
|
|
6195
|
-
<a name="SRC+reload" id="SRC+reload"
|
|
6206
|
+
<a name="SRC+reload" id="SRC+reload"></a>
|
|
6196
6207
|
|
|
6197
6208
|
### srC.reload()
|
|
6198
6209
|
Using this method you can reload the whole checkout
|
|
@@ -6202,7 +6213,7 @@ Using this method you can reload the whole checkout
|
|
|
6202
6213
|
```js
|
|
6203
6214
|
SRC.reload()
|
|
6204
6215
|
```
|
|
6205
|
-
<a name="SRC+useAutoResize" id="SRC+useAutoResize"
|
|
6216
|
+
<a name="SRC+useAutoResize" id="SRC+useAutoResize"></a>
|
|
6206
6217
|
|
|
6207
6218
|
### srC.useAutoResize()
|
|
6208
6219
|
Use this method for resize checkout iFrame according to content height, if applicable
|
|
@@ -6212,7 +6223,7 @@ Use this method for resize checkout iFrame according to content height, if appli
|
|
|
6212
6223
|
```js
|
|
6213
6224
|
SRC.useAutoResize();
|
|
6214
6225
|
```
|
|
6215
|
-
<a name="EVENT" id="EVENT"
|
|
6226
|
+
<a name="EVENT" id="EVENT"></a>
|
|
6216
6227
|
|
|
6217
6228
|
## EVENT : <code>enum</code>
|
|
6218
6229
|
List of available event's name in the SRC checkout lifecycle
|