Web/API/PaymentDetailsUpdate/error

Secure contextThis 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:

• The PaymentRequest specifies using its requestShipping property that shipping information is required.
• The PaymentDetailsUpdate object specifies no valid shipping options in its shippingOptions list.

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 APIThe definition of 'PaymentDetailsUpdate.error' 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
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

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.error by Mozilla Contributors is licensed under CC-BY-SA 2.5.