1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
libeufin-nexus(1)
#################
.. only:: html
Name
====
**libeufin-nexus** - EBICS client.
Synopsis
========
**libeufin-nexus**
[**-h** | **--help**]
[**--version**]
COMMAND [ARGS...]
Subcommands: **dbinit**, **ebics-setup**, **ebics-submit**, **ebics-fetch**
Description
===========
**libeufin-nexus** is a program that provides a service to interface to
various bank access APIs
Its options are as follows:
**-h** \| **--help**
Print short help on options.
**–version**
Print version information.
The interaction model is as follows:
In order to operate any EBICS communication with ``libeufin-nexus``, it is necessary to setup EBICS access via the ``ebics-setup`` subcommand. Setting the access means to share the client keys with the bank and downloading the bank keys. After a successful setup, the subcommands ``ebics-submit`` and ``ebics-fetch`` can be run to respectively send payments and download the bank account history.
The following sections describe each command in detail.
ebics-setup
-----------
This command creates the client keys, if they aren't found already on the disk, and sends them to the bank if they were not sent yet. In case of sending, it ejects the PDF document that contains the keys fingerprints, so that the user can send it to the bank to confirm their keys. The process continues by checking if the bank keys exist already on disk, and proceeds with downloading them in case they are not. It checks then if the bank keys were accepted by the user; if yes, the setup terminates, otherwise it interactively asks the user to mark the keys as accepted. By accepting the bank keys, the setup terminates successfully.
Its options are as follows:
**-h** \| **--help**
Prints short help on options.
**-c** \| **--config** \ \ *FILENAME*
Specifies the configuration file.
**--check-full-config**
Checks the configuration of all the three subcommands and returns.
**--force-keys-resubmission**
Resubmits the client keys. If no keys were found, it creates and submits them.
**--auto-accept-keys**
Accepts the bank keys without interactively asking the user.
**--generate-registration-pdf**
Generates the PDF with the client keys fingerprints, even when the keys aren't going to be submitted in the current run. That's useful in case the PDF went lost after the first submission and the user needs a new PDF.
dbinit
------
This subcommand defines the database schema for Nexus. It is mandatory to run this command before invoking the ``ebics-submit`` or ``ebics-fetch`` subcommands.
Its options are as follows:
**-h** \| **--help**
Print short help on options.
**-c** \| **--config** \ \ *FILENAME*
Specifies the configuration file.
**-r** \| **--reset**
If present, deletes any database table (WARNING: potential data loss)
ebics-submit
------------
This subcommand submits any initiated payment, that was not already sent to the bank. In the current version, initiated payments may come either from a cash-out operation or from a bounced incoming payment. There is therefore **no** way to manually initiate a payment at this moment. This tool is Taler friendly, therefore bounced payments are those that do not contain a valid subject to start a Taler withdrawal. Cash-out operations come from a tightly integrated bank that offers their customers to convert their currency to the currency whose the EBICS subscriber bank account is tied to.
Its options are as follows:
**-h** \| **--help**
Print short help on options.
**-c** \| **--config** \ \ *FILENAME*
Specifies the configuration file.
**--transient**
This flag, enabled by default, causes the command to run only once without any long-polling behaviour.
The configuration value `FREQUENCY` gets therefore ignored.
Bugs
====
Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.
|
