taler-docs

commit b483058f436cfdab7718e87bd65eb8cc4f5adbd1
parent df48100198297b993ad47f25cf4584536a9d507a
Author: Christian Grothoff <christian@grothoff.org>
Date:   Sun, 22 Oct 2017 18:49:28 +0200

spec /tip-enable API, remove unnecessary instance from /tip-pickup

Diffstat:
M
api-merchant.rst
 | 
35
++++++++++++++++++++++++++++++++---

1 file changed, 32 insertions(+), 3 deletions(-)
diff --git a/api-merchant.rst b/api-merchant.rst
@@ -322,6 +322,38 @@ The following API are made available by the merchant's `backend` to the merchant
     }
 
 
+.. http:post:: /tip-enable
+
+  Enable tipping by telling the backend that a reserve was created with funds for tipping.
+
+  **Request**
+
+  The request body is a `TipEnable`_ object.  Note that if an existing,
+  non-expired reserve is credited, the credits are added and the
+  expiration time is updated to the max of the expiration times.
+
+  **Response**
+
+  :status 200 OK:
+    A reserve with credit for tipping has been created. The response is empty.
+
+  .. _TipEnable:
+  .. code-block:: tsref
+
+    interface TipEnable {
+      // Amount that was credited to the reserve
+      credit: Amount;
+
+      // Expiration time for the reserve
+      expiration: Timestamp;
+
+      // Private key of the reserve
+      reserve_priv: ReservePrivateKeyP;
+
+      // Unique ID for the wire transfer, used to detect duplicate credits
+      credit_uuid: HashCode;
+    }
+
 .. http:post:: /tip-authorize
 
   Authorize a tip that can be picked up by the customer's wallet by POSTing to `/tip-pickup`.  Note that this is simply the authorization step the back office has to trigger first.  The frontend must return the tip's identifier (and exchange URL) via a "402 Payment Required" response to the wallet.
@@ -394,9 +426,6 @@ The following API are made available by the merchant's `backend` to the merchant
 
     interface TipPickupRequest {
 
-      // Merchant instance issuing the request
-      instance: string;
-
       // Identifier of the tip.
       tip_id: HashCode;