PaymentRequestUpdateEvent.updateWith()

Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The updateWith() method of the PaymentRequestUpdateEvent interface updates the details of an existing PaymentRequest.

Syntax

paymentRequestUpdateEvent.updateWith(details);

Parameters

details
A PaymentDetailsUpdate object specifying the changes applied to the payment request:
displayItems Optional
An array of PaymentItem objects, each describing one line item for the payment request. These represent the line items on a receipt or invoice.
error Optional
A DOMString specifying an error message to present to the user. When calling updateWith(), including error in the updated data causes the user agent to display the text as a general error message. For address field specific errors, use shippingAddressErrors.
modifiers Optional
An array of PaymentDetailsModifier objects, each describing a modifier for particular payment method identifiers. For example, you can use one to adjust the total payment amount based on the selected payment method ("5% cash discount!").
shippingAddressErrors Optional
An AddressErrors object which includes an error message for each property of the shipping address that could not be validated.
shippingOptions Optional
An array of PaymentShippingOption objects, each describing one available shipping option from which the user may choose.
total Optional
A PaymentItem providing an updated total for the payment. Make sure this equals the sum of all of the items in displayItems. This is not calculated automatically. You must update this value yourself anytime the total amount due changes. This lets you have flexibility for how to handle things like tax, discounts, and other adjustments to the total price charged.

Return value

undefined.

Specifications

Specification Status Comment
Payment Request API
The definition of 'PaymentRequestUpdateEvent.updateWith()' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
updateWith()Chrome Full support 60Edge Full support 15Firefox No support No
Notes
No support No
Notes
Notes Available only in nightly builds.
IE No support NoOpera Full support 47Safari Full support 11.1WebView Android No support NoChrome Android Full support 56Firefox Android No support No
Notes
No support No
Notes
Notes Available only in nightly builds.
Opera Android Full support 43Safari iOS Full support 11.3Samsung Internet Android Full support 6.0

Legend

Full support  
Full support
No support  
No support
See implementation notes.
See implementation notes.