PaymentManager: userHint property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The userHint property of the PaymentManager interface provides a hint for the browser to display along with the payment app's name and icon in the Payment Handler UI.

Value

A string.

Examples

js
navigator.serviceWorker.register("serviceworker.js").then((registration) => {
  registration.paymentManager.userHint = "Card number should be 16 digits";

  registration.paymentManager
    .enableDelegations(["shippingAddress", "payerName"])
    .then(() => {
      // ...
    });

  // ...
});

Specifications

Specification
Payment Handler API
# dom-paymentmanager-userhint

Browser compatibility

BCD tables only load in the browser

See also