PaymentRequest
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()
Secure context-
Creates a new
PaymentRequest
object.
Instance properties
PaymentRequest.id
Read only Secure context-
An unique identifier for a particular
PaymentRequest
, which can be set viadetails.id
. When none is set, it defaults to a UUID. PaymentRequest.shippingAddress
Read only Secure context Deprecated Non-standard-
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
requestShipping
flag 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.shippingOption
Read only Secure context Deprecated Non-standard-
Returns the identifier of the selected shipping option. This property is only populated if the constructor is called with the
requestShipping
flag set to true. PaymentRequest.shippingType
Read only Secure context Deprecated Non-standard-
Returns the type of shipping used to fulfill the transaction. This will be one of
shipping
,delivery
,pickup
, ornull
if a value was not provided in the constructor.
Instance methods
PaymentRequest.canMakePayment()
Secure context-
Indicates whether the
PaymentRequest
object can make a payment before callingshow()
. PaymentRequest.show()
Secure context-
Causes the user agent to begin the user interaction for the payment request.
PaymentRequest.abort()
Secure context-
Causes the user agent to end the payment request and to remove any user interface that might be shown.
Events
merchantvalidation
Secure context Deprecated-
With some payment handlers (e.g., Apple Pay), this event handler is called to handle the
merchantvalidation
event, which is dispatched when the user agent requires that the merchant validate that the merchant or vendor requesting payment is legitimate. paymentmethodchange
Secure context-
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
Secure context Deprecated Non-standard-
Dispatched whenever the user changes their shipping address.
shippingoptionchange
Secure context Deprecated Non-standard-
Dispatched whenever the user changes a shipping option.
Specifications
Specification |
---|
Payment Request API 1.1 # paymentrequest-interface |
Browser compatibility
BCD tables only load in the browser