commit b711253326cd192c34a75d19e6180f291863556b
parent b3d250485a0fd894783b17b2f04c2318ebf4aa1b
Author: Antoine A <>
Date: Mon, 5 Feb 2024 19:07:32 +0100
Update libeufin doc
Diffstat:
4 files changed, 42 insertions(+), 20 deletions(-)
diff --git a/core/api-corebank.rst b/core/api-corebank.rst
@@ -1,7 +1,7 @@
..
This file is part of GNU TALER.
- Copyright (C) 2014-2023 Taler Systems SA
+ Copyright (C) 2014-2024 Taler Systems SA
TALER is free software; you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License as published by the Free Software
@@ -114,6 +114,10 @@ Config
// TAN channels supported by the server
supported_tan_channels: TanChannel[];
+
+ // Wire transfer type supported by the bank.
+ // Default to 'iban' is missing
+ wire_type?: string;
}
diff --git a/libeufin/nexus-manual.rst b/libeufin/nexus-manual.rst
@@ -271,26 +271,24 @@ initiated payment according to their submission state, and return.
Downloading payment records
===========================
-Downloading payment records requires that the `EBICS subscriber setup
-<ebics-setup>`_, where the bank obtained the subscriber keys and the
-subscriber accepted the bank keys has been completed.
-
-The configuration file must contain all the ``[ebics-setup]`` sections, plus
-the following values to set the database connection and a log directory where
-any downloaded record would be stored.
-
-.. code-block:: ini
+Downloading payments must follow a successful `EBICS subscriber setup
+<ebics-setup>`_, where the bank obtained the subscriber keys, and the
+subscriber accepted the bank keys. Furthermore, the database has to
+be set up.
- [nexus-postgres]
- config = postgres:///nexus
+The responsible subcommand for sending payments is ``ebics-fetch``, and its
+configuration is a **superset** of core-config_. On top of that, it expects
+the database connection string and *optionally* a frequency at which it will
+downloads any unseen notifications and ingest them in the database.
-To activate periodic downloads, add the following setting to the ``nexus-fetch``
-configuration section in ``$CONFIG_FILE``:
+The frequency **may** be specified as
.. code-block:: ini
- [nexus-fetch]
- FREQUENCY = 5m
+ [nexus-fetch]
+ FREQUENCY = 5m
+
+The supported time units are ``s`` (seconds), ``m`` (minutes), ``h`` (hours).
Assuming that ``$CONFIG_FILE`` contains all required options, the following command
would download any unseen notifications (as ``camt.054`` files):
@@ -315,8 +313,8 @@ date when the download took place. This is mostly useful for debugging.
-Testing
--------
+For Testing
+-----------
If the bank account history has transactions that are useful for testing, it is
possible to re-download them via the ``--pinned-start`` argument.
diff --git a/manpages/libeufin-bank.conf.5.rst b/manpages/libeufin-bank.conf.5.rst
@@ -35,8 +35,8 @@ 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``
+WIRE_TYPE
+ Supported payment target type, this can either be ``iban`` or ``x-taler-bank``
IBAN_PAYTO_BIC
Bank BIC used in generated iban payto URI
diff --git a/manpages/libeufin-nexus.1.rst b/manpages/libeufin-nexus.1.rst
@@ -115,6 +115,26 @@ This subcommand downloads banking records via EBICS and stores them into the dat
**--pinned-start**
Only supported in --transient mode, this option lets specify the earliest timestamp of the downloaded documents. The latest timestamp is always the current time.
+initiate-payment
+----------------
+
+This subcommand initiates an outgoing payment. The pending payment is stored in the database and will be performed the next time ``ebics-submit`` run.
+
+It takes one argument, the creditor IBAN payto URI, which must contain a 'receiver-name' and may contain an 'amount' and a 'message' if they have not been defined using CLI options.
+
+**-h** \| **--help**
+ Print short help on options.
+**-c** \| **--config** *FILENAME*
+ Specifies the configuration file.
+**-L** \| **--log** *LOGLEVEL*
+ Configure logging to use LOGLEVEL.
+**--amount** *AMOUNT*
+ The amount to transfer, payto 'amount' parameter takes the precedence
+**--subject** *TEXT*
+ The payment subject, payto 'message' parameter takes the precedence
+**--request-uid** *TEXT*
+ The payment request UID, will be randomly generated if missing.
+
.. include:: ../frags/libeufin-config-cli.rst
SEE ALSO
