Web/API/PaymentDetailsUpdate

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

Draft This page is not complete.

The PaymentDetailsUpdate dictionary is used to provide updated information to the payment user interface after it has been instantiated. This can be done either by calling the PaymentRequestUpdateEvent.updateWith() method or by using the PaymentRequest.show() method's detailsPromise parameter to provide a Promise that returns a PaymentDetailsUpdate that updates the payment information before the user interface is even enabled for the first time.

Properties

The PaymentDetailsUpdate dictionary is based on the PaymentDetailsBase dictionary, and inherits its properties, which are included in the list below.

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.

Specifications

Specification	Status	Comment
Payment Request APIThe definition of 'PaymentDetailsUpdate' in that specification.	Candidate Recommendation	Initial definition.

Browser compatibility

The compatibility table on 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.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
PaymentDetailsUpdate	Chrome Full support 61	Edge Full support ≤18	Firefox Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true) and the dom.payments.request.supportedRegions preference (needs to be set to A comma-delineated list of one or more 2-character ISO country codes indicating the countries in which to support payments (for example, US,CA.). To change preferences in Firefox, visit about:config.	IE No support No	Opera No support No	Safari ?	WebView Android No support No	Chrome Android Full support 53	Firefox Android Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true) and the dom.payments.request.supportedRegions preference (needs to be set to A comma-delineated list of one or more 2-character ISO country codes indicating the countries in which to support payments (for example, US,CA.). To change preferences in Firefox, visit about:config.	Opera Android No support No	Safari iOS ?	Samsung Internet Android Full support 6.0
error	Chrome Full support 61	Edge Full support ≤18	Firefox Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	IE No support No	Opera No support No	Safari ?	WebView Android No support No	Chrome Android Full support 60	Firefox Android Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	Opera Android No support No	Safari iOS ?	Samsung Internet Android Full support 8.0
shippingAddressErrors	Chrome Full support 61	Edge Full support ≤18	Firefox Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	IE No support No	Opera No support No	Safari ?	WebView Android No support No	Chrome Android Full support 60	Firefox Android Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	Opera Android No support No	Safari iOS ?	Samsung Internet Android Full support 8.0
total	Chrome Full support 61	Edge Full support ≤18	Firefox Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	IE No support No	Opera No support No	Safari ?	WebView Android No support No	Chrome Android Full support 60	Firefox Android Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	Opera Android No support No	Safari iOS ?	Samsung Internet Android Full support 8.0

Legend

Full support  

Full support

No support  

No support

Compatibility unknown  

Compatibility unknown

See implementation notes.'

See implementation notes.

User must explicitly enable this feature.'

User must explicitly enable this feature.

 

PaymentDetailsUpdate by Mozilla Contributors is licensed under CC-BY-SA 2.5.