npm - @paydock/client-sdk - Versions diffs - 0.0.3 → 0.1.2-beta - Mend

@paydock/client-sdk 0.0.3 → 0.1.2-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (531) hide show

package/docs/wallet-buttons-examples.md ADDED Viewed

@@ -0,0 +1,638 @@
+## 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.
+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.
+## Wallet Buttons simple example
+### Container
+```html
+<div id="widget"></div>
+```
+You must create a container for the Wallet Buttons. Inside this tag, the button will be initialized.
+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
+let button = new paydock.WalletButtons(
+    "#widget",
+    token,
+    {
+        country: "AU",
+    }
+);
+button.load();
+```
+```javascript
+// ES2015 | TypeScript
+import { WalletButtons } from '@paydock/client-sdk';
+var button = new WalletButtons(
+    '#widget',
+    token,
+    {
+        country: 'AU',
+    }
+);
+button.load();
+```
+For Flypay v2 wallet, the client_id is required:
+```javascript
+let button = new paydock.WalletButtons(
+    "#widget",
+    token,
+    {
+        client_id: "client_id",
+    }
+);
+button.load();
+```
+```javascript
+// ES2015 | TypeScript
+import { WalletButtons } from '@paydock/client-sdk';
+var button = new WalletButtons(
+    '#widget',
+    token,
+    {
+        client_id: "client_id",
+    }
+);
+button.load();
+```
+### Setting environment
+Current method can change environment. By default environment = sandbox.
+Bear in mind that you must set an environment before calling `button.load()`.
+```javascript
+button.setEnv('sandbox');
+```
+### 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",
+            token,
+            {
+                amount_label: "Total",
+                country: "DE",
+            }
+        );
+        button.load();
+</script>
+</html>
+```
+## Wallet Buttons advanced example
+### Checking for button availability
+If the customer's browser is not supported, or the customer does not have any card added to their Google Pay or Apple Pay wallets, the button will not load. In this case the callback onUnavailable() will be called. You can define the behavior of this function before loading the button.
+```javascript
+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.
+```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).
+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.
+After analyzing the new shipping information, and making the post with the updated charge and shipping amounts if necessary, the `button.update({ success: true/false })` wallet button method needs to be called to resume the interactions with the customer. Not calling this will result in unexpected behavior.
+```javascript
+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 });
+});
+```
+For ApplePay via MPGS and GooglePay via MPGS integrations, you can also return a new `amount` and new `shipping_options` in case new options are needed based on the updated shipping data. Before the user authorizes the transaction, you receive redacted address information (address_country, address_city, address_state, address_postcode), and this data can be used to recalculate the new amount and new shipping options.
+```javascript
+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,
+        body: {
+            amount: 15,
+            shipping_options: [
+                {
+                    id: "NEW-FreeShip",
+                    label: "NEW - Free Shipping",
+                    detail: "Arrives in 3 to 5 days",
+                    amount: "0.00"
+                },
+                {
+                    id: "NEW-FastShip",
+                    label: "NEW - Fast Shipping",
+                    detail: "Arrives in less than 1 day",
+                    amount: "10.00"
+                }
+            ]
+        }
+    });
+});
+```
+### Performing actions after the payment is completed
+After the payment is completed, the onPaymentSuccessful(data) will be called if the payment was successful. If the payment was not successful, the function onPaymentError(data) will be called. If fraud check is active for the gateway, a fraud body was sent in the wallet charge initialize call and the fraud service left the charge in review, then the onPaymentInReview(data) will be called.
+All three callbacks return relevant data according to each one of the scenarios.
+>*Note that these callbacks will not be triggered for the Afterpay wallet when Redirect mode is used, that is when the charge is initialized with the success_url and error_url parameters, since the payment completion is done through the Redirect method, and therefore this SDK will not be loaded once the payment is completed at checkout.*
+```javascript
+button.onPaymentSuccessful((data) => console.log("The payment was successful"));
+```
+```javascript
+button.onPaymentInReview((data) => console.log("The payment is on fraud review"));
+```
+```javascript
+button.onPaymentError((data) => console.log("The payment was not successful"));
+```
+### Events
+The above events can be used in a more generic way via de `on` function, and making use
+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.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
+```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,
+            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 });
+    });
+    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>
+```
+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
+```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,
+		{
+            access_token: 'TOKEN',
+            refresh_token: 'TOKEN',
+            client_id: 'CLIENT_ID',
+        },
+	);
+    button.setEnv('sandbox');
+    button.onUnavailable((data) => 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.onAuthTokensChanged((data) => console.log('Authentication tokens changed'));
+    button.load();
+</script>
+</html>
+```
+This example shows how to use these functions for **ApplePay via MPGS** and **GooglePay via MPGS**:
+_(Required `meta` fields: `amount_label`, `country`. Optional `meta` fields: `raw_data_initialization`, `request_shipping`, `style.button_type`, `style.button_style`)_
+### ApplePay and GooglePay via MPGS 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',
+            request_shipping: true,
+            show_billing_address: true,
+            style: {
+                google: {
+                    button_type: 'buy',
+                    button_size_mode: 'static',
+                    button_color: 'white',
+                },
+                apple: {
+                    button_type: 'buy',
+                    button_style: 'black',
+                },
+            },
+            shipping_options: [
+                {
+                    id: "FreeShip",
+                    label: "Free Shipping",
+                    detail: "Arrives in 5 to 7 days",
+                    amount: "0.00"
+                },
+                {
+                    id: "FastShip",
+                    label: "Fast Shipping",
+                    detail: "Arrives in 1 day",
+                    amount: "10.00"
+                }
+            ]
+        }
+    );
+    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.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
+        button.update({
+            success: true,
+            body: {
+                amount: 15,
+                shipping_options: [
+                    {
+                        id: "NEW-FreeShip",
+                        label: "NEW - Free Shipping",
+                        detail: "Arrives in 3 to 5 days",
+                        amount: "0.00"
+                    },
+                    {
+                        id: "NEW-FastShip",
+                        label: "NEW - Fast Shipping",
+                        detail: "Arrives in less than 1 day",
+                        amount: "10.00"
+                    }
+                ]
+            }
+        });
+    });
+    button.load();
+</script>
+</html>
+```
+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
+<!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,
+        {
+            raw_data_initialization: {
+                apple: {
+                    countryCode: "AU",
+                    currencyCode: "AUD",
+                    merchantCapabilities: ["supports3DS","supportsCredit","supportsDebit"],
+                    supportedNetworks: ["visa","masterCard","amex","discover"],
+                    requiredBillingContactFields: ["name","postalAddress"],
+                    requiredShippingContactFields:["postalAddress","name","phone","email" ],
+                    total: {
+                        label: "Total",
+                        amount: "10",
+                        type: "final",
+                    }
+                },
+                google: {
+                    type: "CARD",
+                    parameters: {
+                        allowedAuthMethods: ["PAN_ONLY", "CRYPTOGRAM_3DS"],
+                        allowedCardNetworks: [
+                            "AMEX",
+                            "DISCOVER",
+                            "INTERAC",
+                            "JCB",
+                            "MASTERCARD",
+                            "VISA",
+                        ],
+                        billingAddressRequired: true,
+                    },
+                },
+            },
+            amount_label: "Total",
+            country: 'DE',
+            request_shipping: true,
+            show_billing_address: true,
+            style: {
+                google: {
+                    button_type: 'buy',
+                    button_size_mode: 'static',
+                    button_color: 'white',
+                },
+                apple: {
+                    button_type: 'buy',
+                    button_style: 'black',
+                },
+            },
+            shipping_options: [
+                {
+                    id: "FreeShip",
+                    label: "Free Shipping",
+                    detail: "Arrives in 5 to 7 days",
+                    amount: "0.00"
+                },
+                {
+                    id: "FastShip",
+                    label: "Fast Shipping",
+                    detail: "Arrives in 1 day",
+                    amount: "10.00"
+                }
+            ]
+        }
+    );
+    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.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,
+            body: {
+                amount: 15,
+                shipping_options: [
+                    {
+                        id: "NEW-FreeShip",
+                        label: "NEW - Free Shipping",
+                        detail: "Arrives in 3 to 5 days",
+                        amount: "0.00"
+                    },
+                    {
+                        id: "NEW-FastShip",
+                        label: "NEW - Fast Shipping",
+                        detail: "Arrives in less than 1 day",
+                        amount: "10.00"
+                    }
+                ]
+            }
+        });
+    });
+    button.load();
+</script>
+</html>
+```