ContextQMD
Back to Content

PaymentManager: enableDelegations() method

files/en-us/web/api/paymentmanager/enabledelegations/index.md

latest2.4 KB
Original Source

{{APIRef("Web-Based Payment Handler API")}}{{SeeCompatTable}}{{SecureContext_Header}}

The enableDelegations() method of the {{domxref("PaymentManager")}} interface delegates responsibility for providing various parts of the required payment information to the payment app rather than collecting it from the browser (for example, via autofill).

For example, if the requestShipping option is set to true in the options object when invoking the {{domxref("PaymentRequest.PaymentRequest", "PaymentRequest()")}} constructor, a shipping address will be returned.

  • If enableDelegations() was used to delegate shippingAddress, that address will come from the payment app.
  • If not, it will come from the browser autofill.

Syntax

js-nolint
enableDelegations(delegations)

Parameters

  • delegations {{optional_inline}}
    • : An array containing one or more enumerated values that specify the payment information you want to delegate to the payment app. Possible values can be:
      • payerEmail
        • : The payment app will provide the payer's email whenever it is needed.
      • payerName
        • : The payment app will provide the payer's name whenever it is needed.
      • payerPhone
        • : The payment app will provide the payer's phone number whenever it is needed.
      • shippingAddress
        • : The payment app will provide the shipping address whenever it is needed.

Return value

A {{jsxref("Promise")}} that resolves with a value of undefined.

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

{{Specifications}}

Browser compatibility

{{Compat}}

See also