@paydock/client-sdk 1.11.8 → 1.11.9-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 +251 -251
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -335,7 +335,7 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
335
335
|
</dd>
|
|
336
336
|
</dl>
|
|
337
337
|
|
|
338
|
-
<a name="w_IFormValidation" id="w_IFormValidation"
|
|
338
|
+
<a name="w_IFormValidation" id="w_IFormValidation" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="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" class="anchor" aria-hidden="true" href="ITriggerData"> </a>
|
|
588
588
|
|
|
589
589
|
## ITriggerData
|
|
590
590
|
Interface for classes that represent a trigger data.
|
|
@@ -598,7 +598,7 @@ 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" class="anchor" aria-hidden="true" href="HtmlWidget"> </a>
|
|
602
602
|
|
|
603
603
|
## HtmlWidget ⇐ [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
604
604
|
Class Widget include method for working on html and include extended by HtmlMultiWidget methods
|
|
@@ -648,7 +648,7 @@ Class Widget include method for working on html and include extended by HtmlMult
|
|
|
648
648
|
* [.loadIFrameUrl()](#w_MultiWidget+loadIFrameUrl)
|
|
649
649
|
* [.setLanguage(code)](#w_MultiWidget+setLanguage)
|
|
650
650
|
|
|
651
|
-
<a name="w_new_HtmlWidget_new" id="w_new_HtmlWidget_new"
|
|
651
|
+
<a name="w_new_HtmlWidget_new" id="w_new_HtmlWidget_new" class="anchor" aria-hidden="true" href="new_HtmlWidget_new"> </a>
|
|
652
652
|
|
|
653
653
|
### new exports.HtmlWidget(selector, publicKey, [gatewayID], [paymentType], [purpose])
|
|
654
654
|
|
|
@@ -669,7 +669,7 @@ var widget = new HtmlWidget('#widget', 'publicKey', 'gatewayID', 'bank_account',
|
|
|
669
669
|
|
|
670
670
|
var widget = new HtmlWidget('#widget', 'publicKey', 'not_configured'); // without gateway
|
|
671
671
|
```
|
|
672
|
-
<a name="w_HtmlWidget+setWebHookDestination" id="w_HtmlWidget+setWebHookDestination"
|
|
672
|
+
<a name="w_HtmlWidget+setWebHookDestination" id="w_HtmlWidget+setWebHookDestination" class="anchor" aria-hidden="true" href="HtmlWidget+setWebHookDestination"> </a>
|
|
673
673
|
|
|
674
674
|
### htmlWidget.setWebHookDestination(url)
|
|
675
675
|
Destination, where customer will receive all successful responses.
|
|
@@ -686,7 +686,7 @@ Response will contain “data” object with “payment_source” or other param
|
|
|
686
686
|
```javascript
|
|
687
687
|
widget.setWebHookDestination('http://google.com');
|
|
688
688
|
```
|
|
689
|
-
<a name="w_HtmlWidget+setSuccessRedirectUrl" id="w_HtmlWidget+setSuccessRedirectUrl"
|
|
689
|
+
<a name="w_HtmlWidget+setSuccessRedirectUrl" id="w_HtmlWidget+setSuccessRedirectUrl" class="anchor" aria-hidden="true" href="HtmlWidget+setSuccessRedirectUrl"> </a>
|
|
690
690
|
|
|
691
691
|
### htmlWidget.setSuccessRedirectUrl(url)
|
|
692
692
|
URL to which the Customer will be redirected to after the success finish
|
|
@@ -702,7 +702,7 @@ URL to which the Customer will be redirected to after the success finish
|
|
|
702
702
|
```javascript
|
|
703
703
|
widget.setSuccessRedirectUrl('google.com/search?q=success');
|
|
704
704
|
```
|
|
705
|
-
<a name="w_HtmlWidget+setErrorRedirectUrl" id="w_HtmlWidget+setErrorRedirectUrl"
|
|
705
|
+
<a name="w_HtmlWidget+setErrorRedirectUrl" id="w_HtmlWidget+setErrorRedirectUrl" class="anchor" aria-hidden="true" href="HtmlWidget+setErrorRedirectUrl"> </a>
|
|
706
706
|
|
|
707
707
|
### htmlWidget.setErrorRedirectUrl(url)
|
|
708
708
|
URL to which the Customer will be redirected to if an error is triggered in the process of operation
|
|
@@ -718,7 +718,7 @@ URL to which the Customer will be redirected to if an error is triggered in the
|
|
|
718
718
|
```javascript
|
|
719
719
|
widget.setErrorRedirectUrl('google.com/search?q=error');
|
|
720
720
|
```
|
|
721
|
-
<a name="w_HtmlWidget+setFormFields" id="w_HtmlWidget+setFormFields"
|
|
721
|
+
<a name="w_HtmlWidget+setFormFields" id="w_HtmlWidget+setFormFields" class="anchor" aria-hidden="true" href="HtmlWidget+setFormFields"> </a>
|
|
722
722
|
|
|
723
723
|
### htmlWidget.setFormFields(fields)
|
|
724
724
|
Set list with widget form field, which will be shown in form. Also you can set the required validation for these fields
|
|
@@ -734,7 +734,7 @@ Set list with widget form field, which will be shown in form. Also you can set t
|
|
|
734
734
|
```javascript
|
|
735
735
|
widget.setFormFields(['phone', 'email', 'first_name*']);
|
|
736
736
|
```
|
|
737
|
-
<a name="w_HtmlWidget+setFormElements" id="w_HtmlWidget+setFormElements"
|
|
737
|
+
<a name="w_HtmlWidget+setFormElements" id="w_HtmlWidget+setFormElements" class="anchor" aria-hidden="true" href="HtmlWidget+setFormElements"> </a>
|
|
738
738
|
|
|
739
739
|
### htmlWidget.setFormElements(elements)
|
|
740
740
|
The method to set the full configuration for the all specific form elements (visibility, required, label, placeholder, value)
|
|
@@ -769,7 +769,7 @@ widget.setFormElements([
|
|
|
769
769
|
},
|
|
770
770
|
])
|
|
771
771
|
```
|
|
772
|
-
<a name="w_HtmlWidget+setMeta" id="w_HtmlWidget+setMeta"
|
|
772
|
+
<a name="w_HtmlWidget+setMeta" id="w_HtmlWidget+setMeta" class="anchor" aria-hidden="true" href="HtmlWidget+setMeta"> </a>
|
|
773
773
|
|
|
774
774
|
### htmlWidget.setMeta(object)
|
|
775
775
|
The method to set meta information for the checkout page
|
|
@@ -789,13 +789,13 @@ config.setMeta({
|
|
|
789
789
|
email: 'wault@paydock.com'
|
|
790
790
|
});
|
|
791
791
|
```
|
|
792
|
-
<a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load"
|
|
792
|
+
<a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load" class="anchor" aria-hidden="true" href="HtmlMultiWidget+load"> </a>
|
|
793
793
|
|
|
794
794
|
### htmlWidget.load()
|
|
795
795
|
The final method to beginning, the load process of widget to html
|
|
796
796
|
|
|
797
797
|
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
798
|
-
<a name="w_HtmlMultiWidget+on" id="w_HtmlMultiWidget+on"
|
|
798
|
+
<a name="w_HtmlMultiWidget+on" id="w_HtmlMultiWidget+on" class="anchor" aria-hidden="true" href="HtmlMultiWidget+on"> </a>
|
|
799
799
|
|
|
800
800
|
### htmlWidget.on(eventName, [cb]) ⇒ <code>Promise.<(IEventData\|IEventMetaData\|IEventFinishData\|IFormValidation)></code> \| <code>void</code>
|
|
801
801
|
Listen to events of widget
|
|
@@ -818,7 +818,7 @@ widget.on('form_submit', function (data) {
|
|
|
818
818
|
console.log(data);
|
|
819
819
|
});
|
|
820
820
|
```
|
|
821
|
-
<a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger"
|
|
821
|
+
<a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger" class="anchor" aria-hidden="true" href="HtmlMultiWidget+trigger"> </a>
|
|
822
822
|
|
|
823
823
|
### htmlWidget.trigger(triggers, data)
|
|
824
824
|
This callback will be called for every trigger
|
|
@@ -830,21 +830,21 @@ This callback will be called for every trigger
|
|
|
830
830
|
| triggers | <code>triggerName</code> | submit_form, tab |
|
|
831
831
|
| data | [<code>ITriggerData</code>](#w_ITriggerData) | which will be sending to widget |
|
|
832
832
|
|
|
833
|
-
<a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState"
|
|
833
|
+
<a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState" class="anchor" aria-hidden="true" href="HtmlMultiWidget+getValidationState"> </a>
|
|
834
834
|
|
|
835
835
|
### htmlWidget.getValidationState() ⇒ [<code>IFormValidation</code>](#w_IFormValidation)
|
|
836
836
|
Using this method you can get validation state information
|
|
837
837
|
|
|
838
838
|
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
839
839
|
**Returns**: [<code>IFormValidation</code>](#w_IFormValidation) - Form validation object
|
|
840
|
-
<a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm"
|
|
840
|
+
<a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm" class="anchor" aria-hidden="true" href="HtmlMultiWidget+isValidForm"> </a>
|
|
841
841
|
|
|
842
842
|
### htmlWidget.isValidForm() ⇒ <code>boolean</code>
|
|
843
843
|
Using this method you can check if the form is valid
|
|
844
844
|
|
|
845
845
|
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
846
846
|
**Returns**: <code>boolean</code> - Form is valid
|
|
847
|
-
<a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField"
|
|
847
|
+
<a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField" class="anchor" aria-hidden="true" href="HtmlMultiWidget+isInvalidField"> </a>
|
|
848
848
|
|
|
849
849
|
### htmlWidget.isInvalidField(field) ⇒ <code>boolean</code>
|
|
850
850
|
Using this method you can check if a specific form field is invalid
|
|
@@ -856,7 +856,7 @@ Using this method you can check if a specific form field is invalid
|
|
|
856
856
|
| --- | --- | --- |
|
|
857
857
|
| field | <code>string</code> | Field name |
|
|
858
858
|
|
|
859
|
-
<a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed"
|
|
859
|
+
<a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed" class="anchor" aria-hidden="true" href="HtmlMultiWidget+isFieldErrorShowed"> </a>
|
|
860
860
|
|
|
861
861
|
### htmlWidget.isFieldErrorShowed(field) ⇒ <code>boolean</code>
|
|
862
862
|
Using this method you can check if an error is displayed on a specific field
|
|
@@ -868,7 +868,7 @@ Using this method you can check if an error is displayed on a specific field
|
|
|
868
868
|
| --- | --- | --- |
|
|
869
869
|
| field | <code>string</code> | Field name |
|
|
870
870
|
|
|
871
|
-
<a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator"
|
|
871
|
+
<a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator" class="anchor" aria-hidden="true" href="HtmlMultiWidget+isInvalidFieldByValidator"> </a>
|
|
872
872
|
|
|
873
873
|
### htmlWidget.isInvalidFieldByValidator(field, validator) ⇒ <code>boolean</code>
|
|
874
874
|
Using this method you can check if a specific field is invalid
|
|
@@ -881,7 +881,7 @@ Using this method you can check if a specific field is invalid
|
|
|
881
881
|
| field | <code>string</code> | Field name |
|
|
882
882
|
| validator | <code>string</code> | Validator name. Available validators: `required, cardNumberValidator, expireDateValidation` |
|
|
883
883
|
|
|
884
|
-
<a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide"
|
|
884
|
+
<a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide" class="anchor" aria-hidden="true" href="HtmlMultiWidget+hide"> </a>
|
|
885
885
|
|
|
886
886
|
### htmlWidget.hide([saveSize])
|
|
887
887
|
Using this method you can hide widget after load
|
|
@@ -892,19 +892,19 @@ Using this method you can hide widget after load
|
|
|
892
892
|
| --- | --- | --- | --- |
|
|
893
893
|
| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size |
|
|
894
894
|
|
|
895
|
-
<a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show"
|
|
895
|
+
<a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show" class="anchor" aria-hidden="true" href="HtmlMultiWidget+show"> </a>
|
|
896
896
|
|
|
897
897
|
### htmlWidget.show()
|
|
898
898
|
Using this method you can show widget after using hide method
|
|
899
899
|
|
|
900
900
|
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
901
|
-
<a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload"
|
|
901
|
+
<a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload" class="anchor" aria-hidden="true" href="HtmlMultiWidget+reload"> </a>
|
|
902
902
|
|
|
903
903
|
### htmlWidget.reload()
|
|
904
904
|
Using this method you can reload widget
|
|
905
905
|
|
|
906
906
|
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
907
|
-
<a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements"
|
|
907
|
+
<a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements" class="anchor" aria-hidden="true" href="HtmlMultiWidget+hideElements"> </a>
|
|
908
908
|
|
|
909
909
|
### htmlWidget.hideElements(elements)
|
|
910
910
|
Using this method you can hide any elements inside widget
|
|
@@ -920,7 +920,7 @@ Using this method you can hide any elements inside widget
|
|
|
920
920
|
```javascript
|
|
921
921
|
widget.hideElements(['submit_button', 'email']);
|
|
922
922
|
```
|
|
923
|
-
<a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements"
|
|
923
|
+
<a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements" class="anchor" aria-hidden="true" href="HtmlMultiWidget+showElements"> </a>
|
|
924
924
|
|
|
925
925
|
### htmlWidget.showElements(elements)
|
|
926
926
|
Using this method you can show any elements inside widget
|
|
@@ -934,7 +934,7 @@ widget.showElements(['submit_button', 'email']);
|
|
|
934
934
|
| --- | --- | --- |
|
|
935
935
|
| elements | <code>[ 'Array' ].<string></code> | list of element which can be showed [ELEMENT](#w_ELEMENT) || [FORM_FIELD](#w_FORM_FIELD) |
|
|
936
936
|
|
|
937
|
-
<a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues"
|
|
937
|
+
<a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues" class="anchor" aria-hidden="true" href="HtmlMultiWidget+updateFormValues"> </a>
|
|
938
938
|
|
|
939
939
|
### htmlWidget.updateFormValues(fieldValues)
|
|
940
940
|
Method for update values for form fields inside the widget
|
|
@@ -953,7 +953,7 @@ widget.updateFormValues({
|
|
|
953
953
|
card_name: 'Houston'
|
|
954
954
|
});
|
|
955
955
|
```
|
|
956
|
-
<a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert"
|
|
956
|
+
<a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert" class="anchor" aria-hidden="true" href="HtmlMultiWidget+onFinishInsert"> </a>
|
|
957
957
|
|
|
958
958
|
### htmlWidget.onFinishInsert(selector, dataType)
|
|
959
959
|
After finish event of widget, data (dataType) will be insert to input (selector)
|
|
@@ -965,7 +965,7 @@ After finish event of widget, data (dataType) will be insert to input (selector)
|
|
|
965
965
|
| selector | <code>string</code> | css selector . [] # |
|
|
966
966
|
| dataType | <code>string</code> | data type of IEventData object. |
|
|
967
967
|
|
|
968
|
-
<a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm"
|
|
968
|
+
<a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm" class="anchor" aria-hidden="true" href="HtmlMultiWidget+interceptSubmitForm"> </a>
|
|
969
969
|
|
|
970
970
|
### htmlWidget.interceptSubmitForm(selector)
|
|
971
971
|
Widget will intercept submit of your form for processing widget
|
|
@@ -992,13 +992,13 @@ Process: click by submit button in your form --> submit widget ---> submit your
|
|
|
992
992
|
widget.interceptSubmitForm('#myForm');
|
|
993
993
|
</script>
|
|
994
994
|
```
|
|
995
|
-
<a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit"
|
|
995
|
+
<a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit" class="anchor" aria-hidden="true" href="HtmlMultiWidget+useCheckoutAutoSubmit"> </a>
|
|
996
996
|
|
|
997
997
|
### htmlWidget.useCheckoutAutoSubmit()
|
|
998
998
|
This method hides a submit button and automatically execute form submit
|
|
999
999
|
|
|
1000
1000
|
**Kind**: instance method of [<code>HtmlWidget</code>](#w_HtmlWidget)
|
|
1001
|
-
<a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize"
|
|
1001
|
+
<a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize" class="anchor" aria-hidden="true" href="HtmlMultiWidget+useAutoResize"> </a>
|
|
1002
1002
|
|
|
1003
1003
|
### htmlWidget.useAutoResize()
|
|
1004
1004
|
Use this method for resize iFrame according content height
|
|
@@ -1009,7 +1009,7 @@ Use this method for resize iFrame according content height
|
|
|
1009
1009
|
```javascript
|
|
1010
1010
|
widget.useAutoResize();
|
|
1011
1011
|
```
|
|
1012
|
-
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles"
|
|
1012
|
+
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles" class="anchor" aria-hidden="true" href="MultiWidget+setStyles"> </a>
|
|
1013
1013
|
|
|
1014
1014
|
### htmlWidget.setStyles(fields)
|
|
1015
1015
|
Object contain styles for widget
|
|
@@ -1032,7 +1032,7 @@ widget.setStyles({
|
|
|
1032
1032
|
fort_family: 'fantasy'
|
|
1033
1033
|
});
|
|
1034
1034
|
```
|
|
1035
|
-
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask"
|
|
1035
|
+
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask" class="anchor" aria-hidden="true" href="MultiWidget+usePhoneCountryMask"> </a>
|
|
1036
1036
|
|
|
1037
1037
|
### htmlWidget.usePhoneCountryMask([options])
|
|
1038
1038
|
Method to set a country code mask for the phone input.
|
|
@@ -1060,7 +1060,7 @@ widget.usePhoneCountryMask({
|
|
|
1060
1060
|
only_countries: ['au', 'gb', 'us', 'ua']
|
|
1061
1061
|
});
|
|
1062
1062
|
```
|
|
1063
|
-
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts"
|
|
1063
|
+
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts" class="anchor" aria-hidden="true" href="MultiWidget+setTexts"> </a>
|
|
1064
1064
|
|
|
1065
1065
|
### htmlWidget.setTexts(fields)
|
|
1066
1066
|
Method for set different texts inside the widget
|
|
@@ -1082,7 +1082,7 @@ widget.setTexts({
|
|
|
1082
1082
|
submit_button_processing: 'Load...',
|
|
1083
1083
|
});
|
|
1084
1084
|
```
|
|
1085
|
-
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle"
|
|
1085
|
+
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle" class="anchor" aria-hidden="true" href="MultiWidget+setElementStyle"> </a>
|
|
1086
1086
|
|
|
1087
1087
|
### htmlWidget.setElementStyle(element, [state], styles)
|
|
1088
1088
|
Method for set styles for different elements and states
|
|
@@ -1110,7 +1110,7 @@ widget.setElementStyle('input', 'error', {
|
|
|
1110
1110
|
border: 'red solid 1px'
|
|
1111
1111
|
});
|
|
1112
1112
|
```
|
|
1113
|
-
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues"
|
|
1113
|
+
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues" class="anchor" aria-hidden="true" href="MultiWidget+setFormValues"> </a>
|
|
1114
1114
|
|
|
1115
1115
|
### htmlWidget.setFormValues(fieldValues)
|
|
1116
1116
|
The method to set the predefined values for the form fields inside the widget
|
|
@@ -1129,7 +1129,7 @@ widget.setFormValues({
|
|
|
1129
1129
|
card_name: 'Houston'
|
|
1130
1130
|
});
|
|
1131
1131
|
```
|
|
1132
|
-
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels"
|
|
1132
|
+
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels" class="anchor" aria-hidden="true" href="MultiWidget+setFormLabels"> </a>
|
|
1133
1133
|
|
|
1134
1134
|
### htmlWidget.setFormLabels(fieldLabels)
|
|
1135
1135
|
The method to set custom form field labels
|
|
@@ -1148,7 +1148,7 @@ widget.setFormPlaceholders({
|
|
|
1148
1148
|
email: 'Email For Receipt'
|
|
1149
1149
|
})
|
|
1150
1150
|
```
|
|
1151
|
-
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders"
|
|
1151
|
+
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders" class="anchor" aria-hidden="true" href="MultiWidget+setFormPlaceholders"> </a>
|
|
1152
1152
|
|
|
1153
1153
|
### htmlWidget.setFormPlaceholders(fieldPlaceholders)
|
|
1154
1154
|
The method to set custom form fields placeholders
|
|
@@ -1167,7 +1167,7 @@ widget.setFormPlaceholders({
|
|
|
1167
1167
|
email: 'Input your email, like test@example.com'
|
|
1168
1168
|
})
|
|
1169
1169
|
```
|
|
1170
|
-
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons"
|
|
1170
|
+
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons" class="anchor" aria-hidden="true" href="MultiWidget+setIcons"> </a>
|
|
1171
1171
|
|
|
1172
1172
|
### htmlWidget.setIcons()
|
|
1173
1173
|
The method to change the widget icons
|
|
@@ -1177,7 +1177,7 @@ The method to change the widget icons
|
|
|
1177
1177
|
|
|
1178
1178
|
- [ ] DEPRECATED
|
|
1179
1179
|
|
|
1180
|
-
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements"
|
|
1180
|
+
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements" class="anchor" aria-hidden="true" href="MultiWidget+setHiddenElements"> </a>
|
|
1181
1181
|
|
|
1182
1182
|
### htmlWidget.setHiddenElements(elements)
|
|
1183
1183
|
Using this method you can set hidden elements inside widget
|
|
@@ -1193,7 +1193,7 @@ Using this method you can set hidden elements inside widget
|
|
|
1193
1193
|
```javascript
|
|
1194
1194
|
widget.setHiddenElements(['submit_button', 'email']);
|
|
1195
1195
|
```
|
|
1196
|
-
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId"
|
|
1196
|
+
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId" class="anchor" aria-hidden="true" href="MultiWidget+setRefId"> </a>
|
|
1197
1197
|
|
|
1198
1198
|
### htmlWidget.setRefId(refId)
|
|
1199
1199
|
Current method can set custom ID to identify the data in the future
|
|
@@ -1209,7 +1209,7 @@ Current method can set custom ID to identify the data in the future
|
|
|
1209
1209
|
```javascript
|
|
1210
1210
|
widget.setRefId('id');
|
|
1211
1211
|
```
|
|
1212
|
-
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation"
|
|
1212
|
+
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation" class="anchor" aria-hidden="true" href="MultiWidget+useGatewayFieldValidation"> </a>
|
|
1213
1213
|
|
|
1214
1214
|
### htmlWidget.useGatewayFieldValidation()
|
|
1215
1215
|
Current method can add visual validation from gateway to widget's form fields
|
|
@@ -1220,7 +1220,7 @@ Current method can add visual validation from gateway to widget's form fields
|
|
|
1220
1220
|
```javascript
|
|
1221
1221
|
widget.useGatewayFieldValidation();
|
|
1222
1222
|
```
|
|
1223
|
-
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons"
|
|
1223
|
+
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons" class="anchor" aria-hidden="true" href="MultiWidget+setSupportedCardIcons"> </a>
|
|
1224
1224
|
|
|
1225
1225
|
### htmlWidget.setSupportedCardIcons(elements, validateCardNumberInput)
|
|
1226
1226
|
Current method can set icons of supported card types
|
|
@@ -1237,7 +1237,7 @@ Current method can set icons of supported card types
|
|
|
1237
1237
|
```javascript
|
|
1238
1238
|
widget.setSupportedCardIcons(['mastercard', 'visa'], validateCardNumberInput);
|
|
1239
1239
|
```
|
|
1240
|
-
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv"
|
|
1240
|
+
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv" class="anchor" aria-hidden="true" href="MultiWidget+setEnv"> </a>
|
|
1241
1241
|
|
|
1242
1242
|
### htmlWidget.setEnv(env, [alias])
|
|
1243
1243
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -1255,7 +1255,7 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
1255
1255
|
```javascript
|
|
1256
1256
|
widget.setEnv('production', 'paydock.com');
|
|
1257
1257
|
```
|
|
1258
|
-
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl"
|
|
1258
|
+
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl" class="anchor" aria-hidden="true" href="MultiWidget+loadIFrameUrl"> </a>
|
|
1259
1259
|
|
|
1260
1260
|
### htmlWidget.loadIFrameUrl()
|
|
1261
1261
|
Method for creating iframe url
|
|
@@ -1270,7 +1270,7 @@ widget.loadIFrameUrl(function (url) {
|
|
|
1270
1270
|
console.log(errors);
|
|
1271
1271
|
});
|
|
1272
1272
|
```
|
|
1273
|
-
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage"
|
|
1273
|
+
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage" class="anchor" aria-hidden="true" href="MultiWidget+setLanguage"> </a>
|
|
1274
1274
|
|
|
1275
1275
|
### htmlWidget.setLanguage(code)
|
|
1276
1276
|
Method for setting a custom language code
|
|
@@ -1286,7 +1286,7 @@ Method for setting a custom language code
|
|
|
1286
1286
|
```javascript
|
|
1287
1287
|
config.setLanguage('en');
|
|
1288
1288
|
```
|
|
1289
|
-
<a name="w_HtmlMultiWidget" id="w_HtmlMultiWidget"
|
|
1289
|
+
<a name="w_HtmlMultiWidget" id="w_HtmlMultiWidget" class="anchor" aria-hidden="true" href="HtmlMultiWidget"> </a>
|
|
1290
1290
|
|
|
1291
1291
|
## HtmlMultiWidget ⇐ [<code>MultiWidget</code>](#w_MultiWidget)
|
|
1292
1292
|
Class HtmlMultiWidget include method for working with html
|
|
@@ -1331,7 +1331,7 @@ Class HtmlMultiWidget include method for working with html
|
|
|
1331
1331
|
* [.loadIFrameUrl()](#w_MultiWidget+loadIFrameUrl)
|
|
1332
1332
|
* [.setLanguage(code)](#w_MultiWidget+setLanguage)
|
|
1333
1333
|
|
|
1334
|
-
<a name="w_new_HtmlMultiWidget_new" id="w_new_HtmlMultiWidget_new"
|
|
1334
|
+
<a name="w_new_HtmlMultiWidget_new" id="w_new_HtmlMultiWidget_new" class="anchor" aria-hidden="true" href="new_HtmlMultiWidget_new"> </a>
|
|
1335
1335
|
|
|
1336
1336
|
### new exports.HtmlMultiWidget(selector, publicKey, conf)
|
|
1337
1337
|
|
|
@@ -1357,13 +1357,13 @@ var widget = new MultiWidget('#widget', 'publicKey',[ With Configurations
|
|
|
1357
1357
|
Configuration('gatewayId', 'bank_account')
|
|
1358
1358
|
]);
|
|
1359
1359
|
```
|
|
1360
|
-
<a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load"
|
|
1360
|
+
<a name="w_HtmlMultiWidget+load" id="w_HtmlMultiWidget+load" class="anchor" aria-hidden="true" href="HtmlMultiWidget+load"> </a>
|
|
1361
1361
|
|
|
1362
1362
|
### htmlMultiWidget.load()
|
|
1363
1363
|
The final method to beginning, the load process of widget to html
|
|
1364
1364
|
|
|
1365
1365
|
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1366
|
-
<a name="w_HtmlMultiWidget+on" id="w_HtmlMultiWidget+on"
|
|
1366
|
+
<a name="w_HtmlMultiWidget+on" id="w_HtmlMultiWidget+on" class="anchor" aria-hidden="true" href="HtmlMultiWidget+on"> </a>
|
|
1367
1367
|
|
|
1368
1368
|
### htmlMultiWidget.on(eventName, [cb]) ⇒ <code>Promise.<(IEventData\|IEventMetaData\|IEventFinishData\|IFormValidation)></code> \| <code>void</code>
|
|
1369
1369
|
Listen to events of widget
|
|
@@ -1386,7 +1386,7 @@ widget.on('form_submit', function (data) {
|
|
|
1386
1386
|
console.log(data);
|
|
1387
1387
|
});
|
|
1388
1388
|
```
|
|
1389
|
-
<a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger"
|
|
1389
|
+
<a name="w_HtmlMultiWidget+trigger" id="w_HtmlMultiWidget+trigger" class="anchor" aria-hidden="true" href="HtmlMultiWidget+trigger"> </a>
|
|
1390
1390
|
|
|
1391
1391
|
### htmlMultiWidget.trigger(triggers, data)
|
|
1392
1392
|
This callback will be called for every trigger
|
|
@@ -1398,21 +1398,21 @@ This callback will be called for every trigger
|
|
|
1398
1398
|
| triggers | <code>triggerName</code> | submit_form, tab |
|
|
1399
1399
|
| data | [<code>ITriggerData</code>](#w_ITriggerData) | which will be sending to widget |
|
|
1400
1400
|
|
|
1401
|
-
<a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState"
|
|
1401
|
+
<a name="w_HtmlMultiWidget+getValidationState" id="w_HtmlMultiWidget+getValidationState" class="anchor" aria-hidden="true" href="HtmlMultiWidget+getValidationState"> </a>
|
|
1402
1402
|
|
|
1403
1403
|
### htmlMultiWidget.getValidationState() ⇒ [<code>IFormValidation</code>](#w_IFormValidation)
|
|
1404
1404
|
Using this method you can get validation state information
|
|
1405
1405
|
|
|
1406
1406
|
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1407
1407
|
**Returns**: [<code>IFormValidation</code>](#w_IFormValidation) - Form validation object
|
|
1408
|
-
<a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm"
|
|
1408
|
+
<a name="w_HtmlMultiWidget+isValidForm" id="w_HtmlMultiWidget+isValidForm" class="anchor" aria-hidden="true" href="HtmlMultiWidget+isValidForm"> </a>
|
|
1409
1409
|
|
|
1410
1410
|
### htmlMultiWidget.isValidForm() ⇒ <code>boolean</code>
|
|
1411
1411
|
Using this method you can check if the form is valid
|
|
1412
1412
|
|
|
1413
1413
|
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1414
1414
|
**Returns**: <code>boolean</code> - Form is valid
|
|
1415
|
-
<a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField"
|
|
1415
|
+
<a name="w_HtmlMultiWidget+isInvalidField" id="w_HtmlMultiWidget+isInvalidField" class="anchor" aria-hidden="true" href="HtmlMultiWidget+isInvalidField"> </a>
|
|
1416
1416
|
|
|
1417
1417
|
### htmlMultiWidget.isInvalidField(field) ⇒ <code>boolean</code>
|
|
1418
1418
|
Using this method you can check if a specific form field is invalid
|
|
@@ -1424,7 +1424,7 @@ Using this method you can check if a specific form field is invalid
|
|
|
1424
1424
|
| --- | --- | --- |
|
|
1425
1425
|
| field | <code>string</code> | Field name |
|
|
1426
1426
|
|
|
1427
|
-
<a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed"
|
|
1427
|
+
<a name="w_HtmlMultiWidget+isFieldErrorShowed" id="w_HtmlMultiWidget+isFieldErrorShowed" class="anchor" aria-hidden="true" href="HtmlMultiWidget+isFieldErrorShowed"> </a>
|
|
1428
1428
|
|
|
1429
1429
|
### htmlMultiWidget.isFieldErrorShowed(field) ⇒ <code>boolean</code>
|
|
1430
1430
|
Using this method you can check if an error is displayed on a specific field
|
|
@@ -1436,7 +1436,7 @@ Using this method you can check if an error is displayed on a specific field
|
|
|
1436
1436
|
| --- | --- | --- |
|
|
1437
1437
|
| field | <code>string</code> | Field name |
|
|
1438
1438
|
|
|
1439
|
-
<a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator"
|
|
1439
|
+
<a name="w_HtmlMultiWidget+isInvalidFieldByValidator" id="w_HtmlMultiWidget+isInvalidFieldByValidator" class="anchor" aria-hidden="true" href="HtmlMultiWidget+isInvalidFieldByValidator"> </a>
|
|
1440
1440
|
|
|
1441
1441
|
### htmlMultiWidget.isInvalidFieldByValidator(field, validator) ⇒ <code>boolean</code>
|
|
1442
1442
|
Using this method you can check if a specific field is invalid
|
|
@@ -1449,7 +1449,7 @@ Using this method you can check if a specific field is invalid
|
|
|
1449
1449
|
| field | <code>string</code> | Field name |
|
|
1450
1450
|
| validator | <code>string</code> | Validator name. Available validators: `required, cardNumberValidator, expireDateValidation` |
|
|
1451
1451
|
|
|
1452
|
-
<a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide"
|
|
1452
|
+
<a name="w_HtmlMultiWidget+hide" id="w_HtmlMultiWidget+hide" class="anchor" aria-hidden="true" href="HtmlMultiWidget+hide"> </a>
|
|
1453
1453
|
|
|
1454
1454
|
### htmlMultiWidget.hide([saveSize])
|
|
1455
1455
|
Using this method you can hide widget after load
|
|
@@ -1460,19 +1460,19 @@ Using this method you can hide widget after load
|
|
|
1460
1460
|
| --- | --- | --- | --- |
|
|
1461
1461
|
| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size |
|
|
1462
1462
|
|
|
1463
|
-
<a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show"
|
|
1463
|
+
<a name="w_HtmlMultiWidget+show" id="w_HtmlMultiWidget+show" class="anchor" aria-hidden="true" href="HtmlMultiWidget+show"> </a>
|
|
1464
1464
|
|
|
1465
1465
|
### htmlMultiWidget.show()
|
|
1466
1466
|
Using this method you can show widget after using hide method
|
|
1467
1467
|
|
|
1468
1468
|
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1469
|
-
<a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload"
|
|
1469
|
+
<a name="w_HtmlMultiWidget+reload" id="w_HtmlMultiWidget+reload" class="anchor" aria-hidden="true" href="HtmlMultiWidget+reload"> </a>
|
|
1470
1470
|
|
|
1471
1471
|
### htmlMultiWidget.reload()
|
|
1472
1472
|
Using this method you can reload widget
|
|
1473
1473
|
|
|
1474
1474
|
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1475
|
-
<a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements"
|
|
1475
|
+
<a name="w_HtmlMultiWidget+hideElements" id="w_HtmlMultiWidget+hideElements" class="anchor" aria-hidden="true" href="HtmlMultiWidget+hideElements"> </a>
|
|
1476
1476
|
|
|
1477
1477
|
### htmlMultiWidget.hideElements(elements)
|
|
1478
1478
|
Using this method you can hide any elements inside widget
|
|
@@ -1488,7 +1488,7 @@ Using this method you can hide any elements inside widget
|
|
|
1488
1488
|
```javascript
|
|
1489
1489
|
widget.hideElements(['submit_button', 'email']);
|
|
1490
1490
|
```
|
|
1491
|
-
<a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements"
|
|
1491
|
+
<a name="w_HtmlMultiWidget+showElements" id="w_HtmlMultiWidget+showElements" class="anchor" aria-hidden="true" href="HtmlMultiWidget+showElements"> </a>
|
|
1492
1492
|
|
|
1493
1493
|
### htmlMultiWidget.showElements(elements)
|
|
1494
1494
|
Using this method you can show any elements inside widget
|
|
@@ -1502,7 +1502,7 @@ widget.showElements(['submit_button', 'email']);
|
|
|
1502
1502
|
| --- | --- | --- |
|
|
1503
1503
|
| elements | <code>[ 'Array' ].<string></code> | list of element which can be showed [ELEMENT](#w_ELEMENT) || [FORM_FIELD](#w_FORM_FIELD) |
|
|
1504
1504
|
|
|
1505
|
-
<a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues"
|
|
1505
|
+
<a name="w_HtmlMultiWidget+updateFormValues" id="w_HtmlMultiWidget+updateFormValues" class="anchor" aria-hidden="true" href="HtmlMultiWidget+updateFormValues"> </a>
|
|
1506
1506
|
|
|
1507
1507
|
### htmlMultiWidget.updateFormValues(fieldValues)
|
|
1508
1508
|
Method for update values for form fields inside the widget
|
|
@@ -1521,7 +1521,7 @@ widget.updateFormValues({
|
|
|
1521
1521
|
card_name: 'Houston'
|
|
1522
1522
|
});
|
|
1523
1523
|
```
|
|
1524
|
-
<a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert"
|
|
1524
|
+
<a name="w_HtmlMultiWidget+onFinishInsert" id="w_HtmlMultiWidget+onFinishInsert" class="anchor" aria-hidden="true" href="HtmlMultiWidget+onFinishInsert"> </a>
|
|
1525
1525
|
|
|
1526
1526
|
### htmlMultiWidget.onFinishInsert(selector, dataType)
|
|
1527
1527
|
After finish event of widget, data (dataType) will be insert to input (selector)
|
|
@@ -1533,7 +1533,7 @@ After finish event of widget, data (dataType) will be insert to input (selector)
|
|
|
1533
1533
|
| selector | <code>string</code> | css selector . [] # |
|
|
1534
1534
|
| dataType | <code>string</code> | data type of IEventData object. |
|
|
1535
1535
|
|
|
1536
|
-
<a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm"
|
|
1536
|
+
<a name="w_HtmlMultiWidget+interceptSubmitForm" id="w_HtmlMultiWidget+interceptSubmitForm" class="anchor" aria-hidden="true" href="HtmlMultiWidget+interceptSubmitForm"> </a>
|
|
1537
1537
|
|
|
1538
1538
|
### htmlMultiWidget.interceptSubmitForm(selector)
|
|
1539
1539
|
Widget will intercept submit of your form for processing widget
|
|
@@ -1560,13 +1560,13 @@ Process: click by submit button in your form --> submit widget ---> submit your
|
|
|
1560
1560
|
widget.interceptSubmitForm('#myForm');
|
|
1561
1561
|
</script>
|
|
1562
1562
|
```
|
|
1563
|
-
<a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit"
|
|
1563
|
+
<a name="w_HtmlMultiWidget+useCheckoutAutoSubmit" id="w_HtmlMultiWidget+useCheckoutAutoSubmit" class="anchor" aria-hidden="true" href="HtmlMultiWidget+useCheckoutAutoSubmit"> </a>
|
|
1564
1564
|
|
|
1565
1565
|
### htmlMultiWidget.useCheckoutAutoSubmit()
|
|
1566
1566
|
This method hides a submit button and automatically execute form submit
|
|
1567
1567
|
|
|
1568
1568
|
**Kind**: instance method of [<code>HtmlMultiWidget</code>](#w_HtmlMultiWidget)
|
|
1569
|
-
<a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize"
|
|
1569
|
+
<a name="w_HtmlMultiWidget+useAutoResize" id="w_HtmlMultiWidget+useAutoResize" class="anchor" aria-hidden="true" href="HtmlMultiWidget+useAutoResize"> </a>
|
|
1570
1570
|
|
|
1571
1571
|
### htmlMultiWidget.useAutoResize()
|
|
1572
1572
|
Use this method for resize iFrame according content height
|
|
@@ -1577,7 +1577,7 @@ Use this method for resize iFrame according content height
|
|
|
1577
1577
|
```javascript
|
|
1578
1578
|
widget.useAutoResize();
|
|
1579
1579
|
```
|
|
1580
|
-
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles"
|
|
1580
|
+
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles" class="anchor" aria-hidden="true" href="MultiWidget+setStyles"> </a>
|
|
1581
1581
|
|
|
1582
1582
|
### htmlMultiWidget.setStyles(fields)
|
|
1583
1583
|
Object contain styles for widget
|
|
@@ -1600,7 +1600,7 @@ widget.setStyles({
|
|
|
1600
1600
|
fort_family: 'fantasy'
|
|
1601
1601
|
});
|
|
1602
1602
|
```
|
|
1603
|
-
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask"
|
|
1603
|
+
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask" class="anchor" aria-hidden="true" href="MultiWidget+usePhoneCountryMask"> </a>
|
|
1604
1604
|
|
|
1605
1605
|
### htmlMultiWidget.usePhoneCountryMask([options])
|
|
1606
1606
|
Method to set a country code mask for the phone input.
|
|
@@ -1628,7 +1628,7 @@ widget.usePhoneCountryMask({
|
|
|
1628
1628
|
only_countries: ['au', 'gb', 'us', 'ua']
|
|
1629
1629
|
});
|
|
1630
1630
|
```
|
|
1631
|
-
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts"
|
|
1631
|
+
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts" class="anchor" aria-hidden="true" href="MultiWidget+setTexts"> </a>
|
|
1632
1632
|
|
|
1633
1633
|
### htmlMultiWidget.setTexts(fields)
|
|
1634
1634
|
Method for set different texts inside the widget
|
|
@@ -1650,7 +1650,7 @@ widget.setTexts({
|
|
|
1650
1650
|
submit_button_processing: 'Load...',
|
|
1651
1651
|
});
|
|
1652
1652
|
```
|
|
1653
|
-
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle"
|
|
1653
|
+
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle" class="anchor" aria-hidden="true" href="MultiWidget+setElementStyle"> </a>
|
|
1654
1654
|
|
|
1655
1655
|
### htmlMultiWidget.setElementStyle(element, [state], styles)
|
|
1656
1656
|
Method for set styles for different elements and states
|
|
@@ -1678,7 +1678,7 @@ widget.setElementStyle('input', 'error', {
|
|
|
1678
1678
|
border: 'red solid 1px'
|
|
1679
1679
|
});
|
|
1680
1680
|
```
|
|
1681
|
-
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues"
|
|
1681
|
+
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues" class="anchor" aria-hidden="true" href="MultiWidget+setFormValues"> </a>
|
|
1682
1682
|
|
|
1683
1683
|
### htmlMultiWidget.setFormValues(fieldValues)
|
|
1684
1684
|
The method to set the predefined values for the form fields inside the widget
|
|
@@ -1697,7 +1697,7 @@ widget.setFormValues({
|
|
|
1697
1697
|
card_name: 'Houston'
|
|
1698
1698
|
});
|
|
1699
1699
|
```
|
|
1700
|
-
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels"
|
|
1700
|
+
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels" class="anchor" aria-hidden="true" href="MultiWidget+setFormLabels"> </a>
|
|
1701
1701
|
|
|
1702
1702
|
### htmlMultiWidget.setFormLabels(fieldLabels)
|
|
1703
1703
|
The method to set custom form field labels
|
|
@@ -1716,7 +1716,7 @@ widget.setFormPlaceholders({
|
|
|
1716
1716
|
email: 'Email For Receipt'
|
|
1717
1717
|
})
|
|
1718
1718
|
```
|
|
1719
|
-
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders"
|
|
1719
|
+
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders" class="anchor" aria-hidden="true" href="MultiWidget+setFormPlaceholders"> </a>
|
|
1720
1720
|
|
|
1721
1721
|
### htmlMultiWidget.setFormPlaceholders(fieldPlaceholders)
|
|
1722
1722
|
The method to set custom form fields placeholders
|
|
@@ -1735,7 +1735,7 @@ widget.setFormPlaceholders({
|
|
|
1735
1735
|
email: 'Input your email, like test@example.com'
|
|
1736
1736
|
})
|
|
1737
1737
|
```
|
|
1738
|
-
<a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements"
|
|
1738
|
+
<a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements" class="anchor" aria-hidden="true" href="MultiWidget+setFormElements"> </a>
|
|
1739
1739
|
|
|
1740
1740
|
### htmlMultiWidget.setFormElements(elements)
|
|
1741
1741
|
The method to set the full configuration for the all specific form elements (label, placeholder, value)
|
|
@@ -1769,7 +1769,7 @@ widget.setFormElements([
|
|
|
1769
1769
|
},
|
|
1770
1770
|
])
|
|
1771
1771
|
```
|
|
1772
|
-
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons"
|
|
1772
|
+
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons" class="anchor" aria-hidden="true" href="MultiWidget+setIcons"> </a>
|
|
1773
1773
|
|
|
1774
1774
|
### htmlMultiWidget.setIcons()
|
|
1775
1775
|
The method to change the widget icons
|
|
@@ -1779,7 +1779,7 @@ The method to change the widget icons
|
|
|
1779
1779
|
|
|
1780
1780
|
- [ ] DEPRECATED
|
|
1781
1781
|
|
|
1782
|
-
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements"
|
|
1782
|
+
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements" class="anchor" aria-hidden="true" href="MultiWidget+setHiddenElements"> </a>
|
|
1783
1783
|
|
|
1784
1784
|
### htmlMultiWidget.setHiddenElements(elements)
|
|
1785
1785
|
Using this method you can set hidden elements inside widget
|
|
@@ -1795,7 +1795,7 @@ Using this method you can set hidden elements inside widget
|
|
|
1795
1795
|
```javascript
|
|
1796
1796
|
widget.setHiddenElements(['submit_button', 'email']);
|
|
1797
1797
|
```
|
|
1798
|
-
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId"
|
|
1798
|
+
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId" class="anchor" aria-hidden="true" href="MultiWidget+setRefId"> </a>
|
|
1799
1799
|
|
|
1800
1800
|
### htmlMultiWidget.setRefId(refId)
|
|
1801
1801
|
Current method can set custom ID to identify the data in the future
|
|
@@ -1811,7 +1811,7 @@ Current method can set custom ID to identify the data in the future
|
|
|
1811
1811
|
```javascript
|
|
1812
1812
|
widget.setRefId('id');
|
|
1813
1813
|
```
|
|
1814
|
-
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation"
|
|
1814
|
+
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation" class="anchor" aria-hidden="true" href="MultiWidget+useGatewayFieldValidation"> </a>
|
|
1815
1815
|
|
|
1816
1816
|
### htmlMultiWidget.useGatewayFieldValidation()
|
|
1817
1817
|
Current method can add visual validation from gateway to widget's form fields
|
|
@@ -1822,7 +1822,7 @@ Current method can add visual validation from gateway to widget's form fields
|
|
|
1822
1822
|
```javascript
|
|
1823
1823
|
widget.useGatewayFieldValidation();
|
|
1824
1824
|
```
|
|
1825
|
-
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons"
|
|
1825
|
+
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons" class="anchor" aria-hidden="true" href="MultiWidget+setSupportedCardIcons"> </a>
|
|
1826
1826
|
|
|
1827
1827
|
### htmlMultiWidget.setSupportedCardIcons(elements, validateCardNumberInput)
|
|
1828
1828
|
Current method can set icons of supported card types
|
|
@@ -1839,7 +1839,7 @@ Current method can set icons of supported card types
|
|
|
1839
1839
|
```javascript
|
|
1840
1840
|
widget.setSupportedCardIcons(['mastercard', 'visa'], validateCardNumberInput);
|
|
1841
1841
|
```
|
|
1842
|
-
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv"
|
|
1842
|
+
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv" class="anchor" aria-hidden="true" href="MultiWidget+setEnv"> </a>
|
|
1843
1843
|
|
|
1844
1844
|
### htmlMultiWidget.setEnv(env, [alias])
|
|
1845
1845
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -1857,7 +1857,7 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
1857
1857
|
```javascript
|
|
1858
1858
|
widget.setEnv('production', 'paydock.com');
|
|
1859
1859
|
```
|
|
1860
|
-
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl"
|
|
1860
|
+
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl" class="anchor" aria-hidden="true" href="MultiWidget+loadIFrameUrl"> </a>
|
|
1861
1861
|
|
|
1862
1862
|
### htmlMultiWidget.loadIFrameUrl()
|
|
1863
1863
|
Method for creating iframe url
|
|
@@ -1872,7 +1872,7 @@ widget.loadIFrameUrl(function (url) {
|
|
|
1872
1872
|
console.log(errors);
|
|
1873
1873
|
});
|
|
1874
1874
|
```
|
|
1875
|
-
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage"
|
|
1875
|
+
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage" class="anchor" aria-hidden="true" href="MultiWidget+setLanguage"> </a>
|
|
1876
1876
|
|
|
1877
1877
|
### htmlMultiWidget.setLanguage(code)
|
|
1878
1878
|
Method for setting a custom language code
|
|
@@ -1888,7 +1888,7 @@ Method for setting a custom language code
|
|
|
1888
1888
|
```javascript
|
|
1889
1889
|
config.setLanguage('en');
|
|
1890
1890
|
```
|
|
1891
|
-
<a name="w_Configuration" id="w_Configuration"
|
|
1891
|
+
<a name="w_Configuration" id="w_Configuration" class="anchor" aria-hidden="true" href="Configuration"> </a>
|
|
1892
1892
|
|
|
1893
1893
|
## Configuration
|
|
1894
1894
|
Class Configuration include methods for creating configuration token
|
|
@@ -1906,7 +1906,7 @@ Class Configuration include methods for creating configuration token
|
|
|
1906
1906
|
* [.setLabel(label)](#w_Configuration+setLabel)
|
|
1907
1907
|
* [.createToken(accessToken, cb, errorCb)](#w_Configuration+createToken)
|
|
1908
1908
|
|
|
1909
|
-
<a name="w_new_Configuration_new" id="w_new_Configuration_new"
|
|
1909
|
+
<a name="w_new_Configuration_new" id="w_new_Configuration_new" class="anchor" aria-hidden="true" href="new_Configuration_new"> </a>
|
|
1910
1910
|
|
|
1911
1911
|
### new exports.Configuration([gatewayID], paymentType, purpose)
|
|
1912
1912
|
|
|
@@ -1925,7 +1925,7 @@ var config = new Configuration('gatewayId', 'bank_account', 'paymentSource'); //
|
|
|
1925
1925
|
|
|
1926
1926
|
var config = new Configuration('not_configured'); // without gateway
|
|
1927
1927
|
```
|
|
1928
|
-
<a name="w_Configuration+setWebHookDestination" id="w_Configuration+setWebHookDestination"
|
|
1928
|
+
<a name="w_Configuration+setWebHookDestination" id="w_Configuration+setWebHookDestination" class="anchor" aria-hidden="true" href="Configuration+setWebHookDestination"> </a>
|
|
1929
1929
|
|
|
1930
1930
|
### configuration.setWebHookDestination(url)
|
|
1931
1931
|
Destination, where customer will receive all successful responses.
|
|
@@ -1942,7 +1942,7 @@ Response will contain “data” object with “payment_source” or other param
|
|
|
1942
1942
|
```javascript
|
|
1943
1943
|
config.setWebHookDestination('http://google.com');
|
|
1944
1944
|
```
|
|
1945
|
-
<a name="w_Configuration+setSuccessRedirectUrl" id="w_Configuration+setSuccessRedirectUrl"
|
|
1945
|
+
<a name="w_Configuration+setSuccessRedirectUrl" id="w_Configuration+setSuccessRedirectUrl" class="anchor" aria-hidden="true" href="Configuration+setSuccessRedirectUrl"> </a>
|
|
1946
1946
|
|
|
1947
1947
|
### configuration.setSuccessRedirectUrl(url)
|
|
1948
1948
|
URL to which the Customer will be redirected to after the success finish
|
|
@@ -1958,7 +1958,7 @@ URL to which the Customer will be redirected to after the success finish
|
|
|
1958
1958
|
```javascript
|
|
1959
1959
|
config.setSuccessRedirectUrl('google.com/search?q=success');
|
|
1960
1960
|
```
|
|
1961
|
-
<a name="w_Configuration+setErrorRedirectUrl" id="w_Configuration+setErrorRedirectUrl"
|
|
1961
|
+
<a name="w_Configuration+setErrorRedirectUrl" id="w_Configuration+setErrorRedirectUrl" class="anchor" aria-hidden="true" href="Configuration+setErrorRedirectUrl"> </a>
|
|
1962
1962
|
|
|
1963
1963
|
### configuration.setErrorRedirectUrl(url)
|
|
1964
1964
|
URL to which the Customer will be redirected to if an error is triggered in the process of operation
|
|
@@ -1974,7 +1974,7 @@ URL to which the Customer will be redirected to if an error is triggered in the
|
|
|
1974
1974
|
```javascript
|
|
1975
1975
|
config.setErrorRedirectUrl('google.com/search?q=error');
|
|
1976
1976
|
```
|
|
1977
|
-
<a name="w_Configuration+setFormFields" id="w_Configuration+setFormFields"
|
|
1977
|
+
<a name="w_Configuration+setFormFields" id="w_Configuration+setFormFields" class="anchor" aria-hidden="true" href="Configuration+setFormFields"> </a>
|
|
1978
1978
|
|
|
1979
1979
|
### configuration.setFormFields(fields)
|
|
1980
1980
|
Set list with widget form field, which will be shown in form. Also you can set the required validation for these fields
|
|
@@ -1990,7 +1990,7 @@ Set list with widget form field, which will be shown in form. Also you can set t
|
|
|
1990
1990
|
```javascript
|
|
1991
1991
|
config.setFormFields(['phone', 'email', 'first_name*']);
|
|
1992
1992
|
```
|
|
1993
|
-
<a name="w_Configuration+setMeta" id="w_Configuration+setMeta"
|
|
1993
|
+
<a name="w_Configuration+setMeta" id="w_Configuration+setMeta" class="anchor" aria-hidden="true" href="Configuration+setMeta"> </a>
|
|
1994
1994
|
|
|
1995
1995
|
### configuration.setMeta(object)
|
|
1996
1996
|
Method for setting meta information for checkout page
|
|
@@ -2010,7 +2010,7 @@ config.setMeta({
|
|
|
2010
2010
|
email: 'wault@paydock.com'
|
|
2011
2011
|
});
|
|
2012
2012
|
```
|
|
2013
|
-
<a name="w_Configuration+setEnv" id="w_Configuration+setEnv"
|
|
2013
|
+
<a name="w_Configuration+setEnv" id="w_Configuration+setEnv" class="anchor" aria-hidden="true" href="Configuration+setEnv"> </a>
|
|
2014
2014
|
|
|
2015
2015
|
### configuration.setEnv(env, [alias])
|
|
2016
2016
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -2028,7 +2028,7 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
2028
2028
|
```javascript
|
|
2029
2029
|
config.setEnv('production');
|
|
2030
2030
|
```
|
|
2031
|
-
<a name="w_Configuration+setLabel" id="w_Configuration+setLabel"
|
|
2031
|
+
<a name="w_Configuration+setLabel" id="w_Configuration+setLabel" class="anchor" aria-hidden="true" href="Configuration+setLabel"> </a>
|
|
2032
2032
|
|
|
2033
2033
|
### configuration.setLabel(label)
|
|
2034
2034
|
Title for tab which can be set instead of default
|
|
@@ -2044,7 +2044,7 @@ Title for tab which can be set instead of default
|
|
|
2044
2044
|
```javascript
|
|
2045
2045
|
config.setLabel('custom label');
|
|
2046
2046
|
```
|
|
2047
|
-
<a name="w_Configuration+createToken" id="w_Configuration+createToken"
|
|
2047
|
+
<a name="w_Configuration+createToken" id="w_Configuration+createToken" class="anchor" aria-hidden="true" href="Configuration+createToken"> </a>
|
|
2048
2048
|
|
|
2049
2049
|
### configuration.createToken(accessToken, cb, errorCb)
|
|
2050
2050
|
createToken - method which exactly create payment one time token
|
|
@@ -2067,7 +2067,7 @@ config.createToken('582035346f65cdd57ee81192d6e5w65w4e5',
|
|
|
2067
2067
|
console.log(error);
|
|
2068
2068
|
});
|
|
2069
2069
|
```
|
|
2070
|
-
<a name="w_MultiWidget" id="w_MultiWidget"
|
|
2070
|
+
<a name="w_MultiWidget" id="w_MultiWidget" class="anchor" aria-hidden="true" href="MultiWidget"> </a>
|
|
2071
2071
|
|
|
2072
2072
|
## MultiWidget
|
|
2073
2073
|
Class MultiWidget include method for for creating iframe url
|
|
@@ -2093,7 +2093,7 @@ Class MultiWidget include method for for creating iframe url
|
|
|
2093
2093
|
* [.loadIFrameUrl()](#w_MultiWidget+loadIFrameUrl)
|
|
2094
2094
|
* [.setLanguage(code)](#w_MultiWidget+setLanguage)
|
|
2095
2095
|
|
|
2096
|
-
<a name="w_new_MultiWidget_new" id="w_new_MultiWidget_new"
|
|
2096
|
+
<a name="w_new_MultiWidget_new" id="w_new_MultiWidget_new" class="anchor" aria-hidden="true" href="new_MultiWidget_new"> </a>
|
|
2097
2097
|
|
|
2098
2098
|
### new exports.MultiWidget(accessToken, conf)
|
|
2099
2099
|
|
|
@@ -2116,7 +2116,7 @@ var widget = new MultiWidget('accessToken',[ With Configurations
|
|
|
2116
2116
|
Configuration('gatewayId', 'bank_account')
|
|
2117
2117
|
]);
|
|
2118
2118
|
```
|
|
2119
|
-
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles"
|
|
2119
|
+
<a name="w_MultiWidget+setStyles" id="w_MultiWidget+setStyles" class="anchor" aria-hidden="true" href="MultiWidget+setStyles"> </a>
|
|
2120
2120
|
|
|
2121
2121
|
### multiWidget.setStyles(fields)
|
|
2122
2122
|
Object contain styles for widget
|
|
@@ -2139,7 +2139,7 @@ widget.setStyles({
|
|
|
2139
2139
|
fort_family: 'fantasy'
|
|
2140
2140
|
});
|
|
2141
2141
|
```
|
|
2142
|
-
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask"
|
|
2142
|
+
<a name="w_MultiWidget+usePhoneCountryMask" id="w_MultiWidget+usePhoneCountryMask" class="anchor" aria-hidden="true" href="MultiWidget+usePhoneCountryMask"> </a>
|
|
2143
2143
|
|
|
2144
2144
|
### multiWidget.usePhoneCountryMask([options])
|
|
2145
2145
|
Method to set a country code mask for the phone input.
|
|
@@ -2167,7 +2167,7 @@ widget.usePhoneCountryMask({
|
|
|
2167
2167
|
only_countries: ['au', 'gb', 'us', 'ua']
|
|
2168
2168
|
});
|
|
2169
2169
|
```
|
|
2170
|
-
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts"
|
|
2170
|
+
<a name="w_MultiWidget+setTexts" id="w_MultiWidget+setTexts" class="anchor" aria-hidden="true" href="MultiWidget+setTexts"> </a>
|
|
2171
2171
|
|
|
2172
2172
|
### multiWidget.setTexts(fields)
|
|
2173
2173
|
Method for set different texts inside the widget
|
|
@@ -2189,7 +2189,7 @@ widget.setTexts({
|
|
|
2189
2189
|
submit_button_processing: 'Load...',
|
|
2190
2190
|
});
|
|
2191
2191
|
```
|
|
2192
|
-
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle"
|
|
2192
|
+
<a name="w_MultiWidget+setElementStyle" id="w_MultiWidget+setElementStyle" class="anchor" aria-hidden="true" href="MultiWidget+setElementStyle"> </a>
|
|
2193
2193
|
|
|
2194
2194
|
### multiWidget.setElementStyle(element, [state], styles)
|
|
2195
2195
|
Method for set styles for different elements and states
|
|
@@ -2217,7 +2217,7 @@ widget.setElementStyle('input', 'error', {
|
|
|
2217
2217
|
border: 'red solid 1px'
|
|
2218
2218
|
});
|
|
2219
2219
|
```
|
|
2220
|
-
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues"
|
|
2220
|
+
<a name="w_MultiWidget+setFormValues" id="w_MultiWidget+setFormValues" class="anchor" aria-hidden="true" href="MultiWidget+setFormValues"> </a>
|
|
2221
2221
|
|
|
2222
2222
|
### multiWidget.setFormValues(fieldValues)
|
|
2223
2223
|
The method to set the predefined values for the form fields inside the widget
|
|
@@ -2236,7 +2236,7 @@ widget.setFormValues({
|
|
|
2236
2236
|
card_name: 'Houston'
|
|
2237
2237
|
});
|
|
2238
2238
|
```
|
|
2239
|
-
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels"
|
|
2239
|
+
<a name="w_MultiWidget+setFormLabels" id="w_MultiWidget+setFormLabels" class="anchor" aria-hidden="true" href="MultiWidget+setFormLabels"> </a>
|
|
2240
2240
|
|
|
2241
2241
|
### multiWidget.setFormLabels(fieldLabels)
|
|
2242
2242
|
The method to set custom form field labels
|
|
@@ -2255,7 +2255,7 @@ widget.setFormPlaceholders({
|
|
|
2255
2255
|
email: 'Email For Receipt'
|
|
2256
2256
|
})
|
|
2257
2257
|
```
|
|
2258
|
-
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders"
|
|
2258
|
+
<a name="w_MultiWidget+setFormPlaceholders" id="w_MultiWidget+setFormPlaceholders" class="anchor" aria-hidden="true" href="MultiWidget+setFormPlaceholders"> </a>
|
|
2259
2259
|
|
|
2260
2260
|
### multiWidget.setFormPlaceholders(fieldPlaceholders)
|
|
2261
2261
|
The method to set custom form fields placeholders
|
|
@@ -2274,7 +2274,7 @@ widget.setFormPlaceholders({
|
|
|
2274
2274
|
email: 'Input your email, like test@example.com'
|
|
2275
2275
|
})
|
|
2276
2276
|
```
|
|
2277
|
-
<a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements"
|
|
2277
|
+
<a name="w_MultiWidget+setFormElements" id="w_MultiWidget+setFormElements" class="anchor" aria-hidden="true" href="MultiWidget+setFormElements"> </a>
|
|
2278
2278
|
|
|
2279
2279
|
### multiWidget.setFormElements(elements)
|
|
2280
2280
|
The method to set the full configuration for the all specific form elements (label, placeholder, value)
|
|
@@ -2308,7 +2308,7 @@ widget.setFormElements([
|
|
|
2308
2308
|
},
|
|
2309
2309
|
])
|
|
2310
2310
|
```
|
|
2311
|
-
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons"
|
|
2311
|
+
<a name="w_MultiWidget+setIcons" id="w_MultiWidget+setIcons" class="anchor" aria-hidden="true" href="MultiWidget+setIcons"> </a>
|
|
2312
2312
|
|
|
2313
2313
|
### multiWidget.setIcons()
|
|
2314
2314
|
The method to change the widget icons
|
|
@@ -2318,7 +2318,7 @@ The method to change the widget icons
|
|
|
2318
2318
|
|
|
2319
2319
|
- [ ] DEPRECATED
|
|
2320
2320
|
|
|
2321
|
-
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements"
|
|
2321
|
+
<a name="w_MultiWidget+setHiddenElements" id="w_MultiWidget+setHiddenElements" class="anchor" aria-hidden="true" href="MultiWidget+setHiddenElements"> </a>
|
|
2322
2322
|
|
|
2323
2323
|
### multiWidget.setHiddenElements(elements)
|
|
2324
2324
|
Using this method you can set hidden elements inside widget
|
|
@@ -2334,7 +2334,7 @@ Using this method you can set hidden elements inside widget
|
|
|
2334
2334
|
```javascript
|
|
2335
2335
|
widget.setHiddenElements(['submit_button', 'email']);
|
|
2336
2336
|
```
|
|
2337
|
-
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId"
|
|
2337
|
+
<a name="w_MultiWidget+setRefId" id="w_MultiWidget+setRefId" class="anchor" aria-hidden="true" href="MultiWidget+setRefId"> </a>
|
|
2338
2338
|
|
|
2339
2339
|
### multiWidget.setRefId(refId)
|
|
2340
2340
|
Current method can set custom ID to identify the data in the future
|
|
@@ -2350,7 +2350,7 @@ Current method can set custom ID to identify the data in the future
|
|
|
2350
2350
|
```javascript
|
|
2351
2351
|
widget.setRefId('id');
|
|
2352
2352
|
```
|
|
2353
|
-
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation"
|
|
2353
|
+
<a name="w_MultiWidget+useGatewayFieldValidation" id="w_MultiWidget+useGatewayFieldValidation" class="anchor" aria-hidden="true" href="MultiWidget+useGatewayFieldValidation"> </a>
|
|
2354
2354
|
|
|
2355
2355
|
### multiWidget.useGatewayFieldValidation()
|
|
2356
2356
|
Current method can add visual validation from gateway to widget's form fields
|
|
@@ -2361,7 +2361,7 @@ Current method can add visual validation from gateway to widget's form fields
|
|
|
2361
2361
|
```javascript
|
|
2362
2362
|
widget.useGatewayFieldValidation();
|
|
2363
2363
|
```
|
|
2364
|
-
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons"
|
|
2364
|
+
<a name="w_MultiWidget+setSupportedCardIcons" id="w_MultiWidget+setSupportedCardIcons" class="anchor" aria-hidden="true" href="MultiWidget+setSupportedCardIcons"> </a>
|
|
2365
2365
|
|
|
2366
2366
|
### multiWidget.setSupportedCardIcons(elements, validateCardNumberInput)
|
|
2367
2367
|
Current method can set icons of supported card types
|
|
@@ -2378,7 +2378,7 @@ Current method can set icons of supported card types
|
|
|
2378
2378
|
```javascript
|
|
2379
2379
|
widget.setSupportedCardIcons(['mastercard', 'visa'], validateCardNumberInput);
|
|
2380
2380
|
```
|
|
2381
|
-
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv"
|
|
2381
|
+
<a name="w_MultiWidget+setEnv" id="w_MultiWidget+setEnv" class="anchor" aria-hidden="true" href="MultiWidget+setEnv"> </a>
|
|
2382
2382
|
|
|
2383
2383
|
### multiWidget.setEnv(env, [alias])
|
|
2384
2384
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -2396,7 +2396,7 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
2396
2396
|
```javascript
|
|
2397
2397
|
widget.setEnv('production', 'paydock.com');
|
|
2398
2398
|
```
|
|
2399
|
-
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl"
|
|
2399
|
+
<a name="w_MultiWidget+loadIFrameUrl" id="w_MultiWidget+loadIFrameUrl" class="anchor" aria-hidden="true" href="MultiWidget+loadIFrameUrl"> </a>
|
|
2400
2400
|
|
|
2401
2401
|
### multiWidget.loadIFrameUrl()
|
|
2402
2402
|
Method for creating iframe url
|
|
@@ -2411,7 +2411,7 @@ widget.loadIFrameUrl(function (url) {
|
|
|
2411
2411
|
console.log(errors);
|
|
2412
2412
|
});
|
|
2413
2413
|
```
|
|
2414
|
-
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage"
|
|
2414
|
+
<a name="w_MultiWidget+setLanguage" id="w_MultiWidget+setLanguage" class="anchor" aria-hidden="true" href="MultiWidget+setLanguage"> </a>
|
|
2415
2415
|
|
|
2416
2416
|
### multiWidget.setLanguage(code)
|
|
2417
2417
|
Method for setting a custom language code
|
|
@@ -2427,7 +2427,7 @@ Method for setting a custom language code
|
|
|
2427
2427
|
```javascript
|
|
2428
2428
|
config.setLanguage('en');
|
|
2429
2429
|
```
|
|
2430
|
-
<a name="w_EVENT" id="w_EVENT"
|
|
2430
|
+
<a name="w_EVENT" id="w_EVENT" class="anchor" aria-hidden="true" href="EVENT"> </a>
|
|
2431
2431
|
|
|
2432
2432
|
## EVENT : <code>object</code>
|
|
2433
2433
|
List of available event's name
|
|
@@ -2445,7 +2445,7 @@ List of available event's name
|
|
|
2445
2445
|
| META_CHANGE | <code>string</code> | <code>"metaChange"</code> |
|
|
2446
2446
|
| RESIZE | <code>string</code> | <code>"resize"</code> |
|
|
2447
2447
|
|
|
2448
|
-
<a name="w_VAULT_DISPLAY_EVENT" id="w_VAULT_DISPLAY_EVENT"
|
|
2448
|
+
<a name="w_VAULT_DISPLAY_EVENT" id="w_VAULT_DISPLAY_EVENT" class="anchor" aria-hidden="true" href="VAULT_DISPLAY_EVENT"> </a>
|
|
2449
2449
|
|
|
2450
2450
|
## VAULT\_DISPLAY\_EVENT : <code>object</code>
|
|
2451
2451
|
List of available event's name
|
|
@@ -2463,7 +2463,7 @@ List of available event's name
|
|
|
2463
2463
|
| SYSTEM_ERROR | <code>string</code> | <code>"session_expired"</code> |
|
|
2464
2464
|
| OPERATION_FORBIDDEN | <code>string</code> | <code>"operation_forbidden"</code> |
|
|
2465
2465
|
|
|
2466
|
-
<a name="w_PAYMENT_TYPE" id="w_PAYMENT_TYPE"
|
|
2466
|
+
<a name="w_PAYMENT_TYPE" id="w_PAYMENT_TYPE" class="anchor" aria-hidden="true" href="PAYMENT_TYPE"> </a>
|
|
2467
2467
|
|
|
2468
2468
|
## PAYMENT\_TYPE : <code>object</code>
|
|
2469
2469
|
List of available payment source types
|
|
@@ -2476,7 +2476,7 @@ List of available payment source types
|
|
|
2476
2476
|
| BANK_ACCOUNT | <code>string</code> | <code>"bank_account"</code> |
|
|
2477
2477
|
| CHECKOUT | <code>string</code> | <code>"checkout"</code> |
|
|
2478
2478
|
|
|
2479
|
-
<a name="w_PURPOSE" id="w_PURPOSE"
|
|
2479
|
+
<a name="w_PURPOSE" id="w_PURPOSE" class="anchor" aria-hidden="true" href="PURPOSE"> </a>
|
|
2480
2480
|
|
|
2481
2481
|
## PURPOSE : <code>object</code>
|
|
2482
2482
|
Purposes
|
|
@@ -2489,7 +2489,7 @@ Purposes
|
|
|
2489
2489
|
| CARD_PAYMENT_SOURCE_WITH_CVV | <code>string</code> | <code>"card_payment_source_with_cvv"</code> |
|
|
2490
2490
|
| CARD_PAYMENT_SOURCE_WITHOUT_CVV | <code>string</code> | <code>"card_payment_source_without_cvv"</code> |
|
|
2491
2491
|
|
|
2492
|
-
<a name="w_FORM_FIELD" id="w_FORM_FIELD"
|
|
2492
|
+
<a name="w_FORM_FIELD" id="w_FORM_FIELD" class="anchor" aria-hidden="true" href="FORM_FIELD"> </a>
|
|
2493
2493
|
|
|
2494
2494
|
## FORM\_FIELD : <code>object</code>
|
|
2495
2495
|
Current constant include available type of fields which can be included to widget
|
|
@@ -2523,7 +2523,7 @@ Current constant include available type of fields which can be included to widge
|
|
|
2523
2523
|
| ADDRESS_POSTCODE | <code>string</code> | <code>"address_postcode"</code> |
|
|
2524
2524
|
| ADDRESS_COMPANY | <code>string</code> | <code>"address_company"</code> |
|
|
2525
2525
|
|
|
2526
|
-
<a name="w_STYLE" id="w_STYLE"
|
|
2526
|
+
<a name="w_STYLE" id="w_STYLE" class="anchor" aria-hidden="true" href="STYLE"> </a>
|
|
2527
2527
|
|
|
2528
2528
|
## STYLE : <code>object</code>
|
|
2529
2529
|
List of available style params for widget
|
|
@@ -2541,7 +2541,7 @@ List of available style params for widget
|
|
|
2541
2541
|
| FONT_SIZE | <code>string</code> | <code>"font_size"</code> |
|
|
2542
2542
|
| FONT_FAMILY | <code>string</code> | <code>"font_family"</code> |
|
|
2543
2543
|
|
|
2544
|
-
<a name="w_TEXT" id="w_TEXT"
|
|
2544
|
+
<a name="w_TEXT" id="w_TEXT" class="anchor" aria-hidden="true" href="TEXT"> </a>
|
|
2545
2545
|
|
|
2546
2546
|
## TEXT : <code>object</code>
|
|
2547
2547
|
List of available text item params for widget
|
|
@@ -2553,7 +2553,7 @@ List of available text item params for widget
|
|
|
2553
2553
|
| TITLE | <code>string</code> | <code>"title"</code> |
|
|
2554
2554
|
| FINISH | <code>string</code> | <code>"finish_text"</code> |
|
|
2555
2555
|
|
|
2556
|
-
<a name="w_ELEMENT" id="w_ELEMENT"
|
|
2556
|
+
<a name="w_ELEMENT" id="w_ELEMENT" class="anchor" aria-hidden="true" href="ELEMENT"> </a>
|
|
2557
2557
|
|
|
2558
2558
|
## ELEMENT : <code>object</code>
|
|
2559
2559
|
List of available params for hide elements
|
|
@@ -2565,7 +2565,7 @@ List of available params for hide elements
|
|
|
2565
2565
|
| SUBMIT_BUTTON | <code>string</code> | <code>"submit_button"</code> |
|
|
2566
2566
|
| TABS | <code>string</code> | <code>"tabs"</code> |
|
|
2567
2567
|
|
|
2568
|
-
<a name="w_SUPPORTED_CARD_TYPES" id="w_SUPPORTED_CARD_TYPES"
|
|
2568
|
+
<a name="w_SUPPORTED_CARD_TYPES" id="w_SUPPORTED_CARD_TYPES" class="anchor" aria-hidden="true" href="SUPPORTED_CARD_TYPES"> </a>
|
|
2569
2569
|
|
|
2570
2570
|
## SUPPORTED\_CARD\_TYPES : <code>object</code>
|
|
2571
2571
|
The list of available parameters for showing card icons
|
|
@@ -2585,7 +2585,7 @@ The list of available parameters for showing card icons
|
|
|
2585
2585
|
| VISA | <code>string</code> | <code>"visa"</code> |
|
|
2586
2586
|
| VISA_WHITE | <code>string</code> | <code>"visa_white"</code> |
|
|
2587
2587
|
|
|
2588
|
-
<a name="w_STYLABLE_ELEMENT" id="w_STYLABLE_ELEMENT"
|
|
2588
|
+
<a name="w_STYLABLE_ELEMENT" id="w_STYLABLE_ELEMENT" class="anchor" aria-hidden="true" href="STYLABLE_ELEMENT"> </a>
|
|
2589
2589
|
|
|
2590
2590
|
## STYLABLE\_ELEMENT : <code>object</code>
|
|
2591
2591
|
Current constant include available type of element for styling
|
|
@@ -2600,7 +2600,7 @@ Current constant include available type of element for styling
|
|
|
2600
2600
|
| TITLE | <code>string</code> | <code>"title."</code> | These styles are available [IElementStyleTitle](#w_IElementStyleTitle) |
|
|
2601
2601
|
| TITLE_DESCRIPTION | <code>string</code> | <code>"title_description."</code> | These styles are available [IElementStyleTitleDescription](#w_IElementStyleTitleDescription) |
|
|
2602
2602
|
|
|
2603
|
-
<a name="w_STYLABLE_ELEMENT_STATE" id="w_STYLABLE_ELEMENT_STATE"
|
|
2603
|
+
<a name="w_STYLABLE_ELEMENT_STATE" id="w_STYLABLE_ELEMENT_STATE" class="anchor" aria-hidden="true" href="STYLABLE_ELEMENT_STATE"> </a>
|
|
2604
2604
|
|
|
2605
2605
|
## STYLABLE\_ELEMENT\_STATE : <code>object</code>
|
|
2606
2606
|
Current constant include available states of element for styling
|
|
@@ -2613,7 +2613,7 @@ Current constant include available states of element for styling
|
|
|
2613
2613
|
| FOCUS | <code>string</code> | <code>"focus"</code> | focus. This state applies to: input |
|
|
2614
2614
|
| HOVER | <code>string</code> | <code>"hover"</code> | focus. This state applies to: submit_button |
|
|
2615
2615
|
|
|
2616
|
-
<a name="w_TRIGGER" id="w_TRIGGER"
|
|
2616
|
+
<a name="w_TRIGGER" id="w_TRIGGER" class="anchor" aria-hidden="true" href="TRIGGER"> </a>
|
|
2617
2617
|
|
|
2618
2618
|
## TRIGGER : <code>object</code>
|
|
2619
2619
|
List of available triggers
|
|
@@ -2817,7 +2817,7 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
2817
2817
|
</dd>
|
|
2818
2818
|
</dl>
|
|
2819
2819
|
|
|
2820
|
-
<a name="psw_IEventSelectData" id="psw_IEventSelectData"
|
|
2820
|
+
<a name="psw_IEventSelectData" id="psw_IEventSelectData" class="anchor" aria-hidden="true" href="IEventSelectData"> </a>
|
|
2821
2821
|
|
|
2822
2822
|
## IEventSelectData
|
|
2823
2823
|
Interface of data from event.
|
|
@@ -2843,7 +2843,7 @@ Interface of data from event.
|
|
|
2843
2843
|
| [account_name] | <code>string</code> |
|
|
2844
2844
|
| [account_number] | <code>string</code> |
|
|
2845
2845
|
|
|
2846
|
-
<a name="psw_IEventPaginationData" id="psw_IEventPaginationData"
|
|
2846
|
+
<a name="psw_IEventPaginationData" id="psw_IEventPaginationData" class="anchor" aria-hidden="true" href="IEventPaginationData"> </a>
|
|
2847
2847
|
|
|
2848
2848
|
## IEventPaginationData
|
|
2849
2849
|
Interface of data from event.
|
|
@@ -2860,7 +2860,7 @@ Interface of data from event.
|
|
|
2860
2860
|
| skip | <code>number</code> |
|
|
2861
2861
|
| limit | <code>number</code> |
|
|
2862
2862
|
|
|
2863
|
-
<a name="psw_IEventAfterLoadData" id="psw_IEventAfterLoadData"
|
|
2863
|
+
<a name="psw_IEventAfterLoadData" id="psw_IEventAfterLoadData" class="anchor" aria-hidden="true" href="IEventAfterLoadData"> </a>
|
|
2864
2864
|
|
|
2865
2865
|
## IEventAfterLoadData
|
|
2866
2866
|
Interface of data from event.
|
|
@@ -2877,7 +2877,7 @@ Interface of data from event.
|
|
|
2877
2877
|
| skip | <code>number</code> | Pagination param. Skip items from first item |
|
|
2878
2878
|
| limit | <code>number</code> | Pagination param. Query limit |
|
|
2879
2879
|
|
|
2880
|
-
<a name="psw_IEventFinishData" id="psw_IEventFinishData"
|
|
2880
|
+
<a name="psw_IEventFinishData" id="psw_IEventFinishData" class="anchor" aria-hidden="true" href="IEventFinishData"> </a>
|
|
2881
2881
|
|
|
2882
2882
|
## IEventFinishData
|
|
2883
2883
|
Interface of data from event.
|
|
@@ -2891,7 +2891,7 @@ Interface of data from event.
|
|
|
2891
2891
|
| message_source | <code>string</code> | System variable. Event source |
|
|
2892
2892
|
| [ref_id] | <code>string</code> | Custom value for identify result of processed operation |
|
|
2893
2893
|
|
|
2894
|
-
<a name="psw_IEventSizeData" id="psw_IEventSizeData"
|
|
2894
|
+
<a name="psw_IEventSizeData" id="psw_IEventSizeData" class="anchor" aria-hidden="true" href="IEventSizeData"> </a>
|
|
2895
2895
|
|
|
2896
2896
|
## IEventSizeData
|
|
2897
2897
|
Interface of data from event.
|
|
@@ -2907,7 +2907,7 @@ Interface of data from event.
|
|
|
2907
2907
|
| height | <code>number</code> | Height of iFrame |
|
|
2908
2908
|
| width | <code>number</code> | Width of iFrame |
|
|
2909
2909
|
|
|
2910
|
-
<a name="psw_IStyles" id="psw_IStyles"
|
|
2910
|
+
<a name="psw_IStyles" id="psw_IStyles" class="anchor" aria-hidden="true" href="IStyles"> </a>
|
|
2911
2911
|
|
|
2912
2912
|
## IStyles
|
|
2913
2913
|
Interface for classes that represent widget's styles.
|
|
@@ -2923,7 +2923,7 @@ Interface for classes that represent widget's styles.
|
|
|
2923
2923
|
| [font_size] | <code>string</code> |
|
|
2924
2924
|
| [icon_size] | <code>string</code> |
|
|
2925
2925
|
|
|
2926
|
-
<a name="psw_HtmlPaymentSourceWidget" id="psw_HtmlPaymentSourceWidget"
|
|
2926
|
+
<a name="psw_HtmlPaymentSourceWidget" id="psw_HtmlPaymentSourceWidget" class="anchor" aria-hidden="true" href="HtmlPaymentSourceWidget"> </a>
|
|
2927
2927
|
|
|
2928
2928
|
## HtmlPaymentSourceWidget ⇐ [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
2929
2929
|
Class HtmlPaymentSourceWidget include method for working on html
|
|
@@ -2948,7 +2948,7 @@ Class HtmlPaymentSourceWidget include method for working on html
|
|
|
2948
2948
|
* [.filterByTypes(types)](#psw_PaymentSourceWidget+filterByTypes)
|
|
2949
2949
|
* [.setLanguage(code)](#psw_PaymentSourceWidget+setLanguage)
|
|
2950
2950
|
|
|
2951
|
-
<a name="psw_new_HtmlPaymentSourceWidget_new" id="psw_new_HtmlPaymentSourceWidget_new"
|
|
2951
|
+
<a name="psw_new_HtmlPaymentSourceWidget_new" id="psw_new_HtmlPaymentSourceWidget_new" class="anchor" aria-hidden="true" href="new_HtmlPaymentSourceWidget_new"> </a>
|
|
2952
2952
|
|
|
2953
2953
|
### new exports.HtmlPaymentSourceWidget(selector, publicKey, queryToken)
|
|
2954
2954
|
|
|
@@ -2963,13 +2963,13 @@ Class HtmlPaymentSourceWidget include method for working on html
|
|
|
2963
2963
|
```javascript
|
|
2964
2964
|
* var widget = new HtmlPaymentSourceWidget('#widget', 'publicKey','queryToken');
|
|
2965
2965
|
```
|
|
2966
|
-
<a name="psw_HtmlPaymentSourceWidget+load" id="psw_HtmlPaymentSourceWidget+load"
|
|
2966
|
+
<a name="psw_HtmlPaymentSourceWidget+load" id="psw_HtmlPaymentSourceWidget+load" class="anchor" aria-hidden="true" href="HtmlPaymentSourceWidget+load"> </a>
|
|
2967
2967
|
|
|
2968
2968
|
### htmlPaymentSourceWidget.load()
|
|
2969
2969
|
The final method to beginning, the load process of widget to html
|
|
2970
2970
|
|
|
2971
2971
|
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
2972
|
-
<a name="psw_HtmlPaymentSourceWidget+on" id="psw_HtmlPaymentSourceWidget+on"
|
|
2972
|
+
<a name="psw_HtmlPaymentSourceWidget+on" id="psw_HtmlPaymentSourceWidget+on" class="anchor" aria-hidden="true" href="HtmlPaymentSourceWidget+on"> </a>
|
|
2973
2973
|
|
|
2974
2974
|
### htmlPaymentSourceWidget.on(eventName, cb)
|
|
2975
2975
|
Listen to events of widget
|
|
@@ -2988,7 +2988,7 @@ widget.on('select', function (data) {
|
|
|
2988
2988
|
console.log(data);
|
|
2989
2989
|
});
|
|
2990
2990
|
```
|
|
2991
|
-
<a name="psw_HtmlPaymentSourceWidget+hide" id="psw_HtmlPaymentSourceWidget+hide"
|
|
2991
|
+
<a name="psw_HtmlPaymentSourceWidget+hide" id="psw_HtmlPaymentSourceWidget+hide" class="anchor" aria-hidden="true" href="HtmlPaymentSourceWidget+hide"> </a>
|
|
2992
2992
|
|
|
2993
2993
|
### htmlPaymentSourceWidget.hide([saveSize])
|
|
2994
2994
|
Using this method you can hide widget after load
|
|
@@ -2999,19 +2999,19 @@ Using this method you can hide widget after load
|
|
|
2999
2999
|
| --- | --- | --- | --- |
|
|
3000
3000
|
| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size |
|
|
3001
3001
|
|
|
3002
|
-
<a name="psw_HtmlPaymentSourceWidget+show" id="psw_HtmlPaymentSourceWidget+show"
|
|
3002
|
+
<a name="psw_HtmlPaymentSourceWidget+show" id="psw_HtmlPaymentSourceWidget+show" class="anchor" aria-hidden="true" href="HtmlPaymentSourceWidget+show"> </a>
|
|
3003
3003
|
|
|
3004
3004
|
### htmlPaymentSourceWidget.show()
|
|
3005
3005
|
Using this method you can show widget after using hide method
|
|
3006
3006
|
|
|
3007
3007
|
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3008
|
-
<a name="psw_HtmlPaymentSourceWidget+reload" id="psw_HtmlPaymentSourceWidget+reload"
|
|
3008
|
+
<a name="psw_HtmlPaymentSourceWidget+reload" id="psw_HtmlPaymentSourceWidget+reload" class="anchor" aria-hidden="true" href="HtmlPaymentSourceWidget+reload"> </a>
|
|
3009
3009
|
|
|
3010
3010
|
### htmlPaymentSourceWidget.reload()
|
|
3011
3011
|
Using this method you can reload widget
|
|
3012
3012
|
|
|
3013
3013
|
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3014
|
-
<a name="psw_HtmlPaymentSourceWidget+onSelectInsert" id="psw_HtmlPaymentSourceWidget+onSelectInsert"
|
|
3014
|
+
<a name="psw_HtmlPaymentSourceWidget+onSelectInsert" id="psw_HtmlPaymentSourceWidget+onSelectInsert" class="anchor" aria-hidden="true" href="HtmlPaymentSourceWidget+onSelectInsert"> </a>
|
|
3015
3015
|
|
|
3016
3016
|
### htmlPaymentSourceWidget.onSelectInsert(selector, dataType)
|
|
3017
3017
|
After select event of widget, data (dataType) will be insert to input (selector)
|
|
@@ -3023,7 +3023,7 @@ After select event of widget, data (dataType) will be insert to input (selector)
|
|
|
3023
3023
|
| selector | <code>string</code> | css selector . [] # |
|
|
3024
3024
|
| dataType | <code>string</code> | data type of [IEventSelectData](#psw_IEventSelectData). |
|
|
3025
3025
|
|
|
3026
|
-
<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles"
|
|
3026
|
+
<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setStyles"> </a>
|
|
3027
3027
|
|
|
3028
3028
|
### htmlPaymentSourceWidget.setStyles(fields)
|
|
3029
3029
|
Object contain styles for widget
|
|
@@ -3045,7 +3045,7 @@ widget.setStyles({
|
|
|
3045
3045
|
font_size: '20px'
|
|
3046
3046
|
});
|
|
3047
3047
|
```
|
|
3048
|
-
<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId"
|
|
3048
|
+
<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setRefId"> </a>
|
|
3049
3049
|
|
|
3050
3050
|
### htmlPaymentSourceWidget.setRefId(refId)
|
|
3051
3051
|
Current method can set custom ID to identify the data in the future
|
|
@@ -3061,7 +3061,7 @@ Current method can set custom ID to identify the data in the future
|
|
|
3061
3061
|
```javascript
|
|
3062
3062
|
widget.setRefId('id');
|
|
3063
3063
|
```
|
|
3064
|
-
<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit"
|
|
3064
|
+
<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setLimit"> </a>
|
|
3065
3065
|
|
|
3066
3066
|
### htmlPaymentSourceWidget.setLimit(count)
|
|
3067
3067
|
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.
|
|
@@ -3072,7 +3072,7 @@ Current method can set limit for payment sources count. In case when limit sets
|
|
|
3072
3072
|
| --- | --- | --- |
|
|
3073
3073
|
| count | <code>string</code> | payment source count |
|
|
3074
3074
|
|
|
3075
|
-
<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv"
|
|
3075
|
+
<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setEnv"> </a>
|
|
3076
3076
|
|
|
3077
3077
|
### htmlPaymentSourceWidget.setEnv(env, [alias])
|
|
3078
3078
|
Current method can change environment. By default environment = sandbox
|
|
@@ -3090,13 +3090,13 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
3090
3090
|
```javascript
|
|
3091
3091
|
widget.setEnv('production');
|
|
3092
3092
|
```
|
|
3093
|
-
<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl"
|
|
3093
|
+
<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl" class="anchor" aria-hidden="true" href="PaymentSourceWidget+getIFrameUrl"> </a>
|
|
3094
3094
|
|
|
3095
3095
|
### htmlPaymentSourceWidget.getIFrameUrl()
|
|
3096
3096
|
Method for getting iframe's url
|
|
3097
3097
|
|
|
3098
3098
|
**Kind**: instance method of [<code>HtmlPaymentSourceWidget</code>](#psw_HtmlPaymentSourceWidget)
|
|
3099
|
-
<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds"
|
|
3099
|
+
<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds" class="anchor" aria-hidden="true" href="PaymentSourceWidget+filterByGatewayIds"> </a>
|
|
3100
3100
|
|
|
3101
3101
|
### htmlPaymentSourceWidget.filterByGatewayIds(ids)
|
|
3102
3102
|
Show payment source inside widget only with requested gateway ids
|
|
@@ -3107,7 +3107,7 @@ Show payment source inside widget only with requested gateway ids
|
|
|
3107
3107
|
| --- | --- | --- |
|
|
3108
3108
|
| ids | <code>[ 'Array' ].<string></code> | List of paydock gateway_id |
|
|
3109
3109
|
|
|
3110
|
-
<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes"
|
|
3110
|
+
<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes" class="anchor" aria-hidden="true" href="PaymentSourceWidget+filterByTypes"> </a>
|
|
3111
3111
|
|
|
3112
3112
|
### htmlPaymentSourceWidget.filterByTypes(types)
|
|
3113
3113
|
Show payment source inside widget only with requested payment source types
|
|
@@ -3118,7 +3118,7 @@ Show payment source inside widget only with requested payment source types
|
|
|
3118
3118
|
| --- | --- |
|
|
3119
3119
|
| types | List of payment source types. Available parameters [PAYMENT_TYPE](PAYMENT_TYPE) |
|
|
3120
3120
|
|
|
3121
|
-
<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage"
|
|
3121
|
+
<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setLanguage"> </a>
|
|
3122
3122
|
|
|
3123
3123
|
### htmlPaymentSourceWidget.setLanguage(code)
|
|
3124
3124
|
Method for setting a custom language code
|
|
@@ -3134,7 +3134,7 @@ Method for setting a custom language code
|
|
|
3134
3134
|
```javascript
|
|
3135
3135
|
config.setLanguage('en');
|
|
3136
3136
|
```
|
|
3137
|
-
<a name="psw_PaymentSourceWidget" id="psw_PaymentSourceWidget"
|
|
3137
|
+
<a name="psw_PaymentSourceWidget" id="psw_PaymentSourceWidget" class="anchor" aria-hidden="true" href="PaymentSourceWidget"> </a>
|
|
3138
3138
|
|
|
3139
3139
|
## PaymentSourceWidget
|
|
3140
3140
|
Class PaymentSourceWidget include method for for creating iframe url
|
|
@@ -3152,7 +3152,7 @@ Class PaymentSourceWidget include method for for creating iframe url
|
|
|
3152
3152
|
* [.filterByTypes(types)](#psw_PaymentSourceWidget+filterByTypes)
|
|
3153
3153
|
* [.setLanguage(code)](#psw_PaymentSourceWidget+setLanguage)
|
|
3154
3154
|
|
|
3155
|
-
<a name="psw_new_PaymentSourceWidget_new" id="psw_new_PaymentSourceWidget_new"
|
|
3155
|
+
<a name="psw_new_PaymentSourceWidget_new" id="psw_new_PaymentSourceWidget_new" class="anchor" aria-hidden="true" href="new_PaymentSourceWidget_new"> </a>
|
|
3156
3156
|
|
|
3157
3157
|
### new exports.PaymentSourceWidget(publicKey, customer, [useReference])
|
|
3158
3158
|
|
|
@@ -3169,7 +3169,7 @@ var widget = new PaymentSourceWidget('publicKey','customerId');
|
|
|
3169
3169
|
// or
|
|
3170
3170
|
var widget = new PaymentSourceWidget('publicKey', customerReference, true);
|
|
3171
3171
|
```
|
|
3172
|
-
<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles"
|
|
3172
|
+
<a name="psw_PaymentSourceWidget+setStyles" id="psw_PaymentSourceWidget+setStyles" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setStyles"> </a>
|
|
3173
3173
|
|
|
3174
3174
|
### paymentSourceWidget.setStyles(fields)
|
|
3175
3175
|
Object contain styles for widget
|
|
@@ -3191,7 +3191,7 @@ widget.setStyles({
|
|
|
3191
3191
|
font_size: '20px'
|
|
3192
3192
|
});
|
|
3193
3193
|
```
|
|
3194
|
-
<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId"
|
|
3194
|
+
<a name="psw_PaymentSourceWidget+setRefId" id="psw_PaymentSourceWidget+setRefId" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setRefId"> </a>
|
|
3195
3195
|
|
|
3196
3196
|
### paymentSourceWidget.setRefId(refId)
|
|
3197
3197
|
Current method can set custom ID to identify the data in the future
|
|
@@ -3207,7 +3207,7 @@ Current method can set custom ID to identify the data in the future
|
|
|
3207
3207
|
```javascript
|
|
3208
3208
|
widget.setRefId('id');
|
|
3209
3209
|
```
|
|
3210
|
-
<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit"
|
|
3210
|
+
<a name="psw_PaymentSourceWidget+setLimit" id="psw_PaymentSourceWidget+setLimit" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setLimit"> </a>
|
|
3211
3211
|
|
|
3212
3212
|
### paymentSourceWidget.setLimit(count)
|
|
3213
3213
|
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.
|
|
@@ -3218,7 +3218,7 @@ Current method can set limit for payment sources count. In case when limit sets
|
|
|
3218
3218
|
| --- | --- | --- |
|
|
3219
3219
|
| count | <code>string</code> | payment source count |
|
|
3220
3220
|
|
|
3221
|
-
<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv"
|
|
3221
|
+
<a name="psw_PaymentSourceWidget+setEnv" id="psw_PaymentSourceWidget+setEnv" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setEnv"> </a>
|
|
3222
3222
|
|
|
3223
3223
|
### paymentSourceWidget.setEnv(env, [alias])
|
|
3224
3224
|
Current method can change environment. By default environment = sandbox
|
|
@@ -3236,13 +3236,13 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
3236
3236
|
```javascript
|
|
3237
3237
|
widget.setEnv('production');
|
|
3238
3238
|
```
|
|
3239
|
-
<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl"
|
|
3239
|
+
<a name="psw_PaymentSourceWidget+getIFrameUrl" id="psw_PaymentSourceWidget+getIFrameUrl" class="anchor" aria-hidden="true" href="PaymentSourceWidget+getIFrameUrl"> </a>
|
|
3240
3240
|
|
|
3241
3241
|
### paymentSourceWidget.getIFrameUrl()
|
|
3242
3242
|
Method for getting iframe's url
|
|
3243
3243
|
|
|
3244
3244
|
**Kind**: instance method of [<code>PaymentSourceWidget</code>](#psw_PaymentSourceWidget)
|
|
3245
|
-
<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds"
|
|
3245
|
+
<a name="psw_PaymentSourceWidget+filterByGatewayIds" id="psw_PaymentSourceWidget+filterByGatewayIds" class="anchor" aria-hidden="true" href="PaymentSourceWidget+filterByGatewayIds"> </a>
|
|
3246
3246
|
|
|
3247
3247
|
### paymentSourceWidget.filterByGatewayIds(ids)
|
|
3248
3248
|
Show payment source inside widget only with requested gateway ids
|
|
@@ -3253,7 +3253,7 @@ Show payment source inside widget only with requested gateway ids
|
|
|
3253
3253
|
| --- | --- | --- |
|
|
3254
3254
|
| ids | <code>[ 'Array' ].<string></code> | List of paydock gateway_id |
|
|
3255
3255
|
|
|
3256
|
-
<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes"
|
|
3256
|
+
<a name="psw_PaymentSourceWidget+filterByTypes" id="psw_PaymentSourceWidget+filterByTypes" class="anchor" aria-hidden="true" href="PaymentSourceWidget+filterByTypes"> </a>
|
|
3257
3257
|
|
|
3258
3258
|
### paymentSourceWidget.filterByTypes(types)
|
|
3259
3259
|
Show payment source inside widget only with requested payment source types
|
|
@@ -3264,7 +3264,7 @@ Show payment source inside widget only with requested payment source types
|
|
|
3264
3264
|
| --- | --- |
|
|
3265
3265
|
| types | List of payment source types. Available parameters [PAYMENT_TYPE](PAYMENT_TYPE) |
|
|
3266
3266
|
|
|
3267
|
-
<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage"
|
|
3267
|
+
<a name="psw_PaymentSourceWidget+setLanguage" id="psw_PaymentSourceWidget+setLanguage" class="anchor" aria-hidden="true" href="PaymentSourceWidget+setLanguage"> </a>
|
|
3268
3268
|
|
|
3269
3269
|
### paymentSourceWidget.setLanguage(code)
|
|
3270
3270
|
Method for setting a custom language code
|
|
@@ -3280,7 +3280,7 @@ Method for setting a custom language code
|
|
|
3280
3280
|
```javascript
|
|
3281
3281
|
config.setLanguage('en');
|
|
3282
3282
|
```
|
|
3283
|
-
<a name="psw_EVENT" id="psw_EVENT"
|
|
3283
|
+
<a name="psw_EVENT" id="psw_EVENT" class="anchor" aria-hidden="true" href="EVENT"> </a>
|
|
3284
3284
|
|
|
3285
3285
|
## EVENT : <code>object</code>
|
|
3286
3286
|
List of available event's name
|
|
@@ -3298,7 +3298,7 @@ List of available event's name
|
|
|
3298
3298
|
| META_CHANGE | <code>string</code> | <code>"metaChange"</code> |
|
|
3299
3299
|
| RESIZE | <code>string</code> | <code>"resize"</code> |
|
|
3300
3300
|
|
|
3301
|
-
<a name="psw_STYLE" id="psw_STYLE"
|
|
3301
|
+
<a name="psw_STYLE" id="psw_STYLE" class="anchor" aria-hidden="true" href="STYLE"> </a>
|
|
3302
3302
|
|
|
3303
3303
|
## STYLE : <code>object</code>
|
|
3304
3304
|
List of available style params for widget
|
|
@@ -3314,7 +3314,7 @@ List of available style params for widget
|
|
|
3314
3314
|
| ICON_SIZE | <code>string</code> | <code>"icon_size"</code> |
|
|
3315
3315
|
| FONT_SIZE | <code>string</code> | <code>"font_size"</code> |
|
|
3316
3316
|
|
|
3317
|
-
<a name="psw_PAYMENT_SOURCE_TYPE" id="psw_PAYMENT_SOURCE_TYPE"
|
|
3317
|
+
<a name="psw_PAYMENT_SOURCE_TYPE" id="psw_PAYMENT_SOURCE_TYPE" class="anchor" aria-hidden="true" href="PAYMENT_SOURCE_TYPE"> </a>
|
|
3318
3318
|
|
|
3319
3319
|
## PAYMENT\_SOURCE\_TYPE : <code>object</code>
|
|
3320
3320
|
List of available payment source types
|
|
@@ -3327,7 +3327,7 @@ List of available payment source types
|
|
|
3327
3327
|
| BANK_ACCOUNT | <code>string</code> | <code>"bank_account"</code> |
|
|
3328
3328
|
| CHECKOUT | <code>string</code> | <code>"checkout"</code> |
|
|
3329
3329
|
|
|
3330
|
-
<a name="psw_listener--PaymentSourceWidget" id="psw_listener--PaymentSourceWidget"
|
|
3330
|
+
<a name="psw_listener--PaymentSourceWidget" id="psw_listener--PaymentSourceWidget" class="anchor" aria-hidden="true" href="listener--PaymentSourceWidget"> </a>
|
|
3331
3331
|
|
|
3332
3332
|
## listener--PaymentSourceWidget : <code>function</code>
|
|
3333
3333
|
This callback will be called for each event in payment source widget
|
|
@@ -3635,7 +3635,7 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3635
3635
|
</dd>
|
|
3636
3636
|
</dl>
|
|
3637
3637
|
|
|
3638
|
-
<a name="cb_IEventCheckoutFinishData" id="cb_IEventCheckoutFinishData"
|
|
3638
|
+
<a name="cb_IEventCheckoutFinishData" id="cb_IEventCheckoutFinishData" class="anchor" aria-hidden="true" href="IEventCheckoutFinishData"> </a>
|
|
3639
3639
|
|
|
3640
3640
|
## IEventCheckoutFinishData
|
|
3641
3641
|
**Kind**: global interface
|
|
@@ -3644,7 +3644,7 @@ This example shows how you can use a lot of other methods to settings your butto
|
|
|
3644
3644
|
| --- | --- |
|
|
3645
3645
|
| [payment_source_token] | <code>string</code> |
|
|
3646
3646
|
|
|
3647
|
-
<a name="cb_IPayPalMeta" id="cb_IPayPalMeta"
|
|
3647
|
+
<a name="cb_IPayPalMeta" id="cb_IPayPalMeta" class="anchor" aria-hidden="true" href="IPayPalMeta"> </a>
|
|
3648
3648
|
|
|
3649
3649
|
## IPayPalMeta
|
|
3650
3650
|
Interface for PayPal checkout meta information
|
|
@@ -3671,7 +3671,7 @@ Interface for PayPal checkout meta information
|
|
|
3671
3671
|
| [phone] | <code>string</code> | The consumer’s phone number in E.164 international notation (Example: +12345678901) |
|
|
3672
3672
|
| [hide_shipping_address] | <code>boolean</code> | Determines whether PayPal displays shipping address fields on the PayPal pages |
|
|
3673
3673
|
|
|
3674
|
-
<a name="cb_IZipmoneyMeta" id="cb_IZipmoneyMeta"
|
|
3674
|
+
<a name="cb_IZipmoneyMeta" id="cb_IZipmoneyMeta" class="anchor" aria-hidden="true" href="IZipmoneyMeta"> </a>
|
|
3675
3675
|
|
|
3676
3676
|
## IZipmoneyMeta
|
|
3677
3677
|
Interface for ZipMoney checkout meta information
|
|
@@ -3718,7 +3718,7 @@ Interface for ZipMoney checkout meta information
|
|
|
3718
3718
|
| charge.billing_address.postcode | <code>string</code> | Billing postcode |
|
|
3719
3719
|
| charge.billing_address.country | <code>string</code> | Billing country |
|
|
3720
3720
|
|
|
3721
|
-
<a name="cb_IAfterpayMeta" id="cb_IAfterpayMeta"
|
|
3721
|
+
<a name="cb_IAfterpayMeta" id="cb_IAfterpayMeta" class="anchor" aria-hidden="true" href="IAfterpayMeta"> </a>
|
|
3722
3722
|
|
|
3723
3723
|
## IAfterpayMeta
|
|
3724
3724
|
Interface for Afterpay checkout meta information
|
|
@@ -3740,7 +3740,7 @@ Interface for Afterpay checkout meta information
|
|
|
3740
3740
|
| [address_country] | <code>string</code> |
|
|
3741
3741
|
| [phone] | <code>string</code> |
|
|
3742
3742
|
|
|
3743
|
-
<a name="cb_CheckoutButton" id="cb_CheckoutButton"
|
|
3743
|
+
<a name="cb_CheckoutButton" id="cb_CheckoutButton" class="anchor" aria-hidden="true" href="CheckoutButton"> </a>
|
|
3744
3744
|
|
|
3745
3745
|
## CheckoutButton
|
|
3746
3746
|
Class CheckoutButton transform usual button into checkout
|
|
@@ -3758,7 +3758,7 @@ Class CheckoutButton transform usual button into checkout
|
|
|
3758
3758
|
* [.setSuspendedRedirectUri(string)](#cb_CheckoutButton+setSuspendedRedirectUri)
|
|
3759
3759
|
* [.turnOffBackdrop()](#cb_CheckoutButton+turnOffBackdrop)
|
|
3760
3760
|
|
|
3761
|
-
<a name="cb_new_CheckoutButton_new" id="cb_new_CheckoutButton_new"
|
|
3761
|
+
<a name="cb_new_CheckoutButton_new" id="cb_new_CheckoutButton_new" class="anchor" aria-hidden="true" href="new_CheckoutButton_new"> </a>
|
|
3762
3762
|
|
|
3763
3763
|
### new exports.CheckoutButton(selector, aceessToken, [gatewayId], [type])
|
|
3764
3764
|
|
|
@@ -3774,7 +3774,7 @@ Class CheckoutButton transform usual button into checkout
|
|
|
3774
3774
|
```javascript
|
|
3775
3775
|
var widget = new CheckoutButton('#button', 'aceessToken','gatewayId');
|
|
3776
3776
|
```
|
|
3777
|
-
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"
|
|
3777
|
+
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" class="anchor" aria-hidden="true" href="CheckoutButton+on"> </a>
|
|
3778
3778
|
|
|
3779
3779
|
### checkoutButton.on(eventName, cb)
|
|
3780
3780
|
Listen to events of widget
|
|
@@ -3793,13 +3793,13 @@ widget.on('click', function () {
|
|
|
3793
3793
|
|
|
3794
3794
|
});
|
|
3795
3795
|
```
|
|
3796
|
-
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"
|
|
3796
|
+
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" class="anchor" aria-hidden="true" href="CheckoutButton+close"> </a>
|
|
3797
3797
|
|
|
3798
3798
|
### checkoutButton.close()
|
|
3799
3799
|
Close popup window forcibly
|
|
3800
3800
|
|
|
3801
3801
|
**Kind**: instance method of [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3802
|
-
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"
|
|
3802
|
+
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" class="anchor" aria-hidden="true" href="CheckoutButton+onFinishInsert"> </a>
|
|
3803
3803
|
|
|
3804
3804
|
### checkoutButton.onFinishInsert(selector, dataType)
|
|
3805
3805
|
After finish event of checkout button, data (dataType) will be insert to input (selector)
|
|
@@ -3811,7 +3811,7 @@ After finish event of checkout button, data (dataType) will be insert to input (
|
|
|
3811
3811
|
| selector | <code>string</code> | css selector . [] # |
|
|
3812
3812
|
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#cb_IEventCheckoutFinishData). |
|
|
3813
3813
|
|
|
3814
|
-
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"
|
|
3814
|
+
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" class="anchor" aria-hidden="true" href="CheckoutButton+setMeta"> </a>
|
|
3815
3815
|
|
|
3816
3816
|
### checkoutButton.setMeta(meta)
|
|
3817
3817
|
Method for setting meta information for checkout page
|
|
@@ -3831,7 +3831,7 @@ button.setMeta({
|
|
|
3831
3831
|
email: 'wault@paydock.com'
|
|
3832
3832
|
});
|
|
3833
3833
|
```
|
|
3834
|
-
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"
|
|
3834
|
+
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" class="anchor" aria-hidden="true" href="CheckoutButton+setBackdropDescription"> </a>
|
|
3835
3835
|
|
|
3836
3836
|
### checkoutButton.setBackdropDescription(text)
|
|
3837
3837
|
Method for setting backdrop description
|
|
@@ -3847,7 +3847,7 @@ Method for setting backdrop description
|
|
|
3847
3847
|
```javascript
|
|
3848
3848
|
button.setBackdropDescription('Custom description');
|
|
3849
3849
|
```
|
|
3850
|
-
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"
|
|
3850
|
+
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" class="anchor" aria-hidden="true" href="CheckoutButton+setBackdropTitle"> </a>
|
|
3851
3851
|
|
|
3852
3852
|
### checkoutButton.setBackdropTitle(string)
|
|
3853
3853
|
Method for setting backdrop title
|
|
@@ -3863,7 +3863,7 @@ Method for setting backdrop title
|
|
|
3863
3863
|
```javascript
|
|
3864
3864
|
button.setBackdropTitle('Custom title');
|
|
3865
3865
|
```
|
|
3866
|
-
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri"
|
|
3866
|
+
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri" class="anchor" aria-hidden="true" href="CheckoutButton+setSuspendedRedirectUri"> </a>
|
|
3867
3867
|
|
|
3868
3868
|
### checkoutButton.setSuspendedRedirectUri(string)
|
|
3869
3869
|
Method for setting suspended redirect uri. Redirect after referred checkout
|
|
@@ -3874,7 +3874,7 @@ Method for setting suspended redirect uri. Redirect after referred checkout
|
|
|
3874
3874
|
| --- | --- | --- |
|
|
3875
3875
|
| string | <code>uri</code> | uri for redirect (by default) |
|
|
3876
3876
|
|
|
3877
|
-
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"
|
|
3877
|
+
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" class="anchor" aria-hidden="true" href="CheckoutButton+turnOffBackdrop"> </a>
|
|
3878
3878
|
|
|
3879
3879
|
### checkoutButton.turnOffBackdrop()
|
|
3880
3880
|
Method for disable backdrop on the page.
|
|
@@ -3885,7 +3885,7 @@ Method for disable backdrop on the page.
|
|
|
3885
3885
|
```javascript
|
|
3886
3886
|
button.turnOffBackdrop();
|
|
3887
3887
|
```
|
|
3888
|
-
<a name="cb_ZipmoneyCheckoutButton" id="cb_ZipmoneyCheckoutButton"
|
|
3888
|
+
<a name="cb_ZipmoneyCheckoutButton" id="cb_ZipmoneyCheckoutButton" class="anchor" aria-hidden="true" href="ZipmoneyCheckoutButton"> </a>
|
|
3889
3889
|
|
|
3890
3890
|
## ZipmoneyCheckoutButton ⇐ [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
3891
3891
|
Class ZipmoneyCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
|
|
@@ -3904,7 +3904,7 @@ Class ZipmoneyCheckoutButton is wrapper of CheckoutButton transform usual button
|
|
|
3904
3904
|
* [.setBackdropTitle(string)](#cb_CheckoutButton+setBackdropTitle)
|
|
3905
3905
|
* [.turnOffBackdrop()](#cb_CheckoutButton+turnOffBackdrop)
|
|
3906
3906
|
|
|
3907
|
-
<a name="cb_new_ZipmoneyCheckoutButton_new" id="cb_new_ZipmoneyCheckoutButton_new"
|
|
3907
|
+
<a name="cb_new_ZipmoneyCheckoutButton_new" id="cb_new_ZipmoneyCheckoutButton_new" class="anchor" aria-hidden="true" href="new_ZipmoneyCheckoutButton_new"> </a>
|
|
3908
3908
|
|
|
3909
3909
|
### new exports.ZipmoneyCheckoutButton(selector, publicKey, [gatewayId])
|
|
3910
3910
|
|
|
@@ -3919,7 +3919,7 @@ Class ZipmoneyCheckoutButton is wrapper of CheckoutButton transform usual button
|
|
|
3919
3919
|
```javascript
|
|
3920
3920
|
var widget = new ZipmoneyCheckoutButton('#button', 'publicKey','gatewayId');
|
|
3921
3921
|
```
|
|
3922
|
-
<a name="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri" id="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri"
|
|
3922
|
+
<a name="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri" id="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri" class="anchor" aria-hidden="true" href="ZipmoneyCheckoutButton+setSuspendedRedirectUri"> </a>
|
|
3923
3923
|
|
|
3924
3924
|
### zipmoneyCheckoutButton.setSuspendedRedirectUri(string)
|
|
3925
3925
|
Method for setting suspended redirect uri. Redirect after referred checkout
|
|
@@ -3935,7 +3935,7 @@ If using in-context (sdk) we will not automatically redirect to this URI.
|
|
|
3935
3935
|
| --- | --- | --- |
|
|
3936
3936
|
| string | <code>uri</code> | uri for redirect (by default) |
|
|
3937
3937
|
|
|
3938
|
-
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"
|
|
3938
|
+
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" class="anchor" aria-hidden="true" href="CheckoutButton+on"> </a>
|
|
3939
3939
|
|
|
3940
3940
|
### zipmoneyCheckoutButton.on(eventName, cb)
|
|
3941
3941
|
Listen to events of widget
|
|
@@ -3954,13 +3954,13 @@ widget.on('click', function () {
|
|
|
3954
3954
|
|
|
3955
3955
|
});
|
|
3956
3956
|
```
|
|
3957
|
-
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"
|
|
3957
|
+
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" class="anchor" aria-hidden="true" href="CheckoutButton+close"> </a>
|
|
3958
3958
|
|
|
3959
3959
|
### zipmoneyCheckoutButton.close()
|
|
3960
3960
|
Close popup window forcibly
|
|
3961
3961
|
|
|
3962
3962
|
**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#cb_ZipmoneyCheckoutButton)
|
|
3963
|
-
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"
|
|
3963
|
+
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" class="anchor" aria-hidden="true" href="CheckoutButton+onFinishInsert"> </a>
|
|
3964
3964
|
|
|
3965
3965
|
### zipmoneyCheckoutButton.onFinishInsert(selector, dataType)
|
|
3966
3966
|
After finish event of checkout button, data (dataType) will be insert to input (selector)
|
|
@@ -3972,7 +3972,7 @@ After finish event of checkout button, data (dataType) will be insert to input (
|
|
|
3972
3972
|
| selector | <code>string</code> | css selector . [] # |
|
|
3973
3973
|
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#cb_IEventCheckoutFinishData). |
|
|
3974
3974
|
|
|
3975
|
-
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"
|
|
3975
|
+
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" class="anchor" aria-hidden="true" href="CheckoutButton+setMeta"> </a>
|
|
3976
3976
|
|
|
3977
3977
|
### zipmoneyCheckoutButton.setMeta(meta)
|
|
3978
3978
|
Method for setting meta information for checkout page
|
|
@@ -3992,7 +3992,7 @@ button.setMeta({
|
|
|
3992
3992
|
email: 'wault@paydock.com'
|
|
3993
3993
|
});
|
|
3994
3994
|
```
|
|
3995
|
-
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"
|
|
3995
|
+
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" class="anchor" aria-hidden="true" href="CheckoutButton+setBackdropDescription"> </a>
|
|
3996
3996
|
|
|
3997
3997
|
### zipmoneyCheckoutButton.setBackdropDescription(text)
|
|
3998
3998
|
Method for setting backdrop description
|
|
@@ -4008,7 +4008,7 @@ Method for setting backdrop description
|
|
|
4008
4008
|
```javascript
|
|
4009
4009
|
button.setBackdropDescription('Custom description');
|
|
4010
4010
|
```
|
|
4011
|
-
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"
|
|
4011
|
+
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" class="anchor" aria-hidden="true" href="CheckoutButton+setBackdropTitle"> </a>
|
|
4012
4012
|
|
|
4013
4013
|
### zipmoneyCheckoutButton.setBackdropTitle(string)
|
|
4014
4014
|
Method for setting backdrop title
|
|
@@ -4024,7 +4024,7 @@ Method for setting backdrop title
|
|
|
4024
4024
|
```javascript
|
|
4025
4025
|
button.setBackdropTitle('Custom title');
|
|
4026
4026
|
```
|
|
4027
|
-
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"
|
|
4027
|
+
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" class="anchor" aria-hidden="true" href="CheckoutButton+turnOffBackdrop"> </a>
|
|
4028
4028
|
|
|
4029
4029
|
### zipmoneyCheckoutButton.turnOffBackdrop()
|
|
4030
4030
|
Method for disable backdrop on the page.
|
|
@@ -4035,7 +4035,7 @@ Method for disable backdrop on the page.
|
|
|
4035
4035
|
```javascript
|
|
4036
4036
|
button.turnOffBackdrop();
|
|
4037
4037
|
```
|
|
4038
|
-
<a name="cb_PaypalCheckoutButton" id="cb_PaypalCheckoutButton"
|
|
4038
|
+
<a name="cb_PaypalCheckoutButton" id="cb_PaypalCheckoutButton" class="anchor" aria-hidden="true" href="PaypalCheckoutButton"> </a>
|
|
4039
4039
|
|
|
4040
4040
|
## PaypalCheckoutButton ⇐ [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
4041
4041
|
Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
|
|
@@ -4054,7 +4054,7 @@ Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button i
|
|
|
4054
4054
|
* [.setSuspendedRedirectUri(string)](#cb_CheckoutButton+setSuspendedRedirectUri)
|
|
4055
4055
|
* [.turnOffBackdrop()](#cb_CheckoutButton+turnOffBackdrop)
|
|
4056
4056
|
|
|
4057
|
-
<a name="cb_new_PaypalCheckoutButton_new" id="cb_new_PaypalCheckoutButton_new"
|
|
4057
|
+
<a name="cb_new_PaypalCheckoutButton_new" id="cb_new_PaypalCheckoutButton_new" class="anchor" aria-hidden="true" href="new_PaypalCheckoutButton_new"> </a>
|
|
4058
4058
|
|
|
4059
4059
|
### new exports.PaypalCheckoutButton(selector, publicKey, [gatewayId])
|
|
4060
4060
|
|
|
@@ -4069,7 +4069,7 @@ Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button i
|
|
|
4069
4069
|
```javascript
|
|
4070
4070
|
var widget = new PaypalCheckoutButton('#button', 'publicKey','gatewayId');
|
|
4071
4071
|
```
|
|
4072
|
-
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"
|
|
4072
|
+
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" class="anchor" aria-hidden="true" href="CheckoutButton+on"> </a>
|
|
4073
4073
|
|
|
4074
4074
|
### paypalCheckoutButton.on(eventName, cb)
|
|
4075
4075
|
Listen to events of widget
|
|
@@ -4088,13 +4088,13 @@ widget.on('click', function () {
|
|
|
4088
4088
|
|
|
4089
4089
|
});
|
|
4090
4090
|
```
|
|
4091
|
-
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"
|
|
4091
|
+
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" class="anchor" aria-hidden="true" href="CheckoutButton+close"> </a>
|
|
4092
4092
|
|
|
4093
4093
|
### paypalCheckoutButton.close()
|
|
4094
4094
|
Close popup window forcibly
|
|
4095
4095
|
|
|
4096
4096
|
**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#cb_PaypalCheckoutButton)
|
|
4097
|
-
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"
|
|
4097
|
+
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" class="anchor" aria-hidden="true" href="CheckoutButton+onFinishInsert"> </a>
|
|
4098
4098
|
|
|
4099
4099
|
### paypalCheckoutButton.onFinishInsert(selector, dataType)
|
|
4100
4100
|
After finish event of checkout button, data (dataType) will be insert to input (selector)
|
|
@@ -4106,7 +4106,7 @@ After finish event of checkout button, data (dataType) will be insert to input (
|
|
|
4106
4106
|
| selector | <code>string</code> | css selector . [] # |
|
|
4107
4107
|
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#cb_IEventCheckoutFinishData). |
|
|
4108
4108
|
|
|
4109
|
-
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"
|
|
4109
|
+
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" class="anchor" aria-hidden="true" href="CheckoutButton+setMeta"> </a>
|
|
4110
4110
|
|
|
4111
4111
|
### paypalCheckoutButton.setMeta(meta)
|
|
4112
4112
|
Method for setting meta information for checkout page
|
|
@@ -4126,7 +4126,7 @@ button.setMeta({
|
|
|
4126
4126
|
email: 'wault@paydock.com'
|
|
4127
4127
|
});
|
|
4128
4128
|
```
|
|
4129
|
-
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"
|
|
4129
|
+
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" class="anchor" aria-hidden="true" href="CheckoutButton+setBackdropDescription"> </a>
|
|
4130
4130
|
|
|
4131
4131
|
### paypalCheckoutButton.setBackdropDescription(text)
|
|
4132
4132
|
Method for setting backdrop description
|
|
@@ -4142,7 +4142,7 @@ Method for setting backdrop description
|
|
|
4142
4142
|
```javascript
|
|
4143
4143
|
button.setBackdropDescription('Custom description');
|
|
4144
4144
|
```
|
|
4145
|
-
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"
|
|
4145
|
+
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" class="anchor" aria-hidden="true" href="CheckoutButton+setBackdropTitle"> </a>
|
|
4146
4146
|
|
|
4147
4147
|
### paypalCheckoutButton.setBackdropTitle(string)
|
|
4148
4148
|
Method for setting backdrop title
|
|
@@ -4158,7 +4158,7 @@ Method for setting backdrop title
|
|
|
4158
4158
|
```javascript
|
|
4159
4159
|
button.setBackdropTitle('Custom title');
|
|
4160
4160
|
```
|
|
4161
|
-
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri"
|
|
4161
|
+
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri" class="anchor" aria-hidden="true" href="CheckoutButton+setSuspendedRedirectUri"> </a>
|
|
4162
4162
|
|
|
4163
4163
|
### paypalCheckoutButton.setSuspendedRedirectUri(string)
|
|
4164
4164
|
Method for setting suspended redirect uri. Redirect after referred checkout
|
|
@@ -4169,7 +4169,7 @@ Method for setting suspended redirect uri. Redirect after referred checkout
|
|
|
4169
4169
|
| --- | --- | --- |
|
|
4170
4170
|
| string | <code>uri</code> | uri for redirect (by default) |
|
|
4171
4171
|
|
|
4172
|
-
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"
|
|
4172
|
+
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" class="anchor" aria-hidden="true" href="CheckoutButton+turnOffBackdrop"> </a>
|
|
4173
4173
|
|
|
4174
4174
|
### paypalCheckoutButton.turnOffBackdrop()
|
|
4175
4175
|
Method for disable backdrop on the page.
|
|
@@ -4180,7 +4180,7 @@ Method for disable backdrop on the page.
|
|
|
4180
4180
|
```javascript
|
|
4181
4181
|
button.turnOffBackdrop();
|
|
4182
4182
|
```
|
|
4183
|
-
<a name="cb_AfterpayCheckoutButton" id="cb_AfterpayCheckoutButton"
|
|
4183
|
+
<a name="cb_AfterpayCheckoutButton" id="cb_AfterpayCheckoutButton" class="anchor" aria-hidden="true" href="AfterpayCheckoutButton"> </a>
|
|
4184
4184
|
|
|
4185
4185
|
## AfterpayCheckoutButton ⇐ [<code>CheckoutButton</code>](#cb_CheckoutButton)
|
|
4186
4186
|
Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
|
|
@@ -4199,7 +4199,7 @@ Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button
|
|
|
4199
4199
|
* [.setSuspendedRedirectUri(string)](#cb_CheckoutButton+setSuspendedRedirectUri)
|
|
4200
4200
|
* [.turnOffBackdrop()](#cb_CheckoutButton+turnOffBackdrop)
|
|
4201
4201
|
|
|
4202
|
-
<a name="cb_new_AfterpayCheckoutButton_new" id="cb_new_AfterpayCheckoutButton_new"
|
|
4202
|
+
<a name="cb_new_AfterpayCheckoutButton_new" id="cb_new_AfterpayCheckoutButton_new" class="anchor" aria-hidden="true" href="new_AfterpayCheckoutButton_new"> </a>
|
|
4203
4203
|
|
|
4204
4204
|
### new exports.AfterpayCheckoutButton(selector, accessToken, [gatewayId])
|
|
4205
4205
|
|
|
@@ -4214,7 +4214,7 @@ Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button
|
|
|
4214
4214
|
```javascript
|
|
4215
4215
|
var widget = new AfterpayCheckoutButton('#button', 'access-token','gatewayId');
|
|
4216
4216
|
```
|
|
4217
|
-
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on"
|
|
4217
|
+
<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" class="anchor" aria-hidden="true" href="CheckoutButton+on"> </a>
|
|
4218
4218
|
|
|
4219
4219
|
### afterpayCheckoutButton.on(eventName, cb)
|
|
4220
4220
|
Listen to events of widget
|
|
@@ -4233,13 +4233,13 @@ widget.on('click', function () {
|
|
|
4233
4233
|
|
|
4234
4234
|
});
|
|
4235
4235
|
```
|
|
4236
|
-
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close"
|
|
4236
|
+
<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" class="anchor" aria-hidden="true" href="CheckoutButton+close"> </a>
|
|
4237
4237
|
|
|
4238
4238
|
### afterpayCheckoutButton.close()
|
|
4239
4239
|
Close popup window forcibly
|
|
4240
4240
|
|
|
4241
4241
|
**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#cb_AfterpayCheckoutButton)
|
|
4242
|
-
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert"
|
|
4242
|
+
<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" class="anchor" aria-hidden="true" href="CheckoutButton+onFinishInsert"> </a>
|
|
4243
4243
|
|
|
4244
4244
|
### afterpayCheckoutButton.onFinishInsert(selector, dataType)
|
|
4245
4245
|
After finish event of checkout button, data (dataType) will be insert to input (selector)
|
|
@@ -4251,7 +4251,7 @@ After finish event of checkout button, data (dataType) will be insert to input (
|
|
|
4251
4251
|
| selector | <code>string</code> | css selector . [] # |
|
|
4252
4252
|
| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#cb_IEventCheckoutFinishData). |
|
|
4253
4253
|
|
|
4254
|
-
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta"
|
|
4254
|
+
<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" class="anchor" aria-hidden="true" href="CheckoutButton+setMeta"> </a>
|
|
4255
4255
|
|
|
4256
4256
|
### afterpayCheckoutButton.setMeta(meta)
|
|
4257
4257
|
Method for setting meta information for checkout page
|
|
@@ -4271,7 +4271,7 @@ button.setMeta({
|
|
|
4271
4271
|
email: 'wault@paydock.com'
|
|
4272
4272
|
});
|
|
4273
4273
|
```
|
|
4274
|
-
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription"
|
|
4274
|
+
<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" class="anchor" aria-hidden="true" href="CheckoutButton+setBackdropDescription"> </a>
|
|
4275
4275
|
|
|
4276
4276
|
### afterpayCheckoutButton.setBackdropDescription(text)
|
|
4277
4277
|
Method for setting backdrop description
|
|
@@ -4287,7 +4287,7 @@ Method for setting backdrop description
|
|
|
4287
4287
|
```javascript
|
|
4288
4288
|
button.setBackdropDescription('Custom description');
|
|
4289
4289
|
```
|
|
4290
|
-
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle"
|
|
4290
|
+
<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" class="anchor" aria-hidden="true" href="CheckoutButton+setBackdropTitle"> </a>
|
|
4291
4291
|
|
|
4292
4292
|
### afterpayCheckoutButton.setBackdropTitle(string)
|
|
4293
4293
|
Method for setting backdrop title
|
|
@@ -4303,7 +4303,7 @@ Method for setting backdrop title
|
|
|
4303
4303
|
```javascript
|
|
4304
4304
|
button.setBackdropTitle('Custom title');
|
|
4305
4305
|
```
|
|
4306
|
-
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri"
|
|
4306
|
+
<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri" class="anchor" aria-hidden="true" href="CheckoutButton+setSuspendedRedirectUri"> </a>
|
|
4307
4307
|
|
|
4308
4308
|
### afterpayCheckoutButton.setSuspendedRedirectUri(string)
|
|
4309
4309
|
Method for setting suspended redirect uri. Redirect after referred checkout
|
|
@@ -4314,7 +4314,7 @@ Method for setting suspended redirect uri. Redirect after referred checkout
|
|
|
4314
4314
|
| --- | --- | --- |
|
|
4315
4315
|
| string | <code>uri</code> | uri for redirect (by default) |
|
|
4316
4316
|
|
|
4317
|
-
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop"
|
|
4317
|
+
<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" class="anchor" aria-hidden="true" href="CheckoutButton+turnOffBackdrop"> </a>
|
|
4318
4318
|
|
|
4319
4319
|
### afterpayCheckoutButton.turnOffBackdrop()
|
|
4320
4320
|
Method for disable backdrop on the page.
|
|
@@ -4325,7 +4325,7 @@ Method for disable backdrop on the page.
|
|
|
4325
4325
|
```javascript
|
|
4326
4326
|
button.turnOffBackdrop();
|
|
4327
4327
|
```
|
|
4328
|
-
<a name="cb_CHECKOUT_BUTTON_EVENT" id="cb_CHECKOUT_BUTTON_EVENT"
|
|
4328
|
+
<a name="cb_CHECKOUT_BUTTON_EVENT" id="cb_CHECKOUT_BUTTON_EVENT" class="anchor" aria-hidden="true" href="CHECKOUT_BUTTON_EVENT"> </a>
|
|
4329
4329
|
|
|
4330
4330
|
## CHECKOUT\_BUTTON\_EVENT : <code>object</code>
|
|
4331
4331
|
**Kind**: global constant
|
|
@@ -4339,7 +4339,7 @@ button.turnOffBackdrop();
|
|
|
4339
4339
|
| FINISH | <code>string</code> | <code>"finish"</code> |
|
|
4340
4340
|
| CLOSE | <code>string</code> | <code>"close"</code> |
|
|
4341
4341
|
|
|
4342
|
-
<a name="cb_listener" id="cb_listener"
|
|
4342
|
+
<a name="cb_listener" id="cb_listener" class="anchor" aria-hidden="true" href="listener"> </a>
|
|
4343
4343
|
|
|
4344
4344
|
## listener : <code>function</code>
|
|
4345
4345
|
This callback will be called for each event in payment source widget
|
|
@@ -4781,7 +4781,7 @@ This example shows how you can use a lot of other methods to settings your form
|
|
|
4781
4781
|
</html>
|
|
4782
4782
|
```
|
|
4783
4783
|
|
|
4784
|
-
<a name="VaultDisplayWidget" id="VaultDisplayWidget"
|
|
4784
|
+
<a name="VaultDisplayWidget" id="VaultDisplayWidget" class="anchor" aria-hidden="true" href="VaultDisplayWidget"> </a>
|
|
4785
4785
|
|
|
4786
4786
|
## VaultDisplayWidget
|
|
4787
4787
|
Class VaultDisplayWidget include method for working on html
|
|
@@ -4795,7 +4795,7 @@ Class VaultDisplayWidget include method for working on html
|
|
|
4795
4795
|
* [.setStyles(fields)](#VaultDisplayWidget+setStyles)
|
|
4796
4796
|
* [.load()](#VaultDisplayWidget+load)
|
|
4797
4797
|
|
|
4798
|
-
<a name="new_VaultDisplayWidget_new" id="new_VaultDisplayWidget_new"
|
|
4798
|
+
<a name="new_VaultDisplayWidget_new" id="new_VaultDisplayWidget_new" class="anchor" aria-hidden="true" href="new_VaultDisplayWidget_new"> </a>
|
|
4799
4799
|
|
|
4800
4800
|
### new exports.VaultDisplayWidget(selector, token)
|
|
4801
4801
|
|
|
@@ -4808,7 +4808,7 @@ Class VaultDisplayWidget include method for working on html
|
|
|
4808
4808
|
```js
|
|
4809
4809
|
var widget = new VaultDisplayWidget('#widget', 'token');
|
|
4810
4810
|
```
|
|
4811
|
-
<a name="VaultDisplayWidget+setEnv" id="VaultDisplayWidget+setEnv"
|
|
4811
|
+
<a name="VaultDisplayWidget+setEnv" id="VaultDisplayWidget+setEnv" class="anchor" aria-hidden="true" href="VaultDisplayWidget+setEnv"> </a>
|
|
4812
4812
|
|
|
4813
4813
|
### vaultDisplayWidget.setEnv(env, [alias])
|
|
4814
4814
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -4825,7 +4825,7 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
4825
4825
|
```js
|
|
4826
4826
|
widget.setEnv('production', 'paydock.com');
|
|
4827
4827
|
```
|
|
4828
|
-
<a name="VaultDisplayWidget+on" id="VaultDisplayWidget+on"
|
|
4828
|
+
<a name="VaultDisplayWidget+on" id="VaultDisplayWidget+on" class="anchor" aria-hidden="true" href="VaultDisplayWidget+on"> </a>
|
|
4829
4829
|
|
|
4830
4830
|
### vaultDisplayWidget.on(eventName, [cb]) ⇒ <code>[ 'Promise' ].<(IEventData\|void)></code>
|
|
4831
4831
|
Listen to events of widget
|
|
@@ -4847,7 +4847,7 @@ widget.on('after_load', function (data) {
|
|
|
4847
4847
|
console.log(data);
|
|
4848
4848
|
});
|
|
4849
4849
|
```
|
|
4850
|
-
<a name="VaultDisplayWidget+setStyles" id="VaultDisplayWidget+setStyles"
|
|
4850
|
+
<a name="VaultDisplayWidget+setStyles" id="VaultDisplayWidget+setStyles" class="anchor" aria-hidden="true" href="VaultDisplayWidget+setStyles"> </a>
|
|
4851
4851
|
|
|
4852
4852
|
### vaultDisplayWidget.setStyles(fields)
|
|
4853
4853
|
Object contain styles for widget
|
|
@@ -4869,7 +4869,7 @@ widget.setStyles({
|
|
|
4869
4869
|
fort_family: 'fantasy'
|
|
4870
4870
|
});
|
|
4871
4871
|
```
|
|
4872
|
-
<a name="VaultDisplayWidget+load" id="VaultDisplayWidget+load"
|
|
4872
|
+
<a name="VaultDisplayWidget+load" id="VaultDisplayWidget+load" class="anchor" aria-hidden="true" href="VaultDisplayWidget+load"> </a>
|
|
4873
4873
|
|
|
4874
4874
|
### vaultDisplayWidget.load()
|
|
4875
4875
|
The final method to beginning, the load process of widget to html
|
|
@@ -5341,7 +5341,7 @@ Also, for **ApplePay via MPGS** you can initialize the `ApplePayPaymentRequest`
|
|
|
5341
5341
|
</dd>
|
|
5342
5342
|
</dl>
|
|
5343
5343
|
|
|
5344
|
-
<a name="IWalletMeta" id="IWalletMeta"
|
|
5344
|
+
<a name="IWalletMeta" id="IWalletMeta" class="anchor" aria-hidden="true" href="IWalletMeta"> </a>
|
|
5345
5345
|
|
|
5346
5346
|
## IWalletMeta : <code>object</code>
|
|
5347
5347
|
Interface of data used by the wallet checkout and payment proccess.
|
|
@@ -5365,7 +5365,7 @@ Interface of data used by the wallet checkout and payment proccess.
|
|
|
5365
5365
|
| [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
5366
|
| [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
5367
|
|
|
5368
|
-
<a name="IApplePayShippingOption" id="IApplePayShippingOption"
|
|
5368
|
+
<a name="IApplePayShippingOption" id="IApplePayShippingOption" class="anchor" aria-hidden="true" href="IApplePayShippingOption"> </a>
|
|
5369
5369
|
|
|
5370
5370
|
## IApplePayShippingOption : <code>object</code>
|
|
5371
5371
|
Interface of Shipping Options for ApplePay
|
|
@@ -5380,7 +5380,7 @@ Interface of Shipping Options for ApplePay
|
|
|
5380
5380
|
| [detail] | <code>string</code> | Details of the Shipping Option. Required. |
|
|
5381
5381
|
| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
|
|
5382
5382
|
|
|
5383
|
-
<a name="IGooglePayShippingOption" id="IGooglePayShippingOption"
|
|
5383
|
+
<a name="IGooglePayShippingOption" id="IGooglePayShippingOption" class="anchor" aria-hidden="true" href="IGooglePayShippingOption"> </a>
|
|
5384
5384
|
|
|
5385
5385
|
## IGooglePayShippingOption : <code>object</code>
|
|
5386
5386
|
Interface of Shipping Options for GooglePay
|
|
@@ -5394,7 +5394,7 @@ Interface of Shipping Options for GooglePay
|
|
|
5394
5394
|
| [detail] | <code>string</code> | Details of the Shipping Option. Optional. |
|
|
5395
5395
|
| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
|
|
5396
5396
|
|
|
5397
|
-
<a name="IPayPalShippingOption" id="IPayPalShippingOption"
|
|
5397
|
+
<a name="IPayPalShippingOption" id="IPayPalShippingOption" class="anchor" aria-hidden="true" href="IPayPalShippingOption"> </a>
|
|
5398
5398
|
|
|
5399
5399
|
## IPayPalShippingOption : <code>object</code>
|
|
5400
5400
|
Interface of Shipping Options for PayPal
|
|
@@ -5409,7 +5409,7 @@ Interface of Shipping Options for PayPal
|
|
|
5409
5409
|
| [currency] | <code>string</code> | Currency of the Shipping Option. Required. |
|
|
5410
5410
|
| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'SHIPPING' or 'PICKUP'. Required. |
|
|
5411
5411
|
|
|
5412
|
-
<a name="WalletButtons" id="WalletButtons"
|
|
5412
|
+
<a name="WalletButtons" id="WalletButtons" class="anchor" aria-hidden="true" href="WalletButtons"> </a>
|
|
5413
5413
|
|
|
5414
5414
|
## WalletButtons
|
|
5415
5415
|
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 +5429,7 @@ Class WalletButtons to work with different E-Wallets within html (currently supp
|
|
|
5429
5429
|
* [.onPaymentInReview([handler])](#WalletButtons+onPaymentInReview)
|
|
5430
5430
|
* [.onPaymentError([handler])](#WalletButtons+onPaymentError)
|
|
5431
5431
|
|
|
5432
|
-
<a name="new_WalletButtons_new" id="new_WalletButtons_new"
|
|
5432
|
+
<a name="new_WalletButtons_new" id="new_WalletButtons_new" class="anchor" aria-hidden="true" href="new_WalletButtons_new"> </a>
|
|
5433
5433
|
|
|
5434
5434
|
### new exports.WalletButtons(selector, chargeToken, object)
|
|
5435
5435
|
|
|
@@ -5443,7 +5443,7 @@ Class WalletButtons to work with different E-Wallets within html (currently supp
|
|
|
5443
5443
|
```js
|
|
5444
5444
|
var button = new WalletButtons('#wallet-buttons', 'charge-token', { amount_label: 'Total', country: 'us' });
|
|
5445
5445
|
```
|
|
5446
|
-
<a name="WalletButtons+load" id="WalletButtons+load"
|
|
5446
|
+
<a name="WalletButtons+load" id="WalletButtons+load" class="anchor" aria-hidden="true" href="WalletButtons+load"> </a>
|
|
5447
5447
|
|
|
5448
5448
|
### walletButtons.load()
|
|
5449
5449
|
Initializes the availability checks and inserts the button if possible.
|
|
@@ -5462,7 +5462,7 @@ var button = new WalletButtons(
|
|
|
5462
5462
|
);
|
|
5463
5463
|
button.load();
|
|
5464
5464
|
```
|
|
5465
|
-
<a name="WalletButtons+update" id="WalletButtons+update"
|
|
5465
|
+
<a name="WalletButtons+update" id="WalletButtons+update" class="anchor" aria-hidden="true" href="WalletButtons+update"> </a>
|
|
5466
5466
|
|
|
5467
5467
|
### walletButtons.update()
|
|
5468
5468
|
Triggers the update process of the wallet, if available.
|
|
@@ -5520,7 +5520,7 @@ var button = new WalletButtons(
|
|
|
5520
5520
|
});
|
|
5521
5521
|
});
|
|
5522
5522
|
```
|
|
5523
|
-
<a name="WalletButtons+setEnv" id="WalletButtons+setEnv"
|
|
5523
|
+
<a name="WalletButtons+setEnv" id="WalletButtons+setEnv" class="anchor" aria-hidden="true" href="WalletButtons+setEnv"> </a>
|
|
5524
5524
|
|
|
5525
5525
|
### walletButtons.setEnv(env, [alias])
|
|
5526
5526
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -5538,7 +5538,7 @@ Bear in mind that you must set an environment before calling `button.load()`.
|
|
|
5538
5538
|
```js
|
|
5539
5539
|
button.setEnv('production', 'paydock.com');
|
|
5540
5540
|
```
|
|
5541
|
-
<a name="WalletButtons+close" id="WalletButtons+close"
|
|
5541
|
+
<a name="WalletButtons+close" id="WalletButtons+close" class="anchor" aria-hidden="true" href="WalletButtons+close"> </a>
|
|
5542
5542
|
|
|
5543
5543
|
### walletButtons.close()
|
|
5544
5544
|
Closes the checkout forcibly. Currently supported in Flypay wallet.
|
|
@@ -5548,7 +5548,7 @@ Closes the checkout forcibly. Currently supported in Flypay wallet.
|
|
|
5548
5548
|
```js
|
|
5549
5549
|
button.close();
|
|
5550
5550
|
```
|
|
5551
|
-
<a name="WalletButtons+on" id="WalletButtons+on"
|
|
5551
|
+
<a name="WalletButtons+on" id="WalletButtons+on" class="anchor" aria-hidden="true" href="WalletButtons+on"> </a>
|
|
5552
5552
|
|
|
5553
5553
|
### walletButtons.on(eventName, [cb]) ⇒ <code>Promise.<IEventData></code> \| <code>void</code>
|
|
5554
5554
|
Listen to events of button. `unavailable` returns no data, `paymentSuccessful` returns IWalletPaymentSuccessful
|
|
@@ -5573,7 +5573,7 @@ button.on('unavailable').then(function () {
|
|
|
5573
5573
|
console.log('No button is available);
|
|
5574
5574
|
});
|
|
5575
5575
|
```
|
|
5576
|
-
<a name="WalletButtons+onUnavailable" id="WalletButtons+onUnavailable"
|
|
5576
|
+
<a name="WalletButtons+onUnavailable" id="WalletButtons+onUnavailable" class="anchor" aria-hidden="true" href="WalletButtons+onUnavailable"> </a>
|
|
5577
5577
|
|
|
5578
5578
|
### walletButtons.onUnavailable([handler])
|
|
5579
5579
|
User to subscribe to the no button available event. This method is used after loading when the button is not available.
|
|
@@ -5600,7 +5600,7 @@ button.onUnavailable().then(() => console.log('No wallet buttons available'));
|
|
|
5600
5600
|
```js
|
|
5601
5601
|
button.onUnavailable(function (data) {console.log('data.wallet :: ', data.wallet)});
|
|
5602
5602
|
```
|
|
5603
|
-
<a name="WalletButtons+onUpdate" id="WalletButtons+onUpdate"
|
|
5603
|
+
<a name="WalletButtons+onUpdate" id="WalletButtons+onUpdate" class="anchor" aria-hidden="true" href="WalletButtons+onUpdate"> </a>
|
|
5604
5604
|
|
|
5605
5605
|
### walletButtons.onUpdate([handler])
|
|
5606
5606
|
If the wallet performs some update in the checkout process, the function passed as parameter will be called.
|
|
@@ -5623,7 +5623,7 @@ button.onUpdate((data) => {
|
|
|
5623
5623
|
```js
|
|
5624
5624
|
button.onUpdate().then((data) => throw new Error());
|
|
5625
5625
|
```
|
|
5626
|
-
<a name="WalletButtons+onPaymentSuccessful" id="WalletButtons+onPaymentSuccessful"
|
|
5626
|
+
<a name="WalletButtons+onPaymentSuccessful" id="WalletButtons+onPaymentSuccessful" class="anchor" aria-hidden="true" href="WalletButtons+onPaymentSuccessful"> </a>
|
|
5627
5627
|
|
|
5628
5628
|
### walletButtons.onPaymentSuccessful([handler])
|
|
5629
5629
|
If the payment was successful, the function passed as parameter will be called.
|
|
@@ -5645,7 +5645,7 @@ button.onPaymentSuccessful((data) => {
|
|
|
5645
5645
|
```js
|
|
5646
5646
|
button.onPaymentSuccessful().then((data) => console.log('Payment successful!'));
|
|
5647
5647
|
```
|
|
5648
|
-
<a name="WalletButtons+onPaymentInReview" id="WalletButtons+onPaymentInReview"
|
|
5648
|
+
<a name="WalletButtons+onPaymentInReview" id="WalletButtons+onPaymentInReview" class="anchor" aria-hidden="true" href="WalletButtons+onPaymentInReview"> </a>
|
|
5649
5649
|
|
|
5650
5650
|
### walletButtons.onPaymentInReview([handler])
|
|
5651
5651
|
If the payment was left in fraud review, the function passed as parameter will be called.
|
|
@@ -5667,7 +5667,7 @@ button.onPaymentInReview((data) => {
|
|
|
5667
5667
|
```js
|
|
5668
5668
|
button.onPaymentInReview().then((data) => console.log('Payment in fraud review'));
|
|
5669
5669
|
```
|
|
5670
|
-
<a name="WalletButtons+onPaymentError" id="WalletButtons+onPaymentError"
|
|
5670
|
+
<a name="WalletButtons+onPaymentError" id="WalletButtons+onPaymentError" class="anchor" aria-hidden="true" href="WalletButtons+onPaymentError"> </a>
|
|
5671
5671
|
|
|
5672
5672
|
### walletButtons.onPaymentError([handler])
|
|
5673
5673
|
If the payment was not successful, the function passed as parameter will be called.
|
|
@@ -5689,7 +5689,7 @@ button.onPaymentError((err) => {
|
|
|
5689
5689
|
```js
|
|
5690
5690
|
button.onPaymentError().then((err) => console.log('Payment not successful'));
|
|
5691
5691
|
```
|
|
5692
|
-
<a name="EVENT" id="EVENT"
|
|
5692
|
+
<a name="EVENT" id="EVENT" class="anchor" aria-hidden="true" href="EVENT"> </a>
|
|
5693
5693
|
|
|
5694
5694
|
## EVENT : <code>object</code>
|
|
5695
5695
|
List of available event's name in the wallet button lifecycle
|
|
@@ -5979,7 +5979,7 @@ button.setStyles({"primary_color":"#a83232","button_text_color":"#171e9c","font_
|
|
|
5979
5979
|
</dd>
|
|
5980
5980
|
</dl>
|
|
5981
5981
|
|
|
5982
|
-
<a name="IVisaSRCMeta" id="IVisaSRCMeta"
|
|
5982
|
+
<a name="IVisaSRCMeta" id="IVisaSRCMeta" class="anchor" aria-hidden="true" href="IVisaSRCMeta"> </a>
|
|
5983
5983
|
|
|
5984
5984
|
## IVisaSRCMeta : <code>object</code>
|
|
5985
5985
|
Interface of data used for the Visa Checkout.
|
|
@@ -6030,7 +6030,7 @@ Interface of data used for the Visa Checkout.
|
|
|
6030
6030
|
| [customer.payment_source.address_state] | <code>string</code> | Customer billing address state code (if applicable for the country, example "FL" for Florida). |
|
|
6031
6031
|
| [customer.payment_source.address_country] | <code>string</code> | Customer billing address country code (example "US"). |
|
|
6032
6032
|
|
|
6033
|
-
<a name="SRC" id="SRC"
|
|
6033
|
+
<a name="SRC" id="SRC" class="anchor" aria-hidden="true" href="SRC"> </a>
|
|
6034
6034
|
|
|
6035
6035
|
## SRC
|
|
6036
6036
|
Class SRC include methods for interacting with different secure remote commerce options such as Visa SRC
|
|
@@ -6051,7 +6051,7 @@ Class SRC include methods for interacting with different secure remote commerce
|
|
|
6051
6051
|
* [.reload()](#SRC+reload)
|
|
6052
6052
|
* [.useAutoResize()](#SRC+useAutoResize)
|
|
6053
6053
|
|
|
6054
|
-
<a name="new_SRC_new" id="new_SRC_new"
|
|
6054
|
+
<a name="new_SRC_new" id="new_SRC_new" class="anchor" aria-hidden="true" href="new_SRC_new"> </a>
|
|
6055
6055
|
|
|
6056
6056
|
### new exports.SRC(button_selector, iframe_selector, service_id, public_key_or_access_token, meta)
|
|
6057
6057
|
|
|
@@ -6067,7 +6067,7 @@ Class SRC include methods for interacting with different secure remote commerce
|
|
|
6067
6067
|
```js
|
|
6068
6068
|
var SRC = new SRC('#checkoutButton', '#checkoutIframe', 'service_id', 'public_key', {});
|
|
6069
6069
|
```
|
|
6070
|
-
<a name="SRC+setStyles" id="SRC+setStyles"
|
|
6070
|
+
<a name="SRC+setStyles" id="SRC+setStyles" class="anchor" aria-hidden="true" href="SRC+setStyles"> </a>
|
|
6071
6071
|
|
|
6072
6072
|
### srC.setStyles(fields)
|
|
6073
6073
|
Object contain styles for widget - call before `.load()`.
|
|
@@ -6087,13 +6087,13 @@ widget.setStyles({
|
|
|
6087
6087
|
card_schemes: ['visa']
|
|
6088
6088
|
});
|
|
6089
6089
|
```
|
|
6090
|
-
<a name="SRC+load" id="SRC+load"
|
|
6090
|
+
<a name="SRC+load" id="SRC+load" class="anchor" aria-hidden="true" href="SRC+load"> </a>
|
|
6091
6091
|
|
|
6092
6092
|
### srC.load()
|
|
6093
6093
|
The final method after configuring the SRC to start the load process of SRC checkout
|
|
6094
6094
|
|
|
6095
6095
|
**Kind**: instance method of [<code>SRC</code>](#SRC)
|
|
6096
|
-
<a name="SRC+setEnv" id="SRC+setEnv"
|
|
6096
|
+
<a name="SRC+setEnv" id="SRC+setEnv" class="anchor" aria-hidden="true" href="SRC+setEnv"> </a>
|
|
6097
6097
|
|
|
6098
6098
|
### srC.setEnv(env, [alias])
|
|
6099
6099
|
Current method can change environment. By default environment = sandbox.
|
|
@@ -6110,7 +6110,7 @@ Also we can change domain alias for this environment. By default domain_alias =
|
|
|
6110
6110
|
```js
|
|
6111
6111
|
SRC.setEnv('production');
|
|
6112
6112
|
```
|
|
6113
|
-
<a name="SRC+getEnv" id="SRC+getEnv"
|
|
6113
|
+
<a name="SRC+getEnv" id="SRC+getEnv" class="anchor" aria-hidden="true" href="SRC+getEnv"> </a>
|
|
6114
6114
|
|
|
6115
6115
|
### srC.getEnv()
|
|
6116
6116
|
Method to read the current environment
|
|
@@ -6120,7 +6120,7 @@ Method to read the current environment
|
|
|
6120
6120
|
```js
|
|
6121
6121
|
SRC.getEnv();
|
|
6122
6122
|
```
|
|
6123
|
-
<a name="SRC+on" id="SRC+on"
|
|
6123
|
+
<a name="SRC+on" id="SRC+on" class="anchor" aria-hidden="true" href="SRC+on"> </a>
|
|
6124
6124
|
|
|
6125
6125
|
### srC.on(eventName, [cb]) ⇒ <code>Promise.<any></code> \| <code>void</code>
|
|
6126
6126
|
Listen to events of SRC
|
|
@@ -6142,7 +6142,7 @@ SRC.on('checkoutCompleted').then(function (token) {
|
|
|
6142
6142
|
console.log(token);
|
|
6143
6143
|
});
|
|
6144
6144
|
```
|
|
6145
|
-
<a name="SRC+hideButton" id="SRC+hideButton"
|
|
6145
|
+
<a name="SRC+hideButton" id="SRC+hideButton" class="anchor" aria-hidden="true" href="SRC+hideButton"> </a>
|
|
6146
6146
|
|
|
6147
6147
|
### srC.hideButton([saveSize])
|
|
6148
6148
|
Using this method you can hide button
|
|
@@ -6157,7 +6157,7 @@ Using this method you can hide button
|
|
|
6157
6157
|
```js
|
|
6158
6158
|
SRC.hideButton();
|
|
6159
6159
|
```
|
|
6160
|
-
<a name="SRC+showButton" id="SRC+showButton"
|
|
6160
|
+
<a name="SRC+showButton" id="SRC+showButton" class="anchor" aria-hidden="true" href="SRC+showButton"> </a>
|
|
6161
6161
|
|
|
6162
6162
|
### srC.showButton()
|
|
6163
6163
|
Using this method you can show the SRC button after using hideButton method
|
|
@@ -6167,7 +6167,7 @@ Using this method you can show the SRC button after using hideButton method
|
|
|
6167
6167
|
```js
|
|
6168
6168
|
SRC.showButton();
|
|
6169
6169
|
```
|
|
6170
|
-
<a name="SRC+hideCheckout" id="SRC+hideCheckout"
|
|
6170
|
+
<a name="SRC+hideCheckout" id="SRC+hideCheckout" class="anchor" aria-hidden="true" href="SRC+hideCheckout"> </a>
|
|
6171
6171
|
|
|
6172
6172
|
### srC.hideCheckout([saveSize])
|
|
6173
6173
|
Using this method you can hide checkout after load and button click
|
|
@@ -6182,7 +6182,7 @@ Using this method you can hide checkout after load and button click
|
|
|
6182
6182
|
```js
|
|
6183
6183
|
SRC.hideCheckout();
|
|
6184
6184
|
```
|
|
6185
|
-
<a name="SRC+showCheckout" id="SRC+showCheckout"
|
|
6185
|
+
<a name="SRC+showCheckout" id="SRC+showCheckout" class="anchor" aria-hidden="true" href="SRC+showCheckout"> </a>
|
|
6186
6186
|
|
|
6187
6187
|
### srC.showCheckout()
|
|
6188
6188
|
Using this method you can show checkout after using hideCheckout method
|
|
@@ -6192,7 +6192,7 @@ Using this method you can show checkout after using hideCheckout method
|
|
|
6192
6192
|
```js
|
|
6193
6193
|
SRC.showCheckout()
|
|
6194
6194
|
```
|
|
6195
|
-
<a name="SRC+reload" id="SRC+reload"
|
|
6195
|
+
<a name="SRC+reload" id="SRC+reload" class="anchor" aria-hidden="true" href="SRC+reload"> </a>
|
|
6196
6196
|
|
|
6197
6197
|
### srC.reload()
|
|
6198
6198
|
Using this method you can reload the whole checkout
|
|
@@ -6202,7 +6202,7 @@ Using this method you can reload the whole checkout
|
|
|
6202
6202
|
```js
|
|
6203
6203
|
SRC.reload()
|
|
6204
6204
|
```
|
|
6205
|
-
<a name="SRC+useAutoResize" id="SRC+useAutoResize"
|
|
6205
|
+
<a name="SRC+useAutoResize" id="SRC+useAutoResize" class="anchor" aria-hidden="true" href="SRC+useAutoResize"> </a>
|
|
6206
6206
|
|
|
6207
6207
|
### srC.useAutoResize()
|
|
6208
6208
|
Use this method for resize checkout iFrame according to content height, if applicable
|
|
@@ -6212,7 +6212,7 @@ Use this method for resize checkout iFrame according to content height, if appli
|
|
|
6212
6212
|
```js
|
|
6213
6213
|
SRC.useAutoResize();
|
|
6214
6214
|
```
|
|
6215
|
-
<a name="EVENT" id="EVENT"
|
|
6215
|
+
<a name="EVENT" id="EVENT" class="anchor" aria-hidden="true" href="EVENT"> </a>
|
|
6216
6216
|
|
|
6217
6217
|
## EVENT : <code>enum</code>
|
|
6218
6218
|
List of available event's name in the SRC checkout lifecycle
|