PaymentAddress.country

The country read-only property of the 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".

Syntax

var paymentCountry = PaymentAddress.country;

Value

A DOMString 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 PaymentRequestUpdateEvent.updateWith() will be made with a details object containing a shippingAddressErrors field. That field contains an AddressErrors-compliant object whose country property is a string indicating the validation error that occurred and, if possible, suggests how to fix it.

Specifications

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

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Experimental
Chrome Full support 61
Disabled
Full support 61
Disabled
Disabled From version 61: this feature is behind the #web-payments preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.
Edge Full support 15Firefox ? IE No support NoOpera No support NoSafari ? WebView Android No support NoChrome Android Full support 53
Disabled
Full support 53
Disabled
Disabled From version 53: this feature is behind the #web-payments preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.
Edge Mobile Full support YesFirefox Android ? Opera Android No support NoSafari iOS ? Samsung Internet Android Full support 6.0

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.
User must explicitly enable this feature.
User must explicitly enable this feature.

See also

Document Tags and Contributors

Contributors to this page: Sheppy, fscholz, jpmedley, chrisdavidmills, libbymc, dgashmdn
Last updated by: Sheppy,