regional-manual-use.rst (5649B)
1 .. 2 This file is part of GNU TALER. 3 Copyright (C) 2014-2024 Taler Systems SA 4 5 TALER is free software; you can redistribute it and/or modify it under the 6 terms of the GNU Affero General Public License as published by the Free Software 7 Foundation; either version 2.1, or (at your option) any later version. 8 9 TALER is distributed in the hope that it will be useful, but WITHOUT ANY 10 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 11 A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. 12 13 You should have received a copy of the GNU Affero General Public License along with 14 TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> 15 16 @author Florian Dold 17 @author Marcello Stanisci 18 @author Christian Grothoff 19 20 .. _regional-use: 21 22 Using the Regional Currency 23 =========================== 24 25 The very first step you should check after the installation process has been 26 completed successfully, is to make sure all three URLs (bank, backend and exchange), 27 are available (this means to see a Website, and not any NGINX error). 28 29 30 Bank backend walkthrough 31 +++++++++++++++++++++++++ 32 33 - As stated above, please visit before "https://bank.$DOMAIN_NAME", to make sure it is available. 34 35 - Now login with the username "admin" and the password you have choosen during the installation process, or use the one which might 36 have been generated automatically (and shown on your terminal screen), during the installation process. 37 Once inside the Bank Administrator area, please create the "very first" customer account. 38 39 - Transfer some funds from the "admin" bank account to this new customer account. 40 41 - Now logout from the "admin" account, and login again using the recently "customer" account you have created, and make sure the funds you have transfered from admin, have arrived correctly. 42 43 - Now, please choose the option "Send Money to a Taler Wallet", and try to send for example 100 units of your regional currency to the 44 wallet installed on your browser or mobile phone. 45 46 - Now try to spend some of these funds from your wallet, and try to buy something somewhere, with the same digital currency you have choosen, during your installation process, let's say Netzbon. 47 48 - Lastly, you can also try to transfer funds to another "bank account",for that you will need to know the recipient's username or the bank account ID. 49 50 If you have successfully accomplished all the previous steps, for the bank administrator 51 backend and your installed Wallet, you can move now to test other components such 52 as the Merchant backend (https://backend.$DOMAIN_NAME). 53 54 Wallet Setup 55 ++++++++++++ 56 57 This section describes the interaction between the Taler graphical wallet (Android, 58 iOS, WebExtensions) and the regional currency system. 59 60 You need to add your regional currency exchange to the wallet. This can 61 be done by scanning a QR code with a ``taler://withdraw-exchange/exchange.$DOMAIN_NAME/$MASTER_PUBLIC_KEY`` 62 URL or by manually entering the URL into the respective ``Add exchange`` 63 dialogue. 64 65 .. _regional-use-cashin: 66 67 Cash-In 68 +++++++ 69 70 Next, start the withdraw process in the Taler wallet for the respective 71 currency and specify the desired amount. The wallet will then show you the 72 details of the fiat wire transfer that must be made for the cash-in to be 73 completed. Once the money has arrived at the fiat bank account, Nexus will 74 obtain the transaction data and the regional currency bank will create the 75 corresponding amount in regional currency, crediting the GNU Taler exchange 76 account. In turn, the exchange will issue the respective amount to your 77 wallet. 78 79 .. note:: 80 81 Cash-in operations may be subject to conversion rates, conversion fees and 82 minimum amounts to be transferred. 83 84 .. warning:: 85 86 Cash-in operations can take a long time, hours at the best of times, and even days on weekends or holidays when the bank is closed. 87 88 Making payments 89 +++++++++++++++ 90 91 For testing, you should be able to *deposit* regional currency directly into 92 your regional currency libeufin-bank account directly from the Taler wallet. 93 For this, you primarily need to know your bank account details (which should 94 be accessible by clicking on your name in the bank Web site after logging in). 95 96 .. note:: 97 98 There may be a short delay between the wallet making the deposit and 99 the exchange crediting your bank account. This is because the wallet 100 uses a small wire transfer delay by default when initiating a deposit 101 into a bank account. 102 103 For production, it is more common for a shop to configure a :ref:`Taler 104 merchant backend <taler-merchant-backend-operator-manual>` or at least use an 105 instance within such a setup. To configure an instance, you primarily need 106 again the bank account details to :ref:`setup instance bank accounts 107 <instance-bank-account>`. 108 109 .. _regional-use-cashout: 110 111 Cash-Out 112 ++++++++ 113 114 Regional currency accounts that have a positive balance could be eligible for 115 cash-out. Cash-out operations may again be restricted by the regional 116 currency operator and will *only* be made to the respective pre-configured 117 fiat currency bank account. To cash-out, simply log into your regional 118 currency account, select cash-out, specify the desired amount and pass the 119 second-factor authorization challenge by entering the TAN you receive at the 120 registered e-mail address or mobile phone number. 121 122 .. note:: 123 124 Cash-out operations may be subject to conversion rates, conversion fees and 125 minimum amounts to be transferred. 126 127 .. warning:: 128 129 Cash-out operations can take a long time, hours at the best of times, and even days on weekends or holidays when the bank is closed.