PaymentAddress

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

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 valid country 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.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 payment method.

const supportedInstruments = [
  {
    supportedMethods: "https://example.com/pay",
  },
];

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 from the fulfilled promise (instrumentResponse above) will have a PaymentResponse.details property containing response details. This has to conform to the structure defined by the payment method provider.

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
PaymentAddress
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
addressLine
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
city
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
country
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
dependentLocality
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
languageCode
60
15
56-63
No
47
11.1-12.1
No
56
56-63
44
11.3-12.2
Yes
organization
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
phone
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
postalCode
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
recipient
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
region
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
sortingCode
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes
toJSON
60
15
No
No
47
11.1
No
56
No
44
11.3
Yes

© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/PaymentAddress