ServiceWorkerRegistration: paymentManager 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.

Note: This feature is available in Web Workers.

The paymentManager read-only property of the ServiceWorkerRegistration interface returns a payment app's PaymentManager instance, which is used to manage various payment app functionality.

Value

A PaymentManager object instance.

Examples

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

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

  // …
});
  • PaymentManager.userHint is used to provide a hint for the browser to display along with the payment app's name and icon in the Payment Handler UI.
  • PaymentManager.enableDelegations() is used to delegate responsibility for providing various parts of the required payment information to the payment app rather than collecting it from within the merchant website.