From 16466dd547243332ad1284827f34369442e1bc3c Mon Sep 17 00:00:00 2001
From: Torsten Grote <t@grobox.de>
Date: Mon, 18 May 2020 10:21:13 -0300
Subject: clarify amounts in transactions API

---
 taler-wallet.rst | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

(limited to 'taler-wallet.rst')

diff --git a/taler-wallet.rst b/taler-wallet.rst
index 0308e572..ce369002 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -230,6 +230,7 @@ Transactions are all operations or events that are affecting the balance.
       amountRaw: Amount;
 
       // Amount that actually was (or will be) added to the wallet's balance.
+      // Should always be shown as a positive amount.
       amountEffective: Amount;
     }
 
@@ -248,6 +249,7 @@ Transactions are all operations or events that are affecting the balance.
       amountRaw: Amount;
 
       // Amount that was paid, including deposit, wire and refresh fees.
+      // Should always be shown as a negative amount.
       amountEffective: Amount;
     }
 
@@ -310,7 +312,8 @@ Transactions are all operations or events that are affecting the balance.
       // Amount that has been refunded by the merchant
       amountRaw: Amount;
 
-      // Amount will be added to the wallet's balance after fees and refreshing
+      // Amount will be added to the wallet's balance after fees and refreshing.
+      // Should always be shown as a positive amount.
       amountEffective: Amount;
     }
 
@@ -331,7 +334,8 @@ Transactions are all operations or events that are affecting the balance.
       // Raw amount of the tip, without extra fees that apply
       amountRaw: Amount;
 
-      // Amount will be (or was) added to the wallet's balance after fees and refreshing
+      // Amount will be (or was) added to the wallet's balance after fees and refreshing.
+      // Should always be shown as a positive amount.
       amountEffective: Amount;
     }
 
@@ -365,7 +369,8 @@ Transactions are all operations or events that are affecting the balance.
       // Raw amount that is refreshed
       amountRaw: Amount;
 
-      // Amount that will be paid as fees for the refresh
+      // Amount that will be paid as fees for the refresh.
+      // Should always be shown as a negative amount.
       amountEffective: Amount;
     }
 
-- 
cgit v1.2.3