npm - @paydock/client-sdk - Versions diffs - 1.127.0 → 1.128.2 - Mend

@paydock/client-sdk 1.127.0 → 1.128.2

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 (78) hide show

package/slate.md CHANGED Viewed

@@ -370,140 +370,9 @@ When handling errors, consider:
 </html>
 ```
-## Payment sources widget
-You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#payment-sources-simple-example)
-This widget provides a list of previously added (saved) payment-sources by customer_id or reference.
-The widget provides an opportunity to use events to track the process of selecting payment-sources and provide meta information about the payment-sources.
-Payment-source requires a query_token that represents a pre-generated and secure token for limiting the list
-payment-sources, for a specific user or reference.
-In order to generate this token, you need to send a GET request to [getCustomerList](#get-customer-list-with-parameters)
-where required query parameter must be id or reference. In response you get response.query_token which you can use in the widget.
-## Payment sources simple example
-### Container
-```html
-<div id="list"></div>
-```
-You must create a container for the widget. Inside this tag, the widget will be initialized
-### Initialization
-```javascript
-var list = new paydock.HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
-list.load();
-```
-```javascript
-// ES2015 | TypeScript
-import { HtmlPaymentSourceWidget } from '@paydock/client-sdk';
-var list = new HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
-list.load();
-```
-Then write only need 2 lines of code in js to initialize widget
-### Full example
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>Title</title>
-    <style>iframe {border: 0;width: 40%;height: 300px;}</style>
-</head>
-<body>
-    <div id="list"></div>
-    <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
-    <script>
-        var list = new paydock.HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
-        list.load();
-    </script>
-</body>
-</html>
-```
-## Payment sources advanced example
-### Customization
-```javascript
-list.setStyles({
-    icon_size: 'small'
-});
-```
-This example shows how you can customize to your needs and design
-### Settings
-```javascript
-list.filterByTypes(['card', 'checkout']); // filter by any payment source types
-list.filterByGatewayIds(['gateway1']); // also other filters
-list.setRefId('id'); // your unique identifier to identify the data
-list.setLimit(4); // Pagination elements will show if count of elements more then argument passed
-list.onSelectInsert('input[name="ps_id"]', 'payment_source_id'); // insert one-time-token to your input after finish checkout
-list.on('select', function(data) {
-    console.log(data);
-});
-```
-This example shows how you can use a lot of other methods to settings your form
-### Full example
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>Title</title>
-    <style>iframe {border: 0;width: 40%;height: 300px;}</style>
-</head>
-<body>
-    <div id="list"></div>
-    <input type="text" name="ps_id" />
-    <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
-    <script>
-        var list = new paydock.HtmlPaymentSourceWidget('#list', 'publicKey', 'queryToken');
-        list.filterByTypes(['card', 'checkout']);
-        list.filterByGatewayIds(['gateway1']);
-        list.setRefId('id');
-        list.setLimit(4);
-        list.setStyles({
-            icon_size: 'small'
-        });
-        list.load();
-        list.onSelectInsert('input[name="ps_id"]', 'payment_source_id');
-        list.on('select', function(data) {
-            console.log(data);
-        });
-    </script>
-</body>
-</html>
-```
 ## Checkout button
 You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#cb_CheckoutButton)
-PayPal meta parameters description [here](https://www.npmjs.com/package/@paydock/client-sdk#ipaypalmeta)
 Zipmoney meta parameters description [here](https://www.npmjs.com/package/@paydock/client-sdk#izipmoneymeta)
 This widget allows you to turn your button into a full Checkout Button.
@@ -526,96 +395,18 @@ You must create a button to turn it into checkout-button
 ### Initialization
 ```javascript
-var button = new paydock.PaypalCheckoutButton('#button', 'publicKey', 'gatewayId');
+var button = new paydock.ZipmoneyCheckoutButton('#button', 'publicKey', 'gatewayId');
 ```
 ```javascript
 // ES2015 | TypeScript
