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.

BCD tables only load in the browser