From bc7722eeee3655a44edf3a245a8a4a74977332ed Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Thu, 9 Jul 2020 18:58:00 +0530 Subject: wallet API docs, WIP --- taler-wallet.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) (limited to 'taler-wallet.rst') diff --git a/taler-wallet.rst b/taler-wallet.rst index ed081363..c65ea3b6 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 + `__). Integration Tests ================= -- cgit v1.2.3 From c2bd5b95d3a32eeedb4cf0d9dbd15d0cd7191f8e Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Thu, 9 Jul 2020 19:35:02 +0530 Subject: docs --- taler-wallet.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'taler-wallet.rst') diff --git a/taler-wallet.rst b/taler-wallet.rst index c65ea3b6..8d348efc 100644 --- a/taler-wallet.rst +++ b/taler-wallet.rst @@ -403,8 +403,9 @@ Exchange Management: List Exchanges :name: ``"listExchanges"`` :description: - List all exchanges. Can be used on the CLI - as ``taler-wallet-cli exchanges list``. + List all exchanges. +:cli: + ``taler-wallet-cli exchanges list`` :response: .. ts:def:: ExchangesListRespose @@ -425,7 +426,9 @@ Exchange Management: Add Exchange :name: ``"addExchange"`` :description: - Add an exchange. Can be used on the CLI as ``taler-wallet-cli exchanges add $URL``. + Add an exchange. +:cli: + ``taler-wallet-cli exchanges add $URL`` :request: .. ts:def:: ExchangeAddRequest @@ -441,6 +444,8 @@ 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 -- cgit v1.2.3