@paydock/client-sdk 0.1.0 → 0.1.2-beta

package/docs/wallet-buttons-express.md

@@ -0,0 +1,1076 @@
+## 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>
+<dt><a href="#ContactFieldType">ContactFieldType</a> : <code>object</code></dt>
+<dd><p>List of available contact fields for ContactFieldType</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="#OnShippingAddressChangeCallback">OnShippingAddressChangeCallback</a> ⇒ <code><a href="#OnShippingAddressChangeEventResponse">Promise.&lt;OnShippingAddressChangeEventResponse&gt;</a></code></dt>
+<dd><p>Callback for onShippingAddressChange method.</p>
+</dd>
+<dt><a href="#OnShippingOptionsChangeCallback">OnShippingOptionsChangeCallback</a> ⇒ <code><a href="#OnShippingOptionChangeEventResponse">Promise.&lt;OnShippingOptionChangeEventResponse&gt;</a></code></dt>
+<dd><p>Callback for onShippingOptionsChange 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.
+For further information about ApplePay Capabilities refer to <a href="https://developer.apple.com/documentation/apple_pay_on_the_web/applepaysession/4440085-applepaycapabilities">the documentation</a>.
+Apple will determinate if the device has an ApplePay wallet available and at least one active payment.
+If the determinated value is credentials_status_unknown, the payment possbily should might be not able to be finished on the web, and the buyer must complete it on a compatible device, like Iphone or Ipad.</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>
+<dt><a href="#OnShippingAddressChangeEventData">OnShippingAddressChangeEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnShippingAddressChangeEventData.</p>
+</dd>
+<dt><a href="#OnShippingAddressChangeEventResponse">OnShippingAddressChangeEventResponse</a> : <code>object</code></dt>
+<dd><p>Interface for OnShippingAddressChangeEventResponse.</p>
+</dd>
+<dt><a href="#IApplePayShippingOption">IApplePayShippingOption</a> : <code>object</code></dt>
+<dd><p>Interface for IApplePayShippingOption.
+Used for adding new shippings options when customer updates the shipping address.</p>
+</dd>
+<dt><a href="#OnShippingOptionChangeEventData">OnShippingOptionChangeEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnShippingOptionChangeEventData.</p>
+</dd>
+<dt><a href="#OnShippingOptionChangeEventResponse">OnShippingOptionChangeEventResponse</a> : <code>object</code></dt>
+<dd><p>Interface for OnShippingOptionChangeEventResponse.</p>
+</dd>
+<dt><a href="#IApplePayError">IApplePayError</a> : <code>object</code></dt>
+<dd><p>Interface for IApplePayError.</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.
+For further information about ApplePay Capabilities refer to [the documentation](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaysession/4440085-applepaycapabilities).
+Apple will determinate if the device has an ApplePay wallet available and at least one active payment.
+If the determinated value is credentials_status_unknown, the payment possbily should might be not able to be finished on the web, and the buyer must complete it on a compatible device, like Iphone or Ipad.
+
+**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. Required for onShippingAddressChange callback. |
+| [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. |
+| [shipping_editing_mode] | <code>&#x27;available&#x27;</code> \| <code>&#x27;store\_pickup&#x27;</code> | ApplePay - available for allowing editing shipping, store_pickup for not allowing editing shipping. |
+| [shipping_data] | <code>object</code> | ApplePay - Preloaded data used for populate shipping address information |
+| [shipping_data.email_address] | <code>string</code> | ApplePay - The shipping address email |
+| [apple_pay_capabilities] | <code>Array.&lt;(&#x27;credentials\_available&#x27;\|&#x27;credentials\_status\_unknown&#x27;\|&#x27;credentials\_unavailable&#x27;)&gt;</code> | Device capabilities needed for wallet button to be available. |
+
+<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. |
+| [hide_message] | <code>boolean</code> | Used to hide Pay Later message in PayPal Smart Checkout WalletButton integration. Optional for [PayPal]. N/A for other wallets. |
+| [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="OnShippingAddressChangeEventData" id="OnShippingAddressChangeEventData" href="#OnShippingAddressChangeEventData">&nbsp;</a>
+
+## OnShippingAddressChangeEventData : <code>object</code>
+Interface for OnShippingAddressChangeEventData.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'onShippingAddressChange' |
+| chargeId | <code>string</code> | chargeId set after onClick event |
+| data.address_city | <code>string</code> | PayPal and ApplePay - Shipping address city |
+| data.address_state | <code>string</code> | PayPal and ApplePay - Shipping address state |
+| data.address_postcode | <code>string</code> | PayPal and ApplePay - Shipping address postcode |
+| data.address_country | <code>string</code> | PayPal and ApplePay - Shipping address country code |
+| [data.address_line1] | <code>string</code> | ApplePay - Shipping address line 1 |
+| [data.address_line2] | <code>string</code> | ApplePay - Shipping address line 2 |
+| [data.contact.phone] | <code>string</code> | ApplePay - Shipping contact phone |
+| [data.contact.email] | <code>string</code> | ApplePay - Shipping contact email |
+| [data.contact.first_name] | <code>string</code> | ApplePay - Shipping contact first name |
+| [data.contact.last_name] | <code>string</code> | ApplePay - Shipping contact last name |
+
+<a name="OnShippingAddressChangeEventResponse" id="OnShippingAddressChangeEventResponse" href="#OnShippingAddressChangeEventResponse">&nbsp;</a>
+
+## OnShippingAddressChangeEventResponse : <code>object</code>
+Interface for OnShippingAddressChangeEventResponse.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [token] | <code>string</code> | Updated Wallet Token if any |
+| [label] | <code>string</code> | ApplePay - Required. Label to show to the customer. |
+| [amount] | <code>string</code> | ApplePay - Required. New amount for shipping option. |
+| [error] | <code>string</code> | PayPal and ApplePay - Error object in case of error when processing shipping address in if new address unsupported or any other possible error. |
+| error.code | <code>string</code> | PayPal and ApplePay - Error code, mandatory in case of error. Possible values for Paypal are 'address_error', 'country_error', 'state_error', 'zip_error' or any other string if none applies. For ApplePay values are 'address_error', 'shipping_contact_invalid' and 'billing_contact_invalid'. |
+| [error.field] | <code>string</code> | ApplePay - Error field in case of specifically showing it. Possible values for Apple Pay are 'phone', 'email', 'name', 'phonetic_name', 'address_lines', 'locality', 'postal_code', 'administrative_area', 'country', 'country_code'. |
+| [error.message] | <code>string</code> | ApplePay - Custom user facing error message. |
+
+<a name="IApplePayShippingOption" id="IApplePayShippingOption" href="#IApplePayShippingOption">&nbsp;</a>
+
+## IApplePayShippingOption : <code>object</code>
+Interface for IApplePayShippingOption.
+Used for adding new shippings options when customer updates the shipping address.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [id] | <code>string</code> | Updated Wallet Token if any |
+| [label] | <code>string</code> | ApplePay - Required. Label to show to the customer. |
+| [amount] | <code>string</code> | ApplePay - Required. New amount for shipping option. |
+| [detail] | <code>string</code> | ApplePay - Optional detail for shipping option. |
+| [date_components_range] | <code>object</code> | ApplePay - Object that contains the dates for shipping |
+| [date_components_range.start_date_components] | <code>object</code> | ApplePay - Contains the start date object |
+| [date_components_range.start_date_components.years] | <code>string</code> | ApplePay - Contains the start date year |
+| [date_components_range.start_date_components.months] | <code>string</code> | ApplePay - Contains the start date month |
+| [date_components_range.start_date_components.days] | <code>string</code> | ApplePay - Contains the start date day |
+| [date_components_range.start_date_components.hours] | <code>string</code> | ApplePay - Contains the start date hour |
+| [date_components_range.end_date_components] | <code>object</code> | ApplePay - Contains the end date year |
+| [date_components_range.end_date_components.years] | <code>string</code> | ApplePay - Contains the end date year |
+| [date_components_range.end_date_components.months] | <code>string</code> | ApplePay - Contains the end date month |
+| [date_components_range.end_date_components.days] | <code>string</code> | ApplePay - Contains the end date day |
+| [date_components_range.end_date_components.hours] | <code>string</code> | ApplePay - Contains the end date hour |
+
+<a name="OnShippingOptionChangeEventData" id="OnShippingOptionChangeEventData" href="#OnShippingOptionChangeEventData">&nbsp;</a>
+
+## OnShippingOptionChangeEventData : <code>object</code>
+Interface for OnShippingOptionChangeEventData.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'onShippingOptionsChange' |
+| chargeId | <code>string</code> | chargeId set after onClick event |
+| [data.shipping_option_id] | <code>string</code> | PayPal and ApplePay - Selected shipping option id |
+| [data.amount] | <code>string</code> | Paypal and ApplePay - Selected shipping option amount |
+| [data.label] | <code>string</code> | ApplePay - Selected shipping option label |
+| [data.detail] | <code>string</code> | ApplePay - Selected shipping option detail |
+
+<a name="OnShippingOptionChangeEventResponse" id="OnShippingOptionChangeEventResponse" href="#OnShippingOptionChangeEventResponse">&nbsp;</a>
+
+## OnShippingOptionChangeEventResponse : <code>object</code>
+Interface for OnShippingOptionChangeEventResponse.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [token] | <code>string</code> | Updated Wallet Token if any |
+| [label] | <code>string</code> | ApplePay - Required. Label to show to the customer. |
+| [amount] | <code>string</code> | ApplePay - Required. New amount for shipping option. |
+| [error] | <code>string</code> | PayPal - Error object in case of error when processing shipping option selection. |
+| error.code | <code>string</code> | Possible values for Paypal are 'method_unavailable', 'store_unavailable' or any other string if none applies. |
+
+<a name="IApplePayError" id="IApplePayError" href="#IApplePayError">&nbsp;</a>
+
+## IApplePayError : <code>object</code>
+Interface for IApplePayError.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| code | <code>&#x27;shipping\_contact\_invalid&#x27;</code> \| <code>&#x27;billing\_contact\_invalid&#x27;</code> \| <code>&#x27;address\_unserviceable&#x27;</code> \| <code>&#x27;coupon\_code\_invalid&#x27;</code> \| <code>&#x27;coupon\_code\_expired&#x27;</code> \| <code>&#x27;unknown&#x27;</code> | The error code for this instance. |
+| contact_field | [<code>ContactFieldType</code>](#ContactFieldType) | The error code for this instance. |
+| message | <code>string</code> \| <code>undefined</code> | TA localized, user-facing string that describes the error. |
+
+<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)
+    * [.onShippingAddressChange([handler])](#BaseWalletButton+onShippingAddressChange)
+    * [.onShippingOptionsChange([handler])](#BaseWalletButton+onShippingOptionsChange)
+    * [.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+onShippingAddressChange" id="BaseWalletButton+onShippingAddressChange" href="#BaseWalletButton+onShippingAddressChange">&nbsp;</a>
+
+### applePayWalletButtonExpress.onShippingAddressChange([handler])
+If shipping address data is updated, the function passed as parameter will be called.
+Use this method to listen for shipping address selection or input from customer when shipping is enabled.
+The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+In addition, if any error occured, an error string must be supplied.
+By default, the event handler will be processed successfuly if neither token nor error is returned.
+
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)  
+**Overrides**: [<code>onShippingAddressChange</code>](#BaseWalletButton+onShippingAddressChange)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnShippingAddressChangeCallback</code>](#OnShippingAddressChangeCallback) | Function to be called when the shipping address data is updated. |
+
+**Example**  
+```js
+button.onShippingAddressChange((data) => {
+    const responseData = await fetch('https://your-server.com/update-shipping-info');
+    return { error: null, token: responseData.walletToken };
+});
+```
+<a name="BaseWalletButton+onShippingOptionsChange" id="BaseWalletButton+onShippingOptionsChange" href="#BaseWalletButton+onShippingOptionsChange">&nbsp;</a>
+
+### applePayWalletButtonExpress.onShippingOptionsChange([handler])
+If shipping options data is updated, the function passed as parameter will be called.
+Use this method to listen for shipping option selection from customer when shipping is enabled.
+The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+In addition, if any error occured, an error string must be supplied.
+By default, the event handler will be processed successfuly if neither token nor error is returned.
+
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)  
+**Overrides**: [<code>onShippingOptionsChange</code>](#BaseWalletButton+onShippingOptionsChange)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnShippingOptionsChangeCallback</code>](#OnShippingOptionsChangeCallback) | Function to be called when the shipping options data is updated. |
+
+**Example**  
+```js
+button.onShippingOptionsChange((data) => {
+    const responseData = await fetch('https://your-server.com/update-shipping-info');
+    return { error: null, token: responseData.walletToken };
+});
+```
+<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)
+    * [.onShippingAddressChange([handler])](#BaseWalletButton+onShippingAddressChange)
+    * [.onShippingOptionsChange([handler])](#BaseWalletButton+onShippingOptionsChange)
+    * [.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+onShippingAddressChange" id="BaseWalletButton+onShippingAddressChange" href="#BaseWalletButton+onShippingAddressChange">&nbsp;</a>
+
+### paypalWalletButtonExpress.onShippingAddressChange([handler])
+If shipping address data is updated, the function passed as parameter will be called.
+Use this method to listen for shipping address selection or input from customer when shipping is enabled.
+The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+In addition, if any error occured, an error string must be supplied.
+By default, the event handler will be processed successfuly if neither token nor error is returned.
+
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)  
+**Overrides**: [<code>onShippingAddressChange</code>](#BaseWalletButton+onShippingAddressChange)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnShippingAddressChangeCallback</code>](#OnShippingAddressChangeCallback) | Function to be called when the shipping address data is updated. |
+
+**Example**  
+```js
+button.onShippingAddressChange((data) => {
+    const responseData = await fetch('https://your-server.com/update-shipping-info');
+    return { error: null, token: responseData.walletToken };
+});
+```
+<a name="BaseWalletButton+onShippingOptionsChange" id="BaseWalletButton+onShippingOptionsChange" href="#BaseWalletButton+onShippingOptionsChange">&nbsp;</a>
+
+### paypalWalletButtonExpress.onShippingOptionsChange([handler])
+If shipping options data is updated, the function passed as parameter will be called.
+Use this method to listen for shipping option selection from customer when shipping is enabled.
+The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+In addition, if any error occured, an error string must be supplied.
+By default, the event handler will be processed successfuly if neither token nor error is returned.
+
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)  
+**Overrides**: [<code>onShippingOptionsChange</code>](#BaseWalletButton+onShippingOptionsChange)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnShippingOptionsChangeCallback</code>](#OnShippingOptionsChangeCallback) | Function to be called when the shipping options data is updated. |
+
+**Example**  
+```js
+button.onShippingOptionsChange((data) => {
+    const responseData = await fetch('https://your-server.com/update-shipping-info');
+    return { error: null, token: responseData.walletToken };
+});
+```
+<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> | 
+| ON_SHIPPING_ADDRESS_CHANGE | <code>string</code> | <code>&quot;onShippingAddressChange&quot;</code> | 
+| ON_SHIPPING_OPTIONS_CHANGE | <code>string</code> | <code>&quot;onShippingOptionsChange&quot;</code> | 
+
+<a name="ContactFieldType" id="ContactFieldType" href="#ContactFieldType">&nbsp;</a>
+
+## ContactFieldType : <code>object</code>
+List of available contact fields for ContactFieldType
+
+**Kind**: global constant  
+
+| Param | Type |
+| --- | --- |
+| phone | <code>string</code> | 
+| email | <code>string</code> | 
+| name | <code>string</code> | 
+| phonetic_name | <code>string</code> | 
+| address_lines | <code>string</code> | 
+| address_city | <code>string</code> | 
+| address_postcode | <code>string</code> | 
+| address_state | <code>string</code> | 
+| address_country | <code>string</code> | 
+| address_country_code | <code>string</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="OnShippingAddressChangeCallback" id="OnShippingAddressChangeCallback" href="#OnShippingAddressChangeCallback">&nbsp;</a>
+
+## OnShippingAddressChangeCallback ⇒ [<code>Promise.&lt;OnShippingAddressChangeEventResponse&gt;</code>](#OnShippingAddressChangeEventResponse)
+Callback for onShippingAddressChange method.
+
+**Kind**: global typedef  
+**Returns**: [<code>Promise.&lt;OnShippingAddressChangeEventResponse&gt;</code>](#OnShippingAddressChangeEventResponse) - Address update result  
+
+| Param | Type |
+| --- | --- |
+| data | [<code>OnShippingAddressChangeEventData</code>](#OnShippingAddressChangeEventData) | 
+
+<a name="OnShippingOptionsChangeCallback" id="OnShippingOptionsChangeCallback" href="#OnShippingOptionsChangeCallback">&nbsp;</a>
+
+## OnShippingOptionsChangeCallback ⇒ [<code>Promise.&lt;OnShippingOptionChangeEventResponse&gt;</code>](#OnShippingOptionChangeEventResponse)
+Callback for onShippingOptionsChange method.
+
+**Kind**: global typedef  
+**Returns**: [<code>Promise.&lt;OnShippingOptionChangeEventResponse&gt;</code>](#OnShippingOptionChangeEventResponse) - Address update result  
+
+| Param | Type |
+| --- | --- |
+| data | [<code>OnShippingOptionChangeEventData</code>](#OnShippingOptionChangeEventData) | 
+
+<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) | 
+