[taler-docs] branch master updated: cash-out estimation endpoint

[gnunet]

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

ms pushed a commit to branch master
in repository docs.

The following commit(s) were added to refs/heads/master by this push:
     new f6d23e4  cash-out estimation endpoint
f6d23e4 is described below

commit f6d23e4c3486899c9e22411b37e2f6e4b0a38d9f
Author: ms <ms@taler.net>
AuthorDate: Mon Mar 20 15:56:08 2023 +0100

    cash-out estimation endpoint
---
 libeufin/api-sandbox.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index e00df7f..7e42c8e 100644
--- 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

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