taler-docs

commit c0ec8721b8ab34a3e8105473bb6358621f099820
parent 4089195734651c33bffe7ca5a68f0a7222a2b33e
Author: Christian Grothoff <christian@grothoff.org>
Date:   Sun, 24 Apr 2016 06:33:42 +0200

specifying how refunds show up in coin transaction histories

Diffstat:
M
api-exchange.rst
 | 
11
+++++++----

1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/api-exchange.rst b/api-exchange.rst
@@ -570,25 +570,28 @@ denomination.
       history: CoinSpendHistoryItem[];
     }
 
+  .. _CoinSpendHistoryItem:
   .. code-block:: tsref
 
     interface CoinSpendHistoryItem {
-      // Either "deposit" or "melt"
+      // Either "deposit" or "melt" or "refund"
       type: string;
 
-      // The total amount of the coin's value absorbed by this transaction
+      // The total amount of the coin's value absorbed (or restored in the case of a refund) by this transaction
       amount: Amount;
 
       // base32 binary encoding of the transaction data as a
       // `TALER_DepositRequestPS` or `TALER_RefreshMeltCoinAffirmationPS`
+      // or `TALER_RefundRequestPS`
       // struct described in :ref:`Signatures`.  Its `purpose` should match our
       // `type`, `amount_with_fee`, should match our `amount`, and its `size`
-      // should be consistent.
+      // should be consistent with the respective struct type.
       details: string;
 
       // the EdDSA :ref:`signature` (binary-only) made with purpose
       // `TALER_SIGNATURE_WALLET_COIN_DEPOSIT` or
-      // `TALER_SIGNATURE_WALLET_COIN_MELT` over the transaction's details.
+      // `TALER_SIGNATURE_WALLET_COIN_MELT` or
+      // `TALER_SIGNATURE_MERCHANT_REFUND` over the transaction's details.
       signature: EddsaSignature;
     }