gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[taler-docs] branch master updated: wallet API docs, WIP


From: gnunet
Subject: [taler-docs] branch master updated: wallet API docs, WIP
Date: Thu, 09 Jul 2020 15:28:05 +0200

This is an automated email from the git hooks/post-receive script.

dold pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new bc7722e  wallet API docs, WIP
bc7722e is described below

commit bc7722eeee3655a44edf3a245a8a4a74977332ed
Author: Florian Dold <florian.dold@gmail.com>
AuthorDate: Thu Jul 9 18:58:00 2020 +0530

    wallet API docs, WIP
---
 taler-wallet.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

diff --git a/taler-wallet.rst b/taler-wallet.rst
index ed08136..c65ea3b 100644
--- a/taler-wallet.rst
+++ b/taler-wallet.rst
@@ -398,6 +398,59 @@ Refunds
       contractTermsHash: string;
     }
 
+Exchange Management: List Exchanges
+-----------------------------------
+
+:name: ``"listExchanges"``
+:description:
+  List all exchanges.  Can be used on the CLI
+  as ``taler-wallet-cli exchanges list``.
+:response:
+  .. ts:def:: ExchangesListRespose
+  
+    interface ExchangesListRespose {
+      exchanges: ExchangeListItem[];
+    }
+
+  .. ts:def:: ExchangeListItem
+
+    interface ExchangeListItem {
+      exchangeBaseUrl: string;
+      currency: string;
+      paytoUris: string[];
+    }
+
+Exchange Management: Add Exchange
+---------------------------------
+
+:name: ``"addExchange"``
+:description:
+  Add an exchange.  Can be used on the CLI as ``taler-wallet-cli exchanges add 
$URL``.
+:request:
+  .. ts:def:: ExchangeAddRequest
+
+    interface ExchangeAddRequest {
+      exchangeBaseUrl: string;
+    }
+:response:
+  On success, the response is an empty object.
+
+Withdrawal: Get Manual Withdrawal Info
+--------------------------------------
+
+:name: ``"getWithdrawalDetailsForAmount"``
+:description:
+  Get information about fees and exchange for a manual withdrawal of a given 
amount.
+:request:
+  .. ts:def:: GetManualWithdrawalDetailsRequest
+
+    interface ExchangeAddRequest {
+      exchangeBaseUrl: string;
+      amount: string;
+    }
+:response:
+  An ``ExchangeWithdrawDetails`` object (to be documented, see `here
+  
<https://git.taler.net/wallet-core.git/tree/src/types/walletTypes.ts#n61>`__).
 
 Integration Tests
 =================

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]