taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

commit b2edbf05cd019cd3b32cf0e555ae96a729040637
parent 6ede39e26b261695a1f70d5eb150e20fa5c58cab
Author: MS <ms@taler.net>
Date:   Thu, 14 Dec 2023 18:16:59 +0100

regional manual

enabling/rewording sections: custom TAN scripts and
exchange-wallet integration.

Diffstat:
Mlibeufin/regional-manual.rst | 48++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 48 insertions(+), 0 deletions(-)

diff --git a/libeufin/regional-manual.rst b/libeufin/regional-manual.rst @@ -128,6 +128,22 @@ Grab a coffee. At this point, the setup is NOT connected to any fiat bank account! +Custom e-mail / SMS TAN scripts +=============================== + +Should you want to use custom scripts to send the e-mail or SMS TAN, +set the configuration like follows: + +.. code-block:: console + + [libeufin-bank] + + TAN_SMS = custom-tan-sms.sh + TAN_EMAIL = custom-tan-email.sh + +The scripts TAN_SMS/EMAIL must accept the phone number / e-mail address +as the ``$1`` parameter and the content in their standard input. + Connecting to a Fiat Bank ========================= @@ -255,6 +271,38 @@ If so, call the wallet in the following way to finally pay for the order just cr ``./main.sh`` again. +Exchange-wallet integration +=========================== + +Although not strictly needed to start withdrawing regional money, this +section explain how to enable the tight integration between Taler exchange +and wallet, to let wallets learn about the possibility of withdrawing +regional funds via a particular exchange. + +First, you need to use the ``taler-exchange-offline`` tool to inform the +exchange about the fiat bank account that can be used for cash in operations +and also specify the URL for currency conversion. Additionally, you may also +configure restrictions on the bank accounts that may originate the funds, for +example to prevent international wire transfers that may expose you to +additional compliance risks. + +Given the ``$IBAN`` of the fiat currency bank account and ``$NAME`` as +the (URL-encoded) name of the exchange-account owner, the following +``taler-exchange-offline`` invocation can be used to notify wallets about +the possibility of currency conversion (cash in): + +.. code-block:: console + + # taler-exchange-offline \ + enable-account \ + payto://iban/$IBAN?receiver-name=$NAME \ + conversion-url "$CONVERSION_URL" \ + upload + +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. + Wallet setup ============