taler-docs

commit d4a9a2e494b1aa60079c9d726e589f7e6161cbee
parent 4d318f9cea6d05037a95b347985d6d488550e107
Author: Florian Dold <florian.dold@gmail.com>
Date:   Thu, 16 Jul 2020 23:12:51 +0530

wallet api

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

1 file changed, 59 insertions(+), 0 deletions(-)
diff --git a/taler-wallet.rst b/taler-wallet.rst
@@ -519,6 +519,65 @@ Withdrawal: Get Manual Withdrawal Info
       paytoUris: string[];
     }
 
+Withdrawal: Accept Manual Withdrawal
+------------------------------------
+
+:Name: ``"acceptManualWithdrawal"``
+:Description:
+  Accept a manual withdrawal, where the user has to transfer funds manually.
+:CLI:
+  ``taler-wallet-cli advanced withdraw-manually --exchange $EXCHANGE --amount $AMOUNT``
+:Request:
+  .. ts:def:: AcceptManualWithdrawalRequest
+
+    interface AcceptManualWithdrawalRequest {
+      exchangeBaseUrl: string;
+      amount: AmountString;
+    }
+:Response:
+  .. ts:def:: AcceptManualWithdrawalResponse
+
+    interface AcceptManualWithdrawalResponse {
+      // Payto URIs to fund the withdrawal,
+      // with amount and message provided.
+      exchangePaytoUris: string[];
+    }
+
+Withdrawal: Get Manual Withdrawal Info
+--------------------------------------
+
+:Name: ``"getWithdrawalDetailsForAmount"``
+:Description:
+  Get information about fees and exchange for a manual withdrawal of a given amount.
+:CLI:
+  ``taler-wallet-cli advanced manual-withdrawal-details $URL $AMOUNT``
+:Request:
+  .. ts:def:: GetManualWithdrawalDetailsRequest
+
+    interface ExchangeAddRequest {
+      exchangeBaseUrl: string;
+      amount: string;
+    }
+:Response:
+  .. ts:def:: ManualWithdrawalDetails
+
+    export interface ManualWithdrawalDetails {
+      // Did the user accept the current version of the exchange's
+      // terms of service?
+      tosAccepted: boolean;
+
+      // Amount that the user will transfer to the exchange.
+      rawAmount: AmountString;
+
+      // Amount that will be added to the user's wallet balance.
+      effectiveAmount: AmountString;
+
+      // Ways to pay the exchange.
+      // Does not include the amount and message, as the
+      // withdrawal has not been accepted yet.
+      paytoUris: string[];
+    }
+
 Integration Tests
 =================