PaymentRequestEvent: changePaymentMethod() method

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

The changePaymentMethod() method of the PaymentRequestEvent interface is used by the payment handler to get an updated total, given such payment method details as the billing address.

When this method is invoked, a PaymentMethodChangeEvent is fired.

Syntax

js
changePaymentMethod(methodName)
changePaymentMethod(methodName, methodDetails)

Parameters

methodName

The name of the payment method to be used.

methodDetails Optional

An object containing method-specific details that are being updated.

Return value

A Promise that resolves with a PaymentRequestDetailsUpdate object. This object contains the following properties:

error

A string that explains why the user-selected payment method cannot be used.

total

An updated total based on the changed payment method. The total can change, for example, because the billing address of the payment method selected by the user changes the applicable sales tax.

modifiers

An Array of PaymentDetailsModifier objects, whose properties are described in PaymentRequestEvent.modifiers.

paymentMethodErrors

An object containing validation errors for the payment method, if any.

Examples

The following shows a trivial code snippet that could be used in a service worker to send a payment method change notification to the main payment handler window. For a complete test example, see Payment handler for testing payment method change event.

js
function notifyPaymentMethodChanged(e) {
  e.changePaymentMethod("someMethod")
    .then((paymentMethodChangeResponse) => {
      paymentHandlerWindow.postMessage(paymentMethodChangeResponse);
    })
    .catch((error) => {
      sendMessage({ error: error.message });
    });
}

Specifications

Specification
Payment Handler API
# changepaymentmethod-method

Browser compatibility

BCD tables only load in the browser

See also