summaryrefslogtreecommitdiff
path: root/taler-wallet.rst
diff options
context:
space:
mode:
authorTorsten Grote <t@grobox.de>2020-04-29 09:45:15 -0300
committerTorsten Grote <t@grobox.de>2020-04-29 09:45:15 -0300
commitd6df3784a31df42b5d2e77ef92259b62c7a6c47b (patch)
tree2a8c3c8404e8ea50406410c3ba22a9ebf3e2cd76 /taler-wallet.rst
parent8a6d90384d3e1af4412c1be91e8e2ca9c777c183 (diff)
downloaddocs-d6df3784a31df42b5d2e77ef92259b62c7a6c47b.tar.gz
docs-d6df3784a31df42b5d2e77ef92259b62c7a6c47b.tar.bz2
docs-d6df3784a31df42b5d2e77ef92259b62c7a6c47b.zip
slight tweaks to proposed transactions wallet API
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r--taler-wallet.rst40
1 files changed, 36 insertions, 4 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst
index 9ebc1f3..f916121 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -121,6 +121,12 @@ Transactions are all operations or events that are affecting the balance.
// true if the transaction is still pending, false otherwise
pending: boolean;
+
+ // Raw amount of the transaction (exclusive of fees or other extra costs)
+ amountRaw: Amount;
+
+ // Amount added or removed from the wallet's balance (including all fees and other costs)
+ amountEffective: Amount;
}
.. ts:def:: TransactionType
@@ -129,7 +135,8 @@ Transactions are all operations or events that are affecting the balance.
TransactionWithdrawal |
TransactionPayment |
TransactionRefund |
- TransactionTip
+ TransactionTip |
+ TransactionRefresh
)
.. ts:def:: TransactionWithdrawal
@@ -165,6 +172,13 @@ Transactions are all operations or events that are affecting the balance.
// Additional information about the payment.
info: TransactionInfo;
+ // true if the payment failed, false otherwise.
+ // Note that failed payments with zero effective amount will not be returned by the API.
+ failed: boolean;
+
+ // Amount that must be paid for the contract
+ amountRaw: Amount;
+
// Amount that was paid, including deposit, wire and refresh fees.
amountEffective: Amount;
}
@@ -178,9 +192,6 @@ Transactions are all operations or events that are affecting the balance.
// More information about the merchant
merchant: Merchant;
- // Amount that must be paid for the contract
- amount: Amount;
-
// Summary of the order, given by the merchant
summary: string;
@@ -199,6 +210,9 @@ Transactions are all operations or events that are affecting the balance.
interface TransactionRefund extends Transaction {
type: string = "refund",
+ // ID for the transaction that is refunded
+ refundedTransactionId: string;
+
// Additional information about the refunded payment
info: TransactionInfo;
@@ -236,6 +250,24 @@ Transactions are all operations or events that are affecting the balance.
amountEffective: Amount;
}
+ .. ts:def:: TransactionRefresh
+
+ // A transaction shown for refreshes that are not associated to other transactions
+ // such as a refresh necessary before coin expiration.
+ // It should only be returned by the API if the effective amount is different from zero.
+ interface TransactionRefresh extends Transaction {
+ type: string = "refresh",
+
+ // Exchange that the coins are refreshed with
+ exchangeBaseUrl: string;
+
+ // Raw amount that is refreshed
+ amountRaw: Amount;
+
+ // Amount that will be paid as fees for the refresh
+ amountEffective: Amount;
+ }
+
Refunds
-------