@paydock/client-sdk 1.104.3-beta → 1.104.7-beta

package/docs/secure-remote-commerce.md

@@ -1,140 +1,217 @@
 ## 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>
+<dt><a href="#MastercardSRCClickToPay">MastercardSRCClickToPay</a> ⇐ <code>SRC</code></dt>
+<dd><p>Class MastercardSRCClickToPay include methods for interacting with the MastercardSRC checkout and Manual Card option</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>
+<dt><a href="#IMastercardSRCMeta">IMastercardSRCMeta</a> : <code>object</code></dt>
+<dd><p>Interface of data used for the Mastercard Checkout. For further information refer to <a href="https://developer.mastercard.com/unified-checkout-solutions/documentation/sdk-reference/init">the documentation</a>.</p>
+</dd>
+<dt><a href="#EventData">EventData</a> : <code>object</code></dt>
+<dd><p>Interface for data returned in callbacks</p>
+</dd>
+<dt><a href="#EventDataCheckoutCompletedData">EventDataCheckoutCompletedData</a> : <code>object</code></dt>
+<dd><p>Event data returned for checkoutCompleted callback, holding the One Time Token and the flow type completed.
+When the flow type is src, masked checkoutData available is also returned</p>
+</dd>
+<dt><a href="#IStyles">IStyles</a> : <code>object</code></dt>
+<dd><p>Interface for style configs inyected to the SRC checkout</p>
 </dd>
 </dl>
 
-<a name="IVisaSRCMeta" id="IVisaSRCMeta" href="#IVisaSRCMeta">&nbsp;</a>
+<a name="IMastercardSRCMeta" id="IMastercardSRCMeta" href="#IMastercardSRCMeta">&nbsp;</a>
 