-var button = new PaypalCheckoutButton('#button', 'publicKey');
+var button = new ZipmoneyCheckoutButton('#button', 'publicKey');
 ```
 Then write only need 1 line of code in js to initialize widget
-### Full example
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>Title</title>
-</head>
-<body>
-    <button type="button" id="button">checkout</button>
-    <script src="https://widget.paydock.com/sdk/latest/widget.umd.js" ></script>
-    <script>
-        var button = new paydock.PaypalCheckoutButton('#button', 'publicKey');
-    </script>
-</body>
-</html>
-```
-## Checkout button advanced example
-### Optional methods
-```javascript
-button.onFinishInsert('input[name="pst"]', 'payment_source_token'); // insert one-time-token to your input after finish checkout
-button.setMeta({
-       brand_name: 'Paydock',
-       reference: '15',
-       first_name: 'receiver-name',
-       last_name: 'receiver-last-name',
-       phone: '9379992'}); // settings for checkout pages
-button.on('finish', function (data) { // Add handler of event
-       console.log('on:finish', data);
-});
-```
-This example shows how you can use a lot of other methods to settings your button
-### Full Paypal example
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-	<meta charset="UTF-8">
-	<title>Title</title>
-</head>
-<body>
-<form id="paymentForm">
-    <button type="button" id="button">
-        <img src="https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif" align="left" style="margin-right:7px;">
-    </button>
-</form>
-<input type="text" name="pst" />
-<script src="https://widget.paydock.com/sdk/latest/widget.umd.js" ></script>
-<script>
-	var button = new paydock.PaypalCheckoutButton('#button', 'publicKey', 'gatewayId');
-	button.onFinishInsert('input[name="pst"]', 'payment_source_token');
-    button.setMeta({
-           brand_name: 'Paydock',
-           reference: '15',
-           first_name: 'Joshua',
-           last_name: 'Wood',
-           phone: '0231049872'});
-    button.on('finish', function (data) {
-           console.log('on:finish', data);
-    });
-</script>
-</body>
-</html>
-```
 ### Full ZipMoney example
 ```html
@@ -703,52 +494,6 @@ This example shows how you can use a lot of other methods to settings your butto
 </html>
 ```
-### Full Aftepay example
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-	<meta charset="UTF-8">
-	<title>Title</title>
-</head>
-<body>
-<button type="button" id="button">
-    <img src="https://daepxvbfwwgd0.cloudfront.net/assets/logo_scroll-0c43312c5845a0dcd7a3373325da6402bc1d635d3415af28ed40d6c1b48e3d5c.png" align="left" style="margin-right:7px;">
-</button>
-<input type="text" name="pst" />
-<script src="https://widget.paydock.com/sdk/latest/widget.umd.js" ></script>
-<script>
-	var button = new paydock.AfterpayCheckoutButton('#button', 'publicKey', 'gatewayId');
-	button.onFinishInsert('input[name="pst"]', 'payment_source_token');
-    button.showEnhancedTrackingProtectionPopup(true);
-    button.setMeta({
-        amount: "100",
-        currency: "AUD",
-        reference: 'Vitae commodi provident assumenda',
-        email: 'wanda.mertz@example.com',
-        first_name: 'Wanda',
-        last_name: 'Mertz',
-        address_line: '61426 Osvaldo Plains',
-        address_line2: 'Apt. 276',
-        address_city: 'Lake Robyn',
-        address_state: 'WY',
-        address_postcode: '07396',
-        address_country: 'Australia',
-        phone: '0412345678',
-    });
-    button.on('finish', function (data) {
-           console.log('on:finish', data);
-    });
-</script>
-</body>
-</html>
-```
 ## Api
 You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#api)
@@ -1058,144 +803,11 @@ After you initialized the standalone 3ds charge via `v1/charges/standalone-3ds`
 | <code>error</code> | <code>object</code> | error response |
 | <code>charge_3ds_id</code> | <code>string</code> | Universal unique transaction identifier to identify the transaction |
