Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.
The PaymentRequestEvent constructor creates a new PaymentRequestEvent object which is a constructor for a PaymentRequestEvent which is the ojbect passed to a payment handler when a PaymentRequest is made..
Syntax
var paymentRequestEvent = new PaymentRequestEventy(type, options)
Parameters
- type
- Must always be
'PaymentRequest'. - options Optional
- Options are as follows:
instrumentKey: APaymentInstrumentobject reflecting the payment instrument selected by the user or an empty string if the user has not registered or chosen a payment instrument.methodData: An array ofPaymentMethodDataobjects containing payment method identifers for the payment methods that the web site accepts and any associated payment method specific data.modifiers: An array of objects containing changes to payment details.paymentRequestId: The ID of thePaymentRequestobject.paymentRequestOrigin: The origin where thePaymentRequestobject was initialized.topLeveOrigin: The top-level origin where thePaymentRequestobject was initialized.total: The total amount being requested for payment.
Specifications
| Specification | Status | Comment |
|---|---|---|
| Payment Handler API The definition of 'PaymentRequestEvent_' in that specification. |
Working Draft | Initial definition. |
Browser compatibility
The compatibility table in 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.
| Feature | Chrome | Edge | Firefox | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | 571 | ? | ? | ? | No | ? |
| Feature | Android webview | Chrome for Android | Edge mobile | Firefox for Android | Opera Android | iOS Safari | Samsung Internet |
|---|---|---|---|---|---|---|---|
| Basic support | No | 571 | ? | ? | No | ? | No |
1. From version 57: this feature is behind the #service-worker-payment-apps preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.