taler-docs

commit 222e6afb40b39ecb5c9154f9849bc7460347ab41
parent ed5431fba6e1b0847bbec9097ed62abf8dbecff3
Author: Christian Grothoff <christian@grothoff.org>
Date:   Thu,  6 Jul 2023 13:43:52 +0200

tip to reward

Diffstat:
M
core/api-merchant.rst
 | 
58
+++++++++++++++++++++++++++++-----------------------------

1 file changed, 29 insertions(+), 29 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -148,7 +148,7 @@ to interact with directly (without HTTP-based authentication). These
 endpoints are used to process payments (claiming an order, paying
 for the order, checking payment/refund status and aborting payments),
 process refunds (checking refund status, obtaining the refund),
-and to pick up tips.
+and to pick up rewards.
 
 
 Claiming an order
@@ -775,15 +775,15 @@ the contract. Refunds must be approved by the merchant's business logic.
     }
 
 
-Picking up tips
----------------
+Picking up rewards
+------------------
 
-Tips are a way for wallets to obtain e-cash from
+Rewards are a way for wallets to obtain e-cash from
 a website.
 
-.. http:get:: [/instances/$INSTANCE]/tips/$TIP_ID
+.. http:get:: [/instances/$INSTANCE]/rewards/$REWARD_ID
 
-  Handle request from wallet to provide details about a tip.
+  Handle request from wallet to provide details about a reward.
 
   This endpoint typically also supports requests with the "Accept" header
   requesting "text/html".  In this case, an HTML response suitable for
@@ -794,60 +794,60 @@ a website.
   **Response:**
 
   :http:statuscode:`200 OK`:
-    A tip is being returned. The backend responds with a `TipInformation`.
+    A reward is being returned. The backend responds with a `RewardInformation`.
   :http:statuscode:`404 Not found`:
-    The tip identifier is unknown.
+    The reward identifier is unknown.
   :http:statuscode:`406 Not acceptable`:
     The merchant backend could not load the template required to generate a reply in the desired format. (Likely HTML templates were not properly installed.)
   :http:statuscode:`410 Gone`:
-    A tip has been fully claimed. The JSON reply still contains the `TipInformation`.
+    A reward has been fully claimed. The JSON reply still contains the `RewardInformation`.
 
-  .. ts:def:: TipInformation
+  .. ts:def:: RewardInformation
 
-    interface TipInformation {
+    interface RewardInformation {
 
-      // Exchange from which the tip will be withdrawn. Needed by the
+      // Exchange from which the reward will be withdrawn. Needed by the
       // wallet to determine denominations, fees, etc.
       exchange_url: string;
 
-      // URL where to go after obtaining the tip.
+      // URL where to go after obtaining the reward.
       next_url: string;
 
-      // (Remaining) amount of the tip (including fees).
-      tip_amount: Amount;
+      // (Remaining) amount of the reward (including fees).
+      reward_amount: Amount;
 
-      // Timestamp indicating when the tip is set to expire (may be in the past).
-      // Note that tips that have expired MAY also result in a 404 response.
+      // Timestamp indicating when the reward is set to expire (may be in the past).
+      // Note that rewards that have expired MAY also result in a 404 response.
       expiration: Timestamp;
     }
 
 
-.. http:post:: [/instances/$INSTANCE]/tips/$TIP_ID/pickup
+.. http:post:: [/instances/$INSTANCE]/rewards/$REWARD_ID/pickup
 
-  Handle request from wallet to pick up a tip.
+  Handle request from wallet to pick up a reward.
 
   **Request:**
 
-  The request body is a `TipPickupRequest` object.
+  The request body is a `RewardPickupRequest` object.
 
   **Response:**
 
   :http:statuscode:`200 OK`:
-    A tip is being returned. The backend responds with a `TipResponse`.
+    A reward is being returned. The backend responds with a `RewardResponse`.
   :http:statuscode:`401 Unauthorized`:
-    The tip amount requested exceeds the tip.
+    The reward amount requested exceeds the reward.
   :http:statuscode:`404 Not found`:
-    The tip identifier is unknown.
+    The reward identifier is unknown.
   :http:statuscode:`409 Conflict`:
     Some of the denomination key hashes of the request do not match those currently available from the exchange (hence there is a conflict between what the wallet requests and what the merchant believes the exchange can provide).
   :http:statuscode:`410 Gone`:
-    The tip has expired.
+    The reward has expired.
 
-  .. ts:def:: TipPickupRequest
+  .. ts:def:: RewardPickupRequest
 
-    interface TipPickupRequest {
+    interface RewardPickupRequest {
 
-      // List of planchets the wallet wants to use for the tip.
+      // List of planchets the wallet wants to use for the reward.
       planchets: PlanchetDetail[];
     }
 
@@ -862,9 +862,9 @@ a website.
       coin_ev: CoinEnvelope;
     }
 
-  .. ts:def:: TipResponse
+  .. ts:def:: RewardResponse
 
-    interface TipResponse {
+    interface RewardResponse {
 
       // Blind RSA signatures over the planchets.
       // The order of the signatures matches the planchets list.