-## Vault Display Widget
-You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#vault-display-widget)
-The vault display form allows viewing card number and CVV. The form can be customised according to your needs.
-You can set styles as well as subscribe to widget events that help monitor user’s actions in real time.
-## Vault Display Widget simple example
-### Container
-```html
-<div id="widget"></div>
-```
-You must create a container for the widget. Inside this tag, the widget will be initialized
-### Initialization
-```javascript
-var widget = new paydock.VaultDisplayWidget('#widget', 'token');
-widget.load();
-```
-```javascript
-// ES2015 | TypeScript
-import { VaultDisplayWidget } from '@paydock/client-sdk';
-var widget = new VaultDisplayWidget('#widget', 'token');
-widget.load();
-```
-Then write only need 2 lines of code in js to initialize widget
-### Full example
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>Title</title>
-    <style>iframe {border: 0;width: 100%;height: 300px;}</style>
-</head>
-<body>
-    <div id="widget"></div>
-    <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
-    <script>
-        var widget = new paydock.VaultDisplayWidget('#widget', 'token');
-        widget.load();
-    </script>
-</body>
-</html>
-```
-## Widget advanced example
-### Customization
-```javascript
-widget.setEnv('sandbox');
-widget.on('after_load', function (data) {
-  console.log(data);
-});
-widget.on('cvv_secure_code_requested', function (data) {
-  console.log(data);
-});
-widget.on('card_number_secure_code_requested', function (data) {
-  console.log(data);
-});
-widget.setStyles({
-    background_color: 'rgb(0, 0, 0)',
-    border_color: 'yellow',
-    text_color: '#FFFFAA',
-    button_color: 'rgba(255, 255, 255, 0.9)',
-    font_size: '20px'
-});
-```
-This example shows how you can use a lot of other methods to settings your form
-### Full example
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>Title</title>
-    <style>iframe {border: 0;width: 40%;height: 450px;}</style>
-</head>
-<body>
-    <div id="widget"></div>
-    <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
-    <script>
-        var widget = new paydock.VaultDisplayWidget('#widget', 'token');
-        widget.setEnv('sandbox');
-        widget.on('after_load', function (data) {
-          console.log(data);
-        });
-        widget.on('cvv_secure_code_requested', function (data) {
-          console.log(data);
-        });
-        widget.on('card_number_secure_code_requested', function (data) {
-          console.log(data);
-        });
-        widget.setStyles({
-            background_color: 'rgb(0, 0, 0)',
-            border_color: 'yellow',
-            text_color: '#FFFFAA',
-            button_color: 'rgba(255, 255, 255, 0.9)',
-            font_size: '20px'
-        });
-        widget.load();
-    </script>
-</body>
-</html>
-```
 ## Wallet Buttons
 You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#wallet-buttons-simple-example)
 Wallet Buttons allow you to easily integrate different E-Wallets into your checkout.
-Currently supports ApplePay, Google Pay, Google Pay and Apple Pay via Stripe, Flypay and Flypay V2 checkout, Paypal Smart Buttons Checkout and Afterpay.
+Currently supports ApplePay, Google Pay, Google Pay and Apple Pay via Stripe and Flypay V2 checkout, Paypal Smart Buttons Checkout and Afterpay.
 If available in your client environment, you will display a simple button that upon clicking it the user will follow the standard flow for the appropriate Wallet. If not available an event will be raised and no button will be displayed.
@@ -1212,55 +824,6 @@ You must create a container for the Wallet Buttons. Inside this tag, the button
 Before initializing the button, you must perform a POST request to `charges/wallet` from a secure environment like your server. This call will return a token that is required to load the button and securely complete the payment. You can find the documentation to this call in the PayDock API documentation.
 ### Initialization
-The following is the minimum required initialization parameters for Apple Pay and Google Pay via Stripe:
-```javascript
-let button = new paydock.WalletButtons(
-    "#widget",
-    token,
-    {
-        amount_label: "Total",
-        country: "DE",
-    }
-);
-button.load();
-```
-```javascript
-// ES2015 | TypeScript
-import { WalletButtons } from '@paydock/client-sdk';
-var button = new WalletButtons(
-    '#widget',
-    token,
-    {
-        amount_label: 'Total',
-        country: 'DE',
-    }
-);
-button.load();
-```
-Flypay and Paypal wallets do not require any meta sent to the wallet, so the following is enough for initialization:
-```javascript
-let button = new paydock.WalletButtons(
-    "#widget",
-    token,
-    {}
-);
-button.load();
-```
-```javascript
-// ES2015 | TypeScript
-import { WalletButtons } from '@paydock/client-sdk';
-var button = new WalletButtons(
-    '#widget',
-    token,
-    {}
-);
-button.load();
-```
 For Afterpay wallet, the country code is required:
 ```javascript
@@ -1361,14 +924,6 @@ If the customer's browser is not supported, or the customer does not have any ca
 button.onUnavailable(() => console.log("No wallet buttons available"));
 ```
-### Forcibly closing the checkout
-In some situations you may want to forcibly close the checkout so that your user is back in your checkout screen, fow which you can use this method. Currently supported by Flypay wallet only.
-```javascript
-button.close();
-```
 ### Performing actions when the wallet button is clicked
 In some situations you may want to perform some validations or actions when the user clicks on the wallet button, for which you can use this method. Currently supported by Paypal, ApplePay and GooglePay wallets.
