commit f6d23e4c3486899c9e22411b37e2f6e4b0a38d9f parent 7fa5f82998932fab827797dba5d302ace551db11 Author: ms <ms@taler.net> Date: Mon, 20 Mar 2023 15:56:08 +0100 cash-out estimation endpoint Diffstat:
| M | libeufin/api-sandbox.rst | | | 25 | +++++++++++++++++++++++++ |
1 file changed, 25 insertions(+), 0 deletions(-)
diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst @@ -451,6 +451,31 @@ Cashouts :http:statuscode:`412 Precondition failed`: ``$cashoutId`` was already confirmed. + +.. http:get:: /cashouts/estimates + + This endpoint shows how the bank would apply the cash-out + ratio and fee to one input amount. Typically, frontends + ask this endpoint before creating cash-out operations. There + is **no** financial consequence to this endpoint and only + registered users are allowed to request. + + **Request:** + + :query amount_debit: this is the amount (including the regional currency) + that the user will get deducted from their regional bank account. + + **Response:** + + .. ts:def:: CashoutEstimate + + interface CashoutEstimate { + // Amount that the user will receive in their fiat + // bank account, after having TAN-confirmed the cash-out + // operation. + amount_credit: Amount; + } + .. _cashout-rates: .. http:get:: /config