npm - @paydock/client-sdk - Versions diffs - 1.108.2 → 1.110.3-beta - Mend

@paydock/client-sdk 1.108.2 → 1.110.3-beta

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

Files changed (102) hide show

package/README.md CHANGED Viewed

@@ -6406,6 +6406,995 @@ List of available event's name in the wallet button lifecycle
 | ON_CLICK | <code>string</code> | <code>&quot;onClick&quot;</code> |
+## Express Wallet Buttons
+Express Wallet Buttons allow to integrate with E-Wallets in an "express" operational mode, allowing to show the respective button in product or cart pages.
+The general flow to use the widgets is:
+1. Configure your gateway and connect it using Paydock API or Dashboard.
+2. Create a container in your site
+```html
+<div id="widget"></div>
+```
+3. Initialize the specific WalletButtonExpress, providing your Access Token (preferred) or Public Key, plus required and optional meta parameters for the wallet in use. The general format is:
+```js
+new paydock.{Provider}WalletButtonExpress(
+    "#widget",
+    accessTokenOrPublicKey,
+    gatewayId,
+    gatewaySpecificMeta,
+);
+```
+4. (optional) If the screen where the button is rendered allows for cart/amount changes, call `setMeta` method to update the meta information.
+5. Handle the `onClick` callback, where you should call your server, initialize the wallet charge via `POST v1/charges/wallet` and return the wallet token.
+6. Handle the `onPaymentSuccessful`, `onPaymentError` and `onPaymentInReview` (if fraud is applicable) for payment results.
+### Supported Providers
+1. [Apple Pay](#apple-pay-wallet-button-express)
+2. [Paypal](#paypal-wallet-button-express)
+### Apple Pay Wallet Button Express
+A full description of the meta parameters for [ApplePayWalletButtonExpress](#ApplePayWalletButtonExpress) meta parameters can be found [here](#ApplePayWalletMeta). Below you will find a fully working html example.
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+</head>
+<body>
+    <h2>Payment using PayDock ApplePayWalletButtonExpress!</h2>
+    <div id="widget"></div>
+</body>
+<script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
+<script>
+    let button = new paydock.ApplePayWalletButtonExpress(
+        "#widget",
+        accessTokenOrPublicKey,
+        gatewayId,
+        {
+            amount_label: 'TOTAL',
+            country: 'AU',
+            currency: 'AUD',
+            amount: 15.5,
+            // merchant_capabilities: ['supports3DS', 'supportsEMV', 'supportsCredit', 'supportsDebit'],
+            // supported_networks: ['visa', 'masterCard', 'amex', 'chinaUnionPay', 'discover', 'interac', 'jcb', 'privateLabel'],
+            // required_billing_contact_fields: ['email', 'name', 'phone', 'postalAddress'], // phone and email do not work according to relevant testing
+            // required_shipping_contact_fields: ['email', 'phone'], // Workaround to pull phone and email from shipping contact instead - does not require additional shipping address information
+            // supported_countries: ["AU"],
+            // style: {
+            //     button_type: "buy",
+            //     button_style: "black",
+            // },
+        }
+    );
+    button.setEnv(sandbox);
+    button.onUnavailable(function() {
+        console.log("Button not available");
+    });
+    button.onError(function(error) {
+        console.log("On Error Callback", error);
+    });
+    button.onPaymentSuccessful(function(data) {
+        console.log("Payment successful");
+        console.log(data);
+    });
+    button.onPaymentError(function(err) {
+        console.log("Payment error");
+        console.log(err);
+    });
+    button.onPaymentInReview(function(data) {
+        console.log("The payment is on fraud review");
+        console.log(data);
+    });
+    button.onClick(async (data) => {
+        console.log("Button clicked", data);
+        const responseData = await fetch('https://your-server-url/initialize-wallet-charge');
+        const parsedData = await responseData.json();
+        return parsedData.resource.data.token;
+    });
+    button.onCheckoutClose(() => {
+        console.log("Checkout closed");
+    });
+    button.load();
+</script>
+</html>
+```
+### Paypal Wallet Button Express
+A full description of the meta parameters for [PaypalWalletButtonExpress](#PaypalWalletButtonExpress) meta parameters can be found [here](#PaypalWalletMeta). Below you will find a fully working html example.
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+</head>
+<body>
+    <h2>Payment using PayDock PaypalWalletButtonExpress!</h2>
+    <div id="widget"></div>
+</body>
+<script src="https://widget.paydock.com/sdk/latest/widget.umd.min.js" ></script>
+<script>
+    let button = new paydock.PaypalWalletButtonExpress(
+        "#widget",
+        accessTokenOrPublicKey,
+        gatewayId,
+        {
+            amount: 15.5,
+            currency: 'AUD',
+            pay_later: false,
+            standalone: false,
+            capture: true,
+            // style: {
+            //     layout: 'horizontal', // or 'vertical'
+            //     color: 'gold', // or 'blue', 'silver', 'black', 'white'
+            //     shape: 'rect', // or 'pill', 'sharp'
+            //     borderRadius: 5,
+            //     height: 40,
+            //     disableMaxWidth: false,
+            //     label: 'paypal', // or 'checkout', 'buynow', 'pay', 'installment'
+            //     tagline: true,
+            //     messages: {
+            //         layout: 'text', // or 'flex'
+            //         logo: {
+            //             type: 'primary', // or 'alternative', 'inline', 'none'
+            //             position: 'left', // or 'right', 'top'
+            //         },
+            //         text: {
+            //             color: 'black', // or 'white', 'monochrome', 'grayscale'
+            //             size: 10, // or 11, 12, 13, 14, 15, 16
+            //             align: 'left', // or 'center', 'right'
+            //         },
+            //         color: 'blue', // or 'black', 'white', 'white-no-border', 'gray', 'monochrome', 'grayscale'
+            //         ratio: '1x1', // or '1x4', '8x1', '20x1'
+            //     },
+            // }
+        }
+    );
+    button.setEnv('sandbox');
+    button.onUnavailable(function() {
+        console.log("Button not available");
+    });
+    button.onError(function(error) {
+        console.log("On Error Callback", error);
+    });
+    button.onPaymentSuccessful(function(data) {
+        console.log("Payment successful");
+        console.log(data);
+    });
+    button.onPaymentError(function(err) {
+        console.log("Payment error");
+        console.log(err);
+    });
+    button.onPaymentInReview(function(data) {
+        console.log("The payment is on fraud review");
+        console.log(data);
+    });
+    button.onClick(async (data) => {
+        console.log("Button clicked", data);
+        const responseData = await fetch('https://your-server-url/initialize-wallet-charge');
+        const parsedData = await responseData.json();
+        return parsedData.resource.data.token;
+    });
+    button.onCheckoutClose(() => {
+        console.log("Checkout closed");
+    });
+    button.load();
+</script>
+</html>
+```
+## Classes
+<dl>
+<dt><a href="#ApplePayWalletButtonExpress">ApplePayWalletButtonExpress</a> ⇐ <code>BaseWalletButton</code></dt>
+<dd><p>Class ApplePayWalletButtonExpress to work with Apple Pay Wallet.</p>
+</dd>
+<dt><a href="#PaypalWalletButtonExpress">PaypalWalletButtonExpress</a> ⇐ <code>BaseWalletButton</code></dt>
+<dd><p>Class PaypalWalletButtonExpress to work with Paypal Wallet.</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>
+## Typedefs
+<dl>
+<dt><a href="#OnClickCallback">OnClickCallback</a> ⇒ <code>Promise.&lt;string&gt;</code></dt>
+<dd><p>Callback for onClick method.</p>
+</dd>
+<dt><a href="#OnPaymentSuccessfulCallback">OnPaymentSuccessfulCallback</a> : <code>function</code></dt>
+<dd><p>Callback for onPaymentSuccessful method.</p>
+</dd>
+<dt><a href="#OnPaymentInReviewCallback">OnPaymentInReviewCallback</a> : <code>function</code></dt>
+<dd><p>Callback for onPaymentInReview method.</p>
+</dd>
+<dt><a href="#OnPaymentErrorCallback">OnPaymentErrorCallback</a> : <code>function</code></dt>
+<dd><p>Callback for onPaymentError method.</p>
+</dd>
+<dt><a href="#OnCheckoutCloseCallback">OnCheckoutCloseCallback</a> : <code>function</code></dt>
+<dd><p>Callback for onCheckoutClose method.</p>
+</dd>
+<dt><a href="#OnUnavailableCallback">OnUnavailableCallback</a> : <code>function</code></dt>
+<dd><p>Callback for onUnavailable method.</p>
+</dd>
+<dt><a href="#OnErrorCallback">OnErrorCallback</a> : <code>function</code></dt>
+<dd><p>Callback for onError method.</p>
+</dd>
+</dl>
+## Interfaces
+<dl>
+<dt><a href="#ApplePayWalletMeta">ApplePayWalletMeta</a> : <code>object</code></dt>
+<dd><p>Interface for configuration metadata specific to ApplePay integration in the wallet checkout and payment process.</p>
+</dd>
+<dt><a href="#PaypalWalletMeta">PaypalWalletMeta</a> : <code>object</code></dt>
+<dd><p>Interface for configuration metadata specific to PayPal integration in the wallet checkout and payment process.
+For in-depth information, please refer to the <a href="https://developer.paypal.com/docs/multiparty/checkout/standard/customize/buttons-style-guide/">Paypal documentation</a>.</p>
+</dd>
+<dt><a href="#OnClickEventData">OnClickEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnClickEventData</p>
+</dd>
+<dt><a href="#OnCloseEventData">OnCloseEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnCloseEventData</p>
+</dd>
+<dt><a href="#OnPaymentSuccessfulEventData">OnPaymentSuccessfulEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnPaymentSuccessfulEventData. For final secure results, fetch backend to backend data.</p>
+</dd>
+<dt><a href="#OnPaymentInReviewEventData">OnPaymentInReviewEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnPaymentInReviewEventData. For final secure results, fetch backend to backend data.</p>
+</dd>
+<dt><a href="#OnPaymentErrorEventData">OnPaymentErrorEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnPaymentErrorEventData. For final secure results, fetch backend to backend data.</p>
+</dd>
+<dt><a href="#OnUnavailableEventData">OnUnavailableEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnUnavailableEventData</p>
+</dd>
+<dt><a href="#OnErrorEventData">OnErrorEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnErrorEventData</p>
+</dd>
+</dl>
+<a name="ApplePayWalletMeta" id="ApplePayWalletMeta" href="#ApplePayWalletMeta">&nbsp;</a>
+## ApplePayWalletMeta : <code>object</code>
+Interface for configuration metadata specific to ApplePay integration in the wallet checkout and payment process.
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| amount_label | <code>string</code> | Label shown next to the total amount to be paid, used in ApplePay popups. |
+| country | <code>string</code> | Country of the user in 2 letter ISO code format, required for ApplePay. |
+| currency | <code>string</code> | Currency of the transaction. ISO 4217 currency code format. |
+| amount | <code>number</code> | Total transaction amount number. **Note:** this amount will be presented in the payment sheet regardless of amount sent in the Wallet Initialization Backend to Backend call. Use `setMeta` method to keep it up to date. |
+| [merchant_capabilities] | <code>Array.&lt;(&#x27;supports3DS&#x27;\|&#x27;supportsEMV&#x27;\|&#x27;supportsCredit&#x27;\|&#x27;supportsDebit&#x27;)&gt;</code> | Array of capabilities that the merchant supports, influencing the transaction processing features available. |
+| [supported_networks] | <code>Array.&lt;(&#x27;visa&#x27;\|&#x27;masterCard&#x27;\|&#x27;amex&#x27;\|&#x27;chinaUnionPay&#x27;\|&#x27;discover&#x27;\|&#x27;interac&#x27;\|&#x27;jcb&#x27;\|&#x27;privateLabel&#x27;)&gt;</code> | List of payment networks supported by the merchant for ApplePay transactions. |
+| [required_billing_contact_fields] | <code>Array.&lt;(&#x27;email&#x27;\|&#x27;name&#x27;\|&#x27;phone&#x27;\|&#x27;postalAddress&#x27;)&gt;</code> | Contact fields required from the user for billing purposes, improving transaction verification and fraud prevention. Phone and email are currently not returned by Apple. |
+| [required_shipping_contact_fields] | <code>Array.&lt;(&#x27;email&#x27;\|&#x27;phone&#x27;)&gt;</code> | Shipping contact fields that are mandatory to complete the transaction. Use email and phone to collect from customer wallet in the abscense of billing one. |
+| [supported_countries] | <code>Array.&lt;string&gt;</code> | List of countries where ApplePay is supported by the merchant, restricting usage to specified regions. |
+| [style] | <code>object</code> | Styling configuration for ApplePay buttons displayed during checkout. |
+| [style.button_type] | <code>ApplePayButtonType</code> | Enum type to select the type of ApplePay button (e.g., 'buy', 'donate', etc.), providing user interface customization. |
+| [style.button_style] | <code>ApplePayButtonStyle</code> | Style applied to the ApplePay button, which can include color and form factor adjustments according to the brand's visual guidelines. |
+<a name="PaypalWalletMeta" id="PaypalWalletMeta" href="#PaypalWalletMeta">&nbsp;</a>
+## PaypalWalletMeta : <code>object</code>
+Interface for configuration metadata specific to PayPal integration in the wallet checkout and payment process.
+For in-depth information, please refer to the [Paypal documentation](https://developer.paypal.com/docs/multiparty/checkout/standard/customize/buttons-style-guide/).
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| amount | <code>number</code> | Total amount of the transaction. Represents the money to be charged. |
+| currency | <code>string</code> | Currency of the transaction in ISO 4217 currency code format. |
+| [pay_later] | <code>boolean</code> | Flag to enable Pay Later feature of PayPal, allowing Pay in 4. Default false. |
+| [standalone] | <code>boolean</code> | Flag to specify if the PayPal standalone button should be used. Default false. |
+| [capture] | <code>boolean</code> | Flag to specify if the transaction amount should be captured immediately or authorized for later capture. Default false. |
+| [style] | <code>object</code> | Styling configurations for the PayPal widget. |
+| [style.layout] | <code>&#x27;vertical&#x27;</code> \| <code>&#x27;horizontal&#x27;</code> | Layout orientation of the PayPal button. |
+| [style.color] | <code>&#x27;gold&#x27;</code> \| <code>&#x27;blue&#x27;</code> \| <code>&#x27;silver&#x27;</code> \| <code>&#x27;black&#x27;</code> \| <code>&#x27;white&#x27;</code> | Color theme of the PayPal button. |
+| [style.shape] | <code>&#x27;rect&#x27;</code> \| <code>&#x27;pill&#x27;</code> \| <code>&#x27;sharp&#x27;</code> | Shape of the PayPal button. |
+| [style.borderRadius] | <code>number</code> | Border radius for the button, allowing customization of corner roundness. |
+| [style.height] | <code>number</code> | Height of the PayPal button, allowing for size customization. |
+| [style.disableMaxWidth] | <code>boolean</code> | Flag to disable the maximum width constraint of the button. |
+| [style.label] | <code>&#x27;paypal&#x27;</code> \| <code>&#x27;checkout&#x27;</code> \| <code>&#x27;buynow&#x27;</code> \| <code>&#x27;pay&#x27;</code> \| <code>&#x27;installment&#x27;</code> | Label text displayed on the PayPal button. |
+| [style.tagline] | <code>boolean</code> | Flag to include or exclude a tagline beneath the button text. |
+| [style.messages] | <code>object</code> | Messaging options related to the PayPal button to enhance user interaction. |
+| [style.messages.layout] | <code>&#x27;text&#x27;</code> \| <code>&#x27;flex&#x27;</code> | Layout type for the messages displayed near the PayPal button. |
+| [style.messages.logo] | <code>object</code> | Configuration for the logo to be displayed with the PayPal button. |
+| [style.messages.logo.type] | <code>&#x27;primary&#x27;</code> \| <code>&#x27;alternative&#x27;</code> \| <code>&#x27;inline&#x27;</code> \| <code>&#x27;none&#x27;</code> | Type of logo to display. |
+| [style.messages.logo.position] | <code>&#x27;left&#x27;</code> \| <code>&#x27;right&#x27;</code> \| <code>&#x27;top&#x27;</code> | Position of the logo relative to the button or message. |
+| [style.messages.text] | <code>object</code> | Text styling within the message component. |
+| [style.messages.text.color] | <code>&#x27;black&#x27;</code> \| <code>&#x27;white&#x27;</code> \| <code>&#x27;monochrome&#x27;</code> \| <code>&#x27;grayscale&#x27;</code> | Color of the message text. |
+| [style.messages.text.size] | <code>10</code> \| <code>11</code> \| <code>12</code> \| <code>13</code> \| <code>14</code> \| <code>15</code> \| <code>16</code> | Font size of the message text. |
+| [style.messages.text.align] | <code>&#x27;left&#x27;</code> \| <code>&#x27;center&#x27;</code> \| <code>&#x27;right&#x27;</code> | Text alignment within the message area. |
+| [style.messages.color] | <code>&#x27;blue&#x27;</code> \| <code>&#x27;black&#x27;</code> \| <code>&#x27;white&#x27;</code> \| <code>&#x27;white-no-border&#x27;</code> \| <code>&#x27;gray&#x27;</code> \| <code>&#x27;monochrome&#x27;</code> \| <code>&#x27;grayscale&#x27;</code> | Background color of the message area. |
+| [style.messages.ratio] | <code>&#x27;1x1&#x27;</code> \| <code>&#x27;1x4&#x27;</code> \| <code>&#x27;8x1&#x27;</code> \| <code>&#x27;20x1&#x27;</code> | Aspect ratio of the message area, affecting its layout and display. |
+<a name="OnClickEventData" id="OnClickEventData" href="#OnClickEventData">&nbsp;</a>
+## OnClickEventData : <code>object</code>
+Interface for OnClickEventData
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'onClick' |
+<a name="OnCloseEventData" id="OnCloseEventData" href="#OnCloseEventData">&nbsp;</a>
+## OnCloseEventData : <code>object</code>
+Interface for OnCloseEventData
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'onCheckoutClose' |
+| [chargeId] | <code>string</code> | chargeId in case it's already set after onClick event |
+<a name="OnPaymentSuccessfulEventData" id="OnPaymentSuccessfulEventData" href="#OnPaymentSuccessfulEventData">&nbsp;</a>
+## OnPaymentSuccessfulEventData : <code>object</code>
+Interface for OnPaymentSuccessfulEventData. For final secure results, fetch backend to backend data.
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'paymentSuccessful' |
+| chargeId | <code>string</code> | chargeId set after onClick event |
+| data.id | <code>string</code> | Charge ID returned by server |
+| data.amount | <code>string</code> | Charge amount returned by server |
+| data.currency | <code>string</code> | Charge currency returned by server |
+| data.status | <code>string</code> | Charge status returned by server |
+<a name="OnPaymentInReviewEventData" id="OnPaymentInReviewEventData" href="#OnPaymentInReviewEventData">&nbsp;</a>
+## OnPaymentInReviewEventData : <code>object</code>
+Interface for OnPaymentInReviewEventData. For final secure results, fetch backend to backend data.
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'paymentInReview' |
+| chargeId | <code>string</code> | chargeId set after onClick event |
+| data.id | <code>string</code> | Charge ID returned by server |
+| data.amount | <code>string</code> | Charge amount returned by server |
+| data.currency | <code>string</code> | Charge currency returned by server |
+| data.status | <code>string</code> | Charge status returned by server |
+<a name="OnPaymentErrorEventData" id="OnPaymentErrorEventData" href="#OnPaymentErrorEventData">&nbsp;</a>
+## OnPaymentErrorEventData : <code>object</code>
+Interface for OnPaymentErrorEventData. For final secure results, fetch backend to backend data.
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'paymentError' |
+| chargeId | <code>string</code> | chargeId set after onClick event |
+| [data.message] | <code>string</code> | Error message |
+| [data.code] | <code>string</code> | Error code |
+<a name="OnUnavailableEventData" id="OnUnavailableEventData" href="#OnUnavailableEventData">&nbsp;</a>
+## OnUnavailableEventData : <code>object</code>
+Interface for OnUnavailableEventData
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'unavailable' |
+<a name="OnErrorEventData" id="OnErrorEventData" href="#OnErrorEventData">&nbsp;</a>
+## OnErrorEventData : <code>object</code>
+Interface for OnErrorEventData
+**Kind**: global interface
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'error' |
+| [chargeId] | <code>string</code> | chargeId in case it's already set after onClick event |
+| [data] | <code>Error</code> | Error object if present |
+<a name="ApplePayWalletButtonExpress" id="ApplePayWalletButtonExpress" href="#ApplePayWalletButtonExpress">&nbsp;</a>
+## ApplePayWalletButtonExpress ⇐ <code>BaseWalletButton</code>
+Class ApplePayWalletButtonExpress to work with Apple Pay Wallet.
+**Kind**: global class
+**Extends**: <code>BaseWalletButton</code>
+* [ApplePayWalletButtonExpress](#ApplePayWalletButtonExpress) ⇐ <code>BaseWalletButton</code>
+    * [new ApplePayWalletButtonExpress(selector, publicKeyOrAccessToken, gatewayId, meta)](#new_ApplePayWalletButtonExpress_new)
+    * [.load()](#ApplePayWalletButtonExpress+load)
+    * [.setMeta(meta)](#ApplePayWalletButtonExpress+setMeta)
+    * [.setEnv(env, [alias])](#BaseWalletButton+setEnv)
+    * [.onClick(handler)](#BaseWalletButton+onClick)
+    * [.onPaymentSuccessful([handler])](#BaseWalletButton+onPaymentSuccessful)
+    * [.onPaymentInReview([handler])](#BaseWalletButton+onPaymentInReview)
+    * [.onPaymentError([handler])](#BaseWalletButton+onPaymentError)
+    * [.onCheckoutClose(handler)](#BaseWalletButton+onCheckoutClose)
+    * [.onUnavailable(handler)](#BaseWalletButton+onUnavailable)
+    * [.onError(handler)](#BaseWalletButton+onError)
+<a name="new_ApplePayWalletButtonExpress_new" id="new_ApplePayWalletButtonExpress_new" href="#new_ApplePayWalletButtonExpress_new">&nbsp;</a>
+### new ApplePayWalletButtonExpress(selector, publicKeyOrAccessToken, gatewayId, meta)
+| Param | Type | Description |
+| --- | --- | --- |
+| selector | <code>string</code> | Selector of html element. Container for the ApplePayWalletButtonExpress. |
+| publicKeyOrAccessToken | <code>string</code> | Public key or Access token for the ApplePayWalletButtonExpress. |
+| gatewayId | <code>string</code> | Gateway ID for the ApplePayWalletButtonExpress. |
+| meta | [<code>ApplePayWalletMeta</code>](#ApplePayWalletMeta) | data that configures the Apple Pay Wallet. |
+**Example**
+```js
+var button = new ApplePayWalletButtonExpress('#wallet-buttons', 'publicKeyOrAccessToken', 'gatewayId', meta);
+```
+<a name="ApplePayWalletButtonExpress+load" id="ApplePayWalletButtonExpress+load" href="#ApplePayWalletButtonExpress+load">&nbsp;</a>
+### applePayWalletButtonExpress.load()
+Initializes the availability checks and inserts the button if possible.
+Otherwise function onUnavailable(handler: VoidFunction) will be called.
+**Important**: Is required to invoke this method to render the wallet button.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+**Example**
+```js
+button.load();
+```
+<a name="ApplePayWalletButtonExpress+setMeta" id="ApplePayWalletButtonExpress+setMeta" href="#ApplePayWalletButtonExpress+setMeta">&nbsp;</a>
+### applePayWalletButtonExpress.setMeta(meta)
+Call this method if updating the originally-provided meta object after order information changed.
+For example, if the order amount has changed from the time where the button was originally rendered.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+| Param | Type | Description |
+| --- | --- | --- |
+| meta | [<code>ApplePayWalletMeta</code>](#ApplePayWalletMeta) | // data that configures the Apple Pay Wallet. |
+**Example**
+```js
+button.setMeta(meta);
+```
+<a name="BaseWalletButton+setEnv" id="BaseWalletButton+setEnv" href="#BaseWalletButton+setEnv">&nbsp;</a>
+### applePayWalletButtonExpress.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
+Bear in mind that you must set an environment before calling `button.load()`.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+**Overrides**: [<code>setEnv</code>](#BaseWalletButton+setEnv)
+| Param | Type | Description |
+| --- | --- | --- |
+| env | <code>string</code> | sandbox, production |
+| [alias] | <code>string</code> | Own domain alias |
+**Example**
+```js
+button.setEnv('production', 'paydock.com');
+```
+<a name="BaseWalletButton+onClick" id="BaseWalletButton+onClick" href="#BaseWalletButton+onClick">&nbsp;</a>
+### applePayWalletButtonExpress.onClick(handler)
+Registers a callback function to be invoked when the wallet button gets clicked.
+**Note:** is mandatory to handle this event to perform the wallet initialization (and optionally any validation logic).
+The event handler needs to return the wallet token string in order for the Wallet charge processing to proceed, or throw an error in case of failure or validation errors.
+**Note:** this callback may be called multiple times as the customer closes the payment checkout and re-clicks the button.
+It's the merchant's responsibility to handle this situation and evaluate in each case if generating a new WalletCharge Token is required or the previous one can be used in each case, depending on order data and updates.
+In case a new one needs to be generated, remember it will need to be preceded by a `setMeta` call.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+**Overrides**: [<code>onClick</code>](#BaseWalletButton+onClick)
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | [<code>OnClickCallback</code>](#OnClickCallback) | Function to be called when the wallet button is clicked. |
+**Example**
+```js
+button.onClick(async (data) => {
+     const responseData = await fetch('https://your-server.com/init-wallet-charge');
+     return responseData.walletToken;
+});
+```
+<a name="BaseWalletButton+onPaymentSuccessful" id="BaseWalletButton+onPaymentSuccessful" href="#BaseWalletButton+onPaymentSuccessful">&nbsp;</a>
+### applePayWalletButtonExpress.onPaymentSuccessful([handler])
+If the payment was successful, the function passed as parameter will be called.
+Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+**Overrides**: [<code>onPaymentSuccessful</code>](#BaseWalletButton+onPaymentSuccessful)
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnPaymentSuccessfulCallback</code>](#OnPaymentSuccessfulCallback) | Function to be called when the payment was successful. |
+**Example**
+```js
+button.onPaymentSuccessful((data) => {
+     console.log('Payment successful!');
+});
+```
+**Example**
+```js
+button.onPaymentSuccessful().then((data) => console.log('Payment successful!'));
+```
+<a name="BaseWalletButton+onPaymentInReview" id="BaseWalletButton+onPaymentInReview" href="#BaseWalletButton+onPaymentInReview">&nbsp;</a>
+### applePayWalletButtonExpress.onPaymentInReview([handler])
+If the payment was left in fraud review, the function passed as parameter will be called.
+Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+**Overrides**: [<code>onPaymentInReview</code>](#BaseWalletButton+onPaymentInReview)
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnPaymentInReviewCallback</code>](#OnPaymentInReviewCallback) | Function to be called when the payment was left in fraud review status. |
+**Example**
+```js
+button.onPaymentInReview((data) => {
+     console.log('Payment in fraud review');
+});
+```
+**Example**
+```js
+button.onPaymentInReview().then((data) => console.log('Payment in fraud review'));
+```
+<a name="BaseWalletButton+onPaymentError" id="BaseWalletButton+onPaymentError" href="#BaseWalletButton+onPaymentError">&nbsp;</a>
+### applePayWalletButtonExpress.onPaymentError([handler])
+If the payment was not successful, the function passed as parameter will be called.
+Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+**Overrides**: [<code>onPaymentError</code>](#BaseWalletButton+onPaymentError)
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnPaymentErrorCallback</code>](#OnPaymentErrorCallback) | Function to be called when the payment was not successful. |
+**Example**
+```js
+button.onPaymentError((err) => {
+     console.log('Payment not successful');
+});
+```
+**Example**
+```js
+button.onPaymentError().then((err) => console.log('Payment not successful'));
+```
+<a name="BaseWalletButton+onCheckoutClose" id="BaseWalletButton+onCheckoutClose" href="#BaseWalletButton+onCheckoutClose">&nbsp;</a>
+### applePayWalletButtonExpress.onCheckoutClose(handler)
+Registers a callback function to be invoked when the wallet checkout closes.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+**Overrides**: [<code>onCheckoutClose</code>](#BaseWalletButton+onCheckoutClose)
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | [<code>OnCheckoutCloseCallback</code>](#OnCheckoutCloseCallback) | Function to be called when the wallet checkout closes. |
+**Example**
+```js
+button.onCheckoutClose(() => {
+     console.log('Wallet checkout closes');
+});
+```
+<a name="BaseWalletButton+onUnavailable" id="BaseWalletButton+onUnavailable" href="#BaseWalletButton+onUnavailable">&nbsp;</a>
+### applePayWalletButtonExpress.onUnavailable(handler)
+Registers a callback function to be invoked when the wallet is not available in the current context.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+**Overrides**: [<code>onUnavailable</code>](#BaseWalletButton+onUnavailable)
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | [<code>OnUnavailableCallback</code>](#OnUnavailableCallback) | Function to be called when the wallet is not available in the current context. |
+**Example**
+```js
+button.onUnavailable(() => {
+     console.log('Wallet not available');
+});
+```
+<a name="BaseWalletButton+onError" id="BaseWalletButton+onError" href="#BaseWalletButton+onError">&nbsp;</a>
+### applePayWalletButtonExpress.onError(handler)
+Registers a callback function to be invoked when an error that is not related to payment execution occurs.
+For example, if the amount of the wallet token injected via the `onClick` event handler does not match the amount provided via the initial `meta` or `setMeta` method.
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)
+**Overrides**: [<code>onError</code>](#BaseWalletButton+onError)
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | [<code>OnErrorCallback</code>](#OnErrorCallback) | Function to be called when the WalletButton has an error. |
+**Example**
+```js
+button.onError((error) => {
+     console.log('WalletButtonExpress error', error);
+});
+```
+<a name="PaypalWalletButtonExpress" id="PaypalWalletButtonExpress" href="#PaypalWalletButtonExpress">&nbsp;</a>
+## PaypalWalletButtonExpress ⇐ <code>BaseWalletButton</code>
+Class PaypalWalletButtonExpress to work with Paypal Wallet.
+**Kind**: global class
+**Extends**: <code>BaseWalletButton</code>
+* [PaypalWalletButtonExpress](#PaypalWalletButtonExpress) ⇐ <code>BaseWalletButton</code>
+    * [new PaypalWalletButtonExpress(selector, publicKeyOrAccessToken, gatewayId, meta)](#new_PaypalWalletButtonExpress_new)
+    * [.load()](#PaypalWalletButtonExpress+load)
+    * [.setMeta(meta)](#PaypalWalletButtonExpress+setMeta)
+    * [.setEnv(env, [alias])](#BaseWalletButton+setEnv)
+    * [.onClick(handler)](#BaseWalletButton+onClick)
+    * [.onPaymentSuccessful([handler])](#BaseWalletButton+onPaymentSuccessful)
+    * [.onPaymentInReview([handler])](#BaseWalletButton+onPaymentInReview)
+    * [.onPaymentError([handler])](#BaseWalletButton+onPaymentError)
+    * [.onCheckoutClose(handler)](#BaseWalletButton+onCheckoutClose)
+    * [.onUnavailable(handler)](#BaseWalletButton+onUnavailable)
+    * [.onError(handler)](#BaseWalletButton+onError)
+<a name="new_PaypalWalletButtonExpress_new" id="new_PaypalWalletButtonExpress_new" href="#new_PaypalWalletButtonExpress_new">&nbsp;</a>
+### new PaypalWalletButtonExpress(selector, publicKeyOrAccessToken, gatewayId, meta)
+| Param | Type | Description |
+| --- | --- | --- |
+| selector | <code>string</code> | Selector of html element. Container for the PaypalWalletButtonExpress. |
+| publicKeyOrAccessToken | <code>string</code> | Public key or Access token for the PaypalWalletButtonExpress. |
+| gatewayId | <code>string</code> | Gateway ID for the PaypalWalletButtonExpress. |
+| meta | [<code>PaypalWalletMeta</code>](#PaypalWalletMeta) | data that configures the Paypal Wallet. |
+**Example**
+```js
+var button = new PaypalWalletButtonExpress('#wallet-buttons', 'publicKeyOrAccessToken', 'gatewayId', meta);
+```
+<a name="PaypalWalletButtonExpress+load" id="PaypalWalletButtonExpress+load" href="#PaypalWalletButtonExpress+load">&nbsp;</a>
+### paypalWalletButtonExpress.load()
+Initializes the availability checks and inserts the button if possible.
+Otherwise function onUnavailable(handler: VoidFunction) will be called.
+**Important**: Is required to invoke this method to render the wallet button.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+**Example**
+```js
+button.load();
+```
+<a name="PaypalWalletButtonExpress+setMeta" id="PaypalWalletButtonExpress+setMeta" href="#PaypalWalletButtonExpress+setMeta">&nbsp;</a>
+### paypalWalletButtonExpress.setMeta(meta)
+Call this method if updating the originally-provided meta object after order information changed.
+For example, if the order amount has changed from the time where the button was originally rendered.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+| Param | Type | Description |
+| --- | --- | --- |
+| meta | [<code>PaypalWalletMeta</code>](#PaypalWalletMeta) | // data that configures the Paypal Wallet. |
+**Example**
+```js
+button.setMeta(meta);
+```
+<a name="BaseWalletButton+setEnv" id="BaseWalletButton+setEnv" href="#BaseWalletButton+setEnv">&nbsp;</a>
+### paypalWalletButtonExpress.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
+Bear in mind that you must set an environment before calling `button.load()`.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+**Overrides**: [<code>setEnv</code>](#BaseWalletButton+setEnv)
+| Param | Type | Description |
+| --- | --- | --- |
+| env | <code>string</code> | sandbox, production |
+| [alias] | <code>string</code> | Own domain alias |
+**Example**
+```js
+button.setEnv('production', 'paydock.com');
+```
+<a name="BaseWalletButton+onClick" id="BaseWalletButton+onClick" href="#BaseWalletButton+onClick">&nbsp;</a>
+### paypalWalletButtonExpress.onClick(handler)
+Registers a callback function to be invoked when the wallet button gets clicked.
+**Note:** is mandatory to handle this event to perform the wallet initialization (and optionally any validation logic).
+The event handler needs to return the wallet token string in order for the Wallet charge processing to proceed, or throw an error in case of failure or validation errors.
+**Note:** this callback may be called multiple times as the customer closes the payment checkout and re-clicks the button.
+It's the merchant's responsibility to handle this situation and evaluate in each case if generating a new WalletCharge Token is required or the previous one can be used in each case, depending on order data and updates.
+In case a new one needs to be generated, remember it will need to be preceded by a `setMeta` call.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+**Overrides**: [<code>onClick</code>](#BaseWalletButton+onClick)
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | [<code>OnClickCallback</code>](#OnClickCallback) | Function to be called when the wallet button is clicked. |
+**Example**
+```js
+button.onClick(async (data) => {
+     const responseData = await fetch('https://your-server.com/init-wallet-charge');
+     return responseData.walletToken;
+});
+```
+<a name="BaseWalletButton+onPaymentSuccessful" id="BaseWalletButton+onPaymentSuccessful" href="#BaseWalletButton+onPaymentSuccessful">&nbsp;</a>
+### paypalWalletButtonExpress.onPaymentSuccessful([handler])
+If the payment was successful, the function passed as parameter will be called.
+Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+**Overrides**: [<code>onPaymentSuccessful</code>](#BaseWalletButton+onPaymentSuccessful)
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnPaymentSuccessfulCallback</code>](#OnPaymentSuccessfulCallback) | Function to be called when the payment was successful. |
+**Example**
+```js
+button.onPaymentSuccessful((data) => {
+     console.log('Payment successful!');
+});
+```
+**Example**
+```js
+button.onPaymentSuccessful().then((data) => console.log('Payment successful!'));
+```
+<a name="BaseWalletButton+onPaymentInReview" id="BaseWalletButton+onPaymentInReview" href="#BaseWalletButton+onPaymentInReview">&nbsp;</a>
+### paypalWalletButtonExpress.onPaymentInReview([handler])
+If the payment was left in fraud review, the function passed as parameter will be called.
+Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+**Overrides**: [<code>onPaymentInReview</code>](#BaseWalletButton+onPaymentInReview)
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnPaymentInReviewCallback</code>](#OnPaymentInReviewCallback) | Function to be called when the payment was left in fraud review status. |
+**Example**
+```js
+button.onPaymentInReview((data) => {
+     console.log('Payment in fraud review');
+});
+```
+**Example**
+```js
+button.onPaymentInReview().then((data) => console.log('Payment in fraud review'));
+```
+<a name="BaseWalletButton+onPaymentError" id="BaseWalletButton+onPaymentError" href="#BaseWalletButton+onPaymentError">&nbsp;</a>
+### paypalWalletButtonExpress.onPaymentError([handler])
+If the payment was not successful, the function passed as parameter will be called.
+Important: Do not perform thread blocking operations in callback such as window.alert() calls.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+**Overrides**: [<code>onPaymentError</code>](#BaseWalletButton+onPaymentError)
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnPaymentErrorCallback</code>](#OnPaymentErrorCallback) | Function to be called when the payment was not successful. |
+**Example**
+```js
+button.onPaymentError((err) => {
+     console.log('Payment not successful');
+});
+```
+**Example**
+```js
+button.onPaymentError().then((err) => console.log('Payment not successful'));
+```
+<a name="BaseWalletButton+onCheckoutClose" id="BaseWalletButton+onCheckoutClose" href="#BaseWalletButton+onCheckoutClose">&nbsp;</a>
+### paypalWalletButtonExpress.onCheckoutClose(handler)
+Registers a callback function to be invoked when the wallet checkout closes.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+**Overrides**: [<code>onCheckoutClose</code>](#BaseWalletButton+onCheckoutClose)
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | [<code>OnCheckoutCloseCallback</code>](#OnCheckoutCloseCallback) | Function to be called when the wallet checkout closes. |
+**Example**
+```js
+button.onCheckoutClose(() => {
+     console.log('Wallet checkout closes');
+});
+```
+<a name="BaseWalletButton+onUnavailable" id="BaseWalletButton+onUnavailable" href="#BaseWalletButton+onUnavailable">&nbsp;</a>
+### paypalWalletButtonExpress.onUnavailable(handler)
+Registers a callback function to be invoked when the wallet is not available in the current context.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+**Overrides**: [<code>onUnavailable</code>](#BaseWalletButton+onUnavailable)
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | [<code>OnUnavailableCallback</code>](#OnUnavailableCallback) | Function to be called when the wallet is not available in the current context. |
+**Example**
+```js
+button.onUnavailable(() => {
+     console.log('Wallet not available');
+});
+```
+<a name="BaseWalletButton+onError" id="BaseWalletButton+onError" href="#BaseWalletButton+onError">&nbsp;</a>
+### paypalWalletButtonExpress.onError(handler)
+Registers a callback function to be invoked when an error that is not related to payment execution occurs.
+For example, if the amount of the wallet token injected via the `onClick` event handler does not match the amount provided via the initial `meta` or `setMeta` method.
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)
+**Overrides**: [<code>onError</code>](#BaseWalletButton+onError)
+| Param | Type | Description |
+| --- | --- | --- |
+| handler | [<code>OnErrorCallback</code>](#OnErrorCallback) | Function to be called when the WalletButton has an error. |
+**Example**
+```js
+button.onError((error) => {
+     console.log('WalletButtonExpress error', error);
+});
+```
+<a name="EVENT" id="EVENT" href="#EVENT">&nbsp;</a>
+## EVENT : <code>object</code>
+List of available event's name in the wallet button lifecycle
+**Kind**: global constant
+| Param | Type | Default |
+| --- | --- | --- |
+| UNAVAILABLE | <code>string</code> | <code>&quot;unavailable&quot;</code> |
+| ERROR | <code>string</code> | <code>&quot;error&quot;</code> |
+| PAYMENT_SUCCESSFUL | <code>string</code> | <code>&quot;paymentSuccessful&quot;</code> |
+| PAYMENT_ERROR | <code>string</code> | <code>&quot;paymentError&quot;</code> |
+| PAYMENT_IN_REVIEW | <code>string</code> | <code>&quot;paymentInReview&quot;</code> |
+| ON_CLICK | <code>string</code> | <code>&quot;onClick&quot;</code> |
+| ON_CHECKOUT_CLOSE | <code>string</code> | <code>&quot;onCheckoutClose&quot;</code> |
+<a name="OnClickCallback" id="OnClickCallback" href="#OnClickCallback">&nbsp;</a>
+## OnClickCallback ⇒ <code>Promise.&lt;string&gt;</code>
+Callback for onClick method.
+**Kind**: global typedef
+**Returns**: <code>Promise.&lt;string&gt;</code> - walletToken string result
+| Param | Type |
+| --- | --- |
+| data | [<code>OnClickEventData</code>](#OnClickEventData) |
+<a name="OnPaymentSuccessfulCallback" id="OnPaymentSuccessfulCallback" href="#OnPaymentSuccessfulCallback">&nbsp;</a>
+## OnPaymentSuccessfulCallback : <code>function</code>
+Callback for onPaymentSuccessful method.
+**Kind**: global typedef
+| Param | Type |
+| --- | --- |
+| data | [<code>OnPaymentSuccessfulEventData</code>](#OnPaymentSuccessfulEventData) |
+<a name="OnPaymentInReviewCallback" id="OnPaymentInReviewCallback" href="#OnPaymentInReviewCallback">&nbsp;</a>
+## OnPaymentInReviewCallback : <code>function</code>
+Callback for onPaymentInReview method.
+**Kind**: global typedef
+| Param | Type |
+| --- | --- |
+| data | [<code>OnPaymentInReviewEventData</code>](#OnPaymentInReviewEventData) |
+<a name="OnPaymentErrorCallback" id="OnPaymentErrorCallback" href="#OnPaymentErrorCallback">&nbsp;</a>
+## OnPaymentErrorCallback : <code>function</code>
+Callback for onPaymentError method.
+**Kind**: global typedef
+| Param | Type |
+| --- | --- |
+| data | [<code>OnPaymentErrorEventData</code>](#OnPaymentErrorEventData) |
+<a name="OnCheckoutCloseCallback" id="OnCheckoutCloseCallback" href="#OnCheckoutCloseCallback">&nbsp;</a>
+## OnCheckoutCloseCallback : <code>function</code>
+Callback for onCheckoutClose method.
+**Kind**: global typedef
+| Param | Type |
+| --- | --- |
+| data | [<code>OnCloseEventData</code>](#OnCloseEventData) |
+<a name="OnUnavailableCallback" id="OnUnavailableCallback" href="#OnUnavailableCallback">&nbsp;</a>
+## OnUnavailableCallback : <code>function</code>
+Callback for onUnavailable method.
+**Kind**: global typedef
+| Param | Type |
+| --- | --- |
+| data | [<code>OnUnavailableEventData</code>](#OnUnavailableEventData) |
+<a name="OnErrorCallback" id="OnErrorCallback" href="#OnErrorCallback">&nbsp;</a>
+## OnErrorCallback : <code>function</code>
+Callback for onError method.
+**Kind**: global typedef
+| Param | Type |
+| --- | --- |
+| data | [<code>OnErrorEventData</code>](#OnErrorEventData) |
 # Click To Pay
 ## Overview
@@ -6715,7 +7704,7 @@ Interface of data used for the Mastercard Checkout. For further information refe
 | [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). // TODO: Confirm if it can be removed! |
+| [customer.phone.country_code] | <code>string</code> | Customer phone country code (example "1" for US). |
 | [customer.phone.phone] | <code>string</code> | Customer phone number. |
 | [unaccepted_card_type] | <code>string</code> | Used to block a specific card type. Options are 'CREDIT', 'DEBIT'. |