taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

taler-exchange-wire-gateway-client.1.rst (4873B)

      1 taler-exchange-wire-gateway-client(1)
      2 #####################################
      3 
      4 .. only:: html
      5 
      6    Name
      7    ====
      8 
      9    **taler-exchange-wire-gateway-client** - trigger a transfer at the bank (or obtain transaction history)
     10 
     11 Synopsis
     12 ========
     13 
     14 **taler-exchange-wire-gateway-client**
     15 [**-a** *VALUE* | **--amount=**\ ‌\ *VALUE*]
     16 [**-b** *URL* | **--bank=**\ ‌\ *URL*]
     17 [**-C** *ACCOUNT* | **--credit=**\ ‌\ *ACCOUNT*]
     18 [**-c** *FILENAME* | **--config=**\ ‌\ *FILENAME*]
     19 [**-D** *ACCOUNT* | **--debit=**\ ‌\ *ACCOUNT*]
     20 [**-h** | **--help**]
     21 [**-i** | **--credit-history**]
     22 [**-L** *LOGLEVEL* | **--loglevel=**\ ‌\ *LOGLEVEL*]
     23 [**-l** *FILENAME* | **--logfile=**\ ‌\ *FILENAME*]
     24 [**-o** | **--debit-history**]
     25 [**-p** *PASSPHRASE* | **--pass=**\ ‌\ *PASSPHRASE*]
     26 [**-S** *STRING* | **--subject=**\ ‌\ *STRING*]
     27 [**-s** *ACCOUNT-SECTION* | **--section=**\ ‌\ *ACCOUNT-SECTION*]
     28 [**-u** *USERNAME* | **--user=**\ ‌\ *USERNAME*]
     29 [**-v** | **--version**]
     30 [**-w** *ROW* | **--since-when=**\ ‌\ *ROW*]
     31 [**-x** *META* | **--extra=**\ ‌\ *META*]
     32 
     33 Description
     34 ===========
     35 
     36 **taler-exchange-wire-gateway-client** is a command-line tool to trigger bank transfers or
     37 inspect wire transfers for exchange accounts using the wire API.  The tool is
     38 expected to be used during testing or for diagnostics.
     39 
     40 You can do one of the following four operations during one invocation.
     41 
     42   (1) Execute wire transfer from the exchange to consumer account (**-C**).
     43   (2) Execute wire transfer from consumer account to the exchange (**-D**).
     44   (3) Inspect credit history of the exchange (**-i**).
     45   (4) Inspect debit history of the exchange (**-o**).
     46 
     47 Doing more than one of these at a time will result in an error.  Note,
     48 however, that the **-C** and **-D** options also can be used to act as filters
     49 on transaction history operations.
     50 
     51 
     52 Options
     53 =======
     54 
     55 **-a** *VALUE* \| **--amount=**\ ‌\ *VALUE*
     56    Amount to transfer. Given in the Taler-typical format of
     57    CURRENCY:VALUE.FRACTION.
     58 
     59 **-b** *URL* \| **--bank=**\ ‌\ *URL*
     60    URL at which the bank is operation.  Conflicts with **-s**.
     61 
     62 **-C** *ACCOUNT* \| **--credit=**\ ‌\ *ACCOUNT*
     63    When doing a wire transfer from the exchange, the money should be credited to *ACCOUNT*.
     64    Specifies the payto:// URI of the account.  Can also be used as a filter by credit
     65    account when looking at transaction histories.
     66 
     67 **-c** *FILENAME* \| **--config=**\ ‌\ *FILENAME*
     68    Use the given configuration file.
     69 
     70 **-D** *ACCOUNT* \| **--debit=**\ ‌\ *ACCOUNT*
     71    When doing a wire transfer to the exchange, the *ACCOUNT* is to be debited.
     72    Specifies the payto:// URI of the account.  Can also be used as a filter by debit
     73    account when looking at transaction histories.
     74 
     75 **-h** \| **--help**
     76    Print short help on options.
     77 
     78 **-i** \| **--credit-history**
     79    Obtain credit history of the exchange. Conflicts with **-o**.
     80 
     81 **-L** *LOGLEVEL* \| **--loglevel=**\ ‌\ *LOGLEVEL*
     82    Specifies the log level to use. Accepted values are: ``DEBUG``, ``INFO``,
     83    ``WARNING``, ``ERROR``.
     84 
     85 **-l** *FILENAME* \| **--logfile=**\ ‌\ *FILENAME*
     86    Send logging output to *FILENAME*.
     87 
     88 **-o** \| **--debit-history**
     89    Obtain debit history of the exchange. Conflicts with **-i**.
     90 
     91 **-p** *PASSPHRASE* \| **--pass=**\ ‌\ *PASSPHRASE*
     92    Specifies the pass phrase for authentication.  Conflicts with **-s**.
     93 
     94 **-S** *SUBJECT* \| **--subject=**\ ‌\ *SUBJECT*
     95    Use *SUBJECT* for the wire transfer subject.  Must be a reserve public key for credit operations and a wire transfer identifier for debit operations. If not specified, a random value will be generated instead.
     96 
     97 **-s** *ACCOUNT_SECTION* \| **--section=**\ ‌\ *ACCOUNT-SECTION*
     98    Obtain exchange account information from the *ACCOUNT-SECTION* of the configuration. The argument must be a ``[exchange-accountcredentials-$NAME]`` section name and thus start with the ``exchange-accountcredentials-`` prefix. Conflicts with **-u**, **-p** and **-b**.  Note that either **-b** or **-s** must be specified.
     99 
    100 **-u** *USERNAME* \| **--user=**\ ‌\ *USERNAME*
    101    Specifies the username for authentication.  Optional and conflicts with **-s**. If neither **-u** nor **-s** are used, we will attempt to talk to the bank without authentication.
    102 
    103 **-v** \| **--version**
    104    Print version information.
    105 
    106 **-w** *ROW* \| **--since-when=**\ ‌\ *ROW*
    107    Specifies a *ROW* from which the history should be obtained. If not given, the 10 youngest transactions are returned.
    108 
    109 **-x** *METADATA* \| **--extra=**\ ‌\ *METADATA*
    110    Specifies additional optional *METADATA* to be used in the wire transfer subject of a credit transfer.
    111 
    112 
    113 See Also
    114 ========
    115 
    116 taler-exchange.conf(5), https://docs.taler.net/core/api-wire.html#wire-transfer-test-apis
    117 
    118 Bugs
    119 ====
    120 
    121 Report bugs by using https://bugs.taler.net/ or by sending electronic
    122 mail to <taler@gnu.org>