commit d0019033848e2b326ad6be44217dfb58ec406b65
parent 8ed22e0a292e8b0cfbcbb19d9dd138239b833027
Author: Antoine A <>
Date: Sat, 2 Dec 2023 15:58:59 +0000
Update libeufin-bank documentation
Diffstat:
4 files changed, 9 insertions(+), 10 deletions(-)
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -149,6 +149,10 @@ Account Management
// Internal payto URI of this bank account.
// Used mostly for testing.
internal_payto_uri?: string;
+
+ // If present, set the max debit allowed for this user
+ // Only admin can change this property.
+ debit_threshold?: Amount
}
.. ts:def:: ChallengeContactData
@@ -177,6 +181,7 @@ Account Management
* ``TALER_EC_BANK_REGISTER_PAYTO_URI_REUSE`` : payto URI already used.
* ``TALER_EC_BANK_UNALLOWED_DEBIT`` : admin account does not have sufficient funds to grant bonus.
* ``TALER_EC_BANK_RESERVED_USERNAME_CONFLICT`` : a reserved username was attempted, like ``admin`` or ``bank``
+ * ``TALER_EC_BANK_NON_ADMIN_PATCH_DEBT_LIMIT``: a non-admin user has tried to change their debt limit.
**Details:**
diff --git a/libeufin/bank-manual.rst b/libeufin/bank-manual.rst
@@ -48,9 +48,6 @@ The following snippet shows the mandatory configuration values :
[libeufin-bank]
CURRENCY = KUDOS
- # Debt limit
- DEFAULT_ADMIN_DEBT_LIMIT = KUDOS:200000000
-
# Server
SERVE = tcp
PORT = 8080
@@ -124,7 +121,7 @@ Then the following command would start the server with conversion API enabled :
Web-based Configuration
-----------------------
-Now you should be able to setup conversion rates though the Web
+Now you should be able to setup conversion rates and ``admin`` debt limit though the Web
interface of the bank as the ``admin`` user.
Conversion ON!
diff --git a/libeufin/regional-manual.rst b/libeufin/regional-manual.rst
@@ -182,7 +182,7 @@ offers them in ``contrib/``: adjust to your setup!
Web-based Configuration
-----------------------
-Now you should be able to setup conversion rates though the Web
+Now you should be able to setup conversion rates and ``admin`` debt limit though the Web
interface of the bank as the ``admin`` user.
diff --git a/manpages/libeufin-bank.conf.5.rst b/manpages/libeufin-bank.conf.5.rst
@@ -35,11 +35,8 @@ The following options are from the “[libeufin-bank]” section.
CURRENCY
Internal currency of the libeufin-bank, e.g. “EUR” for Euro.
-DEFAULT_CUSTOMER_DEBT_LIMIT
- Default debt limit for newly created customer accounts. Defaults to CURRENCY:0 if not specified.
-
-DEFAULT_ADMIN_DEBT_LIMIT
- Default debt limit of the admin. Typically higher, since sign-up bonuses and cashin are deducted from the admin account. Defaults to CURRENCY:0 if not specified.
+DEFAULT_DEBT_LIMIT
+ Default debt limit for newly created accounts. Defaults to CURRENCY:0 if not specified.
REGISTRATION_BONUS
Value of the registration bonus for new users. Defaults to CURRENCY:0 if not specified.
