- Draft Community - Group Report -
-- Copyright © 2025 - the Contributors to the Web Monetization Specification, published by - the Web Platform Incubator - Community Group under the W3C Community - Contributor License Agreement (CLA). A human-readable summary - is available. -
-Web Monetization allows websites to automatically receive payments from users, facilitated by the user agent and a user's preferred monetization provider.
- This specification was published by the Web Platform Incubator Community - Group. It is not a W3C Standard nor is it on the W3C Standards - Track. Please note that under the W3C Community - Contributor License Agreement (CLA) there is a limited opt-out and - other conditions apply. Learn more about W3C Community and Business Groups. -
-- This specification is a work in progress within the community on - the best shape it should take. Please see the explainer for more info. -
-- The specification reflects the desired end-state of the Web - Monetization APIs as currently anticipated and agreed to between - the contributors. The specification is being prepared here, in this - format, to collect the input of the Web community and prepare the - work to ultimately follow the W3C standards track should it have - the necessary support to do so. -
-- For the most accurate reflection of the APIs that have been - implemented by providers see the - API documentation. -
-+ This specification is a work in progress within the community on the + best shape it should take. Please see the documentation for more info. +
++ The specification reflects the desired end-state of the Web + Monetization APIs as currently anticipated and agreed to between the + contributors. The specification is being prepared here, in this + format, to collect the input of the Web community and prepare the + work to ultimately follow the W3C standards track should it have the + necessary support to do so. +
++ For the most accurate reflection of the APIs that have been + implemented by providers see the + API documentation. +
- GitHub - Issues are preferred for discussion of this specification. -
- This section is non-normative. -
-
- Call supports()
- on a
- link element’s
- relList passing the "monetization"
- keyword to check if Web Monetization is supported by the user agent.
+ Call {{DOMTokenList/supports()}} on a [^link^] element’s
+ {{HTMLLinkElement/relList}} passing the `"monetization"` keyword to
+ check if Web Monetization is supported by the user agent.
If a "monetization" link becomes browsing-context
- disconnected, a user agent MUST stop
- the payment
- session.
+ disconnected, a user agent MUST stop the [=payment session=].
- The onmonetization event handler is an
- event handler content attribute that can be applied to any
- element. The user
- agent uses it to notify that some
- link has been monetized.
+ The `onmonetization` event handler is an [=event handler content
+ attribute=] that can be applied to any [=element=]. The user agent uses
+ it to notify that some [^link^] has been [=monetized=].
- When the payment session has sent a - payment with a non-zero amount, perform the following steps: + When the [=payment session=] has sent a |payment| with a non-zero + amount, perform the following steps:
HTMLLinkElement associated with the
- payment
- session.
+ null, then return.
+ MonetizationEventInit
- dictionary, whose members are initialized to match payment's
- details.
+ MonetizationEvent
- initialized with eventInitDict.
+ "monetization" at target, with bubbles
- initialized to true.
+ - The following task - source is defined by this specifications. + The following [=task source=] is defined by this specifications.
MonetizationEvents.
+ {{MonetizationEvent}}s.
- The MonetizationCurrencyAmount interface maps directly to
- the
- PaymentCurrencyAmount dictionary as defined in
- [payment-request].
-
WebIDL[SecureContext, Exposed=Window]
-interface MonetizationCurrencyAmount {
- readonly attribute DOMString currency;
- readonly attribute DOMString value;
-};
-
+ [SecureContext, Exposed=Window]
+ interface MonetizationCurrencyAmount {
+ readonly attribute DOMString currency;
+ readonly attribute DOMString value;
+ };
+
+
The currency of the MonetizationCurrencyAmount. See the definition of
- the currency member of
- PaymentCurrencyAmount in [payment-request] for details.
+ the `currency` member of {{PaymentCurrencyAmount}} in
+ [[payment-request]] for details.
The amount of the MonetizationAmount. See the definition of the
- value member in of
- PaymentCurrencyAmount in [payment-request] for details.
+ `value` member in of {{PaymentCurrencyAmount}} in [[payment-request]]
+ for details.
WebIDL[SecureContext, Exposed=Window]
-interface MonetizationEvent : Event {
- constructor(DOMString type, MonetizationEventInit eventInitDict);
- readonly attribute DOMString? amount;
- readonly attribute DOMString? assetCode;
- readonly attribute octet? assetScale;
- readonly attribute DOMString? receipt;
- readonly attribute MonetizationCurrencyAmount amountSent;
- readonly attribute USVString paymentPointer;
- readonly attribute USVString? incomingPayment;
-};
+
+
+ `MonetizationEvent` interface
+
+
+ [SecureContext, Exposed=Window]
+ interface MonetizationEvent : Event {
+ constructor(DOMString type, MonetizationEventInit eventInitDict);
+ readonly attribute DOMString? amount;
+ readonly attribute DOMString? assetCode;
+ readonly attribute octet? assetScale;
+ readonly attribute DOMString? receipt;
+ readonly attribute MonetizationCurrencyAmount amountSent;
+ readonly attribute USVString paymentPointer;
+ readonly attribute USVString? incomingPayment;
+ };
-dictionary MonetizationEventInit : EventInit {
- required DOMString? amount;
- required DOMString? assetCode;
- required octet? assetScale;
- required DOMString? receipt;
- required PaymentCurrencyAmount amountSent;
- required USVString paymentPointer;
- required USVString? incomingPayment;
-};
-
- The amount, assetCode,
- assetScale and receipt attributes are
- deprecated.
-
- All monetization receivers - should be migrating from generating a STREAM - Receipt to supporting incoming payments via - [open-payments] and will no longer be - returning receipts to the browser. -
-
- As such the MonetizationEvent
- no longer represents an amount received, it represents an amount
- sent and returns a URL as the incomingPayment
- attribute that can be used to determine the amount received.
-
+ The `amount`, `assetCode`, `assetScale` and `receipt` attributes are + deprecated. +
++ All [=monetization receivers=] should be migrating from generating a + [[[Receipt]]] to supporting incoming payments via [[open-payments]] + and will no longer be returning receipts to the browser. +
++ As such the {{MonetizationEvent}} no longer represents an amount + received, it represents an amount sent and returns a URL as the + {{MonetizationEvent/incomingPayment}} attribute that can be used to + determine the amount received. +
The amount received as reflected in the receipt from the - monetization receiver. When - getting, returns the value it was initialized with. + [=monetization receiver=]. When getting, returns the value it was + initialized with.
The three letter asset code identifying the amount's units (e.g., "USD" for US dollars). When getting, returns the value it was initialized with.
The scale of the amount. For example, USD would have an
assetScale of 2 when denominated in cents.
When getting, returns the value it was initialized with.
MonetizationCurrencyAmount interface
- map directly to the value and currency
- attributes of a
- PaymentCurrencyAmount dictionary. See the documentation of
-
- PaymentCurrencyAmount for guidance on processing and
- display of these attributes.
-
The amount sent. This should be processed in the same way as
- a
- PaymentCurrencyAmount dictionary as defined in
- [payment-request]. When getting,
- returns the value it was initialized with.
+ a {{PaymentCurrencyAmount}} dictionary as defined in
+ [[payment-request]]. When getting, returns the value it was
+ initialized with.
- null or a base64-encoded STREAM
- Receipt issued by the monetization receiver to
- the monetization provider
- as proof of the total amount received in the payment session. When getting,
- returns the value it was initialized with.
+ `null` or a base64-encoded [[[Receipt]]] issued by the [=monetization
+ receiver=] to the [=monetization provider=] as proof of the total
+ amount received in the [=payment session=]. When getting, returns the
+ value it was initialized with.
- A URL representing the - payment - pointer that has been monetized. When getting, returns the value - it was initialized with. + A [=URL=] representing the [=payment pointer=] that has been + monetized. When getting, returns the value it was initialized with.
- A URL representing an - incoming payment at the monetization receiver. - When getting, returns the value it was initialized with. + A [=URL=] representing an incoming payment at the [=monetization + receiver=]. When getting, returns the value it was initialized with.
- This specification defines a
- policy-controlled feature identified by the string "monetization". Its default allowlist
- is 'self'.
+ This specification defines a [=policy-controlled feature=] identified
+ by the string "monetization". Its
+ default allowlist is `'self'`.
- This section will eventually be moved into the [CSP] and - [FETCH] specifications. +
+ This section will eventually be moved into the [[CSP]] and [[FETCH]] + specifications. +
+The monetization-src directive restricts the URLs from which a - payment - pointer is loaded. The syntax for the directive's name and value - is described by the following ABNF: + [=payment pointer=] is loaded. The syntax for the directive's name + and value is described by the following ABNF:
-directive-name = "monetization-src"
-directive-value = serialized-source-list