Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The PaymentValidationErrors
dictionary represents objects providing information about any and all errors that occurred while processing a payment request. When validation of the PaymentResponse
returned by the PaymentRequest.show()
or PaymentResponse.retry()
methods fails, your code creates a PaymentValidationErrors
object to pass into retry()
so that the user agent knows what needs to be fixed and what if any error messages to display to the user.
Properties
error
Optional- A general description of a payment error from which the user may attempt to recover by retrying the payment, possibly after correcting mistakes in the payment information.
error
can be provided all by itself to provide only a generic error message, or in concert with the other properties to serve as an overview while other properties' values gude the user to errors in specific fields in the payment form. payer
Optional- A
PayerErrors
compliant object which provides appropriate error messages for any of the fields describing the payer which failed validation. paymentMethod
Optional- Any payment method specific errors which may have occurred. This object's contents will vary depending on the payment used. For example, if the user chose to pay by credit card using the
basic-card
payment method, this is aBasicCardErrors
object.
shippingAddress
Optional- An
AddressErrors
object which contains error messages for any of the fields in the shipping address that failed validation.
Example
Specifications
Specification | Status | Comment |
---|---|---|
Payment Request API | Candidate Recommendation | Initial definition. |
Basic Card Payment | Working Draft | Defines BasicCardErrors |
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.
No compatibility data found. Please contribute data for "api.PaymentValidationErrors" (depth: 1) to the MDN compatibility data repository.