@@ -1379,7 +934,7 @@ button.onClick(() => console.log("Perform actions on button click"));
 ### Performing actions when shipping info is updated
-In Flypay, Paypal, ApplePay via MPGS and GooglePay via MPGS integrations after each shipping info update the `onUpdate(data)` will be called with the selected shipping address information, plus selected shipping method when applicable for Paypal, ApplePay and GooglePay. Merchants should handle this callback, recalculate shipping costs in their server by analyzing the new data, and submit a backend to backend request to `POST charges/:id` with the new total amount and shipping amount (you can find the documentation of this call in the PayDock API documentation).
+In Paypal, ApplePay via MPGS and GooglePay via MPGS integrations after each shipping info update the `onUpdate(data)` will be called with the selected shipping address information, plus selected shipping method when applicable for Paypal, ApplePay and GooglePay. Merchants should handle this callback, recalculate shipping costs in their server by analyzing the new data, and submit a backend to backend request to `POST charges/:id` with the new total amount and shipping amount (you can find the documentation of this call in the PayDock API documentation).
 For Paypal integration specifically, if shipping is enabled for the wallet button and different shipping methods were provided in the create wallet charge call, Merchants must ensure that the posted `shipping.amount` to `POST charges/:id` matches the selected shipping option amount (value sent in when initializing the wallet charge). In other words, when providing shipping methods the shipping amount is bound to being one of the provided shipping method amount necessarily. Bear in mind that the total charge amount must include the `shipping.amount`, since it represents the full amount to be charged to the customer.
@@ -1446,47 +1001,11 @@ of the corresponding event names.
 ```javascript
 button.on(EVENT.UNAVAILABLE, () => console.log("No wallet buttons available"));
-button.on(EVENT.UPDATE, (data) => console.log("Updating amount via a backend to backend call to POST charges/:id");
+button.on(EVENT.UPDATE, (data) => console.log("Updating amount via a backend to backend call to POST charges/:id"));
 button.on(EVENT.PAYMENT_SUCCESSFUL, (data) => console.log("The payment was successful"));
 button.on(EVENT.PAYMENT_ERROR, (data) => console.log("The payment was not successful"));
 ```
-This example shows how to use these functions for **Apple and Google Pay via Stripe**:
-_(Required `meta` fields: `amount_label`, `country`. Optional `meta` fields: `wallets`)_
-### Apple and Google Pay via Stripe Full example
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>Title</title>
-</head>
-<body>
-    <h2>Payment using PayDock Wallet Button!</h2>
-    <div id="widget"></div>
-</body>
-<script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
-<script>
-    let button = new paydock.WalletButtons(
-        "#widget",
-        charge_token,
-        {
-            amount_label: "Total",
-            country: "DE",
-            wallets: ["google", "apple"],
-        }
-    );
-    button.setEnv('sandbox');
-    button.onUnavailable(() => console.log("No wallet buttons available"));
-    button.onPaymentSuccessful((data) => console.log("The payment was successful"));
-    button.onPaymentError((data) => console.log("The payment was not successful"));
-    button.onPaymentInReview((data) => console.log("The payment is on fraud review"));
-    button.load();
-</script>
-</html>
-```
 This example shows how to use these functions for **Paypal Smart Checkout Buttons**:
 _(Required `meta` fields: - . Optional `meta` fields: `request_shipping`, `pay_later`, `standalone`, `style`)_
 ### Paypal Smart Checkout Buttons Full example
@@ -1554,44 +1073,6 @@ _(Required `meta` fields: - . Optional `meta` fields: `request_shipping`, `pay_l
 </html>
 ```
-This example shows how to use these functions for **Flypay v1 Wallet**.
-_(Required `meta` fields: - . Optional `meta` fields: `request_shipping`, `pay_later`, `style`)_
-### Flypay Full example
-```html
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="UTF-8">
-    <title>Title</title>
-</head>
-<body>
-    <h2>Payment using PayDock Wallet Button!</h2>
-    <div id="widget"></div>
-</body>
-<script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
-<script>
-    let button = new paydock.WalletButtons(
-          "#widget",
-          charge_token,
-          {
-               request_shipping: true
-          }
-     );
-    button.setEnv('sandbox');
-    button.onUnavailable(() => console.log("No wallet buttons available"));
-    button.onUpdate((data) => {
-          console.log("Updating amount via a backend to backend call to POST charges/:id");
-          // call `POST charges/:id` to modify charge
-          button.update({ success: true });
-     });
-    button.onPaymentSuccessful((data) => console.log("The payment was successful"));
-    button.onPaymentError((data) => console.log("The payment was not successful"));
-    button.onPaymentInReview((data) => console.log("The payment is on fraud review"));
-    button.load();
-</script>
-</html>
-```
 This example shows how to use these functions for **Flypay v2 Wallet**.
 _(Required `meta` fields: - . Optional `meta` fields: -)_
 ### Flypay V2 Full example
@@ -2062,6 +1543,115 @@ src.setStyles({
 });
 ```
