You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
* docs: updates based on feedback* docs: feedback updatesUpdates based on GH comments and comments in Slack* docs: addtl feedback updates* docs: fix typo* docs: update contribution counter
Copy file name to clipboardExpand all lines: src/content/docs/developers/about-receiving.mdx
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,15 +9,15 @@ Receiving Web Monetization payments requires you to have an account with a compa
9
9
10
10
Your digital wallet provider will supply you with the financial account you’ll use to receive payments. Withdrawing your funds typically requires you to link a card or bank account to your wallet.
11
11
12
-
Since wallet providers are financial entities, they areregulated within the countries they operate. One regulation, known asKYC (Know Your Customer), requires financial entities to collect your personal information and verify your identity before allowing you to open an account.
12
+
Since wallet providers are financial entities, they'reregulated within the countries they operate. One regulation, known as Know Your Customer (KYC)), requires financial entities to collect your personal information and verify your identity before allowing you to open an account.
13
13
14
14
##Web Monetization-compatible digital wallets
15
15
16
16
You must have an account with a compatible[digital wallet provider](/wallets) to receive payments. Be sure to select a provider that:
17
17
18
18
- Is available in your region
19
19
- Supports your preferred currency
20
-
- Allows you to withdraw your funds if youchoose to transact in fiat
20
+
- Allows you to withdraw your funds if youso choose
21
21
22
22
Your wallet provider will assign your wallet a unique identifier called a_wallet address_ or a_payment pointer_. You’ll need this identifier to web monetize your content.
23
23
@@ -28,7 +28,7 @@ Your wallet provider will assign your wallet a unique identifier called a _walle
28
28
29
29
##Web monetized content
30
30
31
-
Once you have yourpayment pointer orwallet address, you're ready to add the Web Monetization`<link>` element to each page of your site you want to monetize. Visit the[get started](/developers/get-started) page for more information.
31
+
Once you have your wallet address, you're ready to add the Web Monetization`<link>` element to each page of your site you want to monetize. Visit the[get started](/developers/get-started) page for more information.
32
32
33
33
When you include the`<link>` element on a page, you're telling your website visitors' browsers that you can accept Web Monetization payments. Visitors using the[Web Monetization extension](/supporters/get-started) in their browsers can then choose to send you payments in the amount and frequency of their choosing.
34
34
@@ -42,15 +42,15 @@ If you're already familiar with Web Monetization, you may have heard about how i
42
42
43
43
In general, a micropayment is a very small payment. Each wallet provider is responsible for a few things:
44
44
45
-
- Deciding whether to support receiving and/or sending micropayments
45
+
- Deciding whether to support receiving and sending micropayments
46
46
- Defining what a micropayment is in the context of their business
47
47
- Determining the minimum amount for a micropayment
48
48
49
-
Let's say your wallet provider allows you to receive micropayments. Your provider defines a micropayment as any payment under $0.05 USD. This means you could, for example, receive a payment of one US cent--as long as the sender's wallet provider allows them to send that amount.
49
+
Let's say your wallet provider allows you to receive micropayments. Your provider defines a micropayment as any payment under $0.05<abbrtitle="US dollars">USD</abbr>. This means you could, for example, receive a payment of one US cent--as long as the sender's wallet provider allows them to send that amount.
50
50
51
-
Your wallet provider may also have business rules set up such that micropayments accumulate on your account but aren't deposited until you reach aminimum (e.g., $1.00 USD).
51
+
Your wallet provider may also have business rules set up such that micropayments accumulate on your account but aren't deposited until you reach athreshold amount.
52
52
53
-
Web Monetization can even support payments of a fraction of a cent (e.g., $0.00001); however, sending and receiving fractional amounts must be supported by the respective wallet providers.
53
+
Web Monetization can even support payments of a fraction of a cent, but sending and receiving fractional amounts must be supported by the respective wallet providers.
54
54
55
55
###A deeper dive into payments
56
56
@@ -69,7 +69,7 @@ The examples below are simplified representations of the Open Payments API calls
69
69
:::
70
70
71
71
<Steps>
72
-
1. The Web Monetization agent locates your[monetization link](/developers/link-element) and extracts yourpayment URL (the`href` value).
72
+
1. The Web Monetization agent locates your[monetization link](/developers/link-element) and extracts yourwallet address (the`href` value).
@@ -118,7 +118,7 @@ The examples below are simplified representations of the Open Payments API calls
118
118
}
119
119
```
120
120
:::note
121
-
The`client` in the request above is your visitor's wallet address/payment pointer. This URL is only used by the agent and the wallets, andis not available to the website.
121
+
The`client` in the request above is your visitor's wallet address. This URL is only used by the agent and the wallets, andisn't available to the website.
122
122
:::
123
123
</Disclosure>
124
124
5. The response to the agent contains an access token that the agent needs to make its next request.
Social web community servers and apps can expose the wallet address or payment pointer of a user or post to a Web Monetization client, such astheInterledger Foundation's[Web Monetization browser extension](/supporters/get-started#install-the-extension) or embedded SDK.
7
+
Social web community servers and apps can expose the wallet address or payment pointer of a user or post to a Web Monetization client, such as Interledger Foundation's[Web Monetization browser extension](/supporters/get-started#install-the-extension) or embedded SDK.
8
8
9
9
The`monetization` property from the Web Monetization namespace (`https://webmonetization.org/ns.jsonld`) applies to an <LinkOuthref="https://www.w3.org/TR/activitystreams-core/">Activity Streams 2.0</LinkOut> <LinkOuthref="https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object">`Object`</LinkOut>.
Copy file name to clipboardExpand all lines: src/content/docs/developers/csp.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ import data from '/src/data/browser-compat-data/csp-monetization-src.json'
9
9
10
10
A <LinkOuthref="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy">Content Security Policy (CSP)</LinkOut> is an extra layer of security that allows you to control the resources a user agent, such as a web browser, is allowed to load for a given page. CSPs use directives to describe the policies for a certain resource type.
11
11
12
-
The`monetization-src` fetch directive allows you to define the payment pointer and wallet address URLs that a browser can load. If an attempt is made to load an undefined URL, a network error will occur and the URLwill not load.
12
+
The`monetization-src` fetch directive allows you to define the payment pointer and wallet address URLs that a browser can load. If an attempt is made to load an undefined URL, a network error will occur and the URLwon't load.
Copy file name to clipboardExpand all lines: src/content/docs/developers/events.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,15 +56,15 @@ By adding an event listener to the relevant monetization `<link>` element (or on
56
56
The`amountSent` property returns the`value` and`currency` of the sent payment.
57
57
58
58
-`value` - The amount. A <LinkOuthref="https://www.w3.org/TR/payment-request/#dfn-valid-decimal-monetary-value">valid decimal monetary value</LinkOut> containing the amount that was sent.
59
-
-`currency` - The currency code. A well-formed 3-letter <LinkOuthref="https://www.iban.com/currency-codes">ISO4217</LinkOut> code that represents the currency that was sent, such as USD or GBP.
59
+
-`currency` - The currency code. A well-formed 3-letter <LinkOuthref="https://www.iban.com/currency-codes">ISO4217</LinkOut> code that represents the currency that was sent, such as USD(for US dollar)or GBP (for Great Britain Pound).
60
60
61
61
```js title="Example"
62
62
"value":"1.23"
63
63
"currency":"USD"
64
64
```
65
65
66
66
:::note[Received amount]
67
-
The`amountSent`is notnecessarily the amount received. For example, if your payment account is set up to receive GBP, but your site visitor's account sends in USD, then exchange rates and currency conversion fees could affect the amount you receive.
67
+
The`amountSent`isn'tnecessarily the amount received. For example, if your payment account is set up to receive GBP (Great Britain Pound), but your site visitor's account sends in USD (US dollar), then exchange rates and currency conversion fees could affect the amount you receive.
Copy file name to clipboardExpand all lines: src/content/docs/developers/get-started.mdx
+8-10Lines changed: 8 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,29 +10,27 @@ import Wallet from '/src/partials/wallet-prereq.mdx'
10
10
11
11
<Wallet />
12
12
13
-
##Step 1 - Get yourpayment URL
13
+
##Step 1 - Get yourwallet address
14
14
15
-
###Payment pointer
16
-
17
-
If you have a payment pointer that starts with`$`, visit <LinkOuthref='https://paymentpointers.org/'>paymentpointers.org</LinkOut>. Enter your payment pointer into the_Payment Pointer_ field. Take note of the URL that automatically generates in the adjacent field. This is your payment URL. You'll need it in the next step.
15
+
Get your wallet address from your wallet provider.
18
16
19
17
```http title="Example"
20
-
$wallet.example.com/alice
18
+
https://wallet.example.com/alice
21
19
```
22
20
23
-
###Wallet address
24
-
25
-
If you have a wallet address that starts with`https://`, then you have your payment URL. Proceed to the next step.
21
+
Some wallet providers will issue a*payment pointer* instead of a wallet address. Payment pointers begin with`$` instead of`https://`.
26
22
27
23
```http title="Example"
28
-
https://wallet.example.com/alice
24
+
$wallet.example.com/alice
29
25
```
30
26
27
+
If you have a payment pointer, visit <LinkOuthref='https://paymentpointers.org/'>paymentpointers.org</LinkOut>. Enter it into the_Payment Pointer_ field and take note of the URL that automatically generates. This is your wallet address.
28
+
31
29
##Step 2 - Web monetize your page
32
30
33
31
<Steps>
34
32
35
-
1. Create your Web Monetization link tag using the format below. Add yourpayment URL as the`href` value.
33
+
1. Create your Web Monetization link tag using the format below. Add yourwallet address as the`href` value.
Copy file name to clipboardExpand all lines: src/content/docs/developers/interfaces.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ Visit the [Monetization events](/developers/events) page for more information.
62
62
The`MonetizationCurrencyAmount` interface is used to populate the`value` and`currency` variables contained within the`MonetizationEvent amountSent` property.
63
63
64
64
- Value - The amount. A valid decimal monetary value containing the amount that was sent.
65
-
- Currency - The currency code. An ISO 4217-compliant currency code, when possible, that represents the currency that was sent, such as USD or GBP.
65
+
- Currency - The currency code. An ISO 4217-compliant currency code, when possible, that represents the currency that was sent. For example, USD(for US dollar)or GBP (for Great Britain Pound).
66
66
67
67
The`MonetizationCurrencyAmount` interface is modeled on the Payment Request API’s <LinkOuthref="https://www.w3.org/TR/payment-request/#paymentcurrencyamount-dictionary">`PaymentCurrencyAmount`</LinkOut> dictionary.
The most recent draft of the <LinkOuthref="https://webmonetization.org/specification/">Web Monetization specification (v2.0)</LinkOut> introduced updates to be more consistent with the design of other browser features. As a result, libraries that implemented v1.0 of the specification need code updates to be compatible with v2.0.
11
+
12
+
We encourage the community to support the Web Monetization ecosystem by updating existing tools/libraries to be compatible with the latest spec and by creating new tools and plugins for frameworks and libraries.
13
+
14
+
For more information, check out Santosh's <LinkOuthref="https://community.interledger.org/devcer/developer-guide-to-migrating-the-breaking-changes-in-the-latest-web-monetization-draft-cj2">developer guide</LinkOut> to migrating the breaking changes in the latest Web Monetization draft.