@paydock/client-sdk 1.144.1-beta → 1.147.0

package/docs/open-wallet-buttons.md

@@ -100,6 +100,37 @@ Apple will determine if the device has an ApplePay wallet available and at least
 <dt><a href="#GooglePayOpenWalletMeta">GooglePayOpenWalletMeta</a> : <code>object</code></dt>
 <dd><p>Interface for Google Pay-specific metadata.</p>
 </dd>
+<dt><a href="#OpenWalletAvailabilityOptions">OpenWalletAvailabilityOptions</a> : <code>object</code></dt>
+<dd><p>Base options shared by every wallet&#39;s static availability check
+(e.g. <a href="#ApplePayOpenWalletButton">ApplePayOpenWalletButton</a>.checkAvailability). Wallet-specific option
+interfaces (such as <a href="#ApplePayAvailabilityOptions">ApplePayAvailabilityOptions</a>) extend this.</p>
+</dd>
+<dt><a href="#OpenWalletAvailabilityResult">OpenWalletAvailabilityResult</a> : <code>object</code></dt>
+<dd><p>Base result shared by every wallet&#39;s static availability check. Wallet-specific
+result interfaces (such as <a href="#ApplePayAvailabilityResult">ApplePayAvailabilityResult</a>) extend this.</p>
+</dd>
+<dt><a href="#ApplePayAvailabilityOptions">ApplePayAvailabilityOptions</a> : <code>object</code></dt>
+<dd><p>Options for <code>ApplePayOpenWalletButton.checkAvailability</code>. Extends
+<a href="#OpenWalletAvailabilityOptions">OpenWalletAvailabilityOptions</a>. Provide <code>merchant_id</code> directly to skip the network
+call, <strong>or</strong> provide <code>public_key_or_access_token</code> + <code>service_id</code> to resolve the merchant
+identifier from the service configuration.</p>
+</dd>
+<dt><a href="#ApplePayAvailabilityResult">ApplePayAvailabilityResult</a> : <code>object</code></dt>
+<dd><p>Result of <code>ApplePayOpenWalletButton.checkAvailability</code>. Extends
+<a href="#OpenWalletAvailabilityResult">OpenWalletAvailabilityResult</a>.</p>
+<p>Infer the transport (Apple does not expose it directly): <code>available &amp;&amp; has_native_session</code>
+⇒ native sheet likely; <code>available &amp;&amp; !has_native_session</code> ⇒ cross-device / QR handoff likely.</p>
+</dd>
+<dt><a href="#GooglePayAvailabilityOptions">GooglePayAvailabilityOptions</a> : <code>object</code></dt>
+<dd><p>Options for <code>GooglePayOpenWalletButton.checkAvailability</code>. Extends
+<a href="#OpenWalletAvailabilityOptions">OpenWalletAvailabilityOptions</a>. All fields are optional — Google Pay&#39;s
+<code>isReadyToPay</code> check does not require a merchant identifier. Supplying
+<code>public_key_or_access_token</code> + <code>service_id</code> additionally validates the service type.</p>
+</dd>
+<dt><a href="#GooglePayAvailabilityResult">GooglePayAvailabilityResult</a> : <code>object</code></dt>
+<dd><p>Result of <code>GooglePayOpenWalletButton.checkAvailability</code>. Extends
+<a href="#OpenWalletAvailabilityResult">OpenWalletAvailabilityResult</a>.</p>
+</dd>
 <dt><a href="#OnClickEventData">OnClickEventData</a> : <code>object</code></dt>
 <dd><p>Interface for OnClickEventData.
 Emitted when the wallet button is clicked.</p>
