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