PaymentDetailsUpdate.error

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

The PaymentDetailsUpdate dictionary's error property is a human-readable DOMString which provides an error message to be displayed if the specified information doesn't offer any valid shipping options.

Syntax

errorString = paymentDetailsUpdate.error;

paymentDetailsUpdate.error = errorString;

Value

A DOMString specifying the string to display to the user if the information specified in the PaymentDetailsUpdate doesn't provide any valid shipping options. This happens if both of the following are true:

This message can be used to explain to the user why they cannot submit their payment as currently specified—whether that's because the selected products cannot be shipped to their region or because their address is not served by any of the shipping companies you use.

Specifications

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

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
errorChrome Full support 61Edge Full support ≤18Firefox 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 NoOpera No support NoSafari ? WebView Android No support NoChrome Android Full support 60Firefox 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 NoSafari 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.