Web/API/PaymentCurrencyAmount

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

The PaymentCurrencyAmount dictionary describes an amount of money in terms of both a number of units and the currency (US dollars, Euro, yen, etc.), and is part of the Payment Request API. This is used to specify the prices of both line items on a payment, using PaymentItem objects, and to provide the cost of a shipping option, using PaymentShippingOption.

Properties

All properties are required.

currency

A string containing a valid 3-letter ISO 4217 currency identifier (ISO 4217) indicating the currency used for the payment value.

value

A string containing a valid decimal value representing the mount of currency constituting the payment amount. This string must only contain an optional leading "-" to indicate a negative value, then one or more digits from 0 to 9, and an optional decimal point (".", regardless of locale) followed by at least one more digit. No whitespace is permitted.

Obsolete properties

These properties have been removed from the specification and should no longer be used.

currencySystem Optional '

A string describing the standard or specification as well as the currency system identifier within that system which was used to provide the value. This has been removed; instead of allowing sites to choose the standard to use, ISO 4217 is always used for the currency identifier now.

Specifications

Specification	Status	Comment
Payment Request APIThe definition of 'PaymentCurrencyAmount' in that specification.	Candidate Recommendation	Initial definition.

Browser compatibility

The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
PaymentCurrencyAmount	Chrome Full support 56 Full support 56 No support 53 — 56 Disabled' Disabled' From version 53 until version 56 (exclusive): this feature is behind the #web-payments preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.	Edge Full support ≤79	Firefox Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true) and the dom.payments.request.supportedRegions preference (needs to be set to A comma-delineated list of one or more 2-character ISO country codes indicating the countries in which to support payments (for example, US,CA.). To change preferences in Firefox, visit about:config.	IE No support No	Opera No support No	Safari ?	WebView Android Full support 56	Chrome Android Full support 56 Full support 56 No support 53 — 56 Disabled' Disabled' From version 53 until version 56 (exclusive): this feature is behind the #web-payments preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.	Firefox Android Full support 55 Notes' Disabled' Full support 55 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 55: this feature is behind the dom.payments.request.enabled preference (needs to be set to true) and the dom.payments.request.supportedRegions preference (needs to be set to A comma-delineated list of one or more 2-character ISO country codes indicating the countries in which to support payments (for example, US,CA.). To change preferences in Firefox, visit about:config.	Opera Android No support No	Safari iOS ?	Samsung Internet Android Full support 6.0
currency	Chrome Full support 56 Full support 56 No support 53 — 56 Disabled' Disabled' From version 53 until version 56 (exclusive): this feature is behind the #web-payments preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.	Edge Full support ≤79	Firefox Full support 63 Notes' Disabled' Full support 63 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 63: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	IE No support No	Opera No support No	Safari ?	WebView Android Full support 56	Chrome Android Full support 56 Full support 56 No support 53 — 56 Disabled' Disabled' From version 53 until version 56 (exclusive): this feature is behind the #web-payments preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.	Firefox Android Full support 63 Notes' Disabled' Full support 63 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 63: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	Opera Android No support No	Safari iOS ?	Samsung Internet Android Full support 6.0
currencySystem	Chrome No support No	Edge No support No	Firefox No support 55 — 64 Notes' Disabled' No support 55 — 64 Notes' Disabled' Notes' Removed from the specification; currencies are now always identified using ISO 4217. This was only available in nightly builds. Disabled' From version 55 until version 64 (exclusive): this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	IE No support No	Opera No support No	Safari ?	WebView Android No support No	Chrome Android No support No	Firefox Android No support 55 — 64 Notes' Disabled' No support 55 — 64 Notes' Disabled' Notes' Removed from the specification; currencies are now always identified using ISO 4217. This was only available in nightly builds. Disabled' From version 55 until version 64 (exclusive): this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	Opera Android No support No	Safari iOS ?	Samsung Internet Android No support No
value	Chrome Full support 56 Full support 56 No support 53 — 56 Disabled' Disabled' From version 53 until version 56 (exclusive): this feature is behind the #web-payments preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.	Edge Full support ≤79	Firefox Full support 63 Notes' Disabled' Full support 63 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 63: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	IE No support No	Opera No support No	Safari ?	WebView Android Full support 56	Chrome Android Full support 56 Full support 56 No support 53 — 56 Disabled' Disabled' From version 53 until version 56 (exclusive): this feature is behind the #web-payments preference (needs to be set to Enabled). To change preferences in Chrome, visit chrome://flags.	Firefox Android Full support 63 Notes' Disabled' Full support 63 Notes' Disabled' Notes' Available only in nightly builds. Disabled' From version 63: this feature is behind the dom.payments.request.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.	Opera Android No support No	Safari iOS ?	Samsung Internet Android Full support 6.0

Legend

Full support  

Full support

No support  

No support

Compatibility unknown  

Compatibility unknown

See implementation notes.'

See implementation notes.

User must explicitly enable this feature.'

User must explicitly enable this feature.

PaymentCurrencyAmount by Mozilla Contributors is licensed under CC-BY-SA 2.5.