summaryrefslogtreecommitdiff
path: root/taler-wallet.rst
diff options
context:
space:
mode:
authorTorsten Grote <t@grobox.de>2020-05-13 10:18:31 -0300
committerTorsten Grote <t@grobox.de>2020-05-13 10:18:49 -0300
commit84aaedffc6ab612595e724103a1b7b3311b23417 (patch)
treefe38fe4cb24d99d3b386206fc59675c299073afd /taler-wallet.rst
parent58dffa046cc531114a031d2cfcc833f987285155 (diff)
downloaddocs-84aaedffc6ab612595e724103a1b7b3311b23417.tar.gz
docs-84aaedffc6ab612595e724103a1b7b3311b23417.tar.bz2
docs-84aaedffc6ab612595e724103a1b7b3311b23417.zip
Add TransactionError to transaction API
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r--taler-wallet.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst
index beae206..e7351fd 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -127,6 +127,9 @@ Transactions are all operations or events that are affecting the balance.
// but its transactionId will remain unchanged
pending: boolean;
+ // if present, the transaction encountered a fatal error that needs to be shown to the user
+ error?: TransactionError;
+
// Raw amount of the transaction (exclusive of fees or other extra costs)
amountRaw: Amount;
@@ -144,6 +147,20 @@ Transactions are all operations or events that are affecting the balance.
TransactionRefresh
)
+ .. ts:def:: TransactionError
+
+ interface TransactionError {
+ // TALER_EC_* unique error code.
+ // The action(s) offered and message displayed on the transaction item depend on this code.
+ ec: number;
+
+ // English-only error hint, if available.
+ hint?: string;
+
+ // Error details specific to "ec", if applicable/available
+ details?: any;
+ }
+
.. ts:def:: TransactionWithdrawal
// This should only be used for actual withdrawals