PaymentRequest.onpaymentmethodchange

The PaymentRequest event handler onpaymentmethodchange is invoked when the paymentmethodchange is fired, indicating that the user has changed payment methods within a given payment handler.

For example, when using Apple Pay, the user can swipe to select different credit cards, debit cards, and so forth. Each time the user does so, this event is fired.

This event may not be fired by all payment handlers.

Syntax

PaymentRequest.addEventListener('paymentmethodchange', paymentMethodChangeEvent => { ... });

PaymentRequest.onpaymentmethodchange = function(paymentMethodChangeEvent) { ... };

Value

An event handler function which is to be called whenever the paymentmethodchange event is fired at the PaymentRequest, indicating that the user has changed payment methods within the same payment handler.

The paymentmethodchange event is triggered by a user-agent controlled interaction (e.g., the end-user switches from a debit to a credit card in the payment app). To make sure you receive the event, you should add event listeners to PaymentRequest object after instantiation, but before you call show().

Examples

An example payment method change handler is shown below; this example handles changes made to the payment method when using Apple Pay, specifically:

request.onpaymentmethodchange = ev => {
  const { type: cardType } = ev.methodDetails;
  const newStuff = {};
  if (ev.methodName === "https://apple.com/apple-pay") {
    switch (cardType) {
      case "store":
        // do Apple Pay specific handling for store card...
        // methodDetails contains the store card information
        const result = calculateDiscount(ev.methodDetails);
        Object.assign(newStuff, result);
        break;
    }
  }
  // finally...
  ev.updateWith(newStuff);
};
const response = await request.show();

Specifications

Browser compatibility