PaymentRequestEvent: PaymentRequestEvent() constructor

Limited availability

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

See full compatibility

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

Note: This feature is only available in Service Workers.

The PaymentRequestEvent constructor creates a new PaymentRequestEvent object instance.

Syntax

new PaymentRequestEvent(type)
new PaymentRequestEvent(type, options)

Parameters

type

A string with the name of the event. It is case-sensitive and browsers set it to paymentrequest.

options Optional

An object that, in addition of the properties defined in ExtendableEvent(), can have the following properties:

methodData: An array of PaymentMethodData objects (see methodData > Value) containing payment method identifiers for the payment methods that the website accepts and any associated payment method-specific data.
modifiers: An array of objects containing changes to payment details.
paymentRequestId: The ID of the PaymentRequest object.
paymentRequestOrigin: The origin where the PaymentRequest object was initialized.
topOrigin: The top-level origin where the PaymentRequest object was initialized.
total: The total amount being requested for payment.

Return value

A new PaymentRequestEvent object.

Examples

A developer would not use this constructor manually. A new PaymentRequestEvent object is constructed when a handler is invoked as a result of the paymentrequest event firing.

self.addEventListener("paymentrequest", (e) => {
  // …
});

Specifications

Specification
Web-based Payment Handler API # dom-paymentrequestevent-constructor

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`PaymentRequestEvent()` constructor Experimental	Chrome – Full support Chrome 70 (Release date: 2018-10-16) footnote Full support	Edge – Full support Edge 79 (Release date: 2020-01-15) footnote Full support	Firefox – No support Firefox footnote No support	Opera – Full support Opera 57 (Release date: 2018-11-28) footnote Full support	Safari – No support Safari footnote No support	Chrome Android – Full support Chrome Android 70 (Release date: 2018-10-17) footnote Full support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – Full support Opera Android 49 (Release date: 2018-12-07) footnote Full support	Safari on iOS – No support Safari on iOS footnote No support	Samsung Internet – Full support Samsung Internet 10 (Release date: 2019-08-22) footnote Full support	WebView Android – No support WebView Android footnote No support	WebView on iOS – No support WebView on iOS footnote No support

Tip: you can click/tap on a cell for more information.

Full support: Full support
No support: No support
: Experimental. Expect behavior to change in the future.