Web/API/PaymentRequestEvent

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.

The PaymentRequestEvent interface of the the Payment Request API is the object passed to a payment handler when a PaymentRequest is made.

Constructor

PaymentRequestEvent() '

Creates a new PaymentRequestEvent object.

Properties

instrumentKeyRead only '

Returns a PaymentInstrument object reflecting the payment instrument selected by the user or an empty string if the user has not registered or chosen a payment instrument.

methodDataRead only '

Returns an array of PaymentMethodData objects containing payment method identifers for the payment methods that the web site accepts and any associated payment method specific data.

modifiersRead only '

Returns an array of objects containing changes to payment details.

paymentRequestIdRead only '

Returns the ID of the PaymentRequest object.

paymentRequestOriginRead only '

Returns the origin where the PaymentRequest object was initialized.

topOriginRead only '

Returns the top-level origin where the PaymentRequest object was initialized.

totalRead only '

Returns the total amount being requested for payment.

Methods

openWindow() '

Opens the specified URL in a new window, if and only if the given URL is on the same origin as the calling page. It returns a Promise that resolves with a reference to a WindowClient.

respondWith() '

Prevents the default event handling and allows you to provide a Promise for a PaymentResponse object yourself.

Specifications

Specification	Status	Comment
Payment Handler APIThe definition of 'PaymentRequestEvent' in that specification.	Working Draft	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
PaymentRequestEvent Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
PaymentRequestEvent() constructor Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
instrumentKey Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
methodData Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
modifiers Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
openWindow() Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
paymentRequestId Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
paymentRequestOrigin Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
respondWith()</code</a> Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
topOrigin Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes
total Experimental'	Chrome Full support 70	Edge Full support 79	Firefox No support No	IE No support No	Opera Full support 57	Safari No support No	WebView Android No support No	Chrome Android Full support 70	Firefox Android No support No	Opera Android Full support 49	Safari iOS No support No	Samsung Internet Android Full support Yes

Legend

Full support  

Full support

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

PaymentRequestEvent by Mozilla Contributors is licensed under CC-BY-SA 2.5.