16.57. taler-magnet-bank(1)

16.57.1. Name

taler-magnet-bank - Magnet Bank Taler adapter.

16.57.2. Synopsis

taler-magnet-bank [-h | –help] [–version] COMMAND [ARGS…]

Subcommands: dbinit, setup, serve, worker, config

16.57.3. Description

taler-magnet-bank is a Taler adapter for the Magnet Bank API.

Its options are as follows:

-h | –help

Print short help on options.

–version

Print version information.

The interaction model is as follows:

  • Configure the database with commands dbinit.

  • Setup API access with commands setup. Setting the access means to generate an access token, to perform SCA check and upload some keys.

  • After a successful setup, the subcommands worker can be run to both send payments and sync the bank account history.

  • Start the HTTP server with command serve. Let this run in a shell, writing logs to stderr.

The following sections describe each command in detail.

16.57.3.1. dbinit

This command defines the database schema for taler-magnet-bank. It is mandatory to run this command before invoking the setup or serve commands.

Its options are as follows:

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-r | –reset

Reset database (DANGEROUS: All existing data is lost)

-h | –help

Print short help on options.

16.57.3.2. setup

This command setup a working API connection. This command create the keys file, if they aren’t found already on the disk. It generate an access token, performs the SCA check and upload the public key.

It is mandatory to run this command before invoking the worker command.

Its options are as follows:

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-r | –reset

Reset connection info and overwrite keys file

-h | –help

Print short help on options.

16.57.3.3. worker

This subcommand initiate transaction throught the Magnet Bank API and sync the the bank account history.

If ACCOUNT_TYPE is exchange, incoming payments with an invalid Taler subject are bounced.

Its options are as follows:

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

–transient

Execute once and return.

-h | –help

Print short help on options.

16.57.3.4. serve

This command starts the HTTP server.

Its options are as follows:

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

–check

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.

-h | –help

Print short help on options.

16.57.3.5. config

This command inspect or change the configuration.

-h | –help

Print short help on options.

Subcommands: get, dump, pathsub

16.57.3.5.1. config get

This command lookup config value.

It takes two arguments, the section name and the option name

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-f | –filename

Interpret value as path with dollar-expansion.

-h | –help

Print short help on options.

16.57.3.5.2. config dump

This command dump the configuration.

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-h | –help

Print short help on options.

16.57.3.5.3. config pathsub

This command substitute variables in a path.

It takes one argument, a path expression.

-c | –config config_file

Specifies the configuration file.

-L | –log LOGLEVEL

Configure logging to use LOGLEVEL.

-h | –help

Print short help on options.

16.57.4. SEE ALSO

taler-magnet-bank.conf(5)

16.57.5. Bugs

Report bugs by using https://bugs.taler.net or by sending electronic mail to <taler@gnu.org>.