@paydock/client-sdk 1.104.6-beta → 1.105.1

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.
Files changed (494) hide show
  1. package/.nvmrc +1 -0
  2. package/README.md +320 -362
  3. package/api.d.ts +1 -0
  4. package/api.js +1 -0
  5. package/bundles/widget.umd.js +7410 -6717
  6. package/bundles/widget.umd.min.js +1 -2
  7. package/canvas3ds.d.ts +1 -0
  8. package/canvas3ds.js +1 -0
  9. package/checkout-button.d.ts +1 -0
  10. package/checkout-button.js +1 -0
  11. package/inicialization-guide.md +7 -0
  12. package/{bundles/types → lib}/api/api-base.d.ts +1 -2
  13. package/lib/api/api-base.js +101 -0
  14. package/lib/api/api-base.js.map +1 -0
  15. package/{bundles/types → lib}/api/api-charge-internal.d.ts +0 -1
  16. package/lib/api/api-charge-internal.js +30 -0
  17. package/lib/api/api-charge-internal.js.map +1 -0
  18. package/{bundles/types → lib}/api/api-charge.d.ts +0 -1
  19. package/lib/api/api-charge.js +49 -0
  20. package/lib/api/api-charge.js.map +1 -0
  21. package/{bundles/types → lib}/api/api-internal.d.ts +0 -1
  22. package/lib/api/api-internal.js +13 -0
  23. package/lib/api/api-internal.js.map +1 -0
  24. package/{bundles/types → lib}/api/api-service-internal.d.ts +1 -3
  25. package/lib/api/api-service-internal.js +18 -0
  26. package/lib/api/api-service-internal.js.map +1 -0
  27. package/{bundles/types → lib}/api/api.d.ts +0 -1
  28. package/lib/api/api.js +62 -0
  29. package/lib/api/api.js.map +1 -0
  30. package/lib/api/index.d.ts +1 -0
  31. package/lib/api/index.js +2 -0
  32. package/lib/api/index.js.map +1 -0
  33. package/{bundles/types → lib}/canvas-3ds/canvas-3ds.d.ts +0 -1
  34. package/lib/canvas-3ds/canvas-3ds.js +157 -0
  35. package/lib/canvas-3ds/canvas-3ds.js.map +1 -0
  36. package/{bundles/types → lib}/canvas-3ds/index.d.ts +0 -1
  37. package/lib/canvas-3ds/index.js +2 -0
  38. package/lib/canvas-3ds/index.js.map +1 -0
  39. package/{bundles/types → lib}/canvas-3ds/services/gpayments-service.d.ts +0 -1
  40. package/lib/canvas-3ds/services/gpayments-service.js +181 -0
  41. package/lib/canvas-3ds/services/gpayments-service.js.map +1 -0
  42. package/{bundles/types → lib}/canvas-3ds/services/index.d.ts +0 -1
  43. package/lib/canvas-3ds/services/index.js +2 -0
  44. package/lib/canvas-3ds/services/index.js.map +1 -0
  45. package/{bundles/types → lib}/canvas-3ds/services/standalone3ds-service.d.ts +0 -1
  46. package/lib/canvas-3ds/services/standalone3ds-service.js +32 -0
  47. package/lib/canvas-3ds/services/standalone3ds-service.js.map +1 -0
  48. package/{bundles/types → lib}/checkout-button/afterpay/afterpay-checkout-button.d.ts +0 -1
  49. package/lib/checkout-button/afterpay/afterpay-checkout-button.js +50 -0
  50. package/lib/checkout-button/afterpay/afterpay-checkout-button.js.map +1 -0
  51. package/{bundles/types → lib}/checkout-button/afterpay/afterpay.runner.d.ts +0 -1
  52. package/lib/checkout-button/afterpay/afterpay.runner.js +41 -0
  53. package/lib/checkout-button/afterpay/afterpay.runner.js.map +1 -0
  54. package/{bundles/types → lib}/checkout-button/checkout-button.d.ts +0 -1
  55. package/{bundles/types → lib}/checkout-button/checkout-button.interface.d.ts +0 -1
  56. package/lib/checkout-button/checkout-button.interface.js +45 -0
  57. package/lib/checkout-button/checkout-button.interface.js.map +1 -0
  58. package/lib/checkout-button/checkout-button.js +266 -0
  59. package/lib/checkout-button/checkout-button.js.map +1 -0
  60. package/{bundles/types → lib}/checkout-button/checkout-contextual-handler.d.ts +0 -1
  61. package/lib/checkout-button/checkout-contextual-handler.js +75 -0
  62. package/lib/checkout-button/checkout-contextual-handler.js.map +1 -0
  63. package/{bundles/types → lib}/checkout-button/index.d.ts +1 -2
  64. package/lib/checkout-button/index.js +85 -0
  65. package/lib/checkout-button/index.js.map +1 -0
  66. package/{bundles/types → lib}/checkout-button/paypal/paypal-checkout-button.d.ts +0 -1
  67. package/lib/checkout-button/paypal/paypal-checkout-button.js +25 -0
  68. package/lib/checkout-button/paypal/paypal-checkout-button.js.map +1 -0
  69. package/{bundles/types → lib}/checkout-button/paypal/paypal.runner.d.ts +0 -1
  70. package/lib/checkout-button/paypal/paypal.runner.js +14 -0
  71. package/lib/checkout-button/paypal/paypal.runner.js.map +1 -0
  72. package/{bundles/types → lib}/checkout-button/runner/base.runner.d.ts +3 -4
  73. package/lib/checkout-button/runner/base.runner.js +13 -0
  74. package/lib/checkout-button/runner/base.runner.js.map +1 -0
  75. package/{bundles/types → lib}/checkout-button/runner/contextual.runner.d.ts +1 -2
  76. package/lib/checkout-button/runner/contextual.runner.js +40 -0
  77. package/lib/checkout-button/runner/contextual.runner.js.map +1 -0
  78. package/{bundles/types → lib}/checkout-button/runner/index.d.ts +0 -1
  79. package/lib/checkout-button/runner/index.js +11 -0
  80. package/lib/checkout-button/runner/index.js.map +1 -0
  81. package/{bundles/types → lib}/checkout-button/runner/popup.runner.d.ts +1 -2
  82. package/lib/checkout-button/runner/popup.runner.js +68 -0
  83. package/lib/checkout-button/runner/popup.runner.js.map +1 -0
  84. package/{bundles/types → lib}/checkout-button/runner/redirect.runner.d.ts +1 -2
  85. package/lib/checkout-button/runner/redirect.runner.js +15 -0
  86. package/lib/checkout-button/runner/redirect.runner.js.map +1 -0
  87. package/{bundles/types → lib}/checkout-button/zipmoney/zipmoney-checkout-button.d.ts +0 -1
  88. package/lib/checkout-button/zipmoney/zipmoney-checkout-button.js +64 -0
  89. package/lib/checkout-button/zipmoney/zipmoney-checkout-button.js.map +1 -0
  90. package/{bundles/types → lib}/checkout-button/zipmoney/zipmoney-contextual.runner.d.ts +1 -2
  91. package/lib/checkout-button/zipmoney/zipmoney-contextual.runner.js +78 -0
  92. package/lib/checkout-button/zipmoney/zipmoney-contextual.runner.js.map +1 -0
  93. package/{bundles/types → lib}/checkout-button/zipmoney/zipmoney-redirect.runner.d.ts +1 -2
  94. package/lib/checkout-button/zipmoney/zipmoney-redirect.runner.js +49 -0
  95. package/lib/checkout-button/zipmoney/zipmoney-redirect.runner.js.map +1 -0
  96. package/{bundles/types → lib}/checkout-button/zipmoney/zipmoney.config.d.ts +0 -1
  97. package/lib/checkout-button/zipmoney/zipmoney.config.js +4 -0
  98. package/lib/checkout-button/zipmoney/zipmoney.config.js.map +1 -0
  99. package/{bundles/types → lib}/checkout-button/zipmoney/zipmoney.runner.d.ts +1 -2
  100. package/lib/checkout-button/zipmoney/zipmoney.runner.js +23 -0
  101. package/lib/checkout-button/zipmoney/zipmoney.runner.js.map +1 -0
  102. package/{bundles/types → lib}/checkout-button/zipmoney/zipmoney.types.d.ts +0 -1
  103. package/lib/checkout-button/zipmoney/zipmoney.types.js +1 -0
  104. package/lib/checkout-button/zipmoney/zipmoney.types.js.map +1 -0
  105. package/{bundles/types → lib}/components/ability-guard.d.ts +0 -1
  106. package/lib/components/ability-guard.js +44 -0
  107. package/lib/components/ability-guard.js.map +1 -0
  108. package/{bundles/types → lib}/components/background.d.ts +0 -1
  109. package/lib/components/background.js +193 -0
  110. package/lib/components/background.js.map +1 -0
  111. package/{bundles/types → lib}/components/container.d.ts +0 -1
  112. package/lib/components/container.js +63 -0
  113. package/lib/components/container.js.map +1 -0
  114. package/{bundles/types → lib}/components/dispatcher.d.ts +1 -2
  115. package/lib/components/dispatcher.js +39 -0
  116. package/lib/components/dispatcher.js.map +1 -0
  117. package/{bundles/types → lib}/components/element-style.d.ts +1 -2
  118. package/lib/components/element-style.js +52 -0
  119. package/lib/components/element-style.js.map +1 -0
  120. package/{bundles/types → lib}/components/flypay-iframe-event.d.ts +0 -1
  121. package/lib/components/flypay-iframe-event.js +28 -0
  122. package/lib/components/flypay-iframe-event.js.map +1 -0
  123. package/{bundles/types/components/form-interceptor.d.ts → lib/components/form-Interceptor.d.ts} +0 -1
  124. package/lib/components/form-Interceptor.js +38 -0
  125. package/lib/components/form-Interceptor.js.map +1 -0
  126. package/{bundles/types → lib}/components/http-core.d.ts +0 -1
  127. package/lib/components/http-core.js +57 -0
  128. package/lib/components/http-core.js.map +1 -0
  129. package/{bundles/types → lib}/components/iframe-event.d.ts +0 -4
  130. package/lib/components/iframe-event.js +75 -0
  131. package/lib/components/iframe-event.js.map +1 -0
  132. package/{bundles/types → lib}/components/iframe.d.ts +0 -1
  133. package/lib/components/iframe.js +62 -0
  134. package/lib/components/iframe.js.map +1 -0
  135. package/{bundles/types → lib}/components/link.d.ts +3 -5
  136. package/lib/components/link.js +59 -0
  137. package/lib/components/link.js.map +1 -0
  138. package/{bundles/types → lib}/components/loader.d.ts +0 -1
  139. package/lib/components/loader.js +234 -0
  140. package/lib/components/loader.js.map +1 -0
  141. package/{bundles/types → lib}/components/param.d.ts +9 -10
  142. package/lib/components/param.js +147 -0
  143. package/lib/components/param.js.map +1 -0
  144. package/{bundles/types → lib}/components/popup.d.ts +0 -1
  145. package/lib/components/popup.js +104 -0
  146. package/lib/components/popup.js.map +1 -0
  147. package/{bundles/types → lib}/components/storage-dispatcher.d.ts +0 -1
  148. package/lib/components/storage-dispatcher.js +75 -0
  149. package/lib/components/storage-dispatcher.js.map +1 -0
  150. package/{bundles/types → lib}/components/trigger.d.ts +0 -1
  151. package/lib/components/trigger.js +49 -0
  152. package/lib/components/trigger.js.map +1 -0
  153. package/{bundles/types → lib}/components/vault-display-iframe-event.d.ts +0 -1
  154. package/lib/components/vault-display-iframe-event.js +27 -0
  155. package/lib/components/vault-display-iframe-event.js.map +1 -0
  156. package/{bundles/types → lib}/components/wallet-background.d.ts +0 -1
  157. package/lib/components/wallet-background.js +63 -0
  158. package/lib/components/wallet-background.js.map +1 -0
  159. package/{bundles/types → lib}/components/wallet-trigger.d.ts +0 -1
  160. package/lib/components/wallet-trigger.js +27 -0
  161. package/lib/components/wallet-trigger.js.map +1 -0
  162. package/{bundles/types/configs/env/environment.paydock.d.ts → lib/configs/env/env.d.ts} +8 -5
  163. package/lib/configs/env/env.js +117 -0
  164. package/lib/configs/env/env.js.map +1 -0
  165. package/{bundles/types → lib}/configs/sdk.d.ts +2 -3
  166. package/lib/configs/sdk.js +16 -0
  167. package/lib/configs/sdk.js.map +1 -0
  168. package/{bundles/types → lib}/constants/validators.d.ts +2 -3
  169. package/lib/constants/validators.js +42 -0
  170. package/lib/constants/validators.js.map +1 -0
  171. package/{bundles/types → lib}/external-checkout/builder.d.ts +0 -1
  172. package/lib/external-checkout/builder.js +45 -0
  173. package/lib/external-checkout/builder.js.map +1 -0
  174. package/{bundles/types → lib}/external-checkout/checker.d.ts +0 -1
  175. package/lib/external-checkout/checker.js +22 -0
  176. package/lib/external-checkout/checker.js.map +1 -0
  177. package/lib/external-checkout/index.d.ts +2 -0
  178. package/lib/external-checkout/index.js +3 -0
  179. package/lib/external-checkout/index.js.map +1 -0
  180. package/{bundles/types → lib}/helper/access-token.d.ts +0 -1
  181. package/lib/helper/access-token.js +44 -0
  182. package/lib/helper/access-token.js.map +1 -0
  183. package/{bundles/types → lib}/helper/browser.d.ts +0 -1
  184. package/lib/helper/browser.js +79 -0
  185. package/lib/helper/browser.js.map +1 -0
  186. package/{bundles/types → lib}/helper/event-emitter.d.ts +0 -1
  187. package/lib/helper/event-emitter.js +23 -0
  188. package/lib/helper/event-emitter.js.map +1 -0
  189. package/{bundles/types → lib}/helper/event.d.ts +0 -1
  190. package/lib/helper/event.js +23 -0
  191. package/lib/helper/event.js.map +1 -0
  192. package/{bundles/types → lib}/helper/ms.d.ts +0 -1
  193. package/lib/helper/ms.js +32 -0
  194. package/lib/helper/ms.js.map +1 -0
  195. package/{bundles/types → lib}/helper/object.d.ts +0 -1
  196. package/lib/helper/object.js +6 -0
  197. package/lib/helper/object.js.map +1 -0
  198. package/{bundles/types → lib}/helper/url.d.ts +0 -1
  199. package/lib/helper/url.js +11 -0
  200. package/lib/helper/url.js.map +1 -0
  201. package/{bundles/types → lib}/helper/uuid.d.ts +0 -1
  202. package/lib/helper/uuid.js +26 -0
  203. package/lib/helper/uuid.js.map +1 -0
  204. package/lib/index.d.ts +15 -0
  205. package/lib/index.js +15 -0
  206. package/lib/index.js.map +1 -0
  207. package/{bundles/types → lib}/payment-source/builder.d.ts +0 -1
  208. package/lib/payment-source/builder.js +49 -0
  209. package/lib/payment-source/builder.js.map +1 -0
  210. package/{bundles/types → lib}/payment-source/index.d.ts +0 -1
  211. package/lib/payment-source/index.js +2 -0
  212. package/lib/payment-source/index.js.map +1 -0
  213. package/{bundles/types → lib}/payment-source-widget/html-payment-source-widget.d.ts +0 -1
  214. package/lib/payment-source-widget/html-payment-source-widget.js +172 -0
  215. package/lib/payment-source-widget/html-payment-source-widget.js.map +1 -0
  216. package/{bundles/types → lib}/payment-source-widget/index.d.ts +0 -1
  217. package/lib/payment-source-widget/index.js +35 -0
  218. package/lib/payment-source-widget/index.js.map +1 -0
  219. package/{bundles/types → lib}/payment-source-widget/interfaces.d.ts +0 -1
  220. package/lib/payment-source-widget/interfaces.js +2 -0
  221. package/lib/payment-source-widget/interfaces.js.map +1 -0
  222. package/{bundles/types → lib}/payment-source-widget/payment-source-widget.d.ts +0 -1
  223. package/lib/payment-source-widget/payment-source-widget.js +142 -0
  224. package/lib/payment-source-widget/payment-source-widget.js.map +1 -0
  225. package/lib/secure-remote-commerce/index.d.ts +1 -0
  226. package/lib/secure-remote-commerce/index.js +2 -0
  227. package/lib/secure-remote-commerce/index.js.map +1 -0
  228. package/lib/secure-remote-commerce/interfaces.d.ts +71 -0
  229. package/lib/secure-remote-commerce/interfaces.js +28 -0
  230. package/lib/secure-remote-commerce/interfaces.js.map +1 -0
  231. package/{bundles/types → lib}/secure-remote-commerce/providers/src-provider.d.ts +0 -1
  232. package/lib/secure-remote-commerce/providers/src-provider.js +1 -0
  233. package/lib/secure-remote-commerce/providers/src-provider.js.map +1 -0
  234. package/lib/secure-remote-commerce/providers/visa-src/helper.d.ts +7 -0
  235. package/lib/secure-remote-commerce/providers/visa-src/helper.js +36 -0
  236. package/lib/secure-remote-commerce/providers/visa-src/helper.js.map +1 -0
  237. package/lib/secure-remote-commerce/providers/visa-src/index.d.ts +1 -0
  238. package/lib/secure-remote-commerce/providers/visa-src/index.js +2 -0
  239. package/lib/secure-remote-commerce/providers/visa-src/index.js.map +1 -0
  240. package/{bundles/types/secure-remote-commerce/providers/mastercard-src/mastercard-src.d.ts → lib/secure-remote-commerce/providers/visa-src/visa-src.d.ts} +7 -5
  241. package/lib/secure-remote-commerce/providers/visa-src/visa-src.js +113 -0
  242. package/lib/secure-remote-commerce/providers/visa-src/visa-src.js.map +1 -0
  243. package/lib/secure-remote-commerce/providers/visa-src/visa-src.styles.d.ts +8 -0
  244. package/lib/secure-remote-commerce/providers/visa-src/visa-src.styles.js +10 -0
  245. package/lib/secure-remote-commerce/providers/visa-src/visa-src.styles.js.map +1 -0
  246. package/lib/secure-remote-commerce/secure-remote-commerce.d.ts +163 -0
  247. package/lib/secure-remote-commerce/secure-remote-commerce.js +239 -0
  248. package/lib/secure-remote-commerce/secure-remote-commerce.js.map +1 -0
  249. package/{bundles/types → lib}/vault-display-widget/index.d.ts +0 -1
  250. package/lib/vault-display-widget/index.js +14 -0
  251. package/lib/vault-display-widget/index.js.map +1 -0
  252. package/{bundles/types → lib}/vault-display-widget/vault-display-widget.d.ts +0 -1
  253. package/lib/vault-display-widget/vault-display-widget.js +99 -0
  254. package/lib/vault-display-widget/vault-display-widget.js.map +1 -0
  255. package/{bundles/types → lib}/wallet-buttons/afterpay.wallet-service.d.ts +0 -1
  256. package/lib/wallet-buttons/afterpay.wallet-service.js +152 -0
  257. package/lib/wallet-buttons/afterpay.wallet-service.js.map +1 -0
  258. package/{bundles/types → lib}/wallet-buttons/apple.wallet-service.d.ts +0 -1
  259. package/lib/wallet-buttons/apple.wallet-service.js +324 -0
  260. package/lib/wallet-buttons/apple.wallet-service.js.map +1 -0
  261. package/{bundles/types → lib}/wallet-buttons/flypay-v2.wallet-service.d.ts +1 -1
  262. package/lib/wallet-buttons/flypay-v2.wallet-service.js +165 -0
  263. package/lib/wallet-buttons/flypay-v2.wallet-service.js.map +1 -0
  264. package/{bundles/types → lib}/wallet-buttons/flypay.wallet-service.d.ts +0 -1
  265. package/lib/wallet-buttons/flypay.wallet-service.js +117 -0
  266. package/lib/wallet-buttons/flypay.wallet-service.js.map +1 -0
  267. package/{bundles/types → lib}/wallet-buttons/google.wallet-service.d.ts +0 -1
  268. package/lib/wallet-buttons/google.wallet-service.js +301 -0
  269. package/lib/wallet-buttons/google.wallet-service.js.map +1 -0
  270. package/{bundles/types → lib}/wallet-buttons/helpers/flypay-v2.helper.d.ts +0 -1
  271. package/lib/wallet-buttons/helpers/flypay-v2.helper.js +151 -0
  272. package/lib/wallet-buttons/helpers/flypay-v2.helper.js.map +1 -0
  273. package/{bundles/types → lib}/wallet-buttons/index.d.ts +0 -1
  274. package/lib/wallet-buttons/index.js +128 -0
  275. package/lib/wallet-buttons/index.js.map +1 -0
  276. package/{bundles/types → lib}/wallet-buttons/interfaces.d.ts +0 -1
  277. package/lib/wallet-buttons/interfaces.js +1 -0
  278. package/lib/wallet-buttons/interfaces.js.map +1 -0
  279. package/{bundles/types → lib}/wallet-buttons/mastercard.wallet-service.d.ts +0 -1
  280. package/lib/wallet-buttons/mastercard.wallet-service.js +27 -0
  281. package/lib/wallet-buttons/mastercard.wallet-service.js.map +1 -0
  282. package/{bundles/types → lib}/wallet-buttons/paypal.wallet-service.d.ts +0 -1
  283. package/lib/wallet-buttons/paypal.wallet-service.js +144 -0
  284. package/lib/wallet-buttons/paypal.wallet-service.js.map +1 -0
  285. package/{bundles/types → lib}/wallet-buttons/stripe.wallet-service.d.ts +0 -1
  286. package/lib/wallet-buttons/stripe.wallet-service.js +100 -0
  287. package/lib/wallet-buttons/stripe.wallet-service.js.map +1 -0
  288. package/{bundles/types → lib}/wallet-buttons/wallet-buttons.d.ts +0 -1
  289. package/lib/wallet-buttons/wallet-buttons.js +479 -0
  290. package/lib/wallet-buttons/wallet-buttons.js.map +1 -0
  291. package/{bundles/types → lib}/wallet-buttons/wallet-service.d.ts +0 -1
  292. package/lib/wallet-buttons/wallet-service.js +60 -0
  293. package/lib/wallet-buttons/wallet-service.js.map +1 -0
  294. package/{bundles/types → lib}/widget/configuration.d.ts +1 -2
  295. package/lib/widget/configuration.js +260 -0
  296. package/lib/widget/configuration.js.map +1 -0
  297. package/{bundles/types → lib}/widget/html-multi-widget.d.ts +3 -4
  298. package/lib/widget/html-multi-widget.js +422 -0
  299. package/lib/widget/html-multi-widget.js.map +1 -0
  300. package/{bundles/types → lib}/widget/html-widget.d.ts +0 -1
  301. package/lib/widget/html-widget.js +127 -0
  302. package/lib/widget/html-widget.js.map +1 -0
  303. package/{bundles/types → lib}/widget/index.d.ts +1 -2
  304. package/lib/widget/index.js +132 -0
  305. package/lib/widget/index.js.map +1 -0
  306. package/{bundles/types → lib}/widget/meta.d.ts +0 -1
  307. package/lib/widget/meta.js +8 -0
  308. package/lib/widget/meta.js.map +1 -0
  309. package/{bundles/types → lib}/widget/multi-widget.d.ts +1 -2
  310. package/lib/widget/multi-widget.js +437 -0
  311. package/lib/widget/multi-widget.js.map +1 -0
  312. package/{bundles/types → lib}/widget/style.d.ts +0 -1
  313. package/lib/widget/style.js +204 -0
  314. package/lib/widget/style.js.map +1 -0
  315. package/package.json +42 -164
  316. package/payment-source-widget.d.ts +1 -0
  317. package/payment-source-widget.js +1 -0
  318. package/slate.md +189 -163
  319. package/tslint.json +129 -0
  320. package/typings/globals/@auspayplus/open-payments-checkout/index.d.ts +43 -0
  321. package/typings/globals/jasmine/index.d.ts +576 -0
  322. package/typings/globals/jasmine-ajax/index.d.ts +83 -0
  323. package/typings/globals/jquery/index.d.ts +3759 -0
  324. package/typings/index.d.ts +4 -0
  325. package/vault-display-widget.d.ts +1 -0
  326. package/vault-display-widget.js +1 -0
  327. package/vendors/zipmoney.d.ts +18 -0
  328. package/vendors/zipmoney.js +2 -0
  329. package/widget.d.ts +1 -0
  330. package/widget.js +1 -0
  331. package/bundles/index.cjs +0 -10456
  332. package/bundles/index.cjs.d.ts +0 -3206
  333. package/bundles/index.cjs.map +0 -1
  334. package/bundles/index.mjs +0 -10424
  335. package/bundles/index.mjs.d.ts +0 -3206
  336. package/bundles/index.mjs.map +0 -1
  337. package/bundles/types/api/api-base.d.ts.map +0 -1
  338. package/bundles/types/api/api-charge-internal.d.ts.map +0 -1
  339. package/bundles/types/api/api-charge.d.ts.map +0 -1
  340. package/bundles/types/api/api-internal.d.ts.map +0 -1
  341. package/bundles/types/api/api-service-internal.d.ts.map +0 -1
  342. package/bundles/types/api/api.d.ts.map +0 -1
  343. package/bundles/types/api/index.d.ts +0 -2
  344. package/bundles/types/api/index.d.ts.map +0 -1
  345. package/bundles/types/canvas-3ds/canvas-3ds.d.ts.map +0 -1
  346. package/bundles/types/canvas-3ds/index.d.ts.map +0 -1
  347. package/bundles/types/canvas-3ds/services/gpayments-service.d.ts.map +0 -1
  348. package/bundles/types/canvas-3ds/services/index.d.ts.map +0 -1
  349. package/bundles/types/canvas-3ds/services/standalone3ds-service.d.ts.map +0 -1
  350. package/bundles/types/checkout-button/afterpay/afterpay-checkout-button.d.ts.map +0 -1
  351. package/bundles/types/checkout-button/afterpay/afterpay.runner.d.ts.map +0 -1
  352. package/bundles/types/checkout-button/checkout-button.d.ts.map +0 -1
  353. package/bundles/types/checkout-button/checkout-button.interface.d.ts.map +0 -1
  354. package/bundles/types/checkout-button/checkout-contextual-handler.d.ts.map +0 -1
  355. package/bundles/types/checkout-button/index.d.ts.map +0 -1
  356. package/bundles/types/checkout-button/paypal/paypal-checkout-button.d.ts.map +0 -1
  357. package/bundles/types/checkout-button/paypal/paypal.runner.d.ts.map +0 -1
  358. package/bundles/types/checkout-button/runner/base.runner.d.ts.map +0 -1
  359. package/bundles/types/checkout-button/runner/contextual.runner.d.ts.map +0 -1
  360. package/bundles/types/checkout-button/runner/index.d.ts.map +0 -1
  361. package/bundles/types/checkout-button/runner/popup.runner.d.ts.map +0 -1
  362. package/bundles/types/checkout-button/runner/redirect.runner.d.ts.map +0 -1
  363. package/bundles/types/checkout-button/zipmoney/index.d.ts +0 -4
  364. package/bundles/types/checkout-button/zipmoney/index.d.ts.map +0 -1
  365. package/bundles/types/checkout-button/zipmoney/zipmoney-checkout-button.d.ts.map +0 -1
  366. package/bundles/types/checkout-button/zipmoney/zipmoney-contextual.runner.d.ts.map +0 -1
  367. package/bundles/types/checkout-button/zipmoney/zipmoney-redirect.runner.d.ts.map +0 -1
  368. package/bundles/types/checkout-button/zipmoney/zipmoney.config.d.ts.map +0 -1
  369. package/bundles/types/checkout-button/zipmoney/zipmoney.runner.d.ts.map +0 -1
  370. package/bundles/types/checkout-button/zipmoney/zipmoney.types.d.ts.map +0 -1
  371. package/bundles/types/components/ability-guard.d.ts.map +0 -1
  372. package/bundles/types/components/background.d.ts.map +0 -1
  373. package/bundles/types/components/container.d.ts.map +0 -1
  374. package/bundles/types/components/dispatcher.d.ts.map +0 -1
  375. package/bundles/types/components/element-style.d.ts.map +0 -1
  376. package/bundles/types/components/flypay-iframe-event.d.ts.map +0 -1
  377. package/bundles/types/components/form-interceptor.d.ts.map +0 -1
  378. package/bundles/types/components/http-core.d.ts.map +0 -1
  379. package/bundles/types/components/iframe-event.d.ts.map +0 -1
  380. package/bundles/types/components/iframe.d.ts.map +0 -1
  381. package/bundles/types/components/link.d.ts.map +0 -1
  382. package/bundles/types/components/loader.d.ts.map +0 -1
  383. package/bundles/types/components/param.d.ts.map +0 -1
  384. package/bundles/types/components/popup.d.ts.map +0 -1
  385. package/bundles/types/components/storage-dispatcher.d.ts.map +0 -1
  386. package/bundles/types/components/trigger.d.ts.map +0 -1
  387. package/bundles/types/components/vault-display-iframe-event.d.ts.map +0 -1
  388. package/bundles/types/components/wallet-background.d.ts.map +0 -1
  389. package/bundles/types/components/wallet-trigger.d.ts.map +0 -1
  390. package/bundles/types/configs/env/environment.cba.d.ts +0 -29
  391. package/bundles/types/configs/env/environment.cba.d.ts.map +0 -1
  392. package/bundles/types/configs/env/environment.interface.d.ts +0 -12
  393. package/bundles/types/configs/env/environment.interface.d.ts.map +0 -1
  394. package/bundles/types/configs/env/environment.paydock.d.ts.map +0 -1
  395. package/bundles/types/configs/env/index.d.ts +0 -3
  396. package/bundles/types/configs/env/index.d.ts.map +0 -1
  397. package/bundles/types/configs/sdk.d.ts.map +0 -1
  398. package/bundles/types/constants/validators.d.ts.map +0 -1
  399. package/bundles/types/external-checkout/builder.d.ts.map +0 -1
  400. package/bundles/types/external-checkout/checker.d.ts.map +0 -1
  401. package/bundles/types/external-checkout/index.d.ts +0 -3
  402. package/bundles/types/external-checkout/index.d.ts.map +0 -1
  403. package/bundles/types/helper/access-token.d.ts.map +0 -1
  404. package/bundles/types/helper/browser.d.ts.map +0 -1
  405. package/bundles/types/helper/event-emitter.d.ts.map +0 -1
  406. package/bundles/types/helper/event.d.ts.map +0 -1
  407. package/bundles/types/helper/ms.d.ts.map +0 -1
  408. package/bundles/types/helper/object.d.ts.map +0 -1
  409. package/bundles/types/helper/url.d.ts.map +0 -1
  410. package/bundles/types/helper/uuid.d.ts.map +0 -1
  411. package/bundles/types/index-cba.d.ts +0 -13
  412. package/bundles/types/index-cba.d.ts.map +0 -1
  413. package/bundles/types/index.d.ts +0 -14
  414. package/bundles/types/index.d.ts.map +0 -1
  415. package/bundles/types/payment-source/builder.d.ts.map +0 -1
  416. package/bundles/types/payment-source/index.d.ts.map +0 -1
  417. package/bundles/types/payment-source-widget/html-payment-source-widget.d.ts.map +0 -1
  418. package/bundles/types/payment-source-widget/index.d.ts.map +0 -1
  419. package/bundles/types/payment-source-widget/interfaces.d.ts.map +0 -1
  420. package/bundles/types/payment-source-widget/payment-source-widget.d.ts.map +0 -1
  421. package/bundles/types/secure-remote-commerce/index.d.ts +0 -103
  422. package/bundles/types/secure-remote-commerce/index.d.ts.map +0 -1
  423. package/bundles/types/secure-remote-commerce/interfaces.d.ts +0 -149
  424. package/bundles/types/secure-remote-commerce/interfaces.d.ts.map +0 -1
  425. package/bundles/types/secure-remote-commerce/mastercard-secure-remote-commerce.d.ts +0 -31
  426. package/bundles/types/secure-remote-commerce/mastercard-secure-remote-commerce.d.ts.map +0 -1
  427. package/bundles/types/secure-remote-commerce/providers/mastercard-src/index.d.ts +0 -2
  428. package/bundles/types/secure-remote-commerce/providers/mastercard-src/index.d.ts.map +0 -1
  429. package/bundles/types/secure-remote-commerce/providers/mastercard-src/mastercard-src.d.ts.map +0 -1
  430. package/bundles/types/secure-remote-commerce/providers/src-provider.d.ts.map +0 -1
  431. package/bundles/types/secure-remote-commerce/secure-remote-commerce.d.ts +0 -86
  432. package/bundles/types/secure-remote-commerce/secure-remote-commerce.d.ts.map +0 -1
  433. package/bundles/types/vault-display-widget/index.d.ts.map +0 -1
  434. package/bundles/types/vault-display-widget/vault-display-widget.d.ts.map +0 -1
  435. package/bundles/types/wallet-buttons/afterpay.wallet-service.d.ts.map +0 -1
  436. package/bundles/types/wallet-buttons/apple.wallet-service.d.ts.map +0 -1
  437. package/bundles/types/wallet-buttons/flypay-v2.wallet-service.d.ts.map +0 -1
  438. package/bundles/types/wallet-buttons/flypay.wallet-service.d.ts.map +0 -1
  439. package/bundles/types/wallet-buttons/google.wallet-service.d.ts.map +0 -1
  440. package/bundles/types/wallet-buttons/helpers/flypay-v2.helper.d.ts.map +0 -1
  441. package/bundles/types/wallet-buttons/index-cba.d.ts +0 -2
  442. package/bundles/types/wallet-buttons/index-cba.d.ts.map +0 -1
  443. package/bundles/types/wallet-buttons/index.d.ts.map +0 -1
  444. package/bundles/types/wallet-buttons/interfaces.d.ts.map +0 -1
  445. package/bundles/types/wallet-buttons/mastercard.wallet-service.d.ts.map +0 -1
  446. package/bundles/types/wallet-buttons/paypal.wallet-service.d.ts.map +0 -1
  447. package/bundles/types/wallet-buttons/stripe.wallet-service.d.ts.map +0 -1
  448. package/bundles/types/wallet-buttons/wallet-buttons.d.ts.map +0 -1
  449. package/bundles/types/wallet-buttons/wallet-cba-buttons.d.ts +0 -330
  450. package/bundles/types/wallet-buttons/wallet-cba-buttons.d.ts.map +0 -1
  451. package/bundles/types/wallet-buttons/wallet-service.d.ts.map +0 -1
  452. package/bundles/types/widget/configuration.d.ts.map +0 -1
  453. package/bundles/types/widget/html-multi-widget.d.ts.map +0 -1
  454. package/bundles/types/widget/html-widget.d.ts.map +0 -1
  455. package/bundles/types/widget/index.d.ts.map +0 -1
  456. package/bundles/types/widget/meta.d.ts.map +0 -1
  457. package/bundles/types/widget/multi-widget.d.ts.map +0 -1
  458. package/bundles/types/widget/style.d.ts.map +0 -1
  459. package/bundles/widget.umd.js.d.ts +0 -3206
  460. package/bundles/widget.umd.js.map +0 -1
  461. package/bundles/widget.umd.js.min.d.ts +0 -3206
  462. package/bundles/widget.umd.min.js.map +0 -1
  463. package/docs/api-canvas3ds.md +0 -158
  464. package/docs/api-checkout-button.md +0 -912
  465. package/docs/api-examples.md +0 -65
  466. package/docs/api-ps-widget.md +0 -585
  467. package/docs/api-vault-display.md +0 -94
  468. package/docs/api-widget.md +0 -2499
  469. package/docs/api-wrapper.md +0 -78
  470. package/docs/canvas3ds-examples.md +0 -242
  471. package/docs/cba-header.md +0 -13
  472. package/docs/cba-license.md +0 -2
  473. package/docs/checkout-examples.md +0 -248
  474. package/docs/header.md +0 -15
  475. package/docs/html/layout.html +0 -78
  476. package/docs/html/marked.js +0 -23
  477. package/docs/html/style.css +0 -365
  478. package/docs/install/npm.content.md +0 -16
  479. package/docs/install/npm.example.md +0 -24
  480. package/docs/install/umd.content.md +0 -20
  481. package/docs/install/umd.example.md +0 -6
  482. package/docs/install.md +0 -43
  483. package/docs/install.readme.t.md +0 -17
  484. package/docs/install.slate.t.md +0 -17
  485. package/docs/license.md +0 -2
  486. package/docs/partials/header.hbs +0 -3
  487. package/docs/ps-examples.md +0 -129
  488. package/docs/secure-remote-commerce-examples.md +0 -232
  489. package/docs/secure-remote-commerce.md +0 -336
  490. package/docs/vault-display-example.md +0 -132
  491. package/docs/wallet-buttons-examples.md +0 -609
  492. package/docs/wallet-buttons.md +0 -619
  493. package/docs/wallet-cba-buttons-examples.md +0 -388
  494. package/docs/widget-examples.md +0 -134
