summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTorsten Grote <t@grobox.de>2020-05-18 10:21:13 -0300
committerTorsten Grote <t@grobox.de>2020-05-18 10:21:13 -0300
commit16466dd547243332ad1284827f34369442e1bc3c (patch)
treeeb0c3f299ce6aa95be88d1546dd30addf8c494e9
parent07b15dd14a52805b8c7c6f2621182c750e1dcc62 (diff)
downloaddocs-16466dd547243332ad1284827f34369442e1bc3c.tar.gz
docs-16466dd547243332ad1284827f34369442e1bc3c.tar.bz2
docs-16466dd547243332ad1284827f34369442e1bc3c.zip
clarify amounts in transactions API
-rw-r--r--taler-wallet.rst11
1 files changed, 8 insertions, 3 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst
index 0308e57..ce36900 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;
}