summaryrefslogtreecommitdiff
path: root/taler-wallet.rst
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2020-07-09 18:58:00 +0530
committerFlorian Dold <florian.dold@gmail.com>2020-07-09 18:58:00 +0530
commitbc7722eeee3655a44edf3a245a8a4a74977332ed (patch)
tree5340b6923d75b3e06eb0d7c97c6d7ffb5efbced9 /taler-wallet.rst
parent2f705cc5d651a7eb05519ebc86d275b1008000e7 (diff)
downloaddocs-bc7722eeee3655a44edf3a245a8a4a74977332ed.tar.gz
docs-bc7722eeee3655a44edf3a245a8a4a74977332ed.tar.bz2
docs-bc7722eeee3655a44edf3a245a8a4a74977332ed.zip
wallet API docs, WIP
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r--taler-wallet.rst53
1 files changed, 53 insertions, 0 deletions
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
=================