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() This is an experimental API that should not be used in production code.
Creates a new PaymentRequestEvent object.

Properties

instrumentKeyRead only This is an experimental API that should not be used in production code.
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 This is an experimental API that should not be used in production code.
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 This is an experimental API that should not be used in production code.
Returns an array of objects containing changes to payment details.
paymentRequestIdRead only This is an experimental API that should not be used in production code.
Returns the ID of the PaymentRequest object.
paymentRequestOriginRead only This is an experimental API that should not be used in production code.
Returns the origin where the PaymentRequest object was initialized.
topOriginRead only This is an experimental API that should not be used in production code.
Returns the top-level origin where the PaymentRequest object was initialized.
totalRead only This is an experimental API that should not be used in production code.
Returns the total amount being requested for payment.

Methods

openWindow() This is an experimental API that should not be used in production code.
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() This is an experimental API that should not be used in production code.
Prevents the default event handling and allows you to provide a Promise for a PaymentResponse object yourself.

Specifications

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

Browser compatibility

BCD tables only load in the browser