diff options
Diffstat (limited to 'man/libeufin-nexus.1')
| -rw-r--r-- | man/libeufin-nexus.1 | 75 |
1 files changed, 68 insertions, 7 deletions
diff --git a/man/libeufin-nexus.1 b/man/libeufin-nexus.1 index 9cf4e291..cd080498 100644 --- a/man/libeufin-nexus.1 +++ b/man/libeufin-nexus.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "LIBEUFIN-NEXUS" "1" "Jan 21, 2024" "0.9" "GNU Taler" +.TH "LIBEUFIN-NEXUS" "1" "Feb 10, 2024" "0.9" "GNU Taler" .SH NAME libeufin-nexus \- service to interface to various bank access APIs .SH SYNOPSIS @@ -66,11 +66,14 @@ Its options are as follows: .INDENT 0.0 .TP \fB\-h\fP | \fB\-\-help\fP -Prints short help on options. +Print short help on options. .TP -\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP +\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP Specifies the configuration file. .TP +\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP +Configure logging to use LOGLEVEL. +.TP \fB\-\-force\-keys\-resubmission\fP Resubmits the client keys. If no keys were found, it creates and submits them. .TP @@ -90,9 +93,12 @@ Its options are as follows: \fB\-h\fP | \fB\-\-help\fP Print short help on options. .TP -\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP +\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP Specifies the configuration file. .TP +\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP +Configure logging to use LOGLEVEL. +.TP \fB\-r\fP | \fB\-\-reset\fP If present, deletes any database table (WARNING: potential data loss) .UNINDENT @@ -106,29 +112,75 @@ Its options are as follows: \fB\-h\fP | \fB\-\-help\fP Print short help on options. .TP -\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP +\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP Specifies the configuration file. .TP +\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP +Configure logging to use LOGLEVEL. +Uploaded documents will be stored \fIbefore\fP being submitted to the bank. This directory would contain several directories, each named after the \fBYYYY\-MM\-DD/submit\fP format. The pain.001 file would then be named in the following schema: \fB$microseconds_pain.001.xml\fP\&. +.TP \fB\-\-transient\fP This flag, enabled by default, causes the command to check the database and submit only once, and then return. .UNINDENT .SS ebics\-fetch .sp -This subcommand downloads banking records via EBICS and stores them into the database. 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. +This subcommand downloads and parse EBICS files and ingest them into the database. 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 show up in the downloaded records. +.sp +The files type can be given as an argument to select what will be fetched. If no argument is given, all supported files are fetched. The following files are supported: +.INDENT 0.0 +.IP \(bu 2 +\fBacknowledgement\fP: EBICS acknowledgement, retrieves the status of EBICS orders. +.IP \(bu 2 +\fBstatus\fP: Payment status, retrieves status of pending debits. +.IP \(bu 2 +\fBnotification\fP: Debit & credit notifications, retrieves the history of confirmed debits and credits. +.UNINDENT .INDENT 0.0 .TP \fB\-h\fP | \fB\-\-help\fP Print short help on options. .TP -\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP +\fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP Specifies the configuration file. .TP +\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP +Configure logging to use LOGLEVEL. +.TP +\fB\-\-debug\-ebics\fP \fISAVEDIR\fP +Log EBICS content at SAVEDIR. +Downloaded documents will be stored \fIbefore\fP being ingested in the database. This directory would contain several directories, each named after the \fBYYYY\-MM\-DD/fetch\fP format. The stored files would then be named after the following schema: \fB$microseconds_$filename\fP\&. Exception to this naming scheme are the HAC responses, since they do not get any filename assigned by the ZIP archive (they are sent unzipped). Their naming scheme is: \fB$microseconds_HAC_response.pain.002.xml\fP\&. +.TP \fB\-\-transient\fP This flag, enabled by default, causes the command to perform one download and return. .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. .UNINDENT +.SS initiate\-payment +.sp +This subcommand initiates an outgoing payment. The pending payment is stored in the database and will be performed the next time \fBebics\-submit\fP run. +.sp +It takes one argument, the creditor IBAN payto URI, which must contain a \(aqreceiver\-name\(aq and may contain an \(aqamount\(aq and a \(aqmessage\(aq if they have not been defined using CLI options. +.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\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP +Configure logging to use LOGLEVEL. +.TP +\fB\-\-amount\fP \fIAMOUNT\fP +The amount to transfer, payto \(aqamount\(aq parameter takes the precedence +.TP +\fB\-\-subject\fP \fITEXT\fP +The payment subject, payto \(aqmessage\(aq parameter takes the precedence +.TP +\fB\-\-request\-uid\fP \fITEXT\fP +The payment request UID, will be randomly generated if missing. +.UNINDENT .SS config .sp This command inspect or change the configuration. @@ -152,6 +204,9 @@ Print short help on options. \fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP Specifies the configuration file. .TP +\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP +Configure logging to use LOGLEVEL. +.TP \fB\-f\fP | \fB\-\-filename\fP Interpret value as path with dollar\-expansion. .UNINDENT @@ -165,6 +220,9 @@ Print short help on options. .TP \fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP Specifies the configuration file. +.TP +\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP +Configure logging to use LOGLEVEL. .UNINDENT .SS config pathsub .sp @@ -178,6 +236,9 @@ Print short help on options. .TP \fB\-c\fP | \fB\-\-config\fP \fIFILENAME\fP Specifies the configuration file. +.TP +\fB\-L\fP | \fB\-\-log\fP \fILOGLEVEL\fP +Configure logging to use LOGLEVEL. .UNINDENT .SH SEE ALSO .sp |