[taler-docs] 01/02: circuit API

[gnunet]

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

ms pushed a commit to branch master
in repository docs.

commit bb748c56fe5172489bc99e68cda31ba2da4e76b8
Author: MS <ms@taler.net>
AuthorDate: Tue Jan 10 16:01:08 2023 +0100

    circuit API
    
    document how to test the TAN
---
 libeufin/api-sandbox.rst | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/libeufin/api-sandbox.rst b/libeufin/api-sandbox.rst
index 6afcac7..96ca0e0 100644
--- a/libeufin/api-sandbox.rst
+++ b/libeufin/api-sandbox.rst
@@ -251,6 +251,17 @@ Cashouts
      Consult the `cashout rates call <cashout-rates_>`_ to learn
      about any applicable fee or exchange rate.
 
+   To test this operation without relying on any SMS/E-mail provider,
+   Libeufin offers two methods: defining an environment variable called
+   ``LIBEUFIN_CASHOUT_TEST_TAN`` or specifying the value ``file`` to
+   the ``tan_channel`` field of the `request object <cashout-request_>`_.
+   Assuming ``LIBEUFIN_CASHOUT_TEST_TAN`` is set to *T*, every */confirm*
+   operation can use *T* as the TAN.  Setting instead the ``tan_channel``
+   field to ``file`` will cause the server to (over)write every TAN to
+   ``/tmp/libeufin-cashout-tan.txt``.  If both are used, the environment
+   variable takes the precedence.
+
+
    **Request:**
 
    `CashoutRequest <cashout-request_>`_
@@ -259,7 +270,8 @@ Cashouts
 
      enum TanChannel {
        SMS = "sms",
-       EMAIL = "email"
+       EMAIL = "email",
+       FILE = "file"
      }
 
    .. _cashout-request:

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