path: root/man/libeufin-nexus.1

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "LIBEUFIN-NEXUS" "1" "Jan 06, 2024" "0.9" "GNU Taler"
.SH NAME
libeufin-nexus \- service to interface to various bank access APIs
.SH SYNOPSIS
.sp
\fBlibeufin\-nexus\fP
[\fB\-h\fP\ |\ \fB\-\-help\fP]
[\fB\-\-version\fP]
COMMAND [ARGS...]
.sp
Subcommands: \fBdbinit\fP, \fBebics\-setup\fP, \fBebics\-submit\fP, \fBebics\-fetch\fP, \fBconfig\fP
.SH DESCRIPTION
.sp
\fBlibeufin\-nexus\fP is a program that provides a service to interface to
various bank access APIs
.sp
Its options are as follows:
.INDENT 0.0
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
\fB–version\fP
Print version information.
.UNINDENT
.sp
The interaction model is as follows:
.sp
In order to operate any EBICS communication with \fBlibeufin\-nexus\fP, it is necessary to setup EBICS access via the \fBebics\-setup\fP subcommand.  Setting the access means to share the client keys with the bank and downloading the bank keys.  After a successful setup, the subcommands \fBebics\-submit\fP and \fBebics\-fetch\fP can be run to respectively send payments and download the bank account history.
.sp
The following sections describe each command in detail.
.SS ebics\-setup
.sp
This command creates the client keys, if they aren\(aqt 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.
.sp
Its options are as follows:
.INDENT 0.0
.TP
\fB\-h\fP | \fB\-\-help\fP
Prints short help on options.
.TP
\fB\-c\fP | \fB\-\-config\fP ‌\fIFILENAME\fP
Specifies the configuration file.
.TP
\fB\-\-check\-full\-config\fP
Checks the configuration of all the three subcommands and returns.
.TP
\fB\-\-force\-keys\-resubmission\fP
Resubmits the client keys.  If no keys were found, it creates and submits them.
.TP
\fB\-\-auto\-accept\-keys\fP
Accepts the bank keys without interactively asking the user.
.TP
\fB\-\-generate\-registration\-pdf\fP
Generates the PDF with the client keys fingerprints, if the keys have the submitted state.  That\(aqs useful in case the PDF went lost after the first submission and the user needs a new PDF.
.UNINDENT
.SS dbinit
.sp
This subcommand defines the database schema for Nexus.  It is mandatory to run this command before invoking the \fBebics\-submit\fP or \fBebics\-fetch\fP subcommands.
.sp
Its options are as follows:
.INDENT 0.0
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
\fB\-c\fP | \fB\-\-config\fP ‌\fIFILENAME\fP
Specifies the configuration file.
.TP
\fB\-r\fP | \fB\-\-reset\fP
If present, deletes any database table (WARNING: potential data loss)
.UNINDENT
.SS ebics\-submit
.sp
This subcommand submits any initiated payment that was not already sent to the bank.  In the current version, initiated payments may come from a cash\-out operation or from a bounced incoming payment.  ebics\-submit 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.
.sp
Its options are as follows:
.INDENT 0.0
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
\fB\-c\fP | \fB\-\-config\fP ‌\fIFILENAME\fP
Specifies the configuration file.
.TP
\fB\-\-transient\fP
This flag, enabled by default, causes the command to check the database and submit only once, and then return.
.TP
\fB\-\-debug\fP
With this flag, it is possible to pass via STDIN a raw pain.001 document to be submitted to the bank.  This method turns ebics\-submit to run in transient mode and it does NOT affect the database.
.TP
\fB\-\-ebics\-extra\-log\fP
Enables (verbose) logging of EBICS 3 messages to STDERR.  It logs only EBICS 3 messages from the initialisation phase of an upload order.
.UNINDENT
.SS ebics\-fetch
.sp
This subcommand downloads banking records via EBICS and stores them into the database.  By default, it downloads \fBcamt.054\fP notifications.  Along the download, ebics\-fetch would bounce incoming payments that do not have a valid Taler subject, or as well those with an already existing valid subject.  Valid incoming payments are then stored in the database so that they can trigger Taler withdrawals.  Along this process, ebics\-submit would as well reconcile initiated outgoing payments with any outgoing transactions that shows up in the downloaded records.  Any option starting with \fB\-\-only\fP would only be useful with a defined log directory (STATEMENTS_LOG_DIRECTORY) in the configuration.
.INDENT 0.0
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
\fB\-c\fP | \fB\-\-config\fP ‌\fIFILENAME\fP
Specifies the configuration file.
.TP
\fB\-\-transient\fP
This flag, enabled by default, causes the command to perform one download and return.
.TP
\fB\-\-only\-statements\fP
It downloads statements (instead of notifications) in the form of camt.053 documents.  It does NOT affect the database.
.TP
\fB\-\-only\-ack\fP
It downloads payment submissions acknowledgements (instead of notifications) in the form of pain.002 documents.  It MAY affect the database by setting the state of submitted payments.
.TP
\fB\-\-only\-reports\fP
It downloads only intraday reports (instead of notifications) in the form of camt.052 documents.  It does NOT affect the database.
.TP
\fB\-\-only\-logs\fP
It downloads the subscriber activity via EBICS HAC in the form of pain.002 documents.  It does NOT affect the database.
.TP
\fB\-\-pinned\-start\fP
Only supported in \-\-transient mode, this option lets specify the earliest timestamp of the downloaded documents.  The latest timestamp is always the current time.
.TP
\fB\-\-parse\fP
Reads one ISO20022 document from STDIN.  It prints on the console the result and exits without affecting the database
.TP
\fB\-\-import\fP
Reads one ISO20022 document from STDIN.  It prints the result on the console \fBand\fP also ingests the input content into the database.  NOTE: if used in a debug scenario, consider to destroy the database before going to production for the following reasons; (1) the database likely ends up having phony transactions that do not belong to the bank account associated with the EBICS subscriber, and (2) whose timestamps will alter the way ebics\-fetch will request new records to the bank.  (3) This flags skips the check on the bank keys, so the database could receive records even though hte bank keys were not accepted / downloaded.
.UNINDENT
.SS config
.sp
This command inspect or change the configuration.
.INDENT 0.0
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.UNINDENT
.sp
Subcommands: \fBget\fP, \fBdump\fP, \fBpathsub\fP
.SS config get
.sp
This command lookup config value.
.sp
It takes two arguments, the section name and the option name
.INDENT 0.0
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
Specifies the configuration file.
.TP
\fB\-f\fP | \fB\-\-filename\fP
Interpret value as path with dollar\-expansion.
.UNINDENT
.SS config dump
.sp
This command dump the configuration.
.INDENT 0.0
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
Specifies the configuration file.
.UNINDENT
.SS config pathsub
.sp
This command substitute variables in a path.
.sp
It takes one argument, a path expresion.
.INDENT 0.0
.TP
\fB\-h\fP | \fB\-\-help\fP
Print short help on options.
.TP
\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP
Specifies the configuration file.
.UNINDENT
.SH SEE ALSO
.sp
libeufin\-nexus.conf(5)
.SH BUGS
.sp
Report bugs by using \fI\%https://bugs.taler.net\fP or by sending electronic mail to <\fI\%taler@gnu.org\fP>.
.SH AUTHOR
GNU Taler contributors
.SH COPYRIGHT
2014-2022 Taler Systems SA (GPLv3+ or GFDL 1.3+)
.\" Generated by docutils manpage writer.
.