---
title: PaymentAddress
slug: Web/API/PaymentAddress
tags:
  - API
  - Interface
  - NeedsTranslation
  - Payment Request
  - PaymentRequest
  - Reference
  - TopicStub
  - paymentAddress
translation_of: Web/API/PaymentAddress
---
<p>{{SeeCompatTable}}{{APIRef("Payment Request API")}}</p>

<p>The <strong><code>PaymentAddress</code></strong> interface of the <a href="/en-US/docs/Web/API/Payment_Request_API">Payment Request API</a> stores address information.</p>

<h2 id="Properties">Properties</h2>

<dl>
	<dt>{{domxref('PaymentAddress.country')}} {{readonlyinline}} </dt>
	<dd>The Common Locale Data Repository region code. For example, US, GB, CN, etc.</dd>
	<dt>{{domxref('PaymentAddress.addressLine')}} {{readonlyinline}}</dt>
	<dd>An array of strings describing the address. 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.</dd>
	<dt>{{domxref('PaymentAddress.region')}} {{readonlyinline}}</dt>
	<dd>The top level administrative subdivision of the country, for example, a state, province, oblast, or prefecture.</dd>
	<dt>{{domxref('PaymentAddress.city')}} {{readonlyinline}}</dt>
	<dd>The city or town portion of the address.</dd>
	<dt>{{domxref('PaymentAddress.dependentLocality')}} {{readonlyinline}}</dt>
	<dd>The dependent locality or sublocality within a city, for example, a neighborhood, borough, district, or UK dependent locality.</dd>
	<dt>{{domxref('PaymentAddress.postalCode')}} {{readonlyinline}}</dt>
	<dd>A code used by a jurisdiction for mail routing, for example, the ZIP code in the United States or the PIN code in India.</dd>
	<dt>{{domxref('PaymentAddress.sortingCode')}} {{readonlyinline}}</dt>
	<dd>A postal sorting code such as is used in France.</dd>
	<dt>{{domxref('PaymentAddress.languageCode')}} {{readonlyinline}}</dt>
	<dd>The BCP-47 language code for the address, used to determine the field separators and the order of fields when formatting the address for display.</dd>
	<dt>{{domxref('PaymentAddress.organization')}} {{readonlyinline}}</dt>
	<dd>The name of the organization, firm, company, or institution at the payment address.</dd>
	<dt>{{domxref('PaymentAddress.recipient')}} {{readonlyinline}}</dt>
	<dd>The name of the recipient, purchaser, or contact person at the payment address.</dd>
	<dt>{{domxref('PaymentAddress.careOf')}} {{readonlyinline}} {{obsolete_inline()}}</dt>
	<dd>The name of an intermediary party or entity responsible for transferring packages between the postal service and the recipient.</dd>
	<dt>{{domxref('PaymentAddress.phone')}} {{readonlyinline}}</dt>
	<dd>The telephone number of the recipient or contact person.</dd>
</dl>

<h2 id="Methods">Methods</h2>

<p>None.</p>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
	<tbody>
		<tr>
			<th scope="col">Specification</th>
			<th scope="col">Status</th>
			<th scope="col">Comment</th>
		</tr>
		<tr>
			<td>{{SpecName('Payment','#paymentaddress-interface','PaymentAddress')}}</td>
			<td>{{Spec2('Payment')}}</td>
			<td>Initial definition.</td>
		</tr>
	</tbody>
</table>

<h2 id="Browser_Compatibility">Browser Compatibility</h2>

{{Compat("api.PaymentAddress")}}