taler-docs

commit 8918201896dba4d55f7344ab0190252d57720633
parent d4a9a2e494b1aa60079c9d726e589f7e6161cbee
Author: Florian Dold <florian.dold@gmail.com>
Date:   Thu, 16 Jul 2020 23:18:23 +0530

wallet api

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

1 file changed, 30 insertions(+), 8 deletions(-)
diff --git a/taler-wallet.rst b/taler-wallet.rst
@@ -213,6 +213,33 @@ Transactions are all operations or events that are affecting the balance.
      details?: any;
    }
 
+  .. ts:def:: WithdrawalDetails
+
+    export type WithdrawalDetails =
+      | WithdrawalDetailsForManualTransfer
+      | WithdrawalDetailsForTalerBankIntegrationApi;
+
+    interface WithdrawalDetailsForManualTransfer {
+      type: "manual-transfer";
+
+      // Payto URIs that the exchange supports.
+      // Already contains the amount and message.
+      exchangePaytoUris: string[];
+    }
+
+    interface WithdrawalDetailsForTalerBankIntegrationApi {
+      type: "taler-bank-integration-api";
+
+      // Set to true if the bank has confirmed the withdrawal, false if not.
+      // An unconfirmed withdrawal usually requires user-input and should be highlighted in the UI.
+      // See also bankConfirmationUrl below.
+      confirmed: boolean;
+
+      // If the withdrawal is unconfirmed, this can include a URL for user
+      // initiated confirmation.
+      bankConfirmationUrl?: string;
+    }
+
   .. ts:def:: TransactionWithdrawal
 
     // This should only be used for actual withdrawals
@@ -223,20 +250,15 @@ Transactions are all operations or events that are affecting the balance.
       // Exchange that was withdrawn from.
       exchangeBaseUrl: string;
 
-      // true if the bank has confirmed the withdrawal, false if not.
-      // An unconfirmed withdrawal usually requires user-input and should be highlighted in the UI.
-      // See also bankConfirmationUrl below.
-      confirmed: boolean;
-
-      // If the withdrawal is unconfirmed, this can include a URL for user initiated confirmation.
-      bankConfirmationUrl?: string;
-
       // Amount that has been subtracted from the reserve's balance for this withdrawal.
       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;
+
+      // Further details
+      withdrawalDetails: WithdrawalDetails;
     }
 
   .. ts:def:: TransactionPayment