diff options
| author | Antoine A <> | 2024-02-05 19:07:32 +0100 |
|---|---|---|
| committer | Antoine A <> | 2024-02-05 19:07:32 +0100 |
| commit | b711253326cd192c34a75d19e6180f291863556b (patch) | |
| tree | 64d689d9398ddc8655d0c182668a6393746c050f /libeufin | |
| parent | b3d250485a0fd894783b17b2f04c2318ebf4aa1b (diff) | |
| download | docs-b711253326cd192c34a75d19e6180f291863556b.tar.gz docs-b711253326cd192c34a75d19e6180f291863556b.tar.bz2 docs-b711253326cd192c34a75d19e6180f291863556b.zip | |
Update libeufin doc
Diffstat (limited to 'libeufin')
| -rw-r--r-- | libeufin/nexus-manual.rst | 32 |
1 files changed, 15 insertions, 17 deletions
diff --git a/libeufin/nexus-manual.rst b/libeufin/nexus-manual.rst index e52ff605..4f75ea72 100644 --- 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. |