@paydock/client-sdk 1.104.1-beta → 1.104.6-beta

package/slate.md

@@ -31,10 +31,9 @@ we exemplify how to import each format.
 
 
 For browser environments, you can import the Client SDK directly from our CDN to
-your project's HTML. To accomplish this being by including the Client SDK
-in your page using one and only of the two script tags below. After this step
-you will be able to access the Client SDK features via the global
-variable `paydock`.
+your project's HTML. To accomplish this, include the Client SDK in your page
+using one and only of the two script tags below. After this step you will be
+able to access the Client SDK features via the global variable `paydock`.
 
 For production we recommend using the compressed version (`.min.js`) since
 it will result in faster loading times for your end users.
@@ -1207,6 +1206,14 @@ In some situations you may want to forcibly close the checkout so that your user
 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.
+
+```javascript
+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).
@@ -1334,30 +1341,51 @@ _(Required `meta` fields: - . Optional `meta` fields: `request_shipping`, `pay_l
 <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,
-               pay_later: true,
-               standalone: false,
-               style: {
-                    layout: 'horizontal',
-                    color: 'blue',
-                    shape: 'rect',
-                    label: 'paypal',
-               },
-          }
-     );
+        "#widget",
+        charge_token,
+        {
+            request_shipping: true,
+            pay_later: true,
+            standalone: false,
+            style: {
+                layout: 'horizontal',
+                color: 'blue',
+                shape: 'rect',
+                label: 'paypal',
+            },
+        }
+    );
     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 });
-     });
+        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"));
+
+    // Example 1: Asynchronous onClick handler
+    const asyncLogic = async () => {
+        // Perform asynchronous logic. Expectation is that a Promise is returned and attached to response via `attachResult`,
+        // and resolve or reject of it will dictate how wallet behaves.
+    }
+
+    button.onClick(({ data: { attachResult } }) => {
+        // Promise is attached to the result. On Paypal, when promise is resolved, the user Journey will continue.
+        // If no promise is attached then the Paypal journey will not depend on the promise being resolved or rejected
+        attachResult(asyncLogic());
+    });
+
+    // Example 2: Synchronous onClick handler
+    // button.onClick(({ data: { attachResult } }) => {
+    //     // Perform synchronous logic
+    //     console.log("Synchronous onClick: Button clicked");
+    //     // Optionally return a boolean flag to halt the operation
+    //     attachResult(false);
+    // });
+
     button.load();
 </script>
 </html>
