aboutsummaryrefslogtreecommitdiff
path: root/taler-user-guide.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2023-07-16 17:07:51 +0200
committerChristian Grothoff <christian@grothoff.org>2023-07-16 17:07:51 +0200
commit50c89041aa9b5f7300ddaa7b2b1412617101eeac (patch)
tree3bfc5c9b1dad9d1d6d397a3bce89c75413c2b0a3 /taler-user-guide.rst
parenta1eb5922a9985c910d1a7e4c136c82a8ea394d83 (diff)
downloaddocs-50c89041aa9b5f7300ddaa7b2b1412617101eeac.tar.gz
docs-50c89041aa9b5f7300ddaa7b2b1412617101eeac.tar.bz2
docs-50c89041aa9b5f7300ddaa7b2b1412617101eeac.zip
tip -> reward
Diffstat (limited to 'taler-user-guide.rst')
-rw-r--r--taler-user-guide.rst60
1 files changed, 29 insertions, 31 deletions
diff --git a/taler-user-guide.rst b/taler-user-guide.rst
index 1e77ff03..e045833d 100644
--- a/taler-user-guide.rst
+++ b/taler-user-guide.rst
@@ -325,20 +325,20 @@ Mustach templating engine:
-.. _Tipping-visitors:
+.. _Rewarding-visitors:
-Tipping visitors
-================
+Rewarding visitors
+==================
-.. index:: tipping
+.. index:: rewards
-Taler can also be used to tip Web site visitors. For example, you may be
-running an online survey, and you want to reward those people that have
-dutifully completed the survey. If they have installed a Taler wallet,
-you can provide them with a tip for their deeds. This section describes
-how to setup the Taler merchant backend for tipping.
+Taler can also be used to reward digital cash to Web site visitors. For
+example, you may be running an online survey, and you want to reward those
+people that have dutifully completed the survey. If they have installed a
+Taler wallet, you can provide them with a reward for their deeds. This section
+describes how to setup the Taler merchant backend for rewarding.
-There are three basic steps that must happen to tip a visitor.
+There are three basic steps that must happen to reward a visitor.
.. _Fund-the-reserve:
@@ -384,7 +384,7 @@ Make your wire transfer and (optionally) check at
exchange.
Once the funds have arrived, you can start to use the reserve for
-tipping.
+rewarding.
Note that an exchange will typically close a reserve after four weeks, wiring
all remaining funds back to the sender’s account. Thus, you should plan to
@@ -392,45 +392,43 @@ wire funds corresponding to a campaign of about two weeks to the exchange
initially. If your campaign runs longer, you should setup another reserve
every other week to ensure one is always ready.
-.. _Authorize-a-tip:
+.. _Authorize-a-reward:
-Authorize a tip
----------------
+Authorize a reward
+------------------
When your frontend has reached the point where a client is supposed to receive
-a tip, it needs to first authorize the tip. For this, the frontend must use
-a POST to ``/private/reserves/$RESERVE_PUB/authorize-tip``. To authorize a
-tip, the frontend has to provide the following information in the body of the
+a reward, it needs to first authorize the reward. For this, the frontend must use
+a POST to ``/private/reserves/$RESERVE_PUB/authorize-reward``. To authorize a
+reward, the frontend has to provide the following information in the body of the
POST request:
-- The amount of the tip
+- The amount of the reward
- The justification (only used internally for the back-office)
-- The URL where the wallet should navigate next after the tip was
+- The URL where the wallet should navigate next after the reward was
processed
-- The tip-pickup URL (see next section)
+- The reward-pickup URL (see next section)
-In response to this request, the backend will return a tip token, an
+In response to this request, the backend will return a reward token, an
expiration time and the exchange URL. The expiration time will indicate
-how long the tip is valid (when the reserve expires). The tip token is
+how long the reward is valid (when the reserve expires). The reward token is
an opaque string that contains all the information needed by the wallet
-to process the tip. The frontend must send this tip token to the browser
-in a special “402 Payment Required” response inside the ``X-Taler-Tip``
+to process the reward. The frontend must send this reward token to the browser
+in a special “402 Payment Required” response inside the ``Taler``
header.
The frontend should handle errors returned by the backend, such as
-misconfigured instances or a lack of remaining funds for tipping.
+misconfigured instances or a lack of remaining funds for rewarding.
-.. _Picking-up-of-the-tip:
+.. _Picking-up-of-the-reward:
-Picking up of the tip
----------------------
+Picking up of the reward
+------------------------
The wallet will POST a JSON object to the shop’s
-``/tips/$TIP_ID/pickup`` handler.
+``/rewards/$REWARD_ID/pickup`` handler.
The frontend must then forward this request to the backend. The response
generated by the backend can then be forwarded directly to the wallet.
-
-