Secure context
This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The PaymentAddress
interface of the Payment Request API is used to store shipping or payment address information.
It may be useful to refer to the Universal Postal Union web site's Addressing S42 standard materials, which provide information about international standards for postal addresses.
Properties
PaymentAddress.addressLine
Read only- An array of
DOMString
objects providing each line of the address not included among the other properties. The exact size and content varies by country or location and can include, for example, a street name, house number, apartment number, rural delivery route, descriptive instructions, or post office box number. PaymentAddress.country
Read only- A
DOMString
specifying the country in which the address is located, using the ISO-3166-1 alpha-2 standard. The string is always given in its canonical upper-case form. Some examples of validcountry
values:"US"
,"GB"
,"CN"
, or"JP"
. PaymentAddress.city
Read only- A
DOMString
which contains the city or town portion of the address. PaymentAddress.dependentLocality
Read only- A
DOMString
giving the dependent locality or sublocality within a city, for example, a neighborhood, borough, district, or UK dependent locality. PaymentAddress.organization
Read only- A
DOMString
specifying the name of the organization, firm, company, or institution at the payment address. PaymentAddress.phone
Read only- A
DOMString
specifying the telephone number of the recipient or contact person. PaymentAddress.postalCode
Read only- A
DOMString
specifying a code used by a jurisdiction for mail routing, for example, the ZIP code in the United States or the PIN code in India. PaymentAddress.recipient
Read only- A
DOMString
giving the name of the recipient, purchaser, or contact person at the payment address. PaymentAddress.region
Read only- A
DOMString
containing the top level administrative subdivision of the country, for example a state, province, oblast, or prefecture. PaymentAddress.regionCode
Read only- A
DOMString
specifying the region of the address, represented as a "code element" of an ISO3166-2 country subdivision name (e.g. "QLD" for Queensland, Australia, "CA" for California, and so on). PaymentAddress.sortingCode
Read only- A
DOMString
providing a postal sorting code such as is used in France.
Note: Properties for which values were not specified contain empty strings.
Obsolete properties
The following properties are obsolete and should no longer be used, but may still be present in some browser versions.
PaymentAddress.languageCode
Read only- A
DOMString
indicating the language code of the address. This identifies the language in which the address is given, and is intended to aid in localization of the display of the address.
Methods
PaymentAddress.toJSON()
- A standard serializer that returns a JSON representation of the
PaymentAddress
object's properties.
Examples
In the following example, the PaymentRequest()
constructor is used to create a new payment request, which takes three objects as parameters — one containing details of the payment methods that can be used for the payment, one containing details of the actual order (such as items bought and shipping options), and an optional object containing further options.
The first of these three (supportedInstruments
in the example below) contains a data
property that has to conform to the structure defined by the BasicCardRequest
dictionary.
const supportedInstruments = [ { supportedMethods: "basic-card", }, ]; const details = { total: { label: "Donation", amount: { currency: "USD", value: "65.00" } }, displayItems: [ { label: "Original donation amount", amount: { currency: "USD", value: "65.00" }, }, ], shippingOptions: [ { id: "standard", label: "Standard shipping", amount: { currency: "USD", value: "0.00" }, selected: true, }, ], }; const options = { requestShipping: true }; async function doPaymentRequest() { const request = new PaymentRequest(supportedInstruments, details, options); // Add event listeners here. // Call show() to trigger the browser's payment flow. const response = await request.show(); // Process payment. const json = response.toJSON(); const httpResponse = await fetch("/pay/", { method: "POST", body: json }); const result = httpResponse.ok ? "success" : "failure"; await response.complete(result); } doPaymentRequest();
Once the payment flow has been triggered using PaymentRequest.show()
and the promise resolves successfully, the PaymentResponse
object available inside the fulfilled promise (instrumentResponse
above) will have a PaymentResponse.details
property that will contain response details. This has to conform to the structure defined by the BasicCardResponse
dictionary, and may look something like this:
{ "cardNumber' : '9999999999999999", "cardholderName' : 'Pat Straw", "cardSecurityCode" : "999", "expiryMonth" : "07", "expiryYear" : "2021", "billingAddress" : { "country" : "GB", // etc. billing address is a PaymentAddress object } }
Specifications
Specification | Status | Comment |
---|---|---|
Payment Request API The definition of 'PaymentAddress' in that specification. |
Candidate Recommendation | Initial definition. |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
PaymentAddress | Chrome
Full support
61
| Edge Full support ≤18 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
addressLine | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
city | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
country | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
dependentLocality | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
languageCode | Chrome
Full support
61
| Edge Full support 15 | Firefox
No support
56 — 63
| IE No support No | Opera No support No | Safari ? | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
No support
56 — 63
| Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
organization | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
phone | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
postalCode | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
recipient | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
region | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
regionCode | Chrome No support No | Edge No support No | Firefox
Full support
64
| IE No support No | Opera No support No | Safari ? | WebView Android No support No | Chrome Android No support No | Firefox Android
Full support
64
| Opera Android No support No | Safari iOS ? | Samsung Internet Android No support No |
sortingCode | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
56
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
53
| Firefox Android
Full support
56
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
toJSON() | Chrome
Full support
61
| Edge Full support 15 | Firefox
Full support
62
| IE No support No | Opera No support No | Safari Full support Yes | WebView Android No support No | Chrome Android
Full support
61
| Firefox Android
Full support
62
| Opera Android No support No | Safari iOS Full support Yes | Samsung Internet Android No support No |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Non-standard. Expect poor cross-browser support.
- Non-standard. Expect poor cross-browser support.
- Deprecated. Not for use in new websites.
- Deprecated. Not for use in new websites.
- See implementation notes.
- See implementation notes.
- User must explicitly enable this feature.
- User must explicitly enable this feature.