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.
PaymentRequestEvent()
Experimental
Creates a new PaymentRequestEvent object.
instrumentKey
Read only
Experimental
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.
methodData
Read only
Experimental
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.
modifiers
Read only
Experimental
Returns an array of objects containing changes to payment details.
paymentRequestId
Read only
Experimental
Returns the ID of the PaymentRequest object.
paymentRequestOrigin
Read only
Experimental
Returns the origin where the PaymentRequest object was initialized.
topOrigin
Read only
Experimental
Returns the top-level origin where the PaymentRequest object was initialized.
total
Read only
Experimental
Returns the total amount being requested for payment.
openWindow()
Experimental
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()
Experimental
Prevents the default event handling and allows you to provide a Promise for a PaymentResponse object yourself.
| Specification |
|---|
| Payment Handler API # the-paymentrequestevent |
| 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
|
10.0
|
PaymentRequestEvent |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
changePaymentMethod |
76
|
79
|
No
|
No
|
63
|
No
|
No
|
76
|
No
|
54
|
No
|
12.0
|
instrumentKey |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
methodData |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
modifiers |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
openWindow |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
paymentRequestId |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
paymentRequestOrigin |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
respondWith |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
topOrigin |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
total |
70
|
79
|
No
|
No
|
57
|
No
|
No
|
70
|
No
|
49
|
No
|
10.0
|
© 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
| Name | Web APIs |
| Version | |
| Badge |
|
| Last Updated | 2022-04-27T09:33:08Z |