commit 91961d63a885770ad403e7fdadcd5d010cf35789
parent 51fc9f0d4a9cf32e7304e8e0edb08c612482f7c9
Author: Christian Grothoff <grothoff@gnunet.org>
Date: Wed, 12 Apr 2023 22:31:23 +0200
starting with a user guide
Diffstat:
| A | taler-user-guide.rst | | | 145 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 145 insertions(+), 0 deletions(-)
diff --git a/taler-user-guide.rst b/taler-user-guide.rst
@@ -0,0 +1,145 @@
+GNU Taler User Guide
+####################
+
+This guide explains various ways how users can interact with a GNU Taler
+installation. It assumes that a bank, exchange and merchant backend are
+running and that the user has a GNU Taler wallet installed is able to create
+an account at the bank. Some operations also require access to the merchant
+backend.
+
+
+Withdrawing
+===========
+
+Withdrawing is the step where money is moved from a bank account into
+a GNU Taler wallet. There are two main ways to do this.
+
+Bank integrated withdrawal
+--------------------------
+
+If the bank supports it, you can withdraw money into your GNU Taler wallet
+directly from your banking app or online banking website. If supported, there
+should be an option in your online banking to withdraw money to a GNU Taler
+wallet. The bank should ask for the amount and then generate a QR code that
+you need to scan with your GNU Taler wallet. Alternatively, if the
+WebExtension wallet is installed, the bank website may directly switch to the
+GNU Taler wallet. In the GNU Taler wallet, you may have to first confirm the
+terms of service of the selected GNU Taler exchange. Afterwards, applicable
+fees will be shown and you will be given the option to accept the withdrawal.
+Next, you need to authorize the withdraw operation in the bank. If possible,
+the GNU Taler wallet may automatically switch to the bank's website, it is
+also possible that you have to go back to the banking app explicitly. After
+authorizing the withdraw operation, you will have to wait a bit for the money
+to be wired to the exchange. Depending on the banking system, this can take
+anywhere from a few seconds to many hours. Afterwards, the money will show up
+in your wallet.
+
+Wallet initiated withdrawal
+---------------------------
+
+In this case, you will start the withdraw process from the GNU Taler wallet.
+Under "Settings", you will find a list of exchanges. If the list is empty or
+does not contain the desired exchange, you may have to first add the exchange
+by providing the respective URL.
+
+Next to the exchange, there is a drop-down menu with an option to "withdraw".
+(If you already have money in your wallet, you will also find the same button
+when viewing the transaction history of the respective currency.) The wallet
+will ask you to enter the amount to withdraw and accept the terms of service
+and to pay the applicable fees (if any). Afterwards, the wallet will give you
+wire instructions, telling you which amount to wire to which bank account.
+Most importantly, the wallet will give you a wire transfer subject that must
+be specified for the wire transfer. If you make a typo in the subject, the
+wallet will not be charged and the exchange will send the money back to your
+bank account eventually (possibly minus a fee). Simply make the wire transfer
+as instructed by the wallet. Once the money has arrived at the exchange, the
+wallet will automatically withdraw the funds.
+
+
+Depositing
+==========
+
+If you have money in your wallet, you can use the "deposit" button to deposit
+the funds into a bank account. The wallet will ask you to specify the amount
+and the target bank account.
+
+
+Sending cash
+============
+
+Once you have digital cash, you can send it to another GNU Taler
+wallet. Simply specify the amount and a human-readable reason for the
+transfer. The wallet will then show a QR code (and give the option to export
+the payment as a taler://-URL). Send the image of the QR code to the
+receiving wallet (or send the taler://-URL securely to the target wallet).
+
+The target wallet should scan the QR code (or enter the text of the
+taler://-URL into the URL import dialog which is available by holding or
+clicking the QR code scan button). Afterwards, review the reason text and
+accept the funds to complete the transaction.
+
+
+Invoicing
+=========
+
+To receive funds from another user, you can send an invoice to another GNU
+Taler wallet. Simply specify the amount and a human-readable reason for the
+invoice. The wallet will then show a QR code (and give the option to export
+the invoice as a taler://-URL). Send the image of the QR code to the payer
+wallet (or send the taler://-URL to the target wallet).
+
+The target wallet should scan the QR code (or enter the text of the
+taler://-URL into the URL import dialog which is available by holding or
+clicking the QR code scan button). Afterwards, review the reason for
+the invoice and decide whether or not to pay the invoice. Selecting
+"pay" will complete the transaction.
+
+Depending on the configuration of the exchange, the receiving wallet may have
+to undergo some KYC check before the funds are actually released to the
+receiver.
+
+
+Using the Point-of-Sale App
+===========================
+
+
+Setting up an order in the merchant backoffice SPA
+==================================================
+
+
+Paying an order
+===============
+
+The payer simply scans the (dynamic) QR code to initiate the payment. If a
+website is interacting with a WebExtension wallet, it may also directly
+trigger the GNU Taler wallet without requiring the user to explicitly scan the
+QR code. The payer should now review the contract terms and applicable fees.
+Selecting "pay" will complete the transaction. Typically, the wallet will
+then redirect the user to the fulfillment page where they can track the order
+or directly view the digital product that they purchased.
+
+
+Setting up a template
+=====================
+
+
+Paying with static QR codes
+===========================
+
+The payer simply scans the (static) QR code to initiate the payment. If the
+template does not specify a fixed amount, the payer will be prompted to enter
+the amount to be paid (and possibly given the opportunity to specify or alter
+the summary). Selecting "pay" will complete the transaction. If payment
+confirmations are configured by the merchant backend, the wallet will then
+display a confirmation code that can be shown to the merchant as a proof of
+payment.
+
+
+Setting up a webhook
+====================
+
+
+
+
+
+
