PaymentRequest
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The Payment Request API's PaymentRequest interface is the primary access point into the API, and lets web content and apps accept payments from the end user on behalf of the operator of the site or the publisher of the app.
Constructor
PaymentRequest()-
Creates a new
PaymentRequestobject.
Instance properties
PaymentRequest.idRead only-
A unique identifier for a particular
PaymentRequest, which can be set viadetails.id. When none is set, it defaults to a UUID. PaymentRequest.shippingAddressRead only-
If requested via payment options, returns the shipping address chosen by the user for the purposes of calculating shipping. This property is only populated if the constructor is called with the
requestShippingflag set to true. Additionally, in some browsers, the parts of the address will be redacted for privacy until the user indicates they are ready to complete the transaction (i.e., they hit "Pay"). PaymentRequest.shippingOptionRead only-
Returns the identifier of the selected shipping option. This property is only populated if the constructor is called with the
requestShippingflag set to true. PaymentRequest.shippingTypeRead only-
Returns the type of shipping used to fulfill the transaction. This will be one of
shipping,delivery,pickup, ornullif a value was not provided in the constructor.
Static methods
-
Indicates whether the Secure payment confirmation feature is available.
Instance methods
PaymentRequest.canMakePayment()-
Indicates whether the
PaymentRequestobject can make a payment before callingshow(). PaymentRequest.show()-
Causes the user agent to begin the user interaction for the payment request.
PaymentRequest.abort()-
Causes the user agent to end the payment request and to remove any user interface that might be shown.
Events
merchantvalidation-
With some payment handlers (e.g., Apple Pay), this event handler is called to handle the
merchantvalidationevent, which is dispatched when the user agent requires that the merchant validate that the merchant or vendor requesting payment is legitimate. paymentmethodchange-
With some payment handlers (e.g., Apple Pay), dispatched whenever the user changes payment instrument, like switching from a credit card to a debit card.
shippingaddresschange-
Dispatched whenever the user changes their shipping address.
shippingoptionchange-
Dispatched whenever the user changes a shipping option.
Specifications
| Specification |
|---|
| Payment Request API # paymentrequest-interface |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
PaymentRequest
|
|
|
|
|
|
|
|
|
|
|
|
|
PaymentRequest() constructor
|
|
|
|
|
|
|
|
|
|
|
|
|
secure-payment-confirmation method
|
|
|
|
|
|
|
|
|
|
|
|
|
abort()
|
|
|
|
|
|
|
|
|
|
|
|
|
canMakePayment()
|
|
|
|
|
|
|
|
|
|
|
|
|
getSecurePaymentConfirmationCapabilities() static method
|
|
|
|
|
|
|
|
|
|
|
|
|
id
|
|
|
|
|
|
|
|
|
|
|
|
|
merchantvalidation event
|
|
|
|
|
|
|
|
|
|
|
|
|
paymentmethodchange event
|
|
|
|
|
|
|
|
|
|
|
|
|
securePaymentConfirmationAvailability() static method
|
|
|
|
|
|
|
|
|
|
|
|
|
shippingAddress
|
|
|
|
|
|
|
|
|
|
|
|
|
shippingOption
|
|
|
|
|
|
|
|
|
|
|
|
|
shippingType
|
|
|
|
|
|
|
|
|
|
|
|
|
shippingaddresschange event
|
|
|
|
|
|
|
|
|
|
|
|
|
shippingoptionchange event
|
|
|
|
|
|
|
|
|
|
|
|
|
show
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- In development. Supported in a pre-release version.
- In development. Supported in a pre-release version.
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Non-standard. Check cross-browser support before using.
- Deprecated. Not for use in new websites.
- User must explicitly enable this feature.