diff options
author | Florian Dold <florian.dold@gmail.com> | 2020-07-16 23:12:51 +0530 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2020-07-16 23:13:08 +0530 |
commit | d4a9a2e494b1aa60079c9d726e589f7e6161cbee (patch) | |
tree | c127fcb85b8604e798764bcff71ca8c267763169 /taler-wallet.rst | |
parent | 4d318f9cea6d05037a95b347985d6d488550e107 (diff) | |
download | docs-d4a9a2e494b1aa60079c9d726e589f7e6161cbee.tar.gz docs-d4a9a2e494b1aa60079c9d726e589f7e6161cbee.tar.bz2 docs-d4a9a2e494b1aa60079c9d726e589f7e6161cbee.zip |
wallet api
Diffstat (limited to 'taler-wallet.rst')
-rw-r--r-- | taler-wallet.rst | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/taler-wallet.rst b/taler-wallet.rst index 35210cb5..306cd4f0 100644 --- 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 ================= |