commit 7e1e2dc83f2ac63ada709f35c23a9bcbb13c6db9
parent 4be65231eb262bbf1b192edd4beb722d0cac2d56
Author: Christian Grothoff <christian@grothoff.org>
Date: Mon, 5 Feb 2024 01:17:42 +0100
deprecate rewards, bump to protocol v8
Diffstat:
1 file changed, 22 insertions(+), 2 deletions(-)
diff --git a/core/api-merchant.rst b/core/api-merchant.rst
@@ -1,6 +1,6 @@
..
This file is part of GNU TALER.
- Copyright (C) 2014-2023 Taler Systems SA
+ Copyright (C) 2014-2024 Taler Systems SA
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License as published by the Free Software
@@ -121,7 +121,7 @@ such as the implemented version of the protocol and the currency used.
.. http:get:: /config
Return the protocol version and currency supported by this merchant backend.
- This specification corresponds to ``current`` protocol being version **6**.
+ This specification corresponds to ``current`` protocol being version **8**.
**Response:**
@@ -2698,6 +2698,10 @@ once we got a reply from the exchange.
Backend: Giving rewards
-----------------------
+.. note::
+
+ This API is deprecated as of protocol v8.
+
Rewards are a way for websites to give small amounts of e-cash to visitors (for
example as a financial reward for providing information or viewing
advertisements). Rewards are non-contractual: neither merchant nor consumer
@@ -2708,6 +2712,10 @@ reward.
Create reserve
--------------
+.. note::
+
+ This API is deprecated as of protocol v8.
+
Reserves are basically funds a merchant has provided to an exchange for a
rewards campaign. Each reserve has a limited lifetime (say 2--4 weeks). Any
funds not used to reward customers will automatically be wired back from the
@@ -2909,6 +2917,10 @@ Query funds remaining
Authorizing rewards
-------------------
+.. note::
+
+ This API is deprecated as of protocol v8.
+
.. http:post:: [/instances/$INSTANCE]/private/reserves/$RESERVE_PUB/authorize-reward
Authorize creation of a reward from the given reserve.
@@ -2983,6 +2995,10 @@ Authorizing rewards
Deleting reserves
-----------------
+.. note::
+
+ This API is deprecated as of protocol v8.
+
.. http:delete:: [/instances/$INSTANCE]/private/reserves/$RESERVE_PUB
Delete information about a reserve. Fails if the reserve still has
@@ -3008,6 +3024,10 @@ Deleting reserves
Checking reward status
----------------------
+.. note::
+
+ This API is deprecated as of protocol v8.
+
.. http:get:: [/instances/$INSTANCE]/private/rewards/$REWARD_ID
Obtain information about a particular reward.