@@ -1,232 +0,0 @@
1
- # Secure Remote Commerce
2
-
3
- ## Overview
4
-
5
- Integrate with Mastercard SRC using Paydock's Mastercard SRC widget.
6
- For a full description of the methods and parameters, reference the [README file](https://www.npmjs.com/package/@paydock/client-sdk#SRC).
7
-
8
- ## SRC simple example
9
-
10
- The following section provides an example use case and integration for the widget.
11
-
12
- ### Create a Container
13
-
14
- To integrate the SRC checkout iFrame, create a container in your HTML code. This container serves as the placeholder for the iFrame.
15
-
16
- ```html
17
- <div id="checkoutIframe"></div>
18
- ```
19
-
20
- ### Initialize the Widget
21
-
22
- Use the following code to initialize your widget:
23
-
24
- ```javascript
25
- var src = new paydock.MastercardSRCClickToPay(
26
- "#checkoutIframe",
27
- "service_id",
28
- "paydock_public_key_or_access_token",
29
- {}, // meta
30
- );
31
- src.load();
32
- ```
33
-
34
- ```javascript
35
- // ES2015 | TypeScript
36
- import { MastercardSRCClickToPay } from '@paydock/client-sdk';
37
- var src = new MastercardSRCClickToPay(
38
- "#checkoutIframe",
39
- "service_id",
40
- "paydock_public_key_or_access_token",
41
- {}, // meta
42
- );
43
- src.load();
44
- ```
45
-
46
- *NOTE:* Paydock recommends that you use a Paydock Access Token instead of a public key for security reasons in production environments. When creating your access token, you must enable the `Secure Remote Commerce` and add a whitelist for the domain of your checkout screen.
47
-
48
- ### Full example
49
-
50
- A full example of the container and the initialized widget is as follows:
51
-
52
- ```html
53
- <!DOCTYPE html>
54
- <html lang="en">
55
- <head>
56
- <meta charset="UTF-8">
57
- <title>Title</title>
58
- <style>iframe {border: 0;width: 40%;height: 300px;}</style>
59
- </head>
60
- <body>
61
- <div id="checkoutIframe"></div>
62
- <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
63
- <script>
64
- var src = new paydock.MastercardSRCClickToPay(
65
- "#checkoutIframe",
66
- "service_id",
67
- "paydock_public_key_or_access_token",
68
- {},
69
- );
70
- src.load();
71
- </script>
72
- </body>
73
- </html>
74
- ```
75
-
76
- ## Customize your SRC Checkout
77
-
78
- The following is an advanced example that includes customization. You can use these methods to enhance your checkout experience.
79
-
80
- ### Settings
81
-
82
- ```javascript
83
- src.setEnv('sandbox'); // set environment
84
- src.hideCheckout(); // hide checkout iframe
85
- src.showCheckout(); // show checkout iframe
86
- src.on('iframeLoaded', () => {
87
- console.log("Initial iframe loaded");
88
- });
89
- src.on('checkoutReady', () => {
90
- console.log("Checkout ready to be used");
91
- });
92
- src.on('checkoutCompleted', (token) => {
93
- console.log(token);
94
- });
95
- src.on('checkoutError', (error) => {
96
- console.log(error);
97
- });
98
- ```
99
-
100
- ### Full example
101
-
102
- ```html
103
- <!DOCTYPE html>
104
- <html lang="en">
105
- <head>
106
- <meta charset="UTF-8">
107
- <title>Title</title>
108
- <style>iframe {border: 0;width: 40%;height: 450px;}</style>
109
- </head>
110
- <body>
111
- <div id="checkoutIframe"></div>
112
- <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
113
- <script>
114
- var src = new paydock.MastercardSRCClickToPay(
115
- "#checkoutIframe",
116
- "service_id",
117
- "paydock_public_key_or_access_token",
118
- {},
119
- );
120
- src.on('iframeLoaded', () => {
121
- console.log("Initial iframe loaded");
122
- });
123
- src.on('checkoutReady', () => {
124
- console.log("Checkout ready to be used");
125
- });
126
- src.on('checkoutCompleted', (token) => {
127
- console.log(token);
128
- });
129
- src.on('checkoutError', (error) => {
130
- console.log(error);
131
- });
132
- src.load();
133
- </script>
134
- </body>
135
- </html>
136
- ```
137
-
138
- ## Customize your billing address fields
139
-
140
- To customize your billing address experience, Paydock uses a flag that manages whether a customer's billing address is mandatory.
141
- The options for this customization are NONE (default option), and POSTAL_COUNTRY or FULL.
142
-
143
- ```
144
- var src = new paydock.MastercardSRCClickToPay(
145
- "#checkoutIframe",
146
- "service_id",
147
- "paydock_public_key_or_access_token",
148
- {
149
- "dpa_transaction_options": {
150
- "dpa_billing_preference": "FULL"
151
- }
152
- },
153
- );
154
- ```
155
-
156
- The SRC checkout in the example requires the billing address from the customer, which is then returned as a part of the checkout data. The data is then stored and leveraged in the Paydock charge.
157
- You can also provide the billing address at the time of creating the charge. For example, if you have a different method for collecting the billing address, such as outside of the SRC checkout, you can provide it alongside other information at the charge creation step:
158
-
159
- 1. Disable the billing address in Paydock's SRC widget.
160
- 2. Get your One Time Token from the SRC widget alongside other details that may have been collected outside the SRC checkout as the shipping address.
161
- 3. Send the billing address when creating the charge.
162
-
163
- ```
164
- POST v1/charges
165
- {
166
- "amount": "10.00",
167
- "currency": "AUD",
168
- "token": "one_time_token",
169
- "customer": {
170
- "payment_source": {
171
- "gateway_id": "gateway_id",
172
- "address_line1": "address_line1",
173
- "address_line2": "address_line2",
174
- "address_city": "address_city",
175
- "address_postcode": "address_postcode",
176
- "address_state": "address_state",
177
- "address_country": "address_country"
178
- }
179
- },
180
- "shipping": {
181
- "address_line1": "address_line1",
182
- "address_line2": "address_line2",
183
- "address_line3": "address_line3",
184
- "address_city": "address_city",
185
- "address_postcode": "address_postcode",
186
- "address_state": "address_state",
187
- "address_country": "address_country"
188
- }
189
- }
190
- ```
191
-
192
- ## How to customize accepted cards
193
-
194
- You can send a flag `unaccepted_card_type` to block the usage of a specific card type. The available options are 'DEBIT' and 'CREDIT'.
195
-
196
- ### Example code
197
-
198
- The following example demonstrates how to block the card:
199
-
200
- ```
201
- var src = new paydock.MastercardSRCClickToPay(
202
- "#checkoutIframe",
203
- "service_id",
204
- "paydock_public_key",
205
- {
206
- unaccepted_card_type: 'DEBIT'
207
- },
208
- );
209
- ```
210
-
211
- ## Personalize the Style
212
-
213
- Customize the look and feel of your UI. The following example demonstrates changes in the styling of the buttons.
214
-
215
- ### Example code
216
-
217
- ```
218
- var src = new paydock.MastercardSRCClickToPay(
219
- "#checkoutIframe",
220
- "service_id",
221
- "paydock_public_key",
222
- {},
223
- );
224
- src.setStyles({
225
- enable_src_popup: true,
226
- primary_button_color: 'red',
227
- secondary_button_color: 'red',
228
- primary_button_text_color: 'red',
229
- secondary_button_text_color: 'red',
230
- font_family: 'Arial',
231
- });
232
- ```
@@ -1,336 +0,0 @@
1
- ## Classes
2
-
3
- <dl>
4
- <dt><a href="#MastercardSRCClickToPay">MastercardSRCClickToPay</a> ⇐ <code>SRC</code></dt>
5
- <dd><p>Class MastercardSRCClickToPay include methods for interacting with the MastercardSRC checkout and Manual Card option</p>
6
- </dd>
7
- </dl>
8
-
9
- ## Interfaces
10
-
11
- <dl>
12
- <dt><a href="#IMastercardSRCMeta">IMastercardSRCMeta</a> : <code>object</code></dt>
13
- <dd><p>Interface of data used for the Mastercard Checkout. For further information refer to <a href="https://developer.mastercard.com/unified-checkout-solutions/documentation/sdk-reference/init">the documentation</a>.</p>
14
- </dd>
15
- <dt><a href="#EventData">EventData</a> : <code>object</code></dt>
16
- <dd><p>Interface for data returned in callbacks</p>
17
- </dd>
18
- <dt><a href="#EventDataCheckoutCompletedData">EventDataCheckoutCompletedData</a> : <code>object</code></dt>
19
- <dd><p>Event data returned for checkoutCompleted callback, holding the One Time Token and the flow type completed.
20
- When the flow type is src, masked checkoutData available is also returned</p>
21
- </dd>
22
- <dt><a href="#IStyles">IStyles</a> : <code>object</code></dt>
23
- <dd><p>Interface for style configs inyected to the SRC checkout</p>
24
- </dd>
25
- </dl>
26
-
27
- <a name="IMastercardSRCMeta" id="IMastercardSRCMeta" href="#IMastercardSRCMeta">&nbsp;</a>
28
-
29
- ## IMastercardSRCMeta : <code>object</code>
30
- Interface of data used for the Mastercard Checkout. For further information refer to [the documentation](https://developer.mastercard.com/unified-checkout-solutions/documentation/sdk-reference/init).
31
-
32
- **Kind**: global interface
33
-
34
- | Param | Type | Description |
35
- | --- | --- | --- |
36
- | [disable_summary_screen] | <code>boolean</code> | Boolean flag that controls if a final summary screen is presented in the checkout flow. |
37
- | [dpa_data] | <code>object</code> | Object where the DPA creation data is stored. |
38
- | [dpa_data.dpa_presentation_name] | <code>string</code> | Name in which the DPA is presented. |
39
- | [dpa_data.dpa_uri] | <code>string</code> | Used for indicating the DPA URI. |
40
- | [dpa_data.dpa_address] | <code>string</code> | Address associated with the DPA. |
41
- | [dpa_data.dpa_email_address] | <code>string</code> | Email address for DPA communication. |
42
- | [dpa_data.dpa_phone_number] | <code>object</code> | Phone number structure for DPA communication. |
43
- | [dpa_data.dpa_phone_number.country_code] | <code>string</code> | The country code of the phone number. |
44
- | [dpa_data.dpa_phone_number.phone_number] | <code>string</code> | The phone number part of the phone number. |
45
- | [dpa_data.dpa_logo_uri] | <code>string</code> | URI for the DPA logo. |
46
- | [dpa_data.dpa_supported_email_address] | <code>string</code> | Supported email address for DPA support. |
47
- | [dpa_data.dpa_supported_phone_number] | <code>object</code> | Supported phone number for DPA support. |
48
- | [dpa_data.dpa_supported_phone_number.country_code] | <code>string</code> | The country code of the phone number. |
49
- | [dpa_data.dpa_supported_phone_number.phone_number] | <code>string</code> | The phone number part of the phone number. |
50
- | [dpa_data.dpa_support_uri] | <code>string</code> | URI for DPA support. |
51
- | [dpa_data.application_type] | <code>string</code> | Application type, either 'WEB_BROWSER' or 'MOBILE_APP'. |
52
- | [co_brand_names] | <code>Array.&lt;string&gt;</code> | List of co-brand names associated with the SRC experience. |
53
- | [checkout_experience] | <code>string</code> | Checkout experience type, either 'WITHIN_CHECKOUT' or 'PAYMENT_SETTINGS'. |
54
- | [services] | <code>string</code> | Services offered, such as 'INLINE_CHECKOUT' or 'INLINE_INSTALLMENTS'. |
55
- | [dpa_transaction_options] | <code>object</code> | Object that stores options for creating a transaction with DPA. |
56
- | [dpa_transaction_options.dpa_locale] | <code>string</code> | DPA’s preferred locale, example en_US. |
57
- | [dpa_transaction_options.dpa_accepted_billing_countries] | <code>Array.&lt;string&gt;</code> | List of accepted billing countries for DPA in ISO 3166-1 alpha-2 format. |
58
- | [dpa_transaction_options.dpa_billing_preference] | <code>string</code> | Billing preferences for DPA, options are 'FULL', 'POSTAL_COUNTRY', 'NONE'. |
59
- | [dpa_transaction_options.payment_options] | <code>Array.&lt;object&gt;</code> | Payment options included in the transaction. |
60
- | [dpa_transaction_options.payment_options.dynamic_data_type] | <code>string</code> | Dynamic data types. |
61
- | [dpa_transaction_options.order_type] | <code>string</code> | Type of the order, options are 'SPLIT_SHIPMENT', 'PREFERRED_CARD'. |
62
- | [dpa_transaction_options.three_ds_preference] | <code>string</code> | Preference for 3DS usage in the transaction. |
63
- | [dpa_transaction_options.confirm_payment] | <code>boolean</code> | Indicates if payment confirmation is required. |
64
- | [dpa_transaction_options.consumer_name_requested] | <code>boolean</code> | Indicates if consumer name is requested. |
65
- | [dpa_transaction_options.consumer_email_address_requested] | <code>boolean</code> | Indicates if consumer email address is requested. |
66
- | [dpa_transaction_options.consumer_phone_number_requested] | <code>boolean</code> | Indicates if consumer phone number is requested. |
67
- | [dpa_transaction_options.transaction_amount] | <code>object</code> | Details of the transaction amount. |
68
- | [dpa_transaction_options.transaction_amount.transaction_amount] | <code>number</code> | Amount of the transaction. |
69
- | [dpa_transaction_options.transaction_amount.transaction_currency_code] | <code>string</code> | Currency code of the transaction in 3 letter ISO code format. |
70
- | [dpa_transaction_options.merchant_order_id] | <code>string</code> | Merchant's order ID. |
71
- | [dpa_transaction_options.merchant_category_code] | <code>string</code> | Merchant's category code. |
72
- | [dpa_transaction_options.merchant_country_code] | <code>string</code> | Merchant's country code in ISO 3166-1 alpha-2 format. |
73
- | [customer] | <code>object</code> | Object where the customer data is stored to prefill in the checkout. |
74
- | [customer.email] | <code>string</code> | Customer email. |
75
- | [customer.first_name] | <code>string</code> | Customer first name. |
76
- | [customer.last_name] | <code>string</code> | Customer last name. |
77
- | [customer.phone] | <code>object</code> | Object where the customer phone is stored. |
78
- | [customer.phone.country_code] | <code>string</code> | Customer phone country code (example "1" for US). // TODO: Confirm if it can be removed! |
79
- | [customer.phone.phone] | <code>string</code> | Customer phone number. |
80
- | [unaccepted_card_type] | <code>string</code> | Used to block a specific card type. Options are 'CREDIT', 'DEBIT'. |
81
-
82
- <a name="EventData" id="EventData" href="#EventData">&nbsp;</a>
83
-
84
- ## EventData : <code>object</code>
85
- Interface for data returned in callbacks
86
-
87
- **Kind**: global interface
88
-
89
- | Param | Type | Description |
90
- | --- | --- | --- |
91
- | type | [<code>EVENT\_DATA\_TYPE</code>](#EVENT_DATA_TYPE) | Event type of type [EVENT_DATA_TYPE](#EVENT_DATA_TYPE) |
92
- | data | <code>string</code> \| [<code>EventDataCheckoutCompletedData</code>](#EventDataCheckoutCompletedData) | optional data returning a string for checkoutError event or [EventDataCheckoutCompletedData](#EventDataCheckoutCompletedData) for checkoutCompleted |
93
-
94
- <a name="EventDataCheckoutCompletedData" id="EventDataCheckoutCompletedData" href="#EventDataCheckoutCompletedData">&nbsp;</a>
95
-
96
- ## EventDataCheckoutCompletedData : <code>object</code>
97
- Event data returned for checkoutCompleted callback, holding the One Time Token and the flow type completed.
98
- When the flow type is src, masked checkoutData available is also returned
99
-
100
- **Kind**: global interface
101
-
102
- | Param | Type | Description |
103
- | --- | --- | --- |
104
- | type | <code>string</code> | type of the checkout, can be `src` or `manual`. |
105
- | token | <code>string</code> | one time token value. |
106
- | [checkoutData] | <code>object</code> | Optional checkout data related to the checkout information. Only available on src flow. |
107
- | [checkoutData.card_number_bin] | <code>string</code> | The BIN of the card used for the transaction. |
108
- | [checkoutData.card_number_last4] | <code>string</code> | The last four digits of the card number. |
109
- | [checkoutData.card_scheme] | <code>string</code> | The card scheme. Values: visa, mastercard, amex, diners, discover. |
110
- | [checkoutData.card_type] | <code>string</code> | The type of card. Values: credit, debit, prepaid, combo, flex. |
111
- | [checkoutData.address_line1] | <code>string</code> | Address line 1 for billing address. |
112
- | [checkoutData.address_line2] | <code>string</code> | Address line 2 for billing address. |
113
- | [checkoutData.address_line3] | <code>string</code> | Address line 3 for billing address. |
114
- | [checkoutData.address_city] | <code>string</code> | City for billing address. |
115
- | [checkoutData.address_postcode] | <code>string</code> | Postal code for billing address. |
116
- | [checkoutData.address_state] | <code>string</code> | State or province for billing address. |
117
- | [checkoutData.address_country] | <code>string</code> | Country for billing address. |
118
- | [checkoutData.shipping] | <code>object</code> | Optional shipping information. |
119
- | [checkoutData.shipping.address_line1] | <code>string</code> | Address line 1 for shipping address. |
120
- | [checkoutData.shipping.address_line2] | <code>string</code> | Address line 2 for shipping address. |
121
- | [checkoutData.shipping.address_line3] | <code>string</code> | Address line 3 for shipping address. |
122
- | [checkoutData.shipping.address_city] | <code>string</code> | City for shipping address. |
123
- | [checkoutData.shipping.address_postcode] | <code>string</code> | Postal code for shipping address. |
124
- | [checkoutData.shipping.address_state] | <code>string</code> | State or province for shipping address. |
125
- | [checkoutData.shipping.address_country] | <code>string</code> | Country for shipping address. |
126
-
127
- <a name="IStyles" id="IStyles" href="#IStyles">&nbsp;</a>
128
-
129
- ## IStyles : <code>object</code>
130
- Interface for style configs inyected to the SRC checkout
131
-
132
- **Kind**: global interface
133
-
134
- | Param | Type | Description |
135
- | --- | --- | --- |
136
- | [primary_button_color] | <code>string</code> | Color Code for primary button. |
137
- | [primary_button_text_color] | <code>string</code> | Color Code for primary button text. |
138
- | [secondary_button_color] | <code>string</code> | Color Code for secondary button. |
139
- | [secondary_button_text_color] | <code>string</code> | Color Code for secondary button text. |
140
- | [font_family] | <code>string</code> | Font family to be used. |
141
- | [enable_src_popup] | <code>boolean</code> | Boolean flag to make the SRC checkout show in a popup window instead of embedded in iframe. |
142
-
143
- <a name="MastercardSRCClickToPay" id="MastercardSRCClickToPay" href="#MastercardSRCClickToPay">&nbsp;</a>
144
-
145
- ## MastercardSRCClickToPay ⇐ <code>SRC</code>
146
- Class MastercardSRCClickToPay include methods for interacting with the MastercardSRC checkout and Manual Card option
147
-
148
- **Kind**: global class
149
- **Extends**: <code>SRC</code>
150
-
151
- * [MastercardSRCClickToPay](#MastercardSRCClickToPay) ⇐ <code>SRC</code>
152
- * [new MastercardSRCClickToPay(iframe_selector, service_id, public_key_or_access_token, meta)](#new_MastercardSRCClickToPay_new)
153
- * [.load()](#MastercardSRCClickToPay+load)
154
- * [.setStyles(fields)](#SRC+setStyles)
155
- * [.setEnv(env, [alias])](#SRC+setEnv)
156
- * [.getEnv()](#SRC+getEnv)
157
- * [.on(eventName, [cb])](#SRC+on) ⇒ <code>Promise.&lt;any&gt;</code> \| <code>void</code>
158
- * [.hideCheckout([saveSize])](#SRC+hideCheckout)
159
- * [.showCheckout()](#SRC+showCheckout)
160
- * [.reload()](#SRC+reload)
161
- * [.useAutoResize()](#SRC+useAutoResize)
162
-
163
- <a name="new_MastercardSRCClickToPay_new" id="new_MastercardSRCClickToPay_new" href="#new_MastercardSRCClickToPay_new">&nbsp;</a>
164
-
165
- ### new MastercardSRCClickToPay(iframe_selector, service_id, public_key_or_access_token, meta)
166
-
167
- | Param | Type | Description |
168
- | --- | --- | --- |
169
- | iframe_selector | <code>string</code> | Selector of html element. Container for SRC checkout iFrame. |
170
- | service_id | <code>string</code> | Card Scheme Service ID |
171
- | public_key_or_access_token | <code>string</code> | Paydock public key or Access Token |
172
- | meta | [<code>IMastercardSRCMeta</code>](#IMastercardSRCMeta) | Data that configures the SRC checkout |
173
-
174
- **Example**
175
- ```js
176
- var mastercardSRC = new MastercardSRCClickToPay('#checkoutIframe', 'service_id', 'public_key', {});
177
- ```
178
- <a name="MastercardSRCClickToPay+load" id="MastercardSRCClickToPay+load" href="#MastercardSRCClickToPay+load">&nbsp;</a>
179
-
180
- ### mastercardSRCClickToPay.load()
181
- The final method after configuring the SRC to start the load process of SRC checkout
182
-
183
- **Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)
184
- <a name="SRC+setStyles" id="SRC+setStyles" href="#SRC+setStyles">&nbsp;</a>
185
-
186
- ### mastercardSRCClickToPay.setStyles(fields)
187
- Object contain styles for widget - call before `.load()`.
188
-
189
- **Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)
190
- **Overrides**: [<code>setStyles</code>](#SRC+setStyles)
191
-
192
- | Param | Type | Description |
193
- | --- | --- | --- |
194
- | fields | [<code>IStyles</code>](#IStyles) | name of styles which can be shown in widget [STYLE](STYLE) |
195
-
196
- **Example**
197
- ```js
198
- widget.setStyles({
199
- enable_src_popup: true
200
- primary_button_color: 'red',
201
- secondary_button_color: 'blue',
202
- primary_button_text_color: 'white',
203
- secondary_button_text_color: 'white',
204
- font_family: 'Arial',
205
- });
206
- ```
207
- <a name="SRC+setEnv" id="SRC+setEnv" href="#SRC+setEnv">&nbsp;</a>
208
-
209
- ### mastercardSRCClickToPay.setEnv(env, [alias])
210
- Current method can change environment. By default environment = sandbox.
211
- Also we can change domain alias for this environment. By default domain_alias = paydock.com
212
-
213
- **Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)
214
- **Overrides**: [<code>setEnv</code>](#SRC+setEnv)
215
-
216
- | Param | Type | Description |
217
- | --- | --- | --- |
218
- | env | <code>string</code> | sandbox, production |
219
- | [alias] | <code>string</code> | Own domain alias |
220
-
221
- **Example**
222
- ```js
223
- SRC.setEnv('production');
224
- ```
225
- <a name="SRC+getEnv" id="SRC+getEnv" href="#SRC+getEnv">&nbsp;</a>
226
-
227
- ### mastercardSRCClickToPay.getEnv()
228
- Method to read the current environment
229
-
230
- **Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)
231
- **Overrides**: [<code>getEnv</code>](#SRC+getEnv)
232
- **Example**
233
- ```js
234
- SRC.getEnv();
235
- ```
236
- <a name="SRC+on" id="SRC+on" href="#SRC+on">&nbsp;</a>
237
-
238
- ### mastercardSRCClickToPay.on(eventName, [cb]) ⇒ <code>Promise.&lt;any&gt;</code> \| <code>void</code>
239
- Listen to events of SRC
240
-
241
- **Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)
242
- **Overrides**: [<code>on</code>](#SRC+on)
243
-
244
- | Param | Type | Description |
245
- | --- | --- | --- |
246
- | eventName | <code>string</code> | Available event names [EVENT](#EVENT) |
247
- | [cb] | <code>listener</code> | The callback to handle the event. When available, it will send back data of type [EventData](#EventData) |
248
-
249
- **Example**
250
- ```js
251
- SRC.on('checkoutCompleted', function (token) {
252
- console.log(token);
253
- });
254
- // or
255
- SRC.on('checkoutCompleted').then(function (token) {
256
- console.log(token);
257
- });
258
- ```
259
- <a name="SRC+hideCheckout" id="SRC+hideCheckout" href="#SRC+hideCheckout">&nbsp;</a>
260
-
261
- ### mastercardSRCClickToPay.hideCheckout([saveSize])
262
- Using this method you can hide checkout after load and button click
263
-
264
- **Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)
265
- **Overrides**: [<code>hideCheckout</code>](#SRC+hideCheckout)
266
-
267
- | Param | Type | Default | Description |
268
- | --- | --- | --- | --- |
269
- | [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size (if applicable) |
270
-
271
- **Example**
272
- ```js
273
- SRC.hideCheckout();
274
- ```
275
- <a name="SRC+showCheckout" id="SRC+showCheckout" href="#SRC+showCheckout">&nbsp;</a>
276
-
277
- ### mastercardSRCClickToPay.showCheckout()
278
- Using this method you can show checkout after using hideCheckout method
279
-
280
- **Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)
281
- **Overrides**: [<code>showCheckout</code>](#SRC+showCheckout)
282
- **Example**
283
- ```js
284
- SRC.showCheckout()
285
- ```
286
- <a name="SRC+reload" id="SRC+reload" href="#SRC+reload">&nbsp;</a>
287
-
288
- ### mastercardSRCClickToPay.reload()
289
- Using this method you can reload the whole checkout
290
-
291
- **Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)
292
- **Overrides**: [<code>reload</code>](#SRC+reload)
293
- **Example**
294
- ```js
295
- SRC.reload()
296
- ```
297
- <a name="SRC+useAutoResize" id="SRC+useAutoResize" href="#SRC+useAutoResize">&nbsp;</a>
298
-
299
- ### mastercardSRCClickToPay.useAutoResize()
300
- Use this method for resize checkout iFrame according to content height, if applicable
301
-
302
- **Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)
303
- **Overrides**: [<code>useAutoResize</code>](#SRC+useAutoResize)
304
- **Example**
305
- ```js
306
- SRC.useAutoResize();
307
- ```
308
- <a name="EVENT" id="EVENT" href="#EVENT">&nbsp;</a>
309
-
310
- ## EVENT : <code>enum</code>
311
- List of available event's name in the SRC checkout lifecycle
312
-
313
- **Kind**: global enum
314
-
315
- | Param | Type | Default | Description |
316
- | --- | --- | --- | --- |
317
- | IFRAME_LOADED | <code>string</code> | <code>&quot;iframeLoaded&quot;</code> | Initial event sent when IFrame is initially loaded. |
318
- | CHECKOUT_READY | <code>string</code> | <code>&quot;checkoutReady&quot;</code> | Event sent when checkout is loaded and ready to be used by customer. Leverage alongside [showCheckout](#SRC+showCheckout) and [hideCheckout](#SRC+hideCheckout). |
319
- | CHECKOUT_POPUP_OPEN | <code>string</code> | <code>&quot;checkoutPopupOpen&quot;</code> | Event sent when SRC Checkout flow is started, regardless of embedded or windowed mode. |
320
- | CHECKOUT_POPUP_CLOSE | <code>string</code> | <code>&quot;checkoutPopupClose&quot;</code> | Event sent when SRC Checkout flow is closed, regardless of embedded or windowed mode. |
321
- | CHECKOUT_COMPLETED | <code>string</code> | <code>&quot;checkoutCompleted&quot;</code> | Event sent on successful checkout by customer. Check [data](#EventDataCheckoutCompletedData) for more information. |
322
- | CHECKOUT_ERROR | <code>string</code> | <code>&quot;checkoutError&quot;</code> | Event sent on error checkout by customer. Check [data](#EventData) for more information. |
323
-
324
- <a name="EVENT_DATA_TYPE" id="EVENT_DATA_TYPE" href="#EVENT_DATA_TYPE">&nbsp;</a>
325
-
326
- ## EVENT\_DATA\_TYPE : <code>enum</code>
327
- List of available event data types
328
-
329
- **Kind**: global enum
330
-
331
- | Param | Type | Default | Description |
332
- | --- | --- | --- | --- |
333
- | CRITICAL_ERROR | <code>string</code> | <code>&quot;CriticalError&quot;</code> | in this error scenario the checkout is understood to be in a non-recoverable state and should be closed by the merchant and give alternate payment options to the user |
334
- | USER_ERROR | <code>string</code> | <code>&quot;UserError&quot;</code> | in this error scenario the error in likely a user input error and the checkout is in a recoverable state, so the user will be kept within the checkout and can retry the flow |
335
- | SUCCESS | <code>string</code> | <code>&quot;Success&quot;</code> | |
336
-