libeufin-nexus.1.rst (9111B)
1 libeufin-nexus(1) 2 ################# 3 4 .. only:: html 5 6 Name 7 ==== 8 9 **libeufin-nexus** - EBICS client. 10 11 12 Synopsis 13 ======== 14 15 **libeufin-nexus** 16 [**-h** | **--help**] 17 [**--version**] 18 COMMAND [ARGS...] 19 20 Subcommands: **dbinit**, **ebics-setup**, **ebics-submit**, **ebics-fetch**, 21 **serve**, **initiate-payment**, **manual**, **list**, **config** 22 23 24 Description 25 =========== 26 27 **libeufin-nexus** is a program that provides a service to interface to 28 various bank access APIs 29 30 Its options are as follows: 31 32 **-h** \| **--help** 33 Print short help on options. 34 35 **–version** 36 Print version information. 37 38 The interaction model is as follows: 39 40 - Configure the database with commands ``dbinit``. 41 42 - Setup EBICS access with commands ``ebics-setup``. Setting the access means to share the client keys with the bank and downloading the bank keys 43 44 - After a successful setup, the subcommands ``ebics-submit`` and ``ebics-fetch`` can be run to respectively send payments and download the bank account history. 45 46 - Start the HTTP server with command ``serve``. 47 Let this run in a shell, writing logs to stderr. 48 49 The following sections describe each command in detail. 50 51 dbinit 52 ------ 53 54 This command defines the database schema for LibEuFin Nexus. It is mandatory to run this command before invoking the ``ebics-setup`` or ``serve`` commands. 55 56 Its options are as follows: 57 58 **-c** \| **--config** *config_file* 59 Specifies the configuration file. 60 **-L** \| **--log** *LOGLEVEL* 61 Configure logging to use LOGLEVEL. 62 **-r** \| **--reset** 63 Reset database (DANGEROUS: All existing data is lost) 64 **-h** \| **--help** 65 Print short help on options. 66 67 ebics-setup 68 ----------- 69 70 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. 71 72 It is mandatory to run this command before invoking the ``ebics-fetch`` or ``ebics-submit`` commands. 73 74 Its options are as follows: 75 76 **-c** \| **--config** *config_file* 77 Specifies the configuration file. 78 **-L** \| **--log** *LOGLEVEL* 79 Configure logging to use LOGLEVEL. 80 **--force-keys-resubmission** 81 Resubmits all the keys to the bank. 82 **--auto-accept-keys** 83 Accepts the bank keys without interactively asking the user. 84 **--generate-registration-pdf** 85 Generates the PDF with the client keys fingerprints, if the keys have the submitted state. That's useful in case the PDF went lost after the first submission and the user needs a new PDF. 86 **--debug-ebics** 87 Log EBICS transactions steps and payload at log_dir. 88 **-h** \| **--help** 89 Print short help on options. 90 91 ebics-submit 92 ------------ 93 94 This subcommand submits EBICS files to the bank. It submits pending outgoing payments. Outgoing payment status is fetched by ebics-fetch. 95 96 Submits are executed at 'FREQUENCY'. 97 98 Its options are as follows: 99 100 **-c** \| **--config** *config_file* 101 Specifies the configuration file. 102 **-L** \| **--log** *LOGLEVEL* 103 Configure logging to use LOGLEVEL. 104 **--transient** 105 Execute once and return, ignoring the 'FREQUENCY' configuration value. 106 **--debug-ebics** *log_dir* 107 Log EBICS transactions steps and payload at log_dir. 108 **-h** \| **--help** 109 Print short help on options. 110 111 ebics-fetch 112 ----------- 113 114 This subcommand fetches EBICS files from the bank. Incoming payments are recorded and the status of outgoing payments is updated. 115 116 If ACCOUNT_TYPE is ``exchange``, incoming payments with an invalid Taler subject are bounced. Bounces are submitted by ebics-submit. 117 118 Fetches of new documents are executed at 'FREQUENCY' or any time a real-time EBICS notification is received. Every day, a checkpoint is performed, during which all documents since the last checkpoint are fetched. 119 120 **-c** \| **--config** *config_file* 121 Specifies the configuration file. 122 **-L** \| **--log** *LOGLEVEL* 123 Configure logging to use LOGLEVEL. 124 **--transient** 125 Execute once and return, ignoring the 'FREQUENCY' configuration value. 126 **--pinned-start** *YYYY-MM-DD* 127 Only supported in --transient mode, this option lets specify the earliest timestamp of the downloaded documents. 128 **--peek** 129 Only supported in --transient mode, do not consume fetched documents. 130 **--checkpoint** 131 Only supported in --transient mode, run a checkpoint. 132 **--debug-ebics** *log_dir* 133 Log EBICS transactions steps and payload at log_dir. 134 **-h** \| **--help** 135 Print short help on options. 136 137 serve 138 ----- 139 140 This command starts the HTTP server. 141 142 Its options are as follows: 143 144 **-c** \| **--config** *config_file* 145 Specifies the configuration file. 146 **-L** \| **--log** *LOGLEVEL* 147 Configure logging to use LOGLEVEL. 148 **--check** 149 Check whether an API is in use (if it's useful to start the HTTP server). Exit with 0 if at least one API is enabled, otherwise 1. 150 **-h** \| **--help** 151 Print short help on options. 152 153 initiate-payment 154 ---------------- 155 156 This subcommand initiates an outgoing payment. The pending payment is stored in the database and will be performed the next time ``ebics-submit`` run. 157 158 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. 159 160 **-c** \| **--config** *config_file* 161 Specifies the configuration file. 162 **-L** \| **--log** *LOGLEVEL* 163 Configure logging to use LOGLEVEL. 164 **--amount** *AMOUNT* 165 The amount to transfer, payto 'amount' parameter takes the precedence 166 **--subject** *TEXT* 167 The payment subject, payto 'message' parameter takes the precedence 168 **--request-uid** *TEXT* 169 The payment request UID, will be randomly generated if missing. 170 **-h** \| **--help** 171 Print short help on options. 172 173 174 manual 175 ------ 176 177 Manual management commands. 178 179 Its options are as follows: 180 181 **-h** \| **--help** 182 Print short help on options. 183 184 Subcommands: **export**, **import**, **status**, **ack** 185 186 manual export 187 ^^^^^^^^^^^^^ 188 189 Export pending batches as pain001 messages. 190 191 It takes one argument, the path where to write the zip export. 192 193 Its options are as follows: 194 195 **-c** \| **--config** *config_file* 196 Specifies the configuration file. 197 **-L** \| **--log** *LOGLEVEL* 198 Configure logging to use LOGLEVEL. 199 **-h** \| **--help** 200 Print short help on options. 201 202 manual import 203 ^^^^^^^^^^^^^ 204 205 Import EBICS camt files. 206 207 It takes multiple arguments, the paths to XML files to import. 208 209 Its options are as follows: 210 211 **-c** \| **--config** *config_file* 212 Specifies the configuration file. 213 **-L** \| **--log** *LOGLEVEL* 214 Configure logging to use LOGLEVEL. 215 **-h** \| **--help** 216 Print short help on options. 217 218 manual status 219 ^^^^^^^^^^^^^ 220 221 Change batches or transactions status. 222 223 It takes four arguments: the element kind, the element id, the new status and an optional status message. 224 225 Its options are as follows: 226 227 **-c** \| **--config** *config_file* 228 Specifies the configuration file. 229 **-L** \| **--log** *LOGLEVEL* 230 Configure logging to use LOGLEVEL. 231 **-h** \| **--help** 232 Print short help on options. 233 234 manual ack 235 ^^^^^^^^^^ 236 237 Manually acknowledge the outgoing transaction for submission. 238 239 It takes many transactions as arguments. 240 241 Its options are as follows: 242 243 **-c** \| **--config** *config_file* 244 Specifies the configuration file. 245 **-L** \| **--log** *LOGLEVEL* 246 Configure logging to use LOGLEVEL. 247 **-h** \| **--help** 248 Print short help on options. 249 250 list 251 ---- 252 253 List nexus transactions. 254 255 Its options are as follows: 256 257 **-h** \| **--help** 258 Print short help on options. 259 260 Subcommands: **incoming**, **outgoing**, **initiated** 261 262 list incoming 263 ^^^^^^^^^^^^^ 264 265 List incoming transactions. 266 267 Its options are as follows: 268 269 **-c** \| **--config** *config_file* 270 Specifies the configuration file. 271 **-L** \| **--log** *LOGLEVEL* 272 Configure logging to use LOGLEVEL. 273 **-h** \| **--help** 274 Print short help on options. 275 276 list outgoing 277 ^^^^^^^^^^^^^ 278 279 List outgoing transactions. 280 281 Its options are as follows: 282 283 **-c** \| **--config** *config_file* 284 Specifies the configuration file. 285 **-L** \| **--log** *LOGLEVEL* 286 Configure logging to use LOGLEVEL. 287 **-h** \| **--help** 288 Print short help on options. 289 290 list initiated 291 ^^^^^^^^^^^^^^ 292 293 List initiated transactions. 294 295 Its options are as follows: 296 297 **-c** \| **--config** *config_file* 298 Specifies the configuration file. 299 **-L** \| **--log** *LOGLEVEL* 300 Configure logging to use LOGLEVEL. 301 **--ack** \| **--awaiting-ack** 302 Only list transactions awaiting manual acknowledgement. 303 **-h** \| **--help** 304 Print short help on options. 305 306 .. include:: ../frags/common-config-cli.rst 307 308 SEE ALSO 309 ======== 310 311 libeufin-nexus.conf(5) 312 313 Bugs 314 ==== 315 316 Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.