@paydock/client-sdk 1.11.2-beta → 1.11.4

package/README.md

@@ -4868,161 +4868,593 @@ The final method to beginning, the load process of widget to html
 
 **Kind**: instance method of [<code>VaultDisplayWidget</code>](#VaultDisplayWidget)  
 
-## Classes
+## Wallet Buttons
+You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#wallet-buttons-simple-example)
 
-<dl>
-<dt><a href="#WalletButtons">WalletButtons</a></dt>
-<dd><p>Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay™ and Apple Pay via Stripe, Flypay, Paypal)</p>
-</dd>
-</dl>
+Wallet Buttons allow you to easily integrate different E-Wallets into your checkout.
+Currently supports ApplePay, Google Pay and Apple Pay via Stripe, Flypay checkout and Paypal Smart Buttons Checkout.
 
-## Constants
+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.
 
-<dl>
-<dt><a href="#EVENT">EVENT</a> : <code>object</code></dt>
-<dd><p>List of available event&#39;s name in the wallet button lifecycle</p>
-</dd>
-</dl>
+## Wallet Buttons simple example
 
-## Interfaces
+### Container
 
-<dl>
-<dt><a href="#IWalletMeta">IWalletMeta</a> : <code>object</code></dt>
-<dd><p>Interface of data used by the wallet checkout and payment proccess.</p>
-</dd>
-<dt><a href="#IApplePayShippingOption">IApplePayShippingOption</a> : <code>object</code></dt>
-<dd><p>Interface of Shipping Options for ApplePay</p>
-</dd>
-<dt><a href="#IGooglePayShippingOption">IGooglePayShippingOption</a> : <code>object</code></dt>
-<dd><p>Interface of Shipping Options for GooglePay</p>
-</dd>
-<dt><a href="#IPayPalShippingOption">IPayPalShippingOption</a> : <code>object</code></dt>
-<dd><p>Interface of Shipping Options for PayPal</p>
-</dd>
-</dl>
+```html
+<div id="widget"></div>
+```
 
-<a name="IWalletMeta" id="IWalletMeta"></a>
+You must create a container for the Wallet Buttons. Inside this tag, the button will be initialized.
 
-## IWalletMeta : <code>object</code>
-Interface of data used by the wallet checkout and payment proccess.
+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.
 
-**Kind**: global interface  
+### 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();
+```
 
-| Param | Type | Description |
-| --- | --- | --- |
-| [amount_label] | <code>string</code> | Label shown next to the total amount to be paid. Required for [Stripe, ApplePay, GooglePay]. N/A for [FlyPay, PayPal]. |
-| [country] | <code>string</code> | Country of the user. 2 letter ISO code format. Required for [Stripe, ApplePay, GooglePay]. N/A for [FlyPay, PayPal]. |
-| [pay_later] | <code>string</code> | Used to enable Pay Later feature in PayPal Smart Checkout WalletButton integration when available. Optional for [PayPal]. N/A for other wallets. |
-| [show_billing_address] | <code>boolean</code> | Used to hide/show the billing address on ApplePay and GooglePay popups. Default value is false. Optional for [ApplePay, GooglePay]. N/A for other wallets. |
-| [request_payer_name] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
-| [request_payer_email] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
-| [request_payer_phone] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
-| [request_shipping] | <code>boolean</code> | Used to request or not shipping address in the Wallet checkout, being able to handle amount changes via the `update` event. Optional for [FlyPay, PayPal, ApplePay, GooglePay]. N/A for [Stripe]. |
-| [shipping_options] | [<code>Array.&lt;IApplePayShippingOption&gt;</code>](#IApplePayShippingOption) \| [<code>Array.&lt;IPayPalShippingOption&gt;</code>](#IPayPalShippingOption) | Used to provide available shipping options.(To use shipping_options the request_shipping flag should be true). Optional for [ApplePay]. N/A for the other wallets. |
-| [merchant_name] | <code>string</code> | Merchant Name used for GooglePay integration via MPGS. Required for [GooglePay]. N/A for other wallets. |
-| [raw_data_initialization] | <code>object</code> | Used to provide values to initialize wallet with raw data. Optional for [ApplePay]. N/A for the other wallets. |
-| [style] | <code>object</code> | Used to style PayPal buttons, check possible values at https://developer.paypal.com/docs/business/checkout/reference/style-guide. Also used at ApplePay to select button type. Optional for [PayPal, ApplePay]. N/A for [Stripe, FlyPay]. |
-| [style.button_type] | <code>object</code> | Used to select ApplePay button type (e.g: 'buy','donate', etc), check possible values at https://developer.apple.com/documentation/apple_pay_on_the_web/displaying_apple_pay_buttons_using_css. Optional for [ApplePay]. N/A for other wallets. |
-| [wallets] | <code>array</code> | By default if this is not sent or empty, we will try to show either Apple Pay or Google Pay buttons. This can be limited sending the following array in this field: ['apple','google]. Optional for [Stripe, ApplePay, GooglePay]. N/A for other wallets. |
+```javascript--es2015
+// ES2015 | TypeScript
+import { WalletButtons } from '@paydock/client-sdk';
 