@@ -1491,6 +1519,7 @@ _(Required `meta` fields: `amount_label`, `country`. Optional `meta` fields: `ra
     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.onClick(() => console.log("On WalletButton Click"));
     button.onUpdate((data) => {
         console.log("Updating amount via a backend to backend call to POST charges/:id");
         // call `POST charges/:id` to modify charge
@@ -1523,7 +1552,6 @@ _(Required `meta` fields: `amount_label`, `country`. Optional `meta` fields: `ra
 Also, for **ApplePay via MPGS** you can initialize the `ApplePayPaymentRequest` with your own values instead of using the default ones. Below you can see an example on how to initialize the `ApplePayPaymentRequest` with the `raw_data_initialization` meta field.
 
 Similarly, for **GooglePay via MPGS** you can initialize the `PaymentMethodSpecification` with your own values instead of using the default ones. Below you can see an example on how to initialize the `PaymentMethodSpecification` with the `raw_data_initialization` meta field.
-
 ### ApplePay and GooglePay via MPGS Raw data initialization example
 
 ```html
@@ -1636,29 +1664,33 @@ Similarly, for **GooglePay via MPGS** you can initialize the `PaymentMethodSpeci
 </html>
 ```
 
-## Secure Remote Commerce
-You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#SRC).
+# Secure Remote Commerce
 
-This widget provides you with the ability to easily integrate with SRC providers. Currently Visa SRC is supported.
+## Overview
+
+Integrate with Mastercard SRC using Paydock's Mastercard SRC widget.
+For a full description of the methods and parameters, reference the [README file](https://www.npmjs.com/package/@paydock/client-sdk#SRC).
 
 ## SRC simple example
 
-### Container
+The following section provides an example use case and integration for the widget.
+
+### Create a Container
+
+To integrate the SRC checkout iFrame, create a container in your HTML code. This container serves as the placeholder for the iFrame.
 
 ```html
-<div id="checkoutButton"></div>
 <div id="checkoutIframe"></div>
 ```
 
-You must create a container for the initial checkout button, and a different one for the checkout iFrame. Inside the first tag the button will be initialized, and inside the second one the iFrame will be loaded once the button is clicked.
+### Initialize the Widget
 
+Use the following code to initialize your widget:
 
-### Initialization
 ```javascript
-var src = new paydock.SRC(
-    "#checkoutButton",
+var src = new paydock.MastercardSRCClickToPay(
     "#checkoutIframe",
-    "scheme_service_id",
+    "service_id",
     "paydock_public_key_or_access_token",
     {}, // meta
 );
@@ -1667,23 +1699,22 @@ src.load();
 
 ```javascript
 // ES2015 | TypeScript
-
-import { SRC } from '@paydock/client-sdk';
-
-var src = new SRC(
-    "#checkoutButton",
+import { MastercardSRCClickToPay } from '@paydock/client-sdk';
+var src = new MastercardSRCClickToPay(
     "#checkoutIframe",
-    "scheme_service_id",
+    "service_id",
     "paydock_public_key_or_access_token",
     {}, // meta
 );
 src.load();
 ```
 
-*NOTE:* it's highly recommended to use a Paydock Access Token instead of the public key for security reasons. When creating it, you will need to enable the `Secure Remote Commerce` and add a whiteliste for the domain of your checkout screen.
+*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.
 
 ### Full example
 
+A full example of the container and the initialized widget is as follows:
+
 ```html
 <!DOCTYPE html>
 <html lang="en">
@@ -1693,14 +1724,12 @@ src.load();
     <style>iframe {border: 0;width: 40%;height: 300px;}</style>
 </head>
 <body>
-    <div id="checkoutButton"></div>
     <div id="checkoutIframe"></div>
     <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
     <script>
-        var src = new paydock.SRC(
-            "#checkoutButton",
+        var src = new paydock.MastercardSRCClickToPay(
             "#checkoutIframe",
-            "scheme_service_id",
+            "service_id",
             "paydock_public_key_or_access_token",
             {},
         );
@@ -1710,50 +1739,30 @@ src.load();
 </html>
 ```
 
+## Customize your SRC Checkout
 
-## SRC advanced example
+The following is an advanced example that includes customization. You can use these methods to enhance your checkout experience.
 
 ### Settings
 
 ```javascript
-
-src.setEnv('sandbox'); // set enviroment
-
-src.hideButton(); // hide button
-
-src.showButton(); // show button
-
+src.setEnv('sandbox'); // set environment
 src.hideCheckout(); // hide checkout iframe
-
 src.showCheckout(); // show checkout iframe
-
-src.on('checkoutButtonLoaded', () => {
-    console.log("Button loaded");
-});
-
-src.on('checkoutButtonClicked', () => {
-    console.log("Button clicked");
-});
-
 src.on('iframeLoaded', () => {
     console.log("Initial iframe loaded");
 });
-
 src.on('checkoutReady', () => {
     console.log("Checkout ready to be used");
 });
-
 src.on('checkoutCompleted', (token) => {
     console.log(token);
 });
-
 src.on('checkoutError', (error) => {
     console.log(error);
 });
 ```
 
-Here you can see how you can use this methods to customize your checkout experience
-
 ### Full example
 
 ```html
@@ -1765,64 +1774,73 @@ Here you can see how you can use this methods to customize your checkout experie
     <style>iframe {border: 0;width: 40%;height: 450px;}</style>
 </head>
 <body>
-    <div id="checkoutButton"></div>
     <div id="checkoutIframe"></div>
     <script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
     <script>
-        var src = new paydock.SRC(
-            "#checkoutButton",
+        var src = new paydock.MastercardSRCClickToPay(
             "#checkoutIframe",
-            "scheme_service_id",
+            "service_id",
             "paydock_public_key_or_access_token",
             {},
         );
-
+        src.on('iframeLoaded', () => {
+            console.log("Initial iframe loaded");
+        });
         src.on('checkoutReady', () => {
             console.log("Checkout ready to be used");
         });
-
         src.on('checkoutCompleted', (token) => {
             console.log(token);
         });
+        src.on('checkoutError', (error) => {
+            console.log(error);
+        });
         src.load();
     </script>
 </body>
 </html>
 ```
 
-## Customization options for address fields
-### Shipping address:
+## Customize your billing address fields
 
-To customize shipping address experience we use a flag that manages how VisaSRC requires or not shipping address to the customer. Options are NONE (default option), POSTAL_COUNTRY or ALL.
+To customize your billing address experience, Paydock uses a flag that manages whether a customer's billing address is mandatory.
+The options for this customization are NONE (default option), and POSTAL_COUNTRY or FULL.
 
 ```
-var src = new paydock.SRC(
-    "#checkoutButton",
+var src = new paydock.MastercardSRCClickToPay(
     "#checkoutIframe",
-    "scheme_service_id",
+    "service_id",
     "paydock_public_key_or_access_token",
     {
         "dpa_transaction_options": {
-            "dpa_shipping_preference": "ALL"
+            "dpa_billing_preference": "FULL"
         }
     },
 );
 ```
 
-With this the Visa popup requires the shipping address from consumer, and these information will be stored in the Paydock charge.
+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.
+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:
 
-Another option is at time of creating the charge. Say that you have a different way of collecting the shipping address (outside Paydock checkout), you can then disable the shipping address on our SRC widget and send it when creating the charge creation after getting the One Time Token out of the SRC widget:
+1. Disable the billing address in Paydock's SRC widget.
+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.
+3. Send the billing address when creating the charge.
 
 ```
 POST v1/charges
-
 {
     "amount": "10.00",
     "currency": "AUD",
-    "token": "token",
+    "token": "one_time_token",
     "customer": {
         "payment_source": {
-            "gateway_id": "gateway_id"
+            "gateway_id": "gateway_id",
+            "address_line1": "address_line1",
+            "address_line2": "address_line2",
+            "address_city": "address_city",
+            "address_postcode": "address_postcode",
+            "address_state": "address_state",
+            "address_country": "address_country"
         }
     },
     "shipping": {
@@ -1837,60 +1855,44 @@ POST v1/charges
 }
 ```
 
-- Billing address:
+## How to customize accepted cards
 
-Billing address fields are always present on the checkout and required when adding a new credit card (or for new consumer checkout). You can send billing fields on the meta data to pre-fill these fields inside the customer object:
+You can send a flag `unaccepted_card_type` to block the usage of a specific card type. The available options are 'DEBIT' and 'CREDIT'.
+
+### Example code
+
+The following example demonstrates how to block the card:
 
 ```
-var src = new paydock.SRC(
-    "#checkoutButton",
+var src = new paydock.MastercardSRCClickToPay(
     "#checkoutIframe",
-    "scheme_service_id",
-    "paydock_public_key_or_access_token",
+    "service_id",
+    "paydock_public_key",
     {
-        "customer": {
-            "email": "test@email.com",
-            "first_name": "Name",
-            "last_name": "Surname",
-            "phone": {
-                "country_code": "1",
-                "phone": "2124567890"
-            },
-            "payment_source": {
-                "address_line1": "Line 1",
-                "address_line2": "Line 2",
-                "address_city": "Miami",
-                "address_postcode": "33126",
-                "address_state": "FL",
-                "address_country": "US"
-            }
-        }
+        unaccepted_card_type: 'DEBIT'
     },
 );
 ```
 
-## Personalization Styling
+## Personalize the Style
 
-To improve the experience in the use of the widget, it is allowed to send props that customize the UI.
+Customize the look and feel of your UI. The following example demonstrates changes in the styling of the buttons.
 
 ### Example code
 
 ```
-var src = new paydock.SRC(
-    "#checkoutButton",
+var src = new paydock.MastercardSRCClickToPay(
     "#checkoutIframe",
-    "scheme_service_id",
+    "service_id",
     "paydock_public_key",
+    {},
 );
-
-button.setStyles({"primary_color":"#a83232","button_text_color":"#171e9c","font_family":"sans-serif"})
-
+src.setStyles({
+    enable_src_popup: true,
+    primary_button_color: 'red',
+    secondary_button_color: 'red',
+    primary_button_text_color: 'red',
+    secondary_button_text_color: 'red',
+    font_family: 'Arial',
+});
 ```
-## Event and Values
-
-| Event Value         | Type                | Description                                                    |
-| ------------------- | ------------------- | -------------------------------------------------------------- |
-| primary_color  | <code>string</code> | HEX color for the principal buttons, example : #32a852 |
-| button_text_color    | <code>string</code> | HEX color for the text of the buttons, example : #32a852|
-| font_family    | <code>string</code> | Look more [mozilla.org/color](https://developer.mozilla.org/en-US/docs/Web/CSS/font-family)|
-| card_schemes    | <code>[string] - array of string</code> | Possible values "visa", "mastercard", "amex" and "discover" - Default show all logos

package/bundles/types/secure-remote-commerce/providers/visa-src/helper.d.ts

@@ -1,8 +0,0 @@
-export declare const CARD_SCHEME: {
-    VISA: string;
-    MASTERCARD: string;
-    AMEX: string;
-    DISCOVER: string;
-};
-export declare const GenerateCardSchemesLogo: (card_scheme: string[], chevron?: boolean) => string;
-//# sourceMappingURL=helper.d.ts.map

package/bundles/types/secure-remote-commerce/providers/visa-src/helper.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"helper.d.ts","sourceRoot":"","sources":["../../../../src/secure-remote-commerce/providers/visa-src/helper.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,WAAW;;;;;CAKvB,CAAC;AAgBF,eAAO,MAAM,uBAAuB,gBAAiB,MAAM,EAAE,YAAW,OAAO,KAAW,MAsBzF,CAAC"}

package/bundles/types/secure-remote-commerce/providers/visa-src/index.d.ts

@@ -1,2 +0,0 @@
-export { VisaSRC } from './visa-src';
-//# sourceMappingURL=index.d.ts.map

package/bundles/types/secure-remote-commerce/providers/visa-src/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/secure-remote-commerce/providers/visa-src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC"}

package/bundles/types/secure-remote-commerce/providers/visa-src/visa-src.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"visa-src.d.ts","sourceRoot":"","sources":["../../../../src/secure-remote-commerce/providers/visa-src/visa-src.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAY,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAc,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAS,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAIvD,qBAAa,OAAQ,YAAW,WAAW;IAO+D,SAAS,CAAC,IAAI,EAAE,YAAY;IAAE,SAAS,CAAC,YAAY,EAAE,YAAY;IAAE,SAAS,CAAC,UAAU;IAN9L,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC;IACrB,SAAS,CAAC,eAAe,EAAE,SAAS,CAAC;IACrC,SAAS,CAAC,eAAe,EAAE,SAAS,CAAC;IACrC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,WAAW,EAAE,WAAW,CAAC;gBAEvB,eAAe,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAY,IAAI,EAAE,YAAY,EAAY,YAAY,EAAE,YAAY,EAAY,UAAU,KAAA,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAwB1N,OAAO,CAAC,iBAAiB;IAmBlB,IAAI,IAAI,IAAI;IAyCZ,MAAM,IAAI,MAAM;IAIhB,UAAU,CAAC,SAAS,EAAE,OAAO;IAK7B,UAAU;IAKV,YAAY,CAAC,QAAQ,EAAE,OAAO;IAK9B,YAAY;IAKZ,MAAM;IAKN,aAAa,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI;CAa9C"}

package/bundles/types/secure-remote-commerce/providers/visa-src/visa-src.styles.d.ts

@@ -1,9 +0,0 @@
-export declare class VisaSRCStyles {
-    static buttonContainerStyles: string;
-    static buttonStyles: string;
-    static footerContainerStyles: string;
-    static footerTextStyles: string;
-    static verticalLineStyle: string;
-    static clickToPayAllCardsStyle: string;
-}
-//# sourceMappingURL=visa-src.styles.d.ts.map

package/bundles/types/secure-remote-commerce/providers/visa-src/visa-src.styles.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"visa-src.styles.d.ts","sourceRoot":"","sources":["../../../../src/secure-remote-commerce/providers/visa-src/visa-src.styles.ts"],"names":[],"mappings":"AAAA,qBAAa,aAAa;IACtB,OAAc,qBAAqB,SAA0F;IAE7H,OAAc,YAAY,SAA8P;IAExR,OAAc,qBAAqB,SAAuE;IAE1G,OAAc,gBAAgB,SAAwD;IAEtF,OAAc,iBAAiB,SAAqF;IAEpH,OAAc,uBAAuB,SAA+E;CACvH"}