taler-docs

commit 5a1add07e8475496e986162c8888d6ae9732bba2
parent 669ae334e74a7a5894f8acbd07471e239fe3f624
Author: Antoine A <>
Date:   Fri,  2 Feb 2024 21:25:02 +0100

update libeufin-bank documentation

Diffstat:
M
core/api-corebank.rst
 | 
9
+++++----
M
manpages/libeufin-bank.conf.5.rst
 | 
9
+++++++++

2 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -157,7 +157,7 @@ Account Management
       // Addresses where to send the TAN for protected operations.
       contact_data?: ChallengeContactData;
 
-      // 'payto' URI of a fiat bank account with a 'receiver-name' parameter.
+      // IBAN 'payto' URI of a fiat bank account with a 'receiver-name' parameter.
       // If 'receiver-name' is missing, ``name`` will be used instead.
       // Payments will be sent to this bank account
       // when the user wants to convert the regional currency
@@ -165,7 +165,8 @@ Account Management
       cashout_payto_uri?: string;
 
       // Internal payto URI of this bank account.
-      // Used mostly for testing.
+      // Used mostly for testing, this field is ignored if the bank payment 
+      // method is not IBAN.
       payto_uri?: string;
 
       // If present, set the max debit allowed for this user
@@ -253,7 +254,7 @@ Account Management
       // Addresses where to send the TAN for protected operations.
       contact_data?: ChallengeContactData;
 
-      // 'payto' URI of a fiat bank account with a 'receiver-name' parameter.
+      // IBAN 'payto' URI of a fiat bank account with a 'receiver-name' parameter.
       // If 'receiver-name' is missing, ``name`` will be used instead.
       // Payments will be sent to this bank account
       // when the user wants to convert the regional currency
@@ -488,7 +489,7 @@ Account Management
       // as well.
       contact_data?: ChallengeContactData;
 
-      // 'payto' URI pointing the bank account
+      // IBAN 'payto' URI pointing the bank account
       // where to send cashouts.  This field is optional
       // because not all the accounts are required to participate
       // in the merchants' circuit.  One example is the exchange:
diff --git a/manpages/libeufin-bank.conf.5.rst b/manpages/libeufin-bank.conf.5.rst
@@ -35,6 +35,15 @@ The following options are from the “[libeufin-bank]” section.
 CURRENCY
   Internal currency of the libeufin-bank, e.g. “EUR” for Euro.
 
+PAYMENT_METHOD
+  Supported payment method, this can either be ``iban`` or ``x-taler-bank``
+
+IBAN_PAYTO_BIC
+  Bank BIC used in generated iban payto URI
+
+X_TALER_BANK_PAYTO_HOSTNAME
+  Bank hostname used in generated x-taler-bank payto URI
+
 DEFAULT_DEBT_LIMIT
   Default debt limit for newly created accounts. Defaults to CURRENCY:0 if not specified.