commit 2caa9ec930895ab79b8182a21b70ed15dac4b8b7
parent 613e61583ff4d75d62040b451f473943cf658d00
Author: MS <ms@taler.net>
Date: Wed, 4 Jan 2023 14:29:02 +0100
Local currencies tutorial.
Tell how to register new shops belonging
to a local currency 'circuit'.
Diffstat:
1 file changed, 31 insertions(+), 0 deletions(-)
diff --git a/libeufin/nexus-tutorial.rst b/libeufin/nexus-tutorial.rst
@@ -452,6 +452,37 @@ For more information on the available commands, use the built-in ``--help`` flag
The full functionality of the sandbox is available via
the :ref:`Sandbox API <sandbox-api>`.
+Register merchants for local currencies (experimental)
+------------------------------------------------------
+
+This feature allows to register merchants to participate
+in a local currency circuit. After having installed the
+Sandbox with the steps described above, the administrator
+can now register new merchant accounts with the following
+command. The main difference with ordinary registrations
+is that this API offers to associate a `cash-out` address
+to the account, so that merchants can convert the local
+currency back to their fiat bank account.
+
+.. note::
+ Disable ordinary registrations as described in the previous section,
+ to make sure that only the administrator can add new accounts.
+
+.. code-block:: console
+
+ $ export LIBEUFIN_SANDBOX_USERNAME=admin
+ $ export LIBEUFIN_SANDBOX_PASSWORD=$password
+ $ export LIBEUFIN_NEW_CIRCUIT_ACCOUNT_PASSWORD=$circuit-account-password
+ $ libeufin-cli sandbox demobank circuit-register \
+ --username=example-shop \
+ --email=example-shop@example.com \
+ --cashout-address=payto://iban/EXAMPLESHOP-FIAT-IBAN \
+ --name="Example Shop"
+
+
+If the command exited successfully, the new user should be
+able to login with the ``$circuit-account-username`` and
+``$circuit-account-password`` credentials. Run ``libeufin-cli sandbox demobank circuit-register --help``, for additional information about the other options.
Connect Nexus with an EBICS account
===================================
