commit 6e5161db010aafe5efd9d0903ee4eb1aafaace46
parent 95490a3234556594957a270ff0d051961b4b0ebc
Author: MS <ms@taler.net>
Date: Thu, 7 Dec 2023 21:12:50 +0100
regional manual
how to create orders and spend coins
Diffstat:
3 files changed, 65 insertions(+), 50 deletions(-)
diff --git a/libeufin/create_orders.png b/libeufin/create_orders.png
Binary files differ.
diff --git a/libeufin/payment_links.png b/libeufin/payment_links.png
Binary files differ.
diff --git a/libeufin/regional-manual.rst b/libeufin/regional-manual.rst
@@ -228,34 +228,88 @@ Here, the ``$CONVERSION_URL`` must be set to the base URL of the conversion
endpoint of the bank, which should be ``https://bank.$DOMAIN/conversion-info/``
in our setup.
+Merchant setup
+--------------
+
+In order to setup a shop, you need a merchant backend to run. The installation
+installs and sets one backend up, but the user is required to complete the shop
+configuration via the Web browser.
+
+One fundamental piece of information are the banking details, to allow merchant
+receive payments from the exchange. If you haven't already registered one bank
+account at the regional bank, do at ``$proto://bank.$domain_name/`` and take note
+of the IBAN you just got assigned. After having registered a new account, you
+can see your IBAN by clicking on the ``Welcome, $USERNAME`` message in the profile
+page. The IBAN is shown under the ``Internal IBAN`` box.
-.. _withdraw-simulation:
+Next, point your browser to ``$proto://backend.$domain_name/``. You should
+be welcomed by the following merchant backoffice page:
-Testing the installation
-------------------------
+.. image:: merchant_first_login.png
-In the same ``netzbon/`` folder, run the script ``./withdraw.sh``. If it completes
-successfuly, the command ``taler-wallet-cli`` got 5 units more of regional currency
-to spend!
+Such page offers to create a merchant profile: fill any required field (including
+your access token) and clik to ``confirm``. It should now be possible to associate
+the banking details to the profile just created: click to ``Bank account`` at the
+left of the page. The following page should be shown:
-Visit the default Web shop at ``$protocol://backend.$DOMAIN`` and finish your purchases
-by feeding the wallet CLI with the taler://-URI to send the payment. The following
-example sends a payment to ``$payUri``
+.. image:: no_default_account_yet.png
+
+Click on the blue "+" sign on the top right of the page, and expect the following
+page to appear:
+
+.. image:: enter_instance_details.png
+
+This tutorial is focused on IBAN, so choose ``iban`` as the account type, and
+expect the following page to appear:
+
+.. image:: instance_iban_config.png
+
+After providing the details and confirming, the shop is ready to generate orders
+and accept payments.
+
+Make an order
++++++++++++++
+
+Click on ``Orders`` at the top left corner of the merchant backoffice page; the
+following page should appear
+
+.. image:: create_orders.png
+
+After having filled the required fields, the interface should show the following
+page with the related links to check the status of the order and let wallets pay
+for it. Take note of the link beside ``Payment URI`` (we'll call it ``$payUri``).
+
+.. image:: payment_links.png
+
+In order to test the setup, it should be now possible to use the command line wallet
+to withdraw Taler coins and spend them to buy the order we just created.
+
+Pay for the order
++++++++++++++++++
+
+Run the script ``./withdraw.sh`` without any arguments. After the execution, 5 units
+of the regional currency should be found in your waller CLI. Check it with:
.. code-block:: console
- $ taler-wallet-cli handle-uri $payUri
+ $ taler-wallet-cli balance
+If so, call the wallet in the following way to finally pay for the order just created:
+
+.. code-block:: console
+
+ $ taler-wallet-cli handle-uri $payUri
.. note::
Delete the database records before going to production, as they alter the way
nexus-fetch asks records to the bank.
+
Wallet setup
------------
-Next, you need to add your regional currency exchange to the wallet. This can
+You need to add your regional currency exchange to the wallet. This can
be done by scanning a QR code with a ``taler://add-exchange/exchange.$DOMAIN``
URL or by manually entering the URL into the respective ``Add exchange``
dialogue.
@@ -279,42 +333,3 @@ master ``bank`` account which will effectively destroy the respective
amount of regional currency. The conversion triggers will inform Nexus
about the destruction, and Nexus will then wire the corresponding amount
in fiat to the associated fiat bank account.
-
-Merchant setup
---------------
-
-In order to setup a shop, you need a merchant backend to run. The installation
-installs and sets one backend up, but the user is required to complete the shop
-configuration via the Web browser.
-
-One fundamental piece of information are the banking details, to allow merchant
-receive payments from the exchange. If you haven't already registered one bank
-account at the regional bank, do at ``$proto://bank.$domain_name/`` and take note
-of the IBAN you just got assigned. After having registered a new account, you
-can see your IBAN by clicking on the ``Welcome, $USERNAME`` message in the profile
-page. The IBAN is shown under the ``Internal IBAN`` box.
-
-Next, point your browser to ``$proto://backend.$domain_name/``. You should
-be welcomed by the following page:
-
-.. image:: merchant_first_login.png
-
-Such page offers to create a merchant profile: fill any required field (including
-your access token) and clik to ``confirm``. It should now be possible to associate
-the banking details to the profile just created: click to ``Bank account`` at the
-left of the page. The following page should be shown:
-
-.. image:: no_default_account_yet.png
-
-Click on the blue "+" sign on the top right of the page, and expect the following
-page to appear:
-
-.. image:: enter_instance_details.png
-
-This tutorial is focused on IBAN, so choose ``iban`` as the account type, and
-expect the following page to appear:
-
-.. image:: instance_iban_config.png
-
-After providing the details and confirming, the shop is ready to generate orders
-and accept payments.
