Back to Content

PaymentAddress: country property

files/en-us/web/api/paymentaddress/country/index.md

latest1.3 KB
Original Source

{{APIRef("Payment Request API")}}{{SecureContext_Header}}{{Deprecated_Header}}{{Non-standard_Header}}

The country read-only property of the {{domxref('PaymentAddress')}} interface is a string identifying the address's country using the ISO 3166-1 alpha-2 standard. The string is always in its canonical upper-case form.

Some examples of valid country values: "US", "GB", "CN", or "JP".

Value

A string which contains the ISO3166-1 alpha-2 code identifying the country in which the address is located, or an empty string if no country is available, which frequently can be assumed to mean "same country as the site owner."

Usage notes

If the payment handler validates the address and determines that the value of country is invalid, a call to {{domxref("PaymentRequestUpdateEvent.updateWith()")}} will be made with a details object containing a shippingAddressErrors field. That field contains an object whose country property is a string indicating the validation error that occurred and, if possible, suggestions on how to fix it.

Browser compatibility

{{Compat}}

See also