You’re reading the English version of this content since no translation exists yet for this locale. Help us translate this article!
This is an experimental technology
Check 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
instrumentKey
Read 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. methodData
Read 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. modifiers
Read only- Returns an array of objects containing changes to payment details.
paymentRequestId
Read only- Returns the ID of the
PaymentRequest
object. paymentRequestOrigin
Read only- Returns the origin where the
PaymentRequest
object was initialized. topOrigin
Read only- Returns the top-level origin where the
PaymentRequest
object was initialized. total
Read 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 aWindowClient
. respondWith()
- Prevents the default event handling and allows you to provide a
Promise
for aPaymentResponse
object yourself.
Specifications
Specification | Status | Comment |
---|---|---|
Payment Handler API The 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 | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
PaymentRequestEvent | Chrome
Full support
57
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
57
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android Full support 7.0 |
PaymentRequestEvent() constructor | Chrome
Full support
57
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
57
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
instrumentKey | Chrome
Full support
60
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
60
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
methodData | Chrome
Full support
60
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
60
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
modifiers | Chrome
Full support
60
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
60
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
openWindow() | Chrome
Full support
61
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
61
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
paymentRequestId | Chrome
Full support
60
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
60
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
paymentRequestOrigin | Chrome
Full support
60
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
60
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
respondWith() | Chrome
Full support
59
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
59
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android Full support 7.0 |
topOrigin | Chrome
Full support
68
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
68
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
total | Chrome
Full support
60
| Edge ? | Firefox No support No | IE ? | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
60
| Firefox Android No support No | Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
- User must explicitly enable this feature.
- User must explicitly enable this feature.
- Uses a non-standard name.
- Uses a non-standard name.