@paydock/client-sdk 1.103.1 → 1.104.1-beta

package/docs/api-checkout-button.md

@@ -0,0 +1,912 @@
+## Classes
+
+<dl>
+<dt><a href="#user-content-cb_CheckoutButton">CheckoutButton</a></dt>
+<dd><p>Class CheckoutButton transform usual button into checkout</p>
+</dd>
+<dt><a href="#user-content-cb_ZipmoneyCheckoutButton">ZipmoneyCheckoutButton</a> ⇐ <code><a href="#user-content-cb_CheckoutButton">CheckoutButton</a></code></dt>
+<dd><p>Class ZipmoneyCheckoutButton is wrapper of CheckoutButton transform usual button into checkout</p>
+</dd>
+<dt><a href="#user-content-cb_PaypalCheckoutButton">PaypalCheckoutButton</a> ⇐ <code><a href="#user-content-cb_CheckoutButton">CheckoutButton</a></code></dt>
+<dd><p>Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button into checkout</p>
+</dd>
+<dt><a href="#user-content-cb_AfterpayCheckoutButton">AfterpayCheckoutButton</a> ⇐ <code><a href="#user-content-cb_CheckoutButton">CheckoutButton</a></code></dt>
+<dd><p>Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button into checkout</p>
+</dd>
+</dl>
+
+## Members
+
+<dl>
+<dt><a href="#user-content-cb_CHECKOUT_MODE">CHECKOUT_MODE</a> : <code>object</code></dt>
+<dd></dd>
+<dt><a href="#user-content-cb_GATEWAY_TYPE">GATEWAY_TYPE</a> : <code>object</code></dt>
+<dd></dd>
+</dl>
+
+## Constants
+
+<dl>
+<dt><a href="#user-content-cb_CHECKOUT_BUTTON_EVENT">CHECKOUT_BUTTON_EVENT</a> : <code>object</code></dt>
+<dd></dd>
+</dl>
+
+## Typedefs
+
+<dl>
+<dt><a href="#user-content-cb_listener">listener</a> : <code>function</code></dt>
+<dd><p>This callback will be called for each event in payment source widget</p>
+</dd>
+</dl>
+
+## Interfaces
+
+<dl>
+<dt><a href="#user-content-cb_IEventCheckoutFinishData">IEventCheckoutFinishData</a></dt>
+<dd></dd>
+<dt><a href="#user-content-cb_IPayPalMeta">IPayPalMeta</a></dt>
+<dd><p>Interface for PayPal checkout meta information</p>
+</dd>
+<dt><a href="#user-content-cb_IZipmoneyMeta">IZipmoneyMeta</a></dt>
+<dd><p>Interface for ZipMoney checkout meta information</p>
+</dd>
+<dt><a href="#user-content-cb_IAfterpayMeta">IAfterpayMeta</a></dt>
+<dd><p>Interface for Afterpay checkout meta information</p>
+</dd>
+</dl>
+
+<a name="cb_IEventCheckoutFinishData" id="cb_IEventCheckoutFinishData" href="#user-content-cb_IEventCheckoutFinishData">&nbsp;</a>
+
+## IEventCheckoutFinishData
+**Kind**: global interface  
+
+| Param | Type |
+| --- | --- |
+| [payment_source_token] | <code>string</code> | 
+
+<a name="cb_IPayPalMeta" id="cb_IPayPalMeta" href="#user-content-cb_IPayPalMeta">&nbsp;</a>
+
+## IPayPalMeta
+Interface for PayPal checkout meta information
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [brand_name] | <code>string</code> | A  label that overrides the business name in the PayPal account on the PayPal hosted checkout pages |
+| [cart_border_color] | <code>string</code> | The HTML hex code for your principal identifying color |
+| [reference] | <code>string</code> | Merchant Customer Service number displayed on the PayPal pages |
+| [email] | <code>string</code> | The consumer’s email |
+| [hdr_img] | <code>string</code> | URL for the image you want to appear at the top left of the payment page |
+| [logo_img] | <code>string</code> | A URL to your logo image |
+| [pay_flow_color] | <code>string</code> | Sets the background color for the payment page. By default, the color is white. |
+| [first_name] | <code>string</code> | The consumer’s given names |
+| [last_name] | <code>string</code> | The consumer’s surname |
+| [address_line] | <code>string</code> | Street address |
+| [address_line2] | <code>string</code> | Second line of the address |
+| [address_city] | <code>string</code> | City |
+| [address_state] | <code>string</code> | State |
+| [address_postcode] | <code>string</code> | Postcode |
+| [address_country] | <code>string</code> | Country |
+| [phone] | <code>string</code> | The consumer’s phone number in E.164 international notation (Example: +12345678901) |
+| [hide_shipping_address] | <code>boolean</code> | Determines whether PayPal displays shipping address fields on the PayPal pages |
+
+<a name="cb_IZipmoneyMeta" id="cb_IZipmoneyMeta" href="#user-content-cb_IZipmoneyMeta">&nbsp;</a>
+
+## IZipmoneyMeta
+Interface for ZipMoney checkout meta information
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| first_name | <code>string</code> | First name for the customer |
+| last_name | <code>string</code> | Last name for the customer |
+| [phone] | <code>string</code> | The consumer’s phone number in E.164 international notation (Example: +12345678901) |
+| [tokenize] | <code>boolean</code> | Controls whether to tokenize the zip pay / zip money account, defaults to ‘false’ |
+| email | <code>string</code> | The consumer’s email |
+| [gender] | <code>string</code> | Gender name for the customer |
+| [date_of_birth] | <code>string</code> | Date of birth name for the customer |
+| charge.amount | <code>number</code> | Amount to be paid |
+| [charge.currency] | <code>string</code> | Currency code |
+| [charge.reference] | <code>string</code> | Reference |
+| charge.items | <code>array</code> | Collections of orders |
+| charge.items[].name | <code>string</code> | Name of the item |
+| charge.items[].amount | <code>number</code> | Amount of the item |
+| charge.items[].quantity | <code>integer</code> | Quantity of the item |
+| [charge.items[].type] | <code>string</code> | type of the item, values can be: ‘sku’, ‘tax’, ‘shipping’, ‘discount’ |
+| [charge.items[].reference] | <code>string</code> | reference of the item |
+| [charge.items[].item_uri] | <code>string</code> | url of the item in your store |
+| [charge.items[].image_url] | <code>string</code> | url of the image in your store |
+| [charge.shipping_type] | <code>string</code> | Shipping type, values can be: ‘pickup’, ‘delivery’, defaults to ‘delivery’ |
+| [charge.shipping_address] | <code>string</code> | Object with shipping address details |
+| [charge.shipping_address.first_name] | <code>string</code> | Shipping first name |
+| [charge.shipping_address.last_name] | <code>string</code> | Shipping last name |
+| charge.shipping_address.line1 | <code>string</code> | Shipping address line 1 |
+| charge.shipping_address.line2 | <code>string</code> | Shipping address line 2 |
+| charge.shipping_address.city | <code>string</code> | Shipping city |
+| charge.shipping_address.state | <code>string</code> | Shipping state |
+| charge.shipping_address.postcode | <code>string</code> | Shipping postcode |
+| charge.shipping_address.country | <code>string</code> | Shipping country |
+| charge.billing_address | <code>string</code> | Object with billing address details |
+| [charge.billing_address.first_name] | <code>string</code> | Billing first name |
+| [charge.billing_address.last_name] | <code>string</code> | Billing last name |
+| charge.billing_address.line1 | <code>string</code> | Billing address line 1 |
+| [charge.billing_address.line2] | <code>string</code> | Billing address line 1 |
+| charge.billing_address.city | <code>string</code> | Billing city |
+| charge.billing_address.state | <code>string</code> | Billing state |
+| charge.billing_address.postcode | <code>string</code> | Billing postcode |
+| charge.billing_address.country | <code>string</code> | Billing country |
+
+<a name="cb_IAfterpayMeta" id="cb_IAfterpayMeta" href="#user-content-cb_IAfterpayMeta">&nbsp;</a>
+
+## IAfterpayMeta
+Interface for Afterpay checkout meta information
+
+**Kind**: global interface  
+
+| Param | Type |
+| --- | --- |
+| [amount] | <code>number</code> | 
+| [currency] | <code>number</code> | 
+| [first_name] | <code>string</code> | 
+| [last_name] | <code>string</code> | 
+| [email] | <code>string</code> | 
+| [address_line] | <code>string</code> | 
+| [address_line2] | <code>string</code> | 
+| [address_city] | <code>string</code> | 
+| [address_state] | <code>string</code> | 
+| [address_postcode] | <code>string</code> | 
+| [address_country] | <code>string</code> | 
+| [phone] | <code>string</code> | 
+
+<a name="cb_CheckoutButton" id="cb_CheckoutButton" href="#user-content-cb_CheckoutButton">&nbsp;</a>
+
+## CheckoutButton
+Class CheckoutButton transform usual button into checkout
+
+**Kind**: global class  
+
+* [CheckoutButton](#user-content-cb_CheckoutButton)
+    * [new CheckoutButton(selector, aceessToken, [gatewayId], [type])](#user-content-cb_new_CheckoutButton_new)
+    * [.on(eventName, cb)](#user-content-cb_CheckoutButton+on)
+    * [.close()](#user-content-cb_CheckoutButton+close)
+    * [.onFinishInsert(selector, dataType)](#user-content-cb_CheckoutButton+onFinishInsert)
+    * [.setMeta(meta)](#user-content-cb_CheckoutButton+setMeta)
+    * [.setBackdropDescription(text)](#user-content-cb_CheckoutButton+setBackdropDescription)
+    * [.setBackdropTitle(string)](#user-content-cb_CheckoutButton+setBackdropTitle)
+    * [.setSuspendedRedirectUri(string)](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)
+    * [.setRedirectUrl(string)](#user-content-cb_CheckoutButton+setRedirectUrl)
+    * [.turnOffBackdrop()](#user-content-cb_CheckoutButton+turnOffBackdrop)
+
+<a name="cb_new_CheckoutButton_new" id="cb_new_CheckoutButton_new" href="#user-content-cb_new_CheckoutButton_new">&nbsp;</a>
+
+### new CheckoutButton(selector, aceessToken, [gatewayId], [type])
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| selector | <code>string</code> |  | Selector of html element. |
+| aceessToken | <code>string</code> |  | PayDock access token or users public key |
+| [gatewayId] | <code>string</code> | <code>&quot;default&quot;</code> | PayDock's gatewayId. By default or if put 'default', it will use the selected default gateway |
+| [type] | <code>string</code> | <code>&quot;PaypalClassic&quot;</code> | Type of gateway (PaypalClassic, Zipmoney) |
+
+**Example**  
+
+```javascript
+var widget = new CheckoutButton('#button', 'accessToken','gatewayId');
+```
+<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" href="#user-content-cb_CheckoutButton+on">&nbsp;</a>
+
+### checkoutButton.on(eventName, cb)
+Listen to events of widget
+
+**Kind**: instance method of [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#user-content-cb_CHECKOUT_BUTTON_EVENT) |
+| cb | [<code>listener</code>](#user-content-cb_listener) |  |
+
+**Example**  
+
+```javascript
+widget.on('click', function () {
+
+});
+```
+<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" href="#user-content-cb_CheckoutButton+close">&nbsp;</a>
+
+### checkoutButton.close()
+Close popup window forcibly.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" href="#user-content-cb_CheckoutButton+onFinishInsert">&nbsp;</a>
+
+### checkoutButton.onFinishInsert(selector, dataType)
+After finish event of checkout button, data (dataType) will be insert to input (selector)
+
+**Kind**: instance method of [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| selector | <code>string</code> | css selector . [] # |
+| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#user-content-cb_IEventCheckoutFinishData). |
+
+<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" href="#user-content-cb_CheckoutButton+setMeta">&nbsp;</a>
+
+### checkoutButton.setMeta(meta)
+Method for setting meta information for checkout page
+
+**Kind**: instance method of [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| meta | [<code>IPayPalMeta</code>](#user-content-cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#user-content-cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#user-content-cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#user-content-cb_IPayPalMeta) [IZipmoneyMeta](#user-content-cb_IZipmoneyMeta) [IAfterpayMeta](#user-content-cb_IAfterpayMeta) |
+
+**Example**  
+
+```javascript
+button.setMeta({
+            brand_name: 'paydock',
+            reference: '15',
+            email: 'wault@paydock.com'
+        });
+```
+<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" href="#user-content-cb_CheckoutButton+setBackdropDescription">&nbsp;</a>
+
+### checkoutButton.setBackdropDescription(text)
+Method for setting backdrop description.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>string</code> | description which can be shown in overlay of back side checkout page |
+
+**Example**  
+
+```javascript
+button.setBackdropDescription('Custom description');
+```
+<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" href="#user-content-cb_CheckoutButton+setBackdropTitle">&nbsp;</a>
+
+### checkoutButton.setBackdropTitle(string)
+Method for setting backdrop title.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>text</code> | title which can be shown in overlay of back side checkout page |
+
+**Example**  
+
+```javascript
+button.setBackdropTitle('Custom title');
+```
+<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri" href="#user-content-cb_CheckoutButton+setSuspendedRedirectUri">&nbsp;</a>
+
+### checkoutButton.setSuspendedRedirectUri(string)
+Method for setting suspended redirect uri. Redirect after referred checkout.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>uri</code> | uri for redirect (by default) |
+
+<a name="cb_CheckoutButton+setRedirectUrl" id="cb_CheckoutButton+setRedirectUrl" href="#user-content-cb_CheckoutButton+setRedirectUrl">&nbsp;</a>
+
+### checkoutButton.setRedirectUrl(string)
+Method for setting the merchant redirect URL.
+Merchant's customers redirect after successfull checkout.
+Only for 'redirect' mode.
+
+**Kind**: instance method of [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>url</code> | redirect url |
+
+<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" href="#user-content-cb_CheckoutButton+turnOffBackdrop">&nbsp;</a>
+
+### checkoutButton.turnOffBackdrop()
+Method for disable backdrop on the page.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+**Example**  
+
+```javascript
+button.turnOffBackdrop();
+```
+<a name="cb_ZipmoneyCheckoutButton" id="cb_ZipmoneyCheckoutButton" href="#user-content-cb_ZipmoneyCheckoutButton">&nbsp;</a>
+
+## ZipmoneyCheckoutButton ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
+Class ZipmoneyCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
+
+**Kind**: global class  
+**Extends**: [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+* [ZipmoneyCheckoutButton](#user-content-cb_ZipmoneyCheckoutButton) ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
+    * [new ZipmoneyCheckoutButton(selector, publicKey, [gatewayId], [gatewayId])](#user-content-cb_new_ZipmoneyCheckoutButton_new)
+    * [.setSuspendedRedirectUri(string)](#user-content-cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri)
+    * [.setRedirectUrl(string)](#user-content-cb_ZipmoneyCheckoutButton+setRedirectUrl)
+    * [.on(eventName, cb)](#user-content-cb_CheckoutButton+on)
+    * [.close()](#user-content-cb_CheckoutButton+close)
+    * [.onFinishInsert(selector, dataType)](#user-content-cb_CheckoutButton+onFinishInsert)
+    * [.setMeta(meta)](#user-content-cb_CheckoutButton+setMeta)
+    * [.setBackdropDescription(text)](#user-content-cb_CheckoutButton+setBackdropDescription)
+    * [.setBackdropTitle(string)](#user-content-cb_CheckoutButton+setBackdropTitle)
+    * [.turnOffBackdrop()](#user-content-cb_CheckoutButton+turnOffBackdrop)
+
+<a name="cb_new_ZipmoneyCheckoutButton_new" id="cb_new_ZipmoneyCheckoutButton_new" href="#user-content-cb_new_ZipmoneyCheckoutButton_new">&nbsp;</a>
+
+### new ZipmoneyCheckoutButton(selector, publicKey, [gatewayId], [gatewayId])
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| selector | <code>string</code> |  | Selector of html element. |
+| publicKey | <code>string</code> |  | PayDock users public key |
+| [gatewayId] | <code>string</code> | <code>&quot;default&quot;</code> | PayDock's gatewayId. By default or if put 'default', it will use the selected default gateway |
+| [gatewayId] | <code>string</code> | <code>&quot;default&quot;</code> | Checkout mode, it could be set to 'contextual' or 'redirect'. By default it 'contextual' |
+
+**Example**  
+
+```javascript
+var widget = new ZipmoneyCheckoutButton('#button', 'publicKey','gatewayId');
+```
+<a name="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri" id="cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri" href="#user-content-cb_ZipmoneyCheckoutButton+setSuspendedRedirectUri">&nbsp;</a>
+
+### zipmoneyCheckoutButton.setSuspendedRedirectUri(string)
+Method for setting suspended redirect uri. Redirect after referred checkout
+
+The URI is used for a redirect after the checkout is complete.
+This can be provided, even if using in-context checkout (sdk). By default, the standard styled page will be used.
+If using in-context (sdk) we will not automatically redirect to this URI.
+
+**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#user-content-cb_ZipmoneyCheckoutButton)  
+**Overrides**: [<code>setSuspendedRedirectUri</code>](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>uri</code> | uri for suspended redirect (by default) |
+
+<a name="cb_ZipmoneyCheckoutButton+setRedirectUrl" id="cb_ZipmoneyCheckoutButton+setRedirectUrl" href="#user-content-cb_ZipmoneyCheckoutButton+setRedirectUrl">&nbsp;</a>
+
+### zipmoneyCheckoutButton.setRedirectUrl(string)
+Method for setting the merchant redirect URL.
+The merchant's customers would be redirected to the specified URL
+at the end of ZipMoney checkout flow.
+
+Once the redirect URL would be set, the checkout flow would be immediately switched
+from 'contextual' mode to the 'redirect' mode.
+The merchant's customer would be automatically redirected to this URL after the checkout is complete.
+
+**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#user-content-cb_ZipmoneyCheckoutButton)  
+**Overrides**: [<code>setRedirectUrl</code>](#user-content-cb_CheckoutButton+setRedirectUrl)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>url</code> | URL for redirect |
+
+<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" href="#user-content-cb_CheckoutButton+on">&nbsp;</a>
+
+### zipmoneyCheckoutButton.on(eventName, cb)
+Listen to events of widget
+
+**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#user-content-cb_ZipmoneyCheckoutButton)  
+**Overrides**: [<code>on</code>](#user-content-cb_CheckoutButton+on)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#user-content-cb_CHECKOUT_BUTTON_EVENT) |
+| cb | [<code>listener</code>](#user-content-cb_listener) |  |
+
+**Example**  
+
+```javascript
+widget.on('click', function () {
+
+});
+```
+<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" href="#user-content-cb_CheckoutButton+close">&nbsp;</a>
+
+### zipmoneyCheckoutButton.close()
+Close popup window forcibly.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#user-content-cb_ZipmoneyCheckoutButton)  
+**Overrides**: [<code>close</code>](#user-content-cb_CheckoutButton+close)  
+<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" href="#user-content-cb_CheckoutButton+onFinishInsert">&nbsp;</a>
+
+### zipmoneyCheckoutButton.onFinishInsert(selector, dataType)
+After finish event of checkout button, data (dataType) will be insert to input (selector)
+
+**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#user-content-cb_ZipmoneyCheckoutButton)  
+**Overrides**: [<code>onFinishInsert</code>](#user-content-cb_CheckoutButton+onFinishInsert)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| selector | <code>string</code> | css selector . [] # |
+| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#user-content-cb_IEventCheckoutFinishData). |
+
+<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" href="#user-content-cb_CheckoutButton+setMeta">&nbsp;</a>
+
+### zipmoneyCheckoutButton.setMeta(meta)
+Method for setting meta information for checkout page
+
+**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#user-content-cb_ZipmoneyCheckoutButton)  
+**Overrides**: [<code>setMeta</code>](#user-content-cb_CheckoutButton+setMeta)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| meta | [<code>IPayPalMeta</code>](#user-content-cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#user-content-cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#user-content-cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#user-content-cb_IPayPalMeta) [IZipmoneyMeta](#user-content-cb_IZipmoneyMeta) [IAfterpayMeta](#user-content-cb_IAfterpayMeta) |
+
+**Example**  
+
+```javascript
+button.setMeta({
+            brand_name: 'paydock',
+            reference: '15',
+            email: 'wault@paydock.com'
+        });
+```
+<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" href="#user-content-cb_CheckoutButton+setBackdropDescription">&nbsp;</a>
+
+### zipmoneyCheckoutButton.setBackdropDescription(text)
+Method for setting backdrop description.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#user-content-cb_ZipmoneyCheckoutButton)  
+**Overrides**: [<code>setBackdropDescription</code>](#user-content-cb_CheckoutButton+setBackdropDescription)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>string</code> | description which can be shown in overlay of back side checkout page |
+
+**Example**  
+
+```javascript
+button.setBackdropDescription('Custom description');
+```
+<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" href="#user-content-cb_CheckoutButton+setBackdropTitle">&nbsp;</a>
+
+### zipmoneyCheckoutButton.setBackdropTitle(string)
+Method for setting backdrop title.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#user-content-cb_ZipmoneyCheckoutButton)  
+**Overrides**: [<code>setBackdropTitle</code>](#user-content-cb_CheckoutButton+setBackdropTitle)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>text</code> | title which can be shown in overlay of back side checkout page |
+
+**Example**  
+
+```javascript
+button.setBackdropTitle('Custom title');
+```
+<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" href="#user-content-cb_CheckoutButton+turnOffBackdrop">&nbsp;</a>
+
+### zipmoneyCheckoutButton.turnOffBackdrop()
+Method for disable backdrop on the page.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>ZipmoneyCheckoutButton</code>](#user-content-cb_ZipmoneyCheckoutButton)  
+**Overrides**: [<code>turnOffBackdrop</code>](#user-content-cb_CheckoutButton+turnOffBackdrop)  
+**Example**  
+
+```javascript
+button.turnOffBackdrop();
+```
+<a name="cb_PaypalCheckoutButton" id="cb_PaypalCheckoutButton" href="#user-content-cb_PaypalCheckoutButton">&nbsp;</a>
+
+## PaypalCheckoutButton ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
+Class PaypalCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
+
+**Kind**: global class  
+**Extends**: [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+* [PaypalCheckoutButton](#user-content-cb_PaypalCheckoutButton) ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
+    * [new PaypalCheckoutButton(selector, publicKey, [gatewayId])](#user-content-cb_new_PaypalCheckoutButton_new)
+    * [.on(eventName, cb)](#user-content-cb_CheckoutButton+on)
+    * [.close()](#user-content-cb_CheckoutButton+close)
+    * [.onFinishInsert(selector, dataType)](#user-content-cb_CheckoutButton+onFinishInsert)
+    * [.setMeta(meta)](#user-content-cb_CheckoutButton+setMeta)
+    * [.setBackdropDescription(text)](#user-content-cb_CheckoutButton+setBackdropDescription)
+    * [.setBackdropTitle(string)](#user-content-cb_CheckoutButton+setBackdropTitle)
+    * [.setSuspendedRedirectUri(string)](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)
+    * [.setRedirectUrl(string)](#user-content-cb_CheckoutButton+setRedirectUrl)
+    * [.turnOffBackdrop()](#user-content-cb_CheckoutButton+turnOffBackdrop)
+
+<a name="cb_new_PaypalCheckoutButton_new" id="cb_new_PaypalCheckoutButton_new" href="#user-content-cb_new_PaypalCheckoutButton_new">&nbsp;</a>
+
+### new PaypalCheckoutButton(selector, publicKey, [gatewayId])
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| selector | <code>string</code> |  | Selector of html element. |
+| publicKey | <code>string</code> |  | PayDock users public key |
+| [gatewayId] | <code>string</code> | <code>&quot;default&quot;</code> | PayDock's gatewayId. By default or if put 'default', it will use the selected default gateway |
+
+**Example**  
+
+```javascript
+var widget = new PaypalCheckoutButton('#button', 'publicKey','gatewayId');
+```
+<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" href="#user-content-cb_CheckoutButton+on">&nbsp;</a>
+
+### paypalCheckoutButton.on(eventName, cb)
+Listen to events of widget
+
+**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
+**Overrides**: [<code>on</code>](#user-content-cb_CheckoutButton+on)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#user-content-cb_CHECKOUT_BUTTON_EVENT) |
+| cb | [<code>listener</code>](#user-content-cb_listener) |  |
+
+**Example**  
+
+```javascript
+widget.on('click', function () {
+
+});
+```
+<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" href="#user-content-cb_CheckoutButton+close">&nbsp;</a>
+
+### paypalCheckoutButton.close()
+Close popup window forcibly.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
+**Overrides**: [<code>close</code>](#user-content-cb_CheckoutButton+close)  
+<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" href="#user-content-cb_CheckoutButton+onFinishInsert">&nbsp;</a>
+
+### paypalCheckoutButton.onFinishInsert(selector, dataType)
+After finish event of checkout button, data (dataType) will be insert to input (selector)
+
+**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
+**Overrides**: [<code>onFinishInsert</code>](#user-content-cb_CheckoutButton+onFinishInsert)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| selector | <code>string</code> | css selector . [] # |
+| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#user-content-cb_IEventCheckoutFinishData). |
+
+<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" href="#user-content-cb_CheckoutButton+setMeta">&nbsp;</a>
+
+### paypalCheckoutButton.setMeta(meta)
+Method for setting meta information for checkout page
+
+**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
+**Overrides**: [<code>setMeta</code>](#user-content-cb_CheckoutButton+setMeta)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| meta | [<code>IPayPalMeta</code>](#user-content-cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#user-content-cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#user-content-cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#user-content-cb_IPayPalMeta) [IZipmoneyMeta](#user-content-cb_IZipmoneyMeta) [IAfterpayMeta](#user-content-cb_IAfterpayMeta) |
+
+**Example**  
+
+```javascript
+button.setMeta({
+            brand_name: 'paydock',
+            reference: '15',
+            email: 'wault@paydock.com'
+        });
+```
+<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" href="#user-content-cb_CheckoutButton+setBackdropDescription">&nbsp;</a>
+
+### paypalCheckoutButton.setBackdropDescription(text)
+Method for setting backdrop description.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
+**Overrides**: [<code>setBackdropDescription</code>](#user-content-cb_CheckoutButton+setBackdropDescription)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>string</code> | description which can be shown in overlay of back side checkout page |
+
+**Example**  
+
+```javascript
+button.setBackdropDescription('Custom description');
+```
+<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" href="#user-content-cb_CheckoutButton+setBackdropTitle">&nbsp;</a>
+
+### paypalCheckoutButton.setBackdropTitle(string)
+Method for setting backdrop title.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
+**Overrides**: [<code>setBackdropTitle</code>](#user-content-cb_CheckoutButton+setBackdropTitle)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>text</code> | title which can be shown in overlay of back side checkout page |
+
+**Example**  
+
+```javascript
+button.setBackdropTitle('Custom title');
+```
+<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri" href="#user-content-cb_CheckoutButton+setSuspendedRedirectUri">&nbsp;</a>
+
+### paypalCheckoutButton.setSuspendedRedirectUri(string)
+Method for setting suspended redirect uri. Redirect after referred checkout.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
+**Overrides**: [<code>setSuspendedRedirectUri</code>](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>uri</code> | uri for redirect (by default) |
+
+<a name="cb_CheckoutButton+setRedirectUrl" id="cb_CheckoutButton+setRedirectUrl" href="#user-content-cb_CheckoutButton+setRedirectUrl">&nbsp;</a>
+
+### paypalCheckoutButton.setRedirectUrl(string)
+Method for setting the merchant redirect URL.
+Merchant's customers redirect after successfull checkout.
+Only for 'redirect' mode.
+
+**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
+**Overrides**: [<code>setRedirectUrl</code>](#user-content-cb_CheckoutButton+setRedirectUrl)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>url</code> | redirect url |
+
+<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" href="#user-content-cb_CheckoutButton+turnOffBackdrop">&nbsp;</a>
+
+### paypalCheckoutButton.turnOffBackdrop()
+Method for disable backdrop on the page.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>PaypalCheckoutButton</code>](#user-content-cb_PaypalCheckoutButton)  
+**Overrides**: [<code>turnOffBackdrop</code>](#user-content-cb_CheckoutButton+turnOffBackdrop)  
+**Example**  
+
+```javascript
+button.turnOffBackdrop();
+```
+<a name="cb_AfterpayCheckoutButton" id="cb_AfterpayCheckoutButton" href="#user-content-cb_AfterpayCheckoutButton">&nbsp;</a>
+
+## AfterpayCheckoutButton ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
+Class AfterpayCheckoutButton is wrapper of CheckoutButton transform usual button into checkout
+
+**Kind**: global class  
+**Extends**: [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)  
+
+* [AfterpayCheckoutButton](#user-content-cb_AfterpayCheckoutButton) ⇐ [<code>CheckoutButton</code>](#user-content-cb_CheckoutButton)
+    * [new AfterpayCheckoutButton(selector, accessToken, [gatewayId])](#user-content-cb_new_AfterpayCheckoutButton_new)
+    * [.showEnhancedTrackingProtectionPopup(boolean)](#user-content-cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup)
+    * [.on(eventName, cb)](#user-content-cb_CheckoutButton+on)
+    * [.close()](#user-content-cb_CheckoutButton+close)
+    * [.onFinishInsert(selector, dataType)](#user-content-cb_CheckoutButton+onFinishInsert)
+    * [.setMeta(meta)](#user-content-cb_CheckoutButton+setMeta)
+    * [.setBackdropDescription(text)](#user-content-cb_CheckoutButton+setBackdropDescription)
+    * [.setBackdropTitle(string)](#user-content-cb_CheckoutButton+setBackdropTitle)
+    * [.setSuspendedRedirectUri(string)](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)
+    * [.setRedirectUrl(string)](#user-content-cb_CheckoutButton+setRedirectUrl)
+    * [.turnOffBackdrop()](#user-content-cb_CheckoutButton+turnOffBackdrop)
+
+<a name="cb_new_AfterpayCheckoutButton_new" id="cb_new_AfterpayCheckoutButton_new" href="#user-content-cb_new_AfterpayCheckoutButton_new">&nbsp;</a>
+
+### new AfterpayCheckoutButton(selector, accessToken, [gatewayId])
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| selector | <code>string</code> |  | Selector of html element. |
+| accessToken | <code>string</code> |  | PayDock access-token or users public key |
+| [gatewayId] | <code>string</code> | <code>&quot;default&quot;</code> | PayDock's gatewayId. By default or if put 'default', it will use the selected default gateway |
+
+**Example**  
+
+```javascript
+var widget = new AfterpayCheckoutButton('#button', 'access-token','gatewayId');
+```
+<a name="cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup" id="cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup" href="#user-content-cb_AfterpayCheckoutButton+showEnhancedTrackingProtectionPopup">&nbsp;</a>
+
+### afterpayCheckoutButton.showEnhancedTrackingProtectionPopup(boolean)
+Method which toggles the "Enhanced Tracking Protection" warning popup to 'on' mode.
+
+This popup with a warning about "Enhanced Tracking Protection" limitations
+would be shown in the Mozilla Firefox browser version 100+
+
+By default, the popup would not be shown, until
+the flag would be set to `true`
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| boolean | <code>doShow</code> | flag which toggle the popup visibility |
+
+<a name="cb_CheckoutButton+on" id="cb_CheckoutButton+on" href="#user-content-cb_CheckoutButton+on">&nbsp;</a>
+
+### afterpayCheckoutButton.on(eventName, cb)
+Listen to events of widget
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+**Overrides**: [<code>on</code>](#user-content-cb_CheckoutButton+on)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| eventName | <code>string</code> | Available event names [CHECKOUT_BUTTON_EVENT](#user-content-cb_CHECKOUT_BUTTON_EVENT) |
+| cb | [<code>listener</code>](#user-content-cb_listener) |  |
+
+**Example**  
+
+```javascript
+widget.on('click', function () {
+
+});
+```
+<a name="cb_CheckoutButton+close" id="cb_CheckoutButton+close" href="#user-content-cb_CheckoutButton+close">&nbsp;</a>
+
+### afterpayCheckoutButton.close()
+Close popup window forcibly.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+**Overrides**: [<code>close</code>](#user-content-cb_CheckoutButton+close)  
+<a name="cb_CheckoutButton+onFinishInsert" id="cb_CheckoutButton+onFinishInsert" href="#user-content-cb_CheckoutButton+onFinishInsert">&nbsp;</a>
+
+### afterpayCheckoutButton.onFinishInsert(selector, dataType)
+After finish event of checkout button, data (dataType) will be insert to input (selector)
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+**Overrides**: [<code>onFinishInsert</code>](#user-content-cb_CheckoutButton+onFinishInsert)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| selector | <code>string</code> | css selector . [] # |
+| dataType | <code>string</code> | data type of IEventCheckoutFinishData [IEventCheckoutFinishData](#user-content-cb_IEventCheckoutFinishData). |
+
+<a name="cb_CheckoutButton+setMeta" id="cb_CheckoutButton+setMeta" href="#user-content-cb_CheckoutButton+setMeta">&nbsp;</a>
+
+### afterpayCheckoutButton.setMeta(meta)
+Method for setting meta information for checkout page
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+**Overrides**: [<code>setMeta</code>](#user-content-cb_CheckoutButton+setMeta)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| meta | [<code>IPayPalMeta</code>](#user-content-cb_IPayPalMeta) \| [<code>IAfterpayMeta</code>](#user-content-cb_IAfterpayMeta) \| [<code>IZipmoneyMeta</code>](#user-content-cb_IZipmoneyMeta) | Data which can be shown on checkout page [IPayPalMeta](#user-content-cb_IPayPalMeta) [IZipmoneyMeta](#user-content-cb_IZipmoneyMeta) [IAfterpayMeta](#user-content-cb_IAfterpayMeta) |
+
+**Example**  
+
+```javascript
+button.setMeta({
+            brand_name: 'paydock',
+            reference: '15',
+            email: 'wault@paydock.com'
+        });
+```
+<a name="cb_CheckoutButton+setBackdropDescription" id="cb_CheckoutButton+setBackdropDescription" href="#user-content-cb_CheckoutButton+setBackdropDescription">&nbsp;</a>
+
+### afterpayCheckoutButton.setBackdropDescription(text)
+Method for setting backdrop description.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+**Overrides**: [<code>setBackdropDescription</code>](#user-content-cb_CheckoutButton+setBackdropDescription)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| text | <code>string</code> | description which can be shown in overlay of back side checkout page |
+
+**Example**  
+
+```javascript
+button.setBackdropDescription('Custom description');
+```
+<a name="cb_CheckoutButton+setBackdropTitle" id="cb_CheckoutButton+setBackdropTitle" href="#user-content-cb_CheckoutButton+setBackdropTitle">&nbsp;</a>
+
+### afterpayCheckoutButton.setBackdropTitle(string)
+Method for setting backdrop title.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+**Overrides**: [<code>setBackdropTitle</code>](#user-content-cb_CheckoutButton+setBackdropTitle)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>text</code> | title which can be shown in overlay of back side checkout page |
+
+**Example**  
+
+```javascript
+button.setBackdropTitle('Custom title');
+```
+<a name="cb_CheckoutButton+setSuspendedRedirectUri" id="cb_CheckoutButton+setSuspendedRedirectUri" href="#user-content-cb_CheckoutButton+setSuspendedRedirectUri">&nbsp;</a>
+
+### afterpayCheckoutButton.setSuspendedRedirectUri(string)
+Method for setting suspended redirect uri. Redirect after referred checkout.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+**Overrides**: [<code>setSuspendedRedirectUri</code>](#user-content-cb_CheckoutButton+setSuspendedRedirectUri)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>uri</code> | uri for redirect (by default) |
+
+<a name="cb_CheckoutButton+setRedirectUrl" id="cb_CheckoutButton+setRedirectUrl" href="#user-content-cb_CheckoutButton+setRedirectUrl">&nbsp;</a>
+
+### afterpayCheckoutButton.setRedirectUrl(string)
+Method for setting the merchant redirect URL.
+Merchant's customers redirect after successfull checkout.
+Only for 'redirect' mode.
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+**Overrides**: [<code>setRedirectUrl</code>](#user-content-cb_CheckoutButton+setRedirectUrl)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| string | <code>url</code> | redirect url |
+
+<a name="cb_CheckoutButton+turnOffBackdrop" id="cb_CheckoutButton+turnOffBackdrop" href="#user-content-cb_CheckoutButton+turnOffBackdrop">&nbsp;</a>
+
+### afterpayCheckoutButton.turnOffBackdrop()
+Method for disable backdrop on the page.
+Only for 'contextual' mode.
+
+**Kind**: instance method of [<code>AfterpayCheckoutButton</code>](#user-content-cb_AfterpayCheckoutButton)  
+**Overrides**: [<code>turnOffBackdrop</code>](#user-content-cb_CheckoutButton+turnOffBackdrop)  
+**Example**  
+
+```javascript
+button.turnOffBackdrop();
+```
+<a name="cb_CHECKOUT_MODE" id="cb_CHECKOUT_MODE" href="#user-content-cb_CHECKOUT_MODE">&nbsp;</a>
+
+## CHECKOUT\_MODE : <code>object</code>
+**Kind**: global variable  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| CONTEXTUAL | <code>string</code> | <code>&quot;contextual&quot;</code> | 
+| REDIRECT | <code>string</code> | <code>&quot;redirect&quot;</code> | 
+
+<a name="cb_GATEWAY_TYPE" id="cb_GATEWAY_TYPE" href="#user-content-cb_GATEWAY_TYPE">&nbsp;</a>
+
+## GATEWAY\_TYPE : <code>object</code>
+**Kind**: global variable  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| ZIPMONEY | <code>string</code> | <code>&quot;Zipmoney&quot;</code> | 
+| PAYPAL | <code>string</code> | <code>&quot;PaypalClassic&quot;</code> | 
+| AFTERPAY | <code>string</code> | <code>&quot;Afterpay&quot;</code> | 
+
+<a name="cb_CHECKOUT_BUTTON_EVENT" id="cb_CHECKOUT_BUTTON_EVENT" href="#user-content-cb_CHECKOUT_BUTTON_EVENT">&nbsp;</a>
+
+## CHECKOUT\_BUTTON\_EVENT : <code>object</code>
+**Kind**: global constant  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| CLICK | <code>string</code> | <code>&quot;click&quot;</code> | 
+| POPUP_REDIRECT | <code>string</code> | <code>&quot;popup_redirect&quot;</code> | 
+| ERROR | <code>string</code> | <code>&quot;error&quot;</code> | 
+| ACCEPTED | <code>string</code> | <code>&quot;accepted&quot;</code> | 
+| FINISH | <code>string</code> | <code>&quot;finish&quot;</code> | 
+| CLOSE | <code>string</code> | <code>&quot;close&quot;</code> | 
+
+<a name="cb_listener" id="cb_listener" href="#user-content-cb_listener">&nbsp;</a>
+
+## listener : <code>function</code>
+This callback will be called for each event in payment source widget
+
+**Kind**: global typedef