PaymentRequestEvent

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

The PaymentRequestEvent interface of 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 identifiers 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
Payment Handler API
# the-paymentrequestevent

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
PaymentRequestEvent
70
79
No
No
57
No
No
70
No
49
No
Yes
PaymentRequestEvent
70
79
No
No
57
No
No
70
No
49
No
Yes
changePaymentMethod
76
79
No
No
No
No
No
76
No
54
No
12.0
instrumentKey
70
79
No
No
57
No
No
70
No
49
No
Yes
methodData
70
79
No
No
57
No
No
70
No
49
No
Yes
modifiers
70
79
No
No
57
No
No
70
No
49
No
Yes
openWindow
70
79
No
No
57
No
No
70
No
49
No
Yes
paymentRequestId
70
79
No
No
57
No
No
70
No
49
No
Yes
paymentRequestOrigin
70
79
No
No
57
No
No
70
No
49
No
Yes
respondWith
70
79
No
No
57
No
No
70
No
49
No
Yes
topOrigin
70
79
No
No
57
No
No
70
No
49
No
Yes
total
70
79
No
No
57
No
No
70
No
49
No
Yes

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PaymentRequestEvent