+## Configurations for background loading and improved User Load times
+### hold_for_customer_data
+When set to `true`, this flag allows you to load the Click to Pay iframe in the background while collecting customer information. This improves the perceived performance by starting the iframe load process early.
+```javascript
+const clickToPay = new cba.ClickToPay("#checkoutIframe", SERVICE_ID, PUBLIC_KEY, {
+  hold_for_customer_data: true,
+  dpa_config: {
+    dpa_id: DPA_ID,
+    // ... other config
+  }
+});
+```
+### injectCustomerData(customer)
+Once you have collected the customer information, use this method to provide it to the Click to Pay iframe. This will trigger the checkout to continue.
+```javascript
+clickToPay.injectCustomerData({
+  email: "customer@example.com",
+  first_name: "John",
+  last_name: "Doe",
+  phone: "+61400123456"  // Include country code
+});
+```
+### Background Loading Example
+Here's a complete example showing how to implement background loading while collecting customer information:
+```javascript
+// 1. Initialize with hold_for_customer_data
+const clickToPay = new cba.ClickToPay("#checkoutIframe", SERVICE_ID, PUBLIC_KEY, {
+  hold_for_customer_data: true,
+  dpa_config: {
+    dpa_id: DPA_ID,
+    // ... other config
+  }
+});
+// Hide checkout and show form initially
+document.getElementById("checkoutIframe").style.display = 'none';
+document.getElementById("customerForm").style.display = 'block';
+document.getElementById("loader").style.display = 'none';
+// 2. Setup event handlers
+clickToPay.on('iframeLoaded', () => {
+  // Iframe is now loaded
+});
+clickToPay.on('checkoutReady', () => {
+  // Hide loader, show checkout
+  document.getElementById("loader").style.display = 'none';
+  document.getElementById("checkoutIframe").style.display = 'block';
+  clickToPay.showCheckout();
+});
+// 3. Start loading in background
+clickToPay.load();
+// 4. Handle form submission
+document.getElementById("submitButton").addEventListener("click", (e) => {
+  e.preventDefault();
+  const customer = {
+    email: document.getElementById("email").value.trim(),
+    first_name: document.getElementById("firstName").value.trim(),
+    last_name: document.getElementById("lastName").value.trim(),
+    phone: document.getElementById("phone").value.trim()
+  };
+  // Hide form, show loader
+  document.getElementById("customerForm").style.display = "none";
+  document.getElementById("loader").style.display = "flex";
+  try {
+    // Inject customer data to continue checkout
+    clickToPay.injectCustomerData(customer);
+  } catch (error) {
+    // Show form again on error
+    document.getElementById("customerForm").style.display = "block";
+    document.getElementById("loader").style.display = "none";
+    alert("An error occurred. Please try again.");
+  }
+});
+```
+#### HTML Structure
+Here's the required HTML structure for the background loading example:
+```html
+<!-- Click to Pay iframe container -->
+<div id="checkoutIframe"></div>
+<!-- Customer information form -->
+<form id="customerForm">
+  <input type="email" id="email" placeholder="Email" required>
+  <input type="text" id="firstName" placeholder="First Name" required>
+  <input type="text" id="lastName" placeholder="Last Name" required>
+  <input type="tel" id="phone" placeholder="Phone (with country code)" required>
+  <button type="submit" id="submitButton">Continue to Checkout</button>
+</form>
+<!-- Loading indicator -->
+<div id="loader" style="display: none;">
+  Loading...
+</div>
+```
 # Fraud prevention
 The Fraud Prevention module allows you to add security layers to your payment workflows