This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The PaymentAddress
interface of the Payment Request API stores address information.
Properties
PaymentAddress.country
Read only- The Common Locale Data Repository region code. For example, US, GB, CN, etc.
PaymentAddress.addressLine
Read only- 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.
PaymentAddress.region
Read only- The top level administrative subdivision of the country, for example, a state, province, oblast, or prefecture.
PaymentAddress.city
Read only- The city or town portion of the address.
PaymentAddress.dependentLocality
Read only- The dependent locality or sublocality within a city, for example, a neighborhood, borough, district, or UK dependent locality.
PaymentAddress.postalCode
Read only- 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.sortingCode
Read only- A postal sorting code such as is used in France.
PaymentAddress.languageCode
Read only- 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.
PaymentAddress.organization
Read only- The name of the organization, firm, company, or institution at the payment address.
PaymentAddress.recipient
Read only- The name of the recipient, purchaser, or contact person at the payment address.
PaymentAddress.phone
Read only- The telephone number of the recipient or contact person.
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.
var supportedInstruments = [{
supportedMethods: 'basic-card',
data: {
supportedNetworks: ['visa', 'mastercard', 'amex', 'jcb',
'diners', 'discover', 'mir', 'unionpay'],
supportedTypes: ['credit', 'debit']
}
}];
var 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
}
]
};
var options = {requestShipping: true};
try {
var request = new PaymentRequest(supportedInstruments, details, options);
// Add event listeners here.
// Call show() to trigger the browser's payment flow.
request.show().then(function(instrumentResponse) {
// Do something with the response from the UI.
})
.catch(function(err) {
// Do something with the error from request.show().
});
} catch (e) {
// Catch any other errors.
}
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' : 'Mr Dick 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
Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|---|
Basic support | 61 | (Yes) | ? | ? | No support | ? |
toJSON |
61 | ? | ? | No support | ? |
Feature | Android Webview | Chrome for Android | Edge | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile |
---|---|---|---|---|---|---|---|---|
Basic support | No support | 53 | (Yes) | ? | ? | ? | No support | ? |
toJSON |
No support | 61 | ? | ? | ? | ? | No support | ? |