taler-docs

commit 95077e83925e9e5696501e3bb47ee9efb1fa1214
parent bde9651397946b143e31eb8e0c2613cc7e0705f3
Author: Christian Grothoff <christian@grothoff.org>
Date:   Thu, 30 Nov 2017 11:21:54 +0100

properly document TALER_SIGNATURE_MERCHANT_REFUND_OK

Diffstat:
M
api-common.rst
 | 
11
+++++++++++
M
api-merchant.rst
 | 
8
+++-----

2 files changed, 14 insertions(+), 5 deletions(-)
diff --git a/api-common.rst b/api-common.rst
@@ -724,6 +724,17 @@ within the
     struct TALER_AmountNBO refund_fee;
   };
 
+  struct TALER_MerchantRefundConfirmationPS {
+    /**
+     *  purpose.purpose = TALER_SIGNATURE_MERCHANT_REFUND_OK
+     */
+    struct GNUNET_CRYPTO_EccSignaturePurpose purpose;
+    /**
+     * Hash of the order ID (a string), hashed without the 0-termination.
+     */
+    struct GNUNET_HashCode h_order_id;
+  };
+
 
 .. _TALER_PaybackRequestPS:
 .. sourcecode:: c
diff --git a/api-merchant.rst b/api-merchant.rst
@@ -277,10 +277,8 @@ The following API are made available by the merchant's `backend` to the merchant
   .. code-block:: tsref
 
     interface RefundConfirmation {
-      // Merchant signature over the hashed order id. Note
-      // that the purpose is set to zero.  However, this value
-      // is not meant to be soon verified by the frontend, but
-      // could be showed in court.
+      // Merchant signature over the hashed order id.
+      // The purpose is `TALER_SIGNATURE_MERCHANT_REFUND_OK`.
       sig: EddsaSignature
     }
 
@@ -367,7 +365,7 @@ The following API are made available by the merchant's `backend` to the merchant
   :status 200 OK:
     A tip has been created. The backend responds with a `TipCreateConfirmation`_
   :status 404 Not Found:
-    The instance is unknown to the backend, expired or was never enabled.    
+    The instance is unknown to the backend, expired or was never enabled.
   :status 412 Precondition Failed:
     The tip amount requested exceeds the available reserve balance for tipping.