-## IVisaSRCMeta : <code>object</code>
-Interface of data used for the Visa Checkout.
+## IMastercardSRCMeta : <code>object</code>
+Interface of data used for the Mastercard Checkout. For further information refer to [the documentation](https://developer.mastercard.com/unified-checkout-solutions/documentation/sdk-reference/init).
 
 **Kind**: global interface  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| [srci_transaction_id] | <code>string</code> | Used to identify the SRC Id. |
+| [disable_summary_screen] | <code>boolean</code> | Boolean flag that controls if a final summary screen is presented in the checkout flow. |
 | [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_presentation_name] | <code>string</code> | Name in which the DPA is presented. |
 | [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_data.dpa_address] | <code>string</code> | Address associated with the DPA. |
+| [dpa_data.dpa_email_address] | <code>string</code> | Email address for DPA communication. |
+| [dpa_data.dpa_phone_number] | <code>object</code> | Phone number structure for DPA communication. |
+| [dpa_data.dpa_phone_number.country_code] | <code>string</code> | The country code of the phone number. |
+| [dpa_data.dpa_phone_number.phone_number] | <code>string</code> | The phone number part of the phone number. |
+| [dpa_data.dpa_logo_uri] | <code>string</code> | URI for the DPA logo. |
+| [dpa_data.dpa_supported_email_address] | <code>string</code> | Supported email address for DPA support. |
+| [dpa_data.dpa_supported_phone_number] | <code>object</code> | Supported phone number for DPA support. |
+| [dpa_data.dpa_supported_phone_number.country_code] | <code>string</code> | The country code of the phone number. |
+| [dpa_data.dpa_supported_phone_number.phone_number] | <code>string</code> | The phone number part of the phone number. |
+| [dpa_data.dpa_support_uri] | <code>string</code> | URI for DPA support. |
+| [dpa_data.application_type] | <code>string</code> | Application type, either 'WEB_BROWSER' or 'MOBILE_APP'. |
+| [co_brand_names] | <code>Array.&lt;string&gt;</code> | List of co-brand names associated with the SRC experience. |
+| [checkout_experience] | <code>string</code> | Checkout experience type, either 'WITHIN_CHECKOUT' or 'PAYMENT_SETTINGS'. |
+| [services] | <code>string</code> | Services offered, such as 'INLINE_CHECKOUT' or 'INLINE_INSTALLMENTS'. |
+| [dpa_transaction_options] | <code>object</code> | Object that stores options for creating a transaction 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. |
+| [dpa_transaction_options.dpa_accepted_billing_countries] | <code>Array.&lt;string&gt;</code> | List of accepted billing countries for DPA in ISO 3166-1 alpha-2 format. |
+| [dpa_transaction_options.dpa_billing_preference] | <code>string</code> | Billing preferences for DPA, options are 'FULL', 'POSTAL_COUNTRY', 'NONE'. |
+| [dpa_transaction_options.payment_options] | <code>Array.&lt;object&gt;</code> | Payment options included in the transaction. |
+| [dpa_transaction_options.payment_options.dynamic_data_type] | <code>string</code> | Dynamic data types. |
+| [dpa_transaction_options.order_type] | <code>string</code> | Type of the order, options are 'SPLIT_SHIPMENT', 'PREFERRED_CARD'. |
+| [dpa_transaction_options.three_ds_preference] | <code>string</code> | Preference for 3DS usage in the transaction. |
+| [dpa_transaction_options.confirm_payment] | <code>boolean</code> | Indicates if payment confirmation is required. |
+| [dpa_transaction_options.consumer_name_requested] | <code>boolean</code> | Indicates if consumer name is requested. |
+| [dpa_transaction_options.consumer_email_address_requested] | <code>boolean</code> | Indicates if consumer email address is requested. |
+| [dpa_transaction_options.consumer_phone_number_requested] | <code>boolean</code> | Indicates if consumer phone number is requested. |
+| [dpa_transaction_options.transaction_amount] | <code>object</code> | Details of the transaction amount. |
+| [dpa_transaction_options.transaction_amount.transaction_amount] | <code>number</code> | Amount of the transaction. |
+| [dpa_transaction_options.transaction_amount.transaction_currency_code] | <code>string</code> | Currency code of the transaction in 3 letter ISO code format. |
+| [dpa_transaction_options.merchant_order_id] | <code>string</code> | Merchant's order ID. |
+| [dpa_transaction_options.merchant_category_code] | <code>string</code> | Merchant's category code. |
+| [dpa_transaction_options.merchant_country_code] | <code>string</code> | Merchant's country code in ISO 3166-1 alpha-2 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.country_code] | <code>string</code> | Customer phone country code (example "1" for US). // TODO: Confirm if it can be removed! |
 | [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"). |
+| [unaccepted_card_type] | <code>string</code> | Used to block a specific card type. Options are 'CREDIT', 'DEBIT'. |
+
+<a name="EventData" id="EventData" href="#EventData">&nbsp;</a>
+
+## EventData : <code>object</code>
+Interface for data returned in callbacks
+
+**Kind**: global interface  
 
-<a name="SRC" id="SRC" href="#SRC">&nbsp;</a>
+| Param | Type | Description |
+| --- | --- | --- |
+| type | [<code>EVENT\_DATA\_TYPE</code>](#EVENT_DATA_TYPE) | Event type of type [EVENT_DATA_TYPE](#EVENT_DATA_TYPE) |
+| data | <code>string</code> \| [<code>EventDataCheckoutCompletedData</code>](#EventDataCheckoutCompletedData) | optional data returning a string for checkoutError event or [EventDataCheckoutCompletedData](#EventDataCheckoutCompletedData) for checkoutCompleted |
 
-## SRC
-Class SRC include methods for interacting with different secure remote commerce options such as Visa SRC
+<a name="EventDataCheckoutCompletedData" id="EventDataCheckoutCompletedData" href="#EventDataCheckoutCompletedData">&nbsp;</a>
+
+## EventDataCheckoutCompletedData : <code>object</code>
+Event data returned for checkoutCompleted callback, holding the One Time Token and the flow type completed.
+When the flow type is src, masked checkoutData available is also returned
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| type | <code>string</code> | type of the checkout, can be `src` or `manual`. |
+| token | <code>string</code> | one time token value. |
+| [checkoutData] | <code>object</code> | Optional checkout data related to the checkout information. Only available on src flow. |
+| [checkoutData.card_number_bin] | <code>string</code> | The BIN of the card used for the transaction. |
+| [checkoutData.card_number_last4] | <code>string</code> | The last four digits of the card number. |
+| [checkoutData.card_scheme] | <code>string</code> | The card scheme. Values: visa, mastercard, amex, diners, discover. |
+| [checkoutData.card_type] | <code>string</code> | The type of card. Values: credit, debit, prepaid, combo, flex. |
+| [checkoutData.address_line1] | <code>string</code> | Address line 1 for billing address. |
+| [checkoutData.address_line2] | <code>string</code> | Address line 2 for billing address. |
+| [checkoutData.address_line3] | <code>string</code> | Address line 3 for billing address. |
+| [checkoutData.address_city] | <code>string</code> | City for billing address. |
+| [checkoutData.address_postcode] | <code>string</code> | Postal code for billing address. |
+| [checkoutData.address_state] | <code>string</code> | State or province for billing address. |
+| [checkoutData.address_country] | <code>string</code> | Country for billing address. |
+| [checkoutData.shipping] | <code>object</code> | Optional shipping information. |
+| [checkoutData.shipping.address_line1] | <code>string</code> | Address line 1 for shipping address. |
+| [checkoutData.shipping.address_line2] | <code>string</code> | Address line 2 for shipping address. |
+| [checkoutData.shipping.address_line3] | <code>string</code> | Address line 3 for shipping address. |
+| [checkoutData.shipping.address_city] | <code>string</code> | City for shipping address. |
+| [checkoutData.shipping.address_postcode] | <code>string</code> | Postal code for shipping address. |
+| [checkoutData.shipping.address_state] | <code>string</code> | State or province for shipping address. |
+| [checkoutData.shipping.address_country] | <code>string</code> | Country for shipping address. |
+
+<a name="IStyles" id="IStyles" href="#IStyles">&nbsp;</a>
+
+## IStyles : <code>object</code>
+Interface for style configs inyected to the SRC checkout
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [primary_button_color] | <code>string</code> | Color Code for primary button. |
+| [primary_button_text_color] | <code>string</code> | Color Code for primary button text. |
+| [secondary_button_color] | <code>string</code> | Color Code for secondary button. |
+| [secondary_button_text_color] | <code>string</code> | Color Code for secondary button text. |
+| [font_family] | <code>string</code> | Font family to be used. |
+| [enable_src_popup] | <code>boolean</code> | Boolean flag to make the SRC checkout show in a popup window instead of embedded in iframe. |
+
+<a name="MastercardSRCClickToPay" id="MastercardSRCClickToPay" href="#MastercardSRCClickToPay">&nbsp;</a>
+
+## MastercardSRCClickToPay ⇐ <code>SRC</code>
+Class MastercardSRCClickToPay include methods for interacting with the MastercardSRC checkout and Manual Card option
 
 **Kind**: global class  
+**Extends**: <code>SRC</code>  
 
-* [SRC](#SRC)
-    * [new SRC(button_selector, iframe_selector, service_id, public_key_or_access_token, meta)](#new_SRC_new)
+* [MastercardSRCClickToPay](#MastercardSRCClickToPay) ⇐ <code>SRC</code>
+    * [new MastercardSRCClickToPay(iframe_selector, service_id, public_key_or_access_token, meta)](#new_MastercardSRCClickToPay_new)
+    * [.load()](#MastercardSRCClickToPay+load)
     * [.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" href="#new_SRC_new">&nbsp;</a>
+<a name="new_MastercardSRCClickToPay_new" id="new_MastercardSRCClickToPay_new" href="#new_MastercardSRCClickToPay_new">&nbsp;</a>
 
-### new SRC(button_selector, iframe_selector, service_id, public_key_or_access_token, meta)
+### new MastercardSRCClickToPay(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 |
+| meta | [<code>IMastercardSRCMeta</code>](#IMastercardSRCMeta) | Data that configures the SRC checkout |
 
 **Example**  
 ```js
-var SRC = new SRC('#checkoutButton', '#checkoutIframe', 'service_id', 'public_key', {});
+var mastercardSRC = new MastercardSRCClickToPay('#checkoutIframe', 'service_id', 'public_key', {});
 ```
+<a name="MastercardSRCClickToPay+load" id="MastercardSRCClickToPay+load" href="#MastercardSRCClickToPay+load">&nbsp;</a>
+
+### mastercardSRCClickToPay.load()
+The final method after configuring the SRC to start the load process of SRC checkout
+
+**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
 <a name="SRC+setStyles" id="SRC+setStyles" href="#SRC+setStyles">&nbsp;</a>
 
-### srC.setStyles(fields)
+### mastercardSRCClickToPay.setStyles(fields)
 Object contain styles for widget - call before `.load()`.
 
-**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Overrides**: [<code>setStyles</code>](#SRC+setStyles)  
 
 | Param | Type | Description |
 | --- | --- | --- |
-| fields | <code>IStyles</code> | name of styles which can be shown in widget [STYLE](STYLE) |
+| fields | [<code>IStyles</code>](#IStyles) | 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']
-  });
+    enable_src_popup: true
+    primary_button_color: 'red',
+    secondary_button_color: 'blue',
+    primary_button_text_color: 'white',
+    secondary_button_text_color: 'white',
+    font_family: 'Arial',
+});
 ```
-<a name="SRC+load" id="SRC+load" href="#SRC+load">&nbsp;</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" href="#SRC+setEnv">&nbsp;</a>
 
-### srC.setEnv(env, [alias])
+### mastercardSRCClickToPay.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)  
+**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Overrides**: [<code>setEnv</code>](#SRC+setEnv)  
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -147,25 +224,27 @@ SRC.setEnv('production');
 ```
 <a name="SRC+getEnv" id="SRC+getEnv" href="#SRC+getEnv">&nbsp;</a>
 
-### srC.getEnv()
+### mastercardSRCClickToPay.getEnv()
 Method to read the current environment
 
-**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Overrides**: [<code>getEnv</code>](#SRC+getEnv)  
 **Example**  
 ```js
 SRC.getEnv();
 ```
 <a name="SRC+on" id="SRC+on" href="#SRC+on">&nbsp;</a>
 
-### srC.on(eventName, [cb]) ⇒ <code>Promise.&lt;any&gt;</code> \| <code>void</code>
+### mastercardSRCClickToPay.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)  
+**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Overrides**: [<code>on</code>](#SRC+on)  
 
 | Param | Type | Description |
 | --- | --- | --- |
 | eventName | <code>string</code> | Available event names [EVENT](#EVENT) |
-| [cb] | <code>listener</code> |  |
+| [cb] | <code>listener</code> | The callback to handle the event. When available, it will send back data of type [EventData](#EventData) |
 
 **Example**  
 ```js
@@ -177,37 +256,13 @@ SRC.on('checkoutCompleted').then(function (token) {
      console.log(token);
 });
 ```
-<a name="SRC+hideButton" id="SRC+hideButton" href="#SRC+hideButton">&nbsp;</a>
-
-### 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" href="#SRC+showButton">&nbsp;</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" href="#SRC+hideCheckout">&nbsp;</a>
 
-### srC.hideCheckout([saveSize])
+### mastercardSRCClickToPay.hideCheckout([saveSize])
 Using this method you can hide checkout after load and button click
 
-**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Overrides**: [<code>hideCheckout</code>](#SRC+hideCheckout)  
 
 | Param | Type | Default | Description |
 | --- | --- | --- | --- |
@@ -219,30 +274,33 @@ SRC.hideCheckout();
 ```
 <a name="SRC+showCheckout" id="SRC+showCheckout" href="#SRC+showCheckout">&nbsp;</a>
 
-### srC.showCheckout()
+### mastercardSRCClickToPay.showCheckout()
 Using this method you can show checkout after using hideCheckout method
 
-**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Overrides**: [<code>showCheckout</code>](#SRC+showCheckout)  
 **Example**  
 ```js
 SRC.showCheckout()
 ```
 <a name="SRC+reload" id="SRC+reload" href="#SRC+reload">&nbsp;</a>
 
-### srC.reload()
+### mastercardSRCClickToPay.reload()
 Using this method you can reload the whole checkout
 
-**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Overrides**: [<code>reload</code>](#SRC+reload)  
 **Example**  
 ```js
 SRC.reload()
 ```
 <a name="SRC+useAutoResize" id="SRC+useAutoResize" href="#SRC+useAutoResize">&nbsp;</a>
 
-### srC.useAutoResize()
+### mastercardSRCClickToPay.useAutoResize()
 Use this method for resize checkout iFrame according to content height, if applicable
 
-**Kind**: instance method of [<code>SRC</code>](#SRC)  
+**Kind**: instance method of [<code>MastercardSRCClickToPay</code>](#MastercardSRCClickToPay)  
+**Overrides**: [<code>useAutoResize</code>](#SRC+useAutoResize)  
 **Example**  
 ```js
 SRC.useAutoResize();
@@ -254,12 +312,25 @@ List of available event's name in the SRC checkout lifecycle
 
 **Kind**: global enum  
 
-| 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> | 
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| IFRAME_LOADED | <code>string</code> | <code>&quot;iframeLoaded&quot;</code> | Initial event sent when IFrame is initially loaded. |
+| CHECKOUT_READY | <code>string</code> | <code>&quot;checkoutReady&quot;</code> | Event sent when checkout is loaded and ready to be used by customer. Leverage alongside [showCheckout](#SRC+showCheckout) and [hideCheckout](#SRC+hideCheckout). |
+| CHECKOUT_POPUP_OPEN | <code>string</code> | <code>&quot;checkoutPopupOpen&quot;</code> | Event sent when SRC Checkout flow is started, regardless of embedded or windowed mode. |
+| CHECKOUT_POPUP_CLOSE | <code>string</code> | <code>&quot;checkoutPopupClose&quot;</code> | Event sent when SRC Checkout flow is closed, regardless of embedded or windowed mode. |
+| CHECKOUT_COMPLETED | <code>string</code> | <code>&quot;checkoutCompleted&quot;</code> | Event sent on successful checkout by customer. Check [data](#EventDataCheckoutCompletedData) for more information. |
+| CHECKOUT_ERROR | <code>string</code> | <code>&quot;checkoutError&quot;</code> | Event sent on error checkout by customer. Check [data](#EventData) for more information. |
+
+<a name="EVENT_DATA_TYPE" id="EVENT_DATA_TYPE" href="#EVENT_DATA_TYPE">&nbsp;</a>
+
+## EVENT\_DATA\_TYPE : <code>enum</code>
+List of available event data types
+
+**Kind**: global enum  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| CRITICAL_ERROR | <code>string</code> | <code>&quot;CriticalError&quot;</code> | in this error scenario the checkout is understood to be in a non-recoverable state and should be closed by the merchant and give alternate payment options to the user |
+| USER_ERROR | <code>string</code> | <code>&quot;UserError&quot;</code> | in this error scenario the error in likely a user input error and the checkout is in a recoverable state, so the user will be kept within the checkout and can retry the flow |
+| SUCCESS | <code>string</code> | <code>&quot;Success&quot;</code> |  |
 

package/docs/wallet-buttons-examples.md

@@ -150,6 +150,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).
@@ -277,30 +285,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>
@@ -434,6 +463,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
@@ -466,7 +496,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