@@ -187,7 +218,7 @@ Apple will determine if the device has an ApplePay wallet available and at least
 | [shipping_options] | [<code>Array.&lt;IApplePayShippingOption&gt;</code>](#IApplePayShippingOption) | Array of available shipping options. The first item is used as the default selected option. Requires `request_shipping` to be `true`. |
 | [show_billing_address] | <code>boolean</code> | Show billing address fields in the Apple Pay sheet. |
 | store_name | <code>string</code> | The merchant's store name displayed during payment. |
-| [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 the wallet button to be available. |
+| [apple_pay_capabilities] | <code>Array.&lt;(&#x27;credentials\_available&#x27;\|&#x27;credentials\_status\_unknown&#x27;\|&#x27;credentials\_unavailable&#x27;)&gt;</code> | Device credential statuses that make the button render. Defaults to `['credentials_available', 'credentials_status_unknown']`: `credentials_available` means the device has a confirmed Apple Pay card ready to use; `credentials_status_unknown` means a local card can't be confirmed but Apple Pay can still proceed (e.g. the cross-device QR flow used by Chrome, Edge and Firefox). Narrow to `['credentials_available']` to require a confirmed local card. |
 | [merchant_capabilities] | <code>Array.&lt;(&#x27;supports3DS&#x27;\|&#x27;supportsEMV&#x27;\|&#x27;supportsCredit&#x27;\|&#x27;supportsDebit&#x27;)&gt;</code> | Array of merchant capabilities 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 for Apple Pay 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. Phone and email are currently not returned by Apple. |
@@ -221,6 +252,105 @@ Interface for Google Pay-specific metadata.
 | [style.button_color] | <code>GooglePayButtonColor</code> | The color of the Google Pay button (`'default'`, `'black'`, `'white'`). |
 | [style.button_size_mode] | <code>GooglePayButtonSizeMode</code> | The size mode (`'static'`, `'fill'`). |
 
+<a name="OpenWalletAvailabilityOptions" id="OpenWalletAvailabilityOptions" href="#OpenWalletAvailabilityOptions">&nbsp;</a>
+
+## OpenWalletAvailabilityOptions : <code>object</code>
+Base options shared by every wallet's static availability check
+(e.g. [ApplePayOpenWalletButton](#ApplePayOpenWalletButton).checkAvailability). Wallet-specific option
+interfaces (such as [ApplePayAvailabilityOptions](#ApplePayAvailabilityOptions)) extend this.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [public_key_or_access_token] | <code>string</code> | Public key or access token used to fetch the service config when needed. |
+| [service_id] | <code>string</code> | Service ID — used with `public_key_or_access_token` to resolve the wallet configuration. |
+| [env] | <code>string</code> | Environment for the config fetch (e.g. `'sandbox'`). Defaults to the SDK default. |
+| [sync] | <code>boolean</code> | When `true`, performs only the cheap, network-free synchronous check and resolves immediately — no config fetch, SDK load, or remote capability query. |
+
+<a name="OpenWalletAvailabilityResult" id="OpenWalletAvailabilityResult" href="#OpenWalletAvailabilityResult">&nbsp;</a>
+
+## OpenWalletAvailabilityResult : <code>object</code>
+Base result shared by every wallet's static availability check. Wallet-specific
+result interfaces (such as [ApplePayAvailabilityResult](#ApplePayAvailabilityResult)) extend this.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| available | <code>boolean</code> | Convenience verdict: the wallet is usable for a payment in the current context. |
+| supported | <code>boolean</code> | Whether the wallet is supported here at all (may be available via a fallback flow). |
+| [reason] | <code>string</code> | Machine-readable reason when not available. |
+
+<a name="ApplePayAvailabilityOptions" id="ApplePayAvailabilityOptions" href="#ApplePayAvailabilityOptions">&nbsp;</a>
+
+## ApplePayAvailabilityOptions : <code>object</code>
+Options for `ApplePayOpenWalletButton.checkAvailability`. Extends
+[OpenWalletAvailabilityOptions](#OpenWalletAvailabilityOptions). Provide `merchant_id` directly to skip the network
+call, **or** provide `public_key_or_access_token` + `service_id` to resolve the merchant
+identifier from the service configuration.
+
+**Kind**: global interface  
+**Extends**: [<code>OpenWalletAvailabilityOptions</code>](#OpenWalletAvailabilityOptions)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [merchant_id] | <code>string</code> | Apple merchant identifier. Provide this OR (`public_key_or_access_token` + `service_id`). |
+| [apple_pay_capabilities] | <code>Array.&lt;(&#x27;credentials\_available&#x27;\|&#x27;credentials\_status\_unknown&#x27;\|&#x27;credentials\_unavailable&#x27;)&gt;</code> | Device credential statuses that count as available. Defaults to `['credentials_available', 'credentials_status_unknown']` — `credentials_status_unknown` is what third-party / cross-device (QR) browsers report, so the default keeps Apple Pay visible outside Safari. |
+| [sync] | <code>boolean</code> | When `true`, runs only the synchronous native same-device check (`window.ApplePaySession` + `canMakePayments()`) and resolves immediately — no merchant resolution, SDK load, or `applePayCapabilities()` query. In this mode `available` reflects the native session only and `payment_credential_status` is `undefined`; it is **not** authoritative for cross-browser / QR availability. |
+
+<a name="ApplePayAvailabilityResult" id="ApplePayAvailabilityResult" href="#ApplePayAvailabilityResult">&nbsp;</a>
+
+## ApplePayAvailabilityResult : <code>object</code>
+Result of `ApplePayOpenWalletButton.checkAvailability`. Extends
+[OpenWalletAvailabilityResult](#OpenWalletAvailabilityResult).
+
+Infer the transport (Apple does not expose it directly): `available && has_native_session`
+⇒ native sheet likely; `available && !has_native_session` ⇒ cross-device / QR handoff likely.
+
+**Kind**: global interface  
+**Extends**: [<code>OpenWalletAvailabilityResult</code>](#OpenWalletAvailabilityResult)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| available | <code>boolean</code> | Whether the device credential status is within the allowed capability set. |
+| supported | <code>boolean</code> | Whether Apple Pay is usable here at all (incl. the cross-device QR flow). Derived from `payment_credential_status` (anything other than `applePayUnsupported`); falls back to the native `canMakePayments()` signal when the capabilities query could not run. |
+| has_native_session | <code>boolean</code> | Whether a native, same-device Apple Pay session is present right now (`ApplePaySession` exists and `canMakePayments()` is `true`). |
+| [payment_credential_status] | <code>&#x27;paymentCredentialsAvailable&#x27;</code> \| <code>&#x27;paymentCredentialStatusUnknown&#x27;</code> \| <code>&#x27;paymentCredentialsUnavailable&#x27;</code> \| <code>&#x27;applePayUnsupported&#x27;</code> | The raw device-reported credential status. Undefined when unsupported or not queried. |
+| [reason] | <code>string</code> | Machine-readable reason when not available: `'unsupported_browser'`, `'missing_merchant_id'`, `'service_type_mismatch'`, `'config_fetch_failed'`, `'sdk_load_failed'`, `'query_failed'`, `'no_credentials'`, or `'no_native_session'` (only from the synchronous `sync: true` check). |
+
+<a name="GooglePayAvailabilityOptions" id="GooglePayAvailabilityOptions" href="#GooglePayAvailabilityOptions">&nbsp;</a>
+
+## GooglePayAvailabilityOptions : <code>object</code>
+Options for `GooglePayOpenWalletButton.checkAvailability`. Extends
+[OpenWalletAvailabilityOptions](#OpenWalletAvailabilityOptions). All fields are optional — Google Pay's
+`isReadyToPay` check does not require a merchant identifier. Supplying
+`public_key_or_access_token` + `service_id` additionally validates the service type.
+
+**Kind**: global interface  
+**Extends**: [<code>OpenWalletAvailabilityOptions</code>](#OpenWalletAvailabilityOptions)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [merchant_id] | <code>string</code> | Google Pay gateway merchant identifier. Optional; the readiness check runs without it. |
+| [sync] | <code>boolean</code> | When `true`, reports only whether the Google Pay JS API is already present in the page (no `isReadyToPay` call). It does **not** run the device/card readiness check. |
+
+<a name="GooglePayAvailabilityResult" id="GooglePayAvailabilityResult" href="#GooglePayAvailabilityResult">&nbsp;</a>
+
+## GooglePayAvailabilityResult : <code>object</code>
+Result of `GooglePayOpenWalletButton.checkAvailability`. Extends
+[OpenWalletAvailabilityResult](#OpenWalletAvailabilityResult).
+
+**Kind**: global interface  
+**Extends**: [<code>OpenWalletAvailabilityResult</code>](#OpenWalletAvailabilityResult)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| available | <code>boolean</code> | Whether Google Pay is ready to pay in the current context (from `isReadyToPay().result`). |
+| supported | <code>boolean</code> | Whether the Google Pay JS API is present and the readiness query could run. |
+| [payment_method_present] | <code>boolean</code> | Google's `isReadyToPay` `paymentMethodPresent` — whether the buyer already has a usable payment method. Undefined when not reported. |
+| [reason] | <code>string</code> | Machine-readable reason when not available: `'unsupported_browser'`, `'service_type_mismatch'`, `'config_fetch_failed'`, `'sdk_load_failed'`, `'query_failed'`, `'no_payment_method'`, or `'api_not_loaded'` (only from the synchronous `sync: true` check). |
+
 <a name="OnClickEventData" id="OnClickEventData" href="#OnClickEventData">&nbsp;</a>
 
 ## OnClickEventData : <code>object</code>
@@ -487,20 +617,23 @@ if the service type does not match Apple Pay.
 
 * [ApplePayOpenWalletButton](#ApplePayOpenWalletButton) ⇐ [<code>OpenWalletButtons</code>](#OpenWalletButtons)
     * [new ApplePayOpenWalletButton(selector, publicKeyOrAccessToken, serviceId, meta)](#new_ApplePayOpenWalletButton_new)
-    * [.load()](#OpenWalletButtons+load)
-    * [.enable()](#OpenWalletButtons+enable)
-    * [.disable()](#OpenWalletButtons+disable)
-    * [.setEnv(env, [alias])](#OpenWalletButtons+setEnv)
-    * [.setMeta(meta)](#OpenWalletButtons+setMeta)
-    * [.destroy()](#OpenWalletButtons+destroy)
-    * [.onClick(handler)](#OpenWalletButtons+onClick)
-    * [.onSuccess(handler)](#OpenWalletButtons+onSuccess)
-    * [.onUnavailable(handler)](#OpenWalletButtons+onUnavailable)
-    * [.onError(handler)](#OpenWalletButtons+onError)
-    * [.onCancel(handler)](#OpenWalletButtons+onCancel)
-    * [.onLoaded(handler)](#OpenWalletButtons+onLoaded)
-    * [.onShippingAddressChange(handler)](#OpenWalletButtons+onShippingAddressChange)
-    * [.onShippingOptionsChange(handler)](#OpenWalletButtons+onShippingOptionsChange)
+    * _instance_
+        * [.load()](#OpenWalletButtons+load)
+        * [.enable()](#OpenWalletButtons+enable)
+        * [.disable()](#OpenWalletButtons+disable)
+        * [.setEnv(env, [alias])](#OpenWalletButtons+setEnv)
+        * [.setMeta(meta)](#OpenWalletButtons+setMeta)
+        * [.destroy()](#OpenWalletButtons+destroy)
+        * [.onClick(handler)](#OpenWalletButtons+onClick)
+        * [.onSuccess(handler)](#OpenWalletButtons+onSuccess)
+        * [.onUnavailable(handler)](#OpenWalletButtons+onUnavailable)
+        * [.onError(handler)](#OpenWalletButtons+onError)
+        * [.onCancel(handler)](#OpenWalletButtons+onCancel)
+        * [.onLoaded(handler)](#OpenWalletButtons+onLoaded)
+        * [.onShippingAddressChange(handler)](#OpenWalletButtons+onShippingAddressChange)
+        * [.onShippingOptionsChange(handler)](#OpenWalletButtons+onShippingOptionsChange)
+    * _static_
+        * [.checkAvailability([options])](#ApplePayOpenWalletButton.checkAvailability) ⇒ [<code>Promise.&lt;ApplePayAvailabilityResult&gt;</code>](#ApplePayAvailabilityResult)
 
 <a name="new_ApplePayOpenWalletButton_new" id="new_ApplePayOpenWalletButton_new" href="#new_ApplePayOpenWalletButton_new">&nbsp;</a>
 
@@ -873,6 +1006,54 @@ button.onShippingOptionsChange((data) => {
   };
 });
 ```
+<a name="ApplePayOpenWalletButton.checkAvailability" id="ApplePayOpenWalletButton.checkAvailability" href="#ApplePayOpenWalletButton.checkAvailability">&nbsp;</a>
+
+### ApplePayOpenWalletButton.checkAvailability([options]) ⇒ [<code>Promise.&lt;ApplePayAvailabilityResult&gt;</code>](#ApplePayAvailabilityResult)
+Checks Apple Pay availability **without instantiating the button** — the single,
+authoritative, cross-browser-aware availability entry point.
+
+Resolves the merchant identifier (either supplied directly or fetched from the
+service configuration), loads Apple's web SDK if needed, then queries
+`ApplePaySession.applePayCapabilities()`. Returns a convenience `available` verdict
+(computed against `apple_pay_capabilities`), the raw device-reported
+`payment_credential_status`, and `has_native_session` so callers can infer the transport:
+`available && has_native_session` ⇒ native sheet likely; `available && !has_native_session`
+⇒ cross-device / QR handoff likely.
+
+Pass `{ sync: true }` for a cheap, network-free native same-device pre-check that
+resolves immediately (see [ApplePayAvailabilityOptions.sync](ApplePayAvailabilityOptions.sync)).
+
+**Kind**: static method of [<code>ApplePayOpenWalletButton</code>](#ApplePayOpenWalletButton)  
+**Returns**: [<code>Promise.&lt;ApplePayAvailabilityResult&gt;</code>](#ApplePayAvailabilityResult) - The availability result.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [options] | [<code>ApplePayAvailabilityOptions</code>](#ApplePayAvailabilityOptions) | Merchant context, allowed capabilities, and mode. |
+
+**Example**  
+```js
+// Lightest path — no network, when you already know the merchant identifier:
+const result = await ApplePayOpenWalletButton.checkAvailability({ merchant_id });
+```
+**Example**  
+```js
+// Resolve the merchant identifier from the service configuration:
+const result = await ApplePayOpenWalletButton.checkAvailability({
+  public_key_or_access_token,
+  service_id,
+  env: 'sandbox',
+});
+if (result.available) {
+  // Render the Apple Pay button (native sheet or cross-device QR, per has_native_session).
+} else {
+  console.log('Unavailable:', result.reason, result.payment_credential_status);
+}
+```
+**Example**  
+```js
+// Synchronous native-only fast check (no network / SDK load):
+const { has_native_session } = await ApplePayOpenWalletButton.checkAvailability({ sync: true });
+```
 <a name="GooglePayOpenWalletButton" id="GooglePayOpenWalletButton" href="#GooglePayOpenWalletButton">&nbsp;</a>
 
 ## GooglePayOpenWalletButton ⇐ [<code>OpenWalletButtons</code>](#OpenWalletButtons)
@@ -888,20 +1069,23 @@ if the service type does not match Google Pay.
 
 * [GooglePayOpenWalletButton](#GooglePayOpenWalletButton) ⇐ [<code>OpenWalletButtons</code>](#OpenWalletButtons)
     * [new GooglePayOpenWalletButton(selector, publicKeyOrAccessToken, serviceId, meta)](#new_GooglePayOpenWalletButton_new)
-    * [.load()](#OpenWalletButtons+load)
-    * [.enable()](#OpenWalletButtons+enable)
-    * [.disable()](#OpenWalletButtons+disable)
-    * [.setEnv(env, [alias])](#OpenWalletButtons+setEnv)
-    * [.setMeta(meta)](#OpenWalletButtons+setMeta)
-    * [.destroy()](#OpenWalletButtons+destroy)
-    * [.onClick(handler)](#OpenWalletButtons+onClick)
-    * [.onSuccess(handler)](#OpenWalletButtons+onSuccess)
-    * [.onUnavailable(handler)](#OpenWalletButtons+onUnavailable)
-    * [.onError(handler)](#OpenWalletButtons+onError)
-    * [.onCancel(handler)](#OpenWalletButtons+onCancel)
-    * [.onLoaded(handler)](#OpenWalletButtons+onLoaded)
-    * [.onShippingAddressChange(handler)](#OpenWalletButtons+onShippingAddressChange)
-    * [.onShippingOptionsChange(handler)](#OpenWalletButtons+onShippingOptionsChange)
+    * _instance_
+        * [.load()](#OpenWalletButtons+load)
+        * [.enable()](#OpenWalletButtons+enable)
+        * [.disable()](#OpenWalletButtons+disable)
+        * [.setEnv(env, [alias])](#OpenWalletButtons+setEnv)
+        * [.setMeta(meta)](#OpenWalletButtons+setMeta)
+        * [.destroy()](#OpenWalletButtons+destroy)
+        * [.onClick(handler)](#OpenWalletButtons+onClick)
+        * [.onSuccess(handler)](#OpenWalletButtons+onSuccess)
+        * [.onUnavailable(handler)](#OpenWalletButtons+onUnavailable)
+        * [.onError(handler)](#OpenWalletButtons+onError)
+        * [.onCancel(handler)](#OpenWalletButtons+onCancel)
+        * [.onLoaded(handler)](#OpenWalletButtons+onLoaded)
+        * [.onShippingAddressChange(handler)](#OpenWalletButtons+onShippingAddressChange)
+        * [.onShippingOptionsChange(handler)](#OpenWalletButtons+onShippingOptionsChange)
+    * _static_
+        * [.checkAvailability([options])](#GooglePayOpenWalletButton.checkAvailability) ⇒ [<code>Promise.&lt;GooglePayAvailabilityResult&gt;</code>](#GooglePayAvailabilityResult)
 
 <a name="new_GooglePayOpenWalletButton_new" id="new_GooglePayOpenWalletButton_new" href="#new_GooglePayOpenWalletButton_new">&nbsp;</a>
 
@@ -1272,6 +1456,45 @@ button.onShippingOptionsChange((data) => {
   };
 });
 ```
+<a name="GooglePayOpenWalletButton.checkAvailability" id="GooglePayOpenWalletButton.checkAvailability" href="#GooglePayOpenWalletButton.checkAvailability">&nbsp;</a>
+
+### GooglePayOpenWalletButton.checkAvailability([options]) ⇒ [<code>Promise.&lt;GooglePayAvailabilityResult&gt;</code>](#GooglePayAvailabilityResult)
+Checks Google Pay availability **without instantiating the button** — the static
+availability entry point.
+
+Loads the Google Pay JS SDK if needed, then runs `PaymentsClient.isReadyToPay()` using
+the **default** card configuration (a button instance with a custom `card_config` may
+produce a different result). All options are optional — unlike Apple Pay, Google Pay's
+readiness check does not require a merchant identifier; supplying `service_id` +
+`public_key_or_access_token` additionally validates that the service is a Google Pay service.
+
+Pass `{ sync: true }` for a cheap, network-free check that only reports whether the
+Google Pay JS API is already present (see [GooglePayAvailabilityOptions.sync](GooglePayAvailabilityOptions.sync)).
+
+**Kind**: static method of [<code>GooglePayOpenWalletButton</code>](#GooglePayOpenWalletButton)  
+**Returns**: [<code>Promise.&lt;GooglePayAvailabilityResult&gt;</code>](#GooglePayAvailabilityResult) - The availability result.  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [options] | [<code>GooglePayAvailabilityOptions</code>](#GooglePayAvailabilityOptions) | Optional merchant context and mode. |
+
+**Example**  
+```js
+// Simplest form — no merchant context needed:
+const result = await GooglePayOpenWalletButton.checkAvailability();
+if (result.available) {
+  // Render the Google Pay button.
+}
+```
+**Example**  
+```js
+// Validate the service is a Google Pay service while checking:
+const result = await GooglePayOpenWalletButton.checkAvailability({
+  public_key_or_access_token,
+  service_id,
+  env: 'sandbox',
+});
+```
 <a name="OpenWalletButtons" id="OpenWalletButtons" href="#OpenWalletButtons">&nbsp;</a>
 
 ## *OpenWalletButtons*

package/docs/widget-examples.md

@@ -94,8 +94,48 @@ widget.setRefId('id'); // your unique identifier to identify the data
 widget.setFormFields(['phone', 'email']); // add additional fields for form of widget
 
 widget.setSupportedCardIcons(['mastercard', 'visa']); // add icons of supported card types
+
+widget.setAllowedCardSchemes(['mastercard', 'visa']); // restrict which card schemes the card number field accepts
+```
+
+### Restricting accepted card schemes
+
+`setAllowedCardSchemes(schemes)` restricts which card schemes the card number field accepts, **without** changing
+which card icons the widget displays. Call it before `load()`.
+
+```javascript
+widget.setAllowedCardSchemes(['visa', 'mastercard']);
 ```
 
+Accepted identifiers — the schemes the widget can resolve from a card number:
+
+`amex`, `ausbc`, `diners`, `discover`, `eftpos`, `japcb`, `mastercard`, `solo`, `unionpay`, `visa`
+
+Behaviour:
+
+- **Not called, or an empty array** — every scheme is accepted. Existing integrations are unaffected.
+- **Case-insensitive**, and surrounding whitespace is ignored: `' Visa '` and `'MASTERCARD'` both work. Note that
+  `setSupportedCardIcons` matches case-**sensitively**; the two methods differ here.
+- **Unsupported identifiers are ignored with a `console.warn`** naming the value, and never throw. A list in which
+  every identifier is unsupported therefore applies **no restriction at all** — check the console if a restriction
+  seems to have no effect. The icon-only values `visa_white` and `eftpos_white` are not schemes and are rejected,
+  as are `laser` and `maestro`, which the widget can never resolve from a card number.
+- **Takes precedence over `setSupportedCardIcons`.** When a non-empty list is supplied here, it is the only list
+  used for validation, and the second argument of `setSupportedCardIcons` no longer affects validation. Icons keep
+  coming from `setSupportedCardIcons`, so a scheme can legitimately be shown as an icon and still be rejected —
+  make sure that is what you intend:
+
+  ```javascript
+  widget.setSupportedCardIcons(['visa', 'mastercard', 'amex'], true);
+  widget.setAllowedCardSchemes(['visa', 'mastercard']);
+  // three icons are displayed; an Amex card is rejected
+  ```
+
+- **Calling it again replaces the previous list** rather than merging with it.
+- A card of a rejected scheme shows `Card type not accepted.` on the card number field, the submit button is
+  disabled, and the submit handler refuses the card even if the button is re-enabled outside the widget. The same
+  message is shown for a card whose scheme cannot be resolved at all.
+
 This example shows how you can use a lot of other methods to settings your form
 
 ### Error handling
@@ -255,6 +295,7 @@ When handling errors, consider:
  var widget = new paydock.HtmlWidget('#widget', 'publicKey', 'gatewayId');
 
  widget.setSupportedCardIcons(['mastercard', 'visa']);
+ widget.setAllowedCardSchemes(['mastercard', 'visa']);
  widget.setFormFields(['phone', 'email']);
  widget.setRefId('custom-ref-id');
     widget.onFinishInsert('input[name="payment_source_token"]', 'payment_source');

package/package.json

@@ -104,7 +104,7 @@
     }
   },
   "name": "@paydock/client-sdk",
-  "version": "1.144.1-beta",
+  "version": "1.147.0",
   "scripts": {
     "build:doc": "node docs/html/marked.js",
     "build:js": "rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
@@ -145,7 +145,7 @@
   },
   "devDependencies": {
     "@babel/cli": "7.24.5",
-    "@babel/core": "7.24.5",
+    "@babel/core": "7.29.6",
     "@babel/plugin-external-helpers": "7.24.1",
     "@babel/plugin-transform-modules-umd": "7.24.1",
     "@babel/plugin-transform-object-assign": "7.24.1",
@@ -180,7 +180,6 @@
     "buffer": "5.7.1",
     "cross-fetch": "4.1.0",
     "dotenv": "16.4.5",
-    "fs": "0.0.2",
     "grunt": "1.6.1",
     "grunt-cli": "1.4.3",
     "grunt-jsdoc-to-markdown": "6.0.0",
@@ -214,35 +213,45 @@
     "tsify": "3.0.4",
     "tslib": "2.6.2",
     "typescript": "5.4.5",
-    "vitest": "3.0.5",
+    "vitest": "3.2.6",
     "zod": "3.23.8"
   },
   "overrides": {
     "sha.js@>=2.0.0 <=2.4.11": "2.4.12",
     "pbkdf2": ">=3.1.3",
-    "form-data": ">=4.0.4",
+    "form-data": ">=4.0.6",
     "qs": ">=6.15.2",
+    "js-yaml": "4.3.1",
     "@babel/plugin-transform-modules-systemjs": ">=7.29.4",
-    "fast-uri": ">=3.1.2",
+    "fast-uri": "3.1.7",
     "tmp": ">=0.2.6",
     "ws": ">=8.20.1",
     "minimatch@^3": "3.1.5",
     "minimatch@^5": "5.1.9",
     "minimatch@^9": "9.0.9",
     "@isaacs/brace-expansion": ">=5.0.1",
+    "brace-expansion@1": "1.1.18",
+    "brace-expansion@2": "2.1.4",
+    "postcss": "8.5.23",
     "bn.js": ">=5.2.3",
     "ajv": "8.18.0",
     "serialize-javascript": ">=7.0.3",
     "underscore": ">=1.13.8",
-    "dompurify": ">=3.4.0",
-    "immutable": ">=5.1.5",
+    "dompurify": "3.4.13",
+    "immutable": "5.1.8",
     "flatted": ">=3.4.2",
     "node-forge": ">=1.4.0",
     "picomatch": ">=2.3.2",
-    "socket.io-parser": ">=4.2.6",
+    "socket.io-parser": "4.2.7",
+    "engine.io": "6.6.9",
     "lodash": ">=4.18.0",
-    "vite": ">=6.4.2",
-    "follow-redirects": ">=1.16.0"
+    "vite": ">=6.4.2 <7",
+    "follow-redirects": ">=1.16.0",
+    "shell-quote": "1.9.0",
+    "esbuild": ">=0.28.1",
+    "linkify-it": "5.0.2",
+    "body-parser": "1.20.6",
+    "nanoid": "3.3.18"
   },
   "engines": {
     "node": ">=16.0.0"