-<a name="IApplePayShippingOption" id="IApplePayShippingOption"></a>
+var button = new WalletButtons(
+    '#widget',
+    token,
+    {
+        amount_label: 'Total',
+        country: 'DE',
+    }
+);
+button.load();
+```
 
-## IApplePayShippingOption : <code>object</code>
-Interface of Shipping Options for ApplePay
+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();
+```
 
-**Kind**: global interface  
+```javascript--es2015
+// ES2015 | TypeScript
+import { WalletButtons } from '@paydock/client-sdk';
 
-| Param | Type | Description |
-| --- | --- | --- |
-| [id] | <code>string</code> | Identifier of the Shipping Option. Required. |
-| [label] | <code>string</code> | Identifier of the Shipping Option. Required. |
-| [amount] | <code>string</code> | Amount of the Shipping Option. Required. |
-| [detail] | <code>string</code> | Details of the Shipping Option. Required. |
-| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
+var button = new WalletButtons(
+    '#widget',
+    token,
+    {}
+);
+button.load();
+```
+### Setting environment
 
-<a name="IGooglePayShippingOption" id="IGooglePayShippingOption"></a>
+Current method can change environment. By default environment = sandbox.
+Bear in mind that you must set an environment before calling `button.load()`.
 
-## IGooglePayShippingOption : <code>object</code>
-Interface of Shipping Options for GooglePay
+```javascript
+button.setEnv('sandbox');
+```
 
-**Kind**: global interface  
+### Full example
 
-| Param | Type | Description |
-| --- | --- | --- |
-| [id] | <code>string</code> | Identifier of the Shipping Option. Required. |
-| [label] | <code>string</code> | Identifier of the Shipping Option. Required. |
-| [detail] | <code>string</code> | Details of the Shipping Option. Optional. |
-| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
+```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://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
+<script>
+        let button = new paydock.WalletButtons(
+            "#widget",
+            token,
+            {
+                amount_label: "Total",
+                country: "DE",
+            }
+        );
+        button.load();
+</script>
+</html>
+```
 
-<a name="IPayPalShippingOption" id="IPayPalShippingOption"></a>
+## Wallet Buttons advanced example
 
-## IPayPalShippingOption : <code>object</code>
-Interface of Shipping Options for PayPal
+### Checking for button availability
 
-**Kind**: global interface  
+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.
 
-| Param | Type | Description |
-| --- | --- | --- |
-| [id] | <code>string</code> | Identifier of the Shipping Option. Required. |
-| [label] | <code>string</code> | Identifier of the Shipping Option. Required. |
-| [amount] | <code>string</code> | Amount of the Shipping Option. Required. |
-| [currency] | <code>string</code> | Currency of the Shipping Option. Required. |
-| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'SHIPPING' or 'PICKUP'. Required. |
+```javascript
+button.onUnavailable(() => console.log("No wallet buttons available"));
+```
 
-<a name="WalletButtons" id="WalletButtons"></a>
+### Forcibly closing the checkout
 
-## WalletButtons
-Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay™ and Apple Pay via Stripe, Flypay, Paypal)
+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.
 
-**Kind**: global class  
+```javascript
+button.close();
+```
 
-* [WalletButtons](#WalletButtons)
-    * [new exports.WalletButtons(selector, chargeToken, object)](#new_WalletButtons_new)
-    * [.load()](#WalletButtons+load)
-    * [.update()](#WalletButtons+update)
-    * [.setEnv(env, [alias])](#WalletButtons+setEnv)
-    * [.close()](#WalletButtons+close)
-    * [.on(eventName, [cb])](#WalletButtons+on) ⇒ <code>Promise.&lt;IEventData&gt;</code> \| <code>void</code>
-    * [.onUnavailable([handler])](#WalletButtons+onUnavailable)
-    * [.onUpdate([handler])](#WalletButtons+onUpdate)
-    * [.onPaymentSuccessful([handler])](#WalletButtons+onPaymentSuccessful)
-    * [.onPaymentInReview([handler])](#WalletButtons+onPaymentInReview)
-    * [.onPaymentError([handler])](#WalletButtons+onPaymentError)
+### Performing actions when shipping info is updated
 
-<a name="new_WalletButtons_new" id="new_WalletButtons_new"></a>
+In Flypay, Paypal and ApplePay via MPGS integrations after each shipping info update the `onUpdate(data)` will be called with the selected shipping address information (plus selected shipping method for Paypal). 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).
 
-### new exports.WalletButtons(selector, chargeToken, object)
+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.
 
-| Param | Type | Description |
-| --- | --- | --- |
-| selector | <code>string</code> | Selector of html element. Container for the WalletButtons. |
-| chargeToken | <code>string</code> | token for the wallet transaction, created with a secure call to `POST charges/wallet`. |
-| object | [<code>IWalletMeta</code>](#IWalletMeta) | data that configures the E-Wallet, which can be shown on checkout page and configures required customer information. |
+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.
 
-**Example**  
-```js
-var button = new WalletButtons('#wallet-buttons', 'charge-token', { amount_label: 'Total', country: 'us' });
+```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 });
+});
 ```
-<a name="WalletButtons+load" id="WalletButtons+load"></a>
 
-### walletButtons.load()
-Initializes the availability checks and inserts the button if possible.
-Otherwise function onUnavailable(handler: VoidFunction) will be called.
+For ApplePay via MPGS integration specifically, you must return the new `amount` and new `shipping_options` If new options are needed based on the updated shipping data. Before the user authorizes the transaction with Touch ID, Face ID, or passcode, you receive redacted address information (address_country, address_city, address_state, address_postcode), this data can be used to recalculate the amount and new shipping options. (https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment/1916097-shippingcontact)
 
-**Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)  
-**Example**  
-```js
-var button = new WalletButtons(
-     '#buttons',
-     token,
-     {
-         amount_label: 'Total',
-         country: 'DE',
-     }
- );
- button.load();
+```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"
+                }
+            ]
+        }
+    });
+});
 ```
-<a name="WalletButtons+update" id="WalletButtons+update"></a>
+
+### 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.
+
+```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`)_
+### 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://app-sandbox.paydock.com/v1/widget.umd.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`, `style`)_
+### 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://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
+<script>
+    let button = new paydock.WalletButtons(
+		"#widget",
+		charge_token,
+		{
+			request_shipping: true,
+			pay_later: true,
+			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"));
+    button.load();
+</script>
+</html>
+```
+
+This example shows how to use these functions for **Flypay Checkout**.
+_(Required `meta` fields: - . Optional `meta` fields: `request_shipping`, `pay_later`, `style`)_
+### 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://app-sandbox.paydock.com/v1/widget.umd.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 **ApplePay via MPGS**:
+_(Required `meta` fields: `amount_label`, `country`. Optional `meta` fields: `raw_data_initialization`, `request_shipping`, `style.button_type`)_
+### 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://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
+<script>
+    let button = new paydock.WalletButtons(
+        "#widget",
+        charge_token,
+        {
+            amount_label: "Total",
+            country: 'DE',
+            request_shipping: true,
+            style: {
+                button_type: 'buy',
+            },
+            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.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:
+
+### 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://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
+<script>
+    let button = new paydock.WalletButtons(
+        "#widget",
+        charge_token,
+        {
+            raw_data_initialization: {
+                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",
+                }
+            },
+            amount_label: "Total",
+            country: 'DE',
+            request_shipping: true,
+            style: {
+                button_type: 'buy',
+            },
+            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.load();
+</script>
+</html>
+```
+## Classes
+
+<dl>
+<dt><a href="#WalletButtons">WalletButtons</a></dt>
+<dd><p>Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay™ and Apple Pay via Stripe, Flypay, Paypal)</p>
+</dd>
+</dl>
+
+## Constants
+
+<dl>
+<dt><a href="#EVENT">EVENT</a> : <code>object</code></dt>
+<dd><p>List of available event&#39;s name in the wallet button lifecycle</p>
+</dd>
+</dl>
+
+## Interfaces
+
+<dl>
+<dt><a href="#IWalletMeta">IWalletMeta</a> : <code>object</code></dt>
+<dd><p>Interface of data used by the wallet checkout and payment proccess.</p>
+</dd>
+<dt><a href="#IApplePayShippingOption">IApplePayShippingOption</a> : <code>object</code></dt>
+<dd><p>Interface of Shipping Options for ApplePay</p>
+</dd>
+<dt><a href="#IGooglePayShippingOption">IGooglePayShippingOption</a> : <code>object</code></dt>
+<dd><p>Interface of Shipping Options for GooglePay</p>
+</dd>
+<dt><a href="#IPayPalShippingOption">IPayPalShippingOption</a> : <code>object</code></dt>
+<dd><p>Interface of Shipping Options for PayPal</p>
+</dd>
+</dl>
+
+<a name="IWalletMeta" id="IWalletMeta"></a>
+
+## IWalletMeta : <code>object</code>
+Interface of data used by the wallet checkout and payment proccess.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [amount_label] | <code>string</code> | Label shown next to the total amount to be paid. Required for [Stripe, ApplePay, GooglePay]. N/A for [FlyPay, PayPal]. |
+| [country] | <code>string</code> | Country of the user. 2 letter ISO code format. Required for [Stripe, ApplePay, GooglePay]. N/A for [FlyPay, PayPal]. |
+| [pay_later] | <code>string</code> | Used to enable Pay Later feature in PayPal Smart Checkout WalletButton integration when available. Optional for [PayPal]. N/A for other wallets. |
+| [show_billing_address] | <code>boolean</code> | Used to hide/show the billing address on ApplePay and GooglePay popups. Default value is false. Optional for [ApplePay, GooglePay]. N/A for other wallets. |
+| [request_payer_name] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
+| [request_payer_email] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
+| [request_payer_phone] | <code>boolean</code> | Used mainly for fraud purposes - recommended set to true. Optional for [Stripe]. N/A for other wallets. |
+| [request_shipping] | <code>boolean</code> | Used to request or not shipping address in the Wallet checkout, being able to handle amount changes via the `update` event. Optional for [FlyPay, PayPal, ApplePay, GooglePay]. N/A for [Stripe]. |
+| [shipping_options] | [<code>Array.&lt;IApplePayShippingOption&gt;</code>](#IApplePayShippingOption) \| [<code>Array.&lt;IPayPalShippingOption&gt;</code>](#IPayPalShippingOption) | Used to provide available shipping options.(To use shipping_options the request_shipping flag should be true). Optional for [ApplePay]. N/A for the other wallets. |
+| [merchant_name] | <code>string</code> | Merchant Name used for GooglePay integration via MPGS. Required for [GooglePay]. N/A for other wallets. |
+| [raw_data_initialization] | <code>object</code> | Used to provide values to initialize wallet with raw data. Optional for [ApplePay]. N/A for the other wallets. |
+| [style] | <code>object</code> | Used to style PayPal buttons, check possible values at https://developer.paypal.com/docs/business/checkout/reference/style-guide. Also used at ApplePay to select button type. Optional for [PayPal, ApplePay]. N/A for [Stripe, FlyPay]. |
+| [style.button_type] | <code>object</code> | Used to select ApplePay button type (e.g: 'buy','donate', etc), check possible values at https://developer.apple.com/documentation/apple_pay_on_the_web/displaying_apple_pay_buttons_using_css. Optional for [ApplePay]. N/A for other wallets. |
+| [wallets] | <code>array</code> | By default if this is not sent or empty, we will try to show either Apple Pay or Google Pay buttons. This can be limited sending the following array in this field: ['apple','google]. Optional for [Stripe, ApplePay, GooglePay]. N/A for other wallets. |
+
+<a name="IApplePayShippingOption" id="IApplePayShippingOption"></a>
+
+## IApplePayShippingOption : <code>object</code>
+Interface of Shipping Options for ApplePay
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [id] | <code>string</code> | Identifier of the Shipping Option. Required. |
+| [label] | <code>string</code> | Identifier of the Shipping Option. Required. |
+| [amount] | <code>string</code> | Amount of the Shipping Option. Required. |
+| [detail] | <code>string</code> | Details of the Shipping Option. Required. |
+| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
+
+<a name="IGooglePayShippingOption" id="IGooglePayShippingOption"></a>
+
+## IGooglePayShippingOption : <code>object</code>
+Interface of Shipping Options for GooglePay
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [id] | <code>string</code> | Identifier of the Shipping Option. Required. |
+| [label] | <code>string</code> | Identifier of the Shipping Option. Required. |
+| [detail] | <code>string</code> | Details of the Shipping Option. Optional. |
+| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'ELECTRONIC', 'GROUND', 'NOT_SHIPPED', 'OVERNIGHT', 'PICKUP', 'PRIORITY', 'SAME_DAY'. Optional. |
+
+<a name="IPayPalShippingOption" id="IPayPalShippingOption"></a>
+
+## IPayPalShippingOption : <code>object</code>
+Interface of Shipping Options for PayPal
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [id] | <code>string</code> | Identifier of the Shipping Option. Required. |
+| [label] | <code>string</code> | Identifier of the Shipping Option. Required. |
+| [amount] | <code>string</code> | Amount of the Shipping Option. Required. |
+| [currency] | <code>string</code> | Currency of the Shipping Option. Required. |
+| [type] | <code>string</code> | Type of the Shipping Option. Values can be 'SHIPPING' or 'PICKUP'. Required. |
+
+<a name="WalletButtons" id="WalletButtons"></a>
+
+## WalletButtons
+Class WalletButtons to work with different E-Wallets within html (currently supports Apple Pay, Google Pay™ and Apple Pay via Stripe, Flypay, Paypal)
+
+**Kind**: global class  
+
+* [WalletButtons](#WalletButtons)
+    * [new exports.WalletButtons(selector, chargeToken, object)](#new_WalletButtons_new)
+    * [.load()](#WalletButtons+load)
+    * [.update()](#WalletButtons+update)
+    * [.setEnv(env, [alias])](#WalletButtons+setEnv)
+    * [.close()](#WalletButtons+close)
+    * [.on(eventName, [cb])](#WalletButtons+on) ⇒ <code>Promise.&lt;IEventData&gt;</code> \| <code>void</code>
+    * [.onUnavailable([handler])](#WalletButtons+onUnavailable)
+    * [.onUpdate([handler])](#WalletButtons+onUpdate)
+    * [.onPaymentSuccessful([handler])](#WalletButtons+onPaymentSuccessful)
+    * [.onPaymentInReview([handler])](#WalletButtons+onPaymentInReview)
+    * [.onPaymentError([handler])](#WalletButtons+onPaymentError)
+
+<a name="new_WalletButtons_new" id="new_WalletButtons_new"></a>
+
+### new exports.WalletButtons(selector, chargeToken, object)
+
+| Param | Type | Description |
+| --- | --- | --- |
+| selector | <code>string</code> | Selector of html element. Container for the WalletButtons. |
+| chargeToken | <code>string</code> | token for the wallet transaction, created with a secure call to `POST charges/wallet`. |
+| object | [<code>IWalletMeta</code>](#IWalletMeta) | data that configures the E-Wallet, which can be shown on checkout page and configures required customer information. |
+
+**Example**  
+```js
+var button = new WalletButtons('#wallet-buttons', 'charge-token', { amount_label: 'Total', country: 'us' });
+```
+<a name="WalletButtons+load" id="WalletButtons+load"></a>
+
+### walletButtons.load()
+Initializes the availability checks and inserts the button if possible.
+Otherwise function onUnavailable(handler: VoidFunction) will be called.
+
+**Kind**: instance method of [<code>WalletButtons</code>](#WalletButtons)  
+**Example**  
+```js
+var button = new WalletButtons(
+     '#buttons',
+     token,
+     {
+         amount_label: 'Total',
+         country: 'DE',
+     }
+ );
+ button.load();
+```
+<a name="WalletButtons+update" id="WalletButtons+update"></a>
 
 ### walletButtons.update()
 Triggers the update process of the wallet, if available.
@@ -5264,85 +5696,124 @@ List of available event's name in the wallet button lifecycle
 | PAYMENT_ERROR | <code>string</code> | <code>&quot;paymentError&quot;</code> | 
 
 
-## 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 and Apple Pay via Stripe, Flypay checkout and Paypal Smart Buttons Checkout.
+## Secure Remote Commerce
+You can find description of all methods and parameters [here](https://www.npmjs.com/package/@paydock/client-sdk#SRC).
 
-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.
+This widget provides you with the ability to easily integrate with SRC providers. Currently Visa SRC is supported.
 
-## Wallet Buttons simple example
+## SRC simple example
 
 ### Container
 
 ```html
-<div id="widget"></div>
+<div id="checkoutButton"></div>
+<div id="checkoutIframe"></div>
 ```
 
-You must create a container for the Wallet Buttons. Inside this tag, the button will be initialized.
+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.
 
-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",
-    }
+var src = new paydock.SRC(
+    "#checkoutButton",
+    "#checkoutIframe",
+    "scheme_service_id",
+    "paydock_public_key_or_access_token",
+    {}, // meta
 );
-button.load();
+src.load();
 ```
 
 ```javascript--es2015
 // ES2015 | TypeScript
-import { WalletButtons } from '@paydock/client-sdk/widget';
 
-var button = new WalletButtons(
-    '#widget',
-    token,
-    {
-        amount_label: 'Total',
-        country: 'DE',
-    }
-);
-button.load();
-```
+import { SRC } from '@paydock/client-sdk';
 
-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,
-    {}
+var src = new SRC(
+    "#checkoutButton",
+    "#checkoutIframe",
+    "scheme_service_id",
+    "paydock_public_key_or_access_token",
+    {}, // meta
 );
-button.load();
+src.load();
 ```
 
-```javascript--es2015
-// ES2015 | TypeScript
-import { WalletButtons } from '@paydock/client-sdk/widget';
+*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.
 
-var button = new WalletButtons(
-    '#widget',
-    token,
-    {}
-);
-button.load();
+### 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="checkoutButton"></div>
+    <div id="checkoutIframe"></div>
+    <script src="https://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
+    <script>
+        var src = new paydock.SRC(
+            "#checkoutButton",
+            "#checkoutIframe",
+            "scheme_service_id",
+            "paydock_public_key_or_access_token",
+            {},
+        );
+        src.load();
+    </script>
+</body>
+</html>
 ```
-### Setting environment
 
-Current method can change environment. By default environment = sandbox.
-Bear in mind that you must set an environment before calling `button.load()`.
+
+## SRC advanced example
+
+### Settings
 
 ```javascript
-button.setEnv('sandbox');
+
+src.setEnv('sandbox'); // set enviroment
+
+src.hideButton(); // hide button
+
+src.showButton(); // show button
+
+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
@@ -5351,350 +5822,404 @@ button.setEnv('sandbox');
 <head>
     <meta charset="UTF-8">
     <title>Title</title>
+    <style>iframe {border: 0;width: 40%;height: 450px;}</style>
 </head>
 <body>
-    <h2>Payment using PayDock Wallet Button!</h2>
-    <div id="widget"></div>
-</body>
-<script src="https://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
-<script>
-        let button = new paydock.WalletButtons(
-            "#widget",
-            token,
-            {
-                amount_label: "Total",
-                country: "DE",
-            }
+    <div id="checkoutButton"></div>
+    <div id="checkoutIframe"></div>
+    <script src="https://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
+    <script>
+        var src = new paydock.SRC(
+            "#checkoutButton",
+            "#checkoutIframe",
+            "scheme_service_id",
+            "paydock_public_key_or_access_token",
+            {},
         );
-        button.load();
-</script>
+
+        src.on('checkoutReady', () => {
+            console.log("Checkout ready to be used");
+        });
+
+        src.on('checkoutCompleted', (token) => {
+            console.log(token);
+        });
+        src.load();
+    </script>
+</body>
 </html>
 ```
 
-## Wallet Buttons advanced example
+## Customization options for address fields
+### Shipping address:
 
-### Checking for button availability
+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.
 
-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.
+```
+var src = new paydock.SRC(
+    "#checkoutButton",
+    "#checkoutIframe",
+    "scheme_service_id",
+    "paydock_public_key_or_access_token",
+    {
+        "dpa_transaction_options": {
+            "dpa_shipping_preference": "ALL"
+        }
+    },
+);
+```
+
+With this the Visa popup requires the shipping address from consumer, and these information will be stored in the Paydock charge.
+
+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:
 
-```javascript
-button.onUnavailable(() => console.log("No wallet buttons available"));
 ```
+POST v1/charges
 
-### Forcibly closing the checkout
+{
+    "amount": "10.00",
+    "currency": "AUD",
+    "token": "token",
+    "customer": {
+        "payment_source": {
+            "gateway_id": "gateway_id"
+        }
+    },
+    "shipping": {
+        "address_line1": "address_line1",
+        "address_line2": "address_line2",
+        "address_line3": "address_line3",
+        "address_city": "address_city",
+        "address_postcode": "address_postcode",
+        "address_state": "address_state",
+        "address_country": "address_country"
+    }
+}
+```
 
-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.
+- Billing address:
 
-```javascript
-button.close();
+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:
+
+```
+var src = new paydock.SRC(
+    "#checkoutButton",
+    "#checkoutIframe",
+    "scheme_service_id",
+    "paydock_public_key_or_access_token",
+    {
+        "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"
+            }
+        }
+    },
+);
 ```
 
-### Performing actions when shipping info is updated
+## Personalization Styling
 
-In Flypay, Paypal and ApplePay via MPGS integrations after each shipping info update the `onUpdate(data)` will be called with the selected shipping address information (plus selected shipping method for Paypal). 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).
+To improve the experience in the use of the widget, it is allowed to send props that customize the UI.
 
-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.
+### Example code
 
-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.
+```
+var src = new paydock.SRC(
+    "#checkoutButton",
+    "#checkoutIframe",
+    "scheme_service_id",
+    "paydock_public_key",
+);
+
+button.setStyles({"primary_color":"#a83232","button_text_color":"#171e9c","font_family":"sans-serif"})
 
-```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 });
-});
 ```
+## Event and Values
 
-For ApplePay via MPGS integration specifically, you must return the new `amount` and new `shipping_options` If new options are needed based on the updated shipping data. Before the user authorizes the transaction with Touch ID, Face ID, or passcode, you receive redacted address information (address_country, address_city, address_state, address_postcode), this data can be used to recalculate the amount and new shipping options. (https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment/1916097-shippingcontact)
+| 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
 
-```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"
-                }
-            ]
-        }
-    });
+## Classes
+
+<dl>
+<dt><a href="#SRC">SRC</a></dt>
+<dd><p>Class SRC include methods for interacting with different secure remote commerce options such as Visa SRC</p>
+</dd>
+</dl>
+
+## Interfaces
+
+<dl>
+<dt><a href="#IVisaSRCMeta">IVisaSRCMeta</a> : <code>object</code></dt>
+<dd><p>Interface of data used for the Visa Checkout.</p>
+</dd>
+</dl>
+
+<a name="IVisaSRCMeta" id="IVisaSRCMeta"></a>
+
+## IVisaSRCMeta : <code>object</code>
+Interface of data used for the Visa Checkout.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [srci_transaction_id] | <code>string</code> | Used to identify the SRC Id. |
+| [dpa_data] | <code>object</code> | Object where the DPA creation data is stored. |
+| [dpa_data.dpa_presentation_name] | <code>string</code> | Name in which the DPA is presented in. |
+| [dpa_data.dpa_uri] | <code>string</code> | Used for indicating the DPA URI. |
+| [dpa_transaction_options] | <code>object</code> | Object that stores options for creating a trasaction with DPA. |
+| [dpa_transaction_options.dpa_locale] | <code>string</code> | DPA’s preferred locale, example en_US. |
+| [dpa_transaction_options.dpa_accepted_billing_countries] | <code>Array</code> | Used to indicate list of accepted billing countries for DPA. |
+| [dpa_transaction_options.dpa_accepted_shipping_countries] | <code>Array</code> | Used to indicate list of accepted shipping countries for DPA. |
+| [dpa_transaction_options.dpa_billing_preference] | <code>string</code> | Used for listing the enumeration for billing preferences for DPA. Options are 'ALL', 'POSTAL_COUNTRY' and 'NONE'. |
+| [dpa_transaction_options.dpa_shipping_preference] | <code>string</code> | Used for listing the enumeration for shipping preferences for DPA. Options are 'ALL', 'POSTAL_COUNTRY' and 'NONE'. |
+| [dpa_transaction_options.consumer_name_requested] | <code>boolean</code> | Used to check if the name of the consumer is needed. |
+| [dpa_transaction_options.consumer_email_address_requested] | <code>boolean</code> | Used to check if the email of the consumer is needed. |
+| [dpa_transaction_options.consumer_phone_number_requested] | <code>boolean</code> | Used to check if the phone number of the consumer is needed. |
+| [dpa_transaction_options.payment_options] | <code>object</code> | Object used to check the payment options that are included. |
+| [dpa_transaction_options.payment_options.dpa_dynamic_data_ttl_minutes] | <code>number</code> | The minimum requested validity period for the transaction credentials. |
+| [dpa_transaction_options.payment_options.dynamic_data_type] | <code>string</code> | Used for listing the enumeration for dynamic data types. Options are 'TAVV' and 'DTVV'. |
+| [dpa_transaction_options.payment_options.dpa_pan_requested] | <code>boolean</code> | Used to check if PAN number was requested. |
+| [dpa_transaction_options.review_action] | <code>string</code> | Used for listing the enumeration of review actions. Options are 'pay' and 'continue'. |
+| [dpa_transaction_options.checkout_description] | <code>string</code> | Used for indicating the description of the checkout. |
+| [dpa_transaction_options.transaction_type] | <code>string</code> | Used for listing the enumeration of the type of the transaction. 'PURCHASE', 'BILL_PAYMENT' and 'MONEY_TRANSFER' |
+| [dpa_transaction_options.order_type] | <code>string</code> | Used for listing the enumeration of the type of the order. Options are 'REAUTHORIZATION', 'RECURRING' and 'INSTALLMENT'. |
+| [dpa_transaction_options.transaction_amount] | <code>object</code> | Object used to describe the details of the transaction. |
+| [dpa_transaction_options.transaction_amount.transaction_amount] | <code>number</code> | Used to indicate the amount of the transaction. |
+| [dpa_transaction_options.transaction_amount.transaction_currency_code] | <code>string</code> | Used to indicate the currency code of the transaction. 3 letter ISO code format. |
+| [dpa_transaction_options.merchant_order_id] | <code>string</code> | Used to indicate the merchants order Id. |
+| [dpa_transaction_options.merchant_category_code] | <code>string</code> | Used to indicate the merchants category code. |
+| [dpa_transaction_options.merchant_country_code] | <code>string</code> | Used to indicate the merchants country code. 2 letter ISO code format. |
+| [customer] | <code>object</code> | Object where the customer data is stored to prefill in the checkout. |
+| [customer.email] | <code>string</code> | Customer email. |
+| [customer.first_name] | <code>string</code> | Customer first name. |
+| [customer.last_name] | <code>string</code> | Customer last name. |
+| [customer.phone] | <code>object</code> | Object where the customer phone is stored. |
+| [customer.phone.country_code] | <code>string</code> | Customer phone country code (example "1" for US). |
+| [customer.phone.phone] | <code>string</code> | Customer phone number. |
+| [customer.payment_source] | <code>object</code> | Object where the customer billing address data is stored. |
+| [customer.payment_source.address_line1] | <code>string</code> | Customer billing address line 1. |
+| [customer.payment_source.address_line2] | <code>string</code> | Customer billing address line 2. |
+| [customer.payment_source.address_city] | <code>string</code> | Customer billing address city. |
+| [customer.payment_source.address_postcode] | <code>string</code> | Customer billing address postcode. |
+| [customer.payment_source.address_state] | <code>string</code> | Customer billing address state code (if applicable for the country, example "FL" for Florida). |
+| [customer.payment_source.address_country] | <code>string</code> | Customer billing address country code (example "US"). |
+
+<a name="SRC" id="SRC"></a>
+
+## SRC
+Class SRC include methods for interacting with different secure remote commerce options such as Visa SRC
+
+**Kind**: global class  
+
+* [SRC](#SRC)
+    * [new exports.SRC(button_selector, iframe_selector, service_id, public_key_or_access_token, meta)](#new_SRC_new)
+    * [.setStyles(fields)](#SRC+setStyles)
+    * [.load()](#SRC+load)
+    * [.setEnv(env, [alias])](#SRC+setEnv)
+    * [.getEnv()](#SRC+getEnv)
+    * [.on(eventName, [cb])](#SRC+on) ⇒ <code>Promise.&lt;any&gt;</code> \| <code>void</code>
+    * [.hideButton([saveSize])](#SRC+hideButton)
+    * [.showButton()](#SRC+showButton)
+    * [.hideCheckout([saveSize])](#SRC+hideCheckout)
+    * [.showCheckout()](#SRC+showCheckout)
+    * [.reload()](#SRC+reload)
+    * [.useAutoResize()](#SRC+useAutoResize)
+
+<a name="new_SRC_new" id="new_SRC_new"></a>
+
+### new exports.SRC(button_selector, iframe_selector, service_id, public_key_or_access_token, meta)
+
+| Param | Type | Description |
+| --- | --- | --- |
+| button_selector | <code>string</code> | Selector of html element. Container for SRC checkout button. |
+| iframe_selector | <code>string</code> | Selector of html element. Container for SRC checkout iFrame. |
+| service_id | <code>string</code> | Card Scheme Service ID |
+| public_key_or_access_token | <code>string</code> | Paydock public key or Access Token |
+| meta | [<code>IVisaSRCMeta</code>](#IVisaSRCMeta) | Data that configures the SRC checkout |
+
+**Example**  
+```js
+var SRC = new SRC('#checkoutButton', '#checkoutIframe', 'service_id', 'public_key', {});
+```
+<a name="SRC+setStyles" id="SRC+setStyles"></a>
+
+### srC.setStyles(fields)
+Object contain styles for widget - call before `.load()`.
+
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| fields | <code>IStyles</code> | name of styles which can be shown in widget [STYLE](STYLE) |
+
+**Example**  
+```js
+widget.setStyles({
+      button_text_color: '#32a852',
+      primary_color: '#32a852',
+      font_family: 'sans-serif',
+      card_schemes: ['visa']
+  });
+```
+<a name="SRC+load" id="SRC+load"></a>
+
+### srC.load()
+The final method after configuring the SRC to start the load process of SRC checkout
+
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+<a name="SRC+setEnv" id="SRC+setEnv"></a>
+
+### srC.setEnv(env, [alias])
+Current method can change environment. By default environment = sandbox.
+Also we can change domain alias for this environment. By default domain_alias = paydock.com
+
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| env | <code>string</code> | sandbox, production |
+| [alias] | <code>string</code> | Own domain alias |
+
+**Example**  
+```js
+SRC.setEnv('production');
+```
+<a name="SRC+getEnv" id="SRC+getEnv"></a>
+
+### srC.getEnv()
+Method to read the current environment
+
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Example**  
+```js
+SRC.getEnv();
+```
+<a name="SRC+on" id="SRC+on"></a>
+
+### srC.on(eventName, [cb]) ⇒ <code>Promise.&lt;any&gt;</code> \| <code>void</code>
+Listen to events of SRC
+
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| eventName | <code>string</code> | Available event names [EVENT](#EVENT) |
+| [cb] | <code>listener</code> |  |
+
+**Example**  
+```js
+SRC.on('checkoutCompleted', function (token) {
+     console.log(token);
+});
+// or
+SRC.on('checkoutCompleted').then(function (token) {
+     console.log(token);
 });
 ```
+<a name="SRC+hideButton" id="SRC+hideButton"></a>
 
-### Performing actions after the payment is completed
+### srC.hideButton([saveSize])
+Using this method you can hide button
+
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size (if applicable) |
+
+**Example**  
+```js
+SRC.hideButton();
+```
+<a name="SRC+showButton" id="SRC+showButton"></a>
+
+### srC.showButton()
+Using this method you can show the SRC button after using hideButton method
+
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Example**  
+```js
+SRC.showButton();
+```
+<a name="SRC+hideCheckout" id="SRC+hideCheckout"></a>
+
+### srC.hideCheckout([saveSize])
+Using this method you can hide checkout after load and button click
 
-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.
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
 
-```javascript
-button.onPaymentSuccessful((data) => console.log("The payment was successful"));
-```
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| [saveSize] | <code>boolean</code> | <code>false</code> | using this param you can save iframe's size (if applicable) |
 
-```javascript
-button.onPaymentInReview((data) => console.log("The payment is on fraud review"));
+**Example**  
+```js
+SRC.hideCheckout();
 ```
+<a name="SRC+showCheckout" id="SRC+showCheckout"></a>
 
-```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.
+### srC.showCheckout()
+Using this method you can show checkout after using hideCheckout method
 
-```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"));
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Example**  
+```js
+SRC.showCheckout()
 ```
+<a name="SRC+reload" id="SRC+reload"></a>
 
-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`)_
-### Full example
+### srC.reload()
+Using this method you can reload the whole checkout
 
-```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://app-sandbox.paydock.com/v1/widget.umd.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>
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Example**  
+```js
+SRC.reload()
 ```
+<a name="SRC+useAutoResize" id="SRC+useAutoResize"></a>
 
-This example shows how to use these functions for **Paypal Smart Checkout Buttons**:
-_(Required `meta` fields: - . Optional `meta` fields: `request_shipping`, `pay_later`, `style`)_
-### 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://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
-<script>
-    let button = new paydock.WalletButtons(
-		"#widget",
-		charge_token,
-		{
-			request_shipping: true,
-			pay_later: true,
-			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"));
-    button.load();
-</script>
-</html>
-```
+### srC.useAutoResize()
+Use this method for resize checkout iFrame according to content height, if applicable
 
-This example shows how to use these functions for **Flypay Checkout**.
-_(Required `meta` fields: - . Optional `meta` fields: `request_shipping`, `pay_later`, `style`)_
-### 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://app-sandbox.paydock.com/v1/widget.umd.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>
+**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Example**  
+```js
+SRC.useAutoResize();
 ```
+<a name="EVENT" id="EVENT"></a>
 
-This example shows how to use these functions for **ApplePay via MPGS**:
-_(Required `meta` fields: `amount_label`, `country`. Optional `meta` fields: `raw_data_initialization`, `request_shipping`, `style.button_type`)_
-### Full example
+## EVENT : <code>enum</code>
+List of available event's name in the SRC checkout lifecycle
 
-```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://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
-<script>
-    let button = new paydock.WalletButtons(
-        "#widget",
-        charge_token,
-        {
-            amount_label: "Total",
-            country: 'DE',
-            request_shipping: true,
-            style: {
-                button_type: 'buy',
-            },
-            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.load();
-</script>
-</html>
-```
+**Kind**: global enum  
 
-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:
+| Param | Type | Default |
+| --- | --- | --- |
+| CHECKOUT_BUTTON_LOADED | <code>string</code> | <code>&quot;checkoutButtonLoaded&quot;</code> | 
+| CHECKOUT_BUTTON_CLICKED | <code>string</code> | <code>&quot;checkoutButtonClicked&quot;</code> | 
+| IFRAME_LOADED | <code>string</code> | <code>&quot;iframeLoaded&quot;</code> | 
+| CHECKOUT_READY | <code>string</code> | <code>&quot;checkoutReady&quot;</code> | 
+| CHECKOUT_COMPLETED | <code>string</code> | <code>&quot;checkoutCompleted&quot;</code> | 
+| CHECKOUT_ERROR | <code>string</code> | <code>&quot;checkoutError&quot;</code> | 
 
-### 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://app-sandbox.paydock.com/v1/widget.umd.js" ></script>
-<script>
-    let button = new paydock.WalletButtons(
-        "#widget",
-        charge_token,
-        {
-            raw_data_initialization: {
-                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",
-                }
-            },
-            amount_label: "Total",
-            country: 'DE',
-            request_shipping: true,
-            style: {
-                button_type: 'buy',
-            },
-            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.load();
-</script>
-</html>
-```
 ## License
 Copyright (c) 2017 paydock