taler-docs

commit 84aaedffc6ab612595e724103a1b7b3311b23417
parent 58dffa046cc531114a031d2cfcc833f987285155
Author: Torsten Grote <t@grobox.de>
Date:   Wed, 13 May 2020 10:18:31 -0300

Add TransactionError to transaction API

Diffstat:
M
taler-wallet.rst
 | 
17
+++++++++++++++++

1 file changed, 17 insertions(+), 0 deletions(-)
diff --git 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