PaymentRequestEvent: total property

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Note: This feature is only available in Service Workers.

The total read-only property of the PaymentRequestEvent interface returns a PaymentCurrencyAmount object containing the total amount being requested for payment.

Value

A PaymentCurrencyAmount object. This object contains the following properties:

currency

A string containing a three-letter ISO 4217 standard currency code representing the currency of the payment. Examples include USD, CAN, and GBP.

value

A string containing a decimal monetary value, e.g. 2.55.

Examples

js
self.addEventListener("paymentrequest", (e) => {
  console.log(e.total);
});

Specifications

Specification
Payment Handler API
# dom-paymentrequestevent-total

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
total
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support
Experimental. Expect behavior to change in the future.

See also