nexus-ebics-setup.rst (2855B)
1 2 When you sign up for an EBICS-enabled bank account, the bank will provide you 3 with various credentials. Those must be provided in the 4 ``/etc/libeufin/libeufin-nexus.conf`` configuration file together with the 5 name of the *fiat* currency. 6 7 .. note:: 8 As legacy transactions in that bank account would likely confuse the system, it is advisable to use a fresh bank account with an empty transaction history. 9 10 The following snippet shows the mandatory configuration values: 11 12 .. code-block:: ini 13 14 [nexus-ebics] 15 CURRENCY = CHF 16 17 # Bank 18 HOST_BASE_URL = https://ebics.postfinance.ch/ebics/ebics.aspx 19 BANK_DIALECT = postfinance 20 21 # EBICS IDs 22 HOST_ID = PFEBICS 23 USER_ID = PFC00563 24 PARTNER_ID = PFC00563 25 26 # Account information 27 IBAN = CH7789144474425692816 28 BIC = POFICHBEXXX 29 NAME = John Smith S.A. 30 31 .. note:: 32 Refer to the manpage ``libeufin-nexus.conf(5)`` 33 for the full array of configuration values. 34 35 .. warning:: 36 This combination of HOST_ID, USER_ID and PARTNER_ID must never be used by another instance of libeufin-nexus or by other EBICS clients, otherwise data will be lost. 37 38 Reuse existing client keys 39 -------------------------- 40 41 If you have client keys from a previous EBICS setup you can copy the JSON file to the configured path ``CLIENT_PRIVATE_KEYS_FILE`` (``/var/lib/libeufin-nexus/client-ebics-keys.json`` with the default config). 42 43 Make sure this file is accessible to the user running ``libeufin-nexus``, for the default services you should run: 44 45 .. code-block:: console 46 47 $ chown libeufin-nexus:libeufin-nexus /var/lib/libeufin-nexus/client-ebics-keys.json 48 49 Create new client keys 50 ---------------------- 51 52 Assuming that the configuration file exists at ``$CONFIG_FILE``, the following 53 command should start the EBICS setup process: 54 55 .. code-block:: console 56 57 $ libeufin-nexus ebics-setup -c "$CONFIG_FILE" 58 59 If the previous command failed when running EBICS INI with an error code of 60 ``EBICS_INVALID_USER_OR_USER_STATE``, you need to confirm your keys to your bank to 61 activate your account. 62 63 To that end, the previous run should have left a PDF document that you can 64 print, sign and send to the bank. Look for the message that looks like ``PDF 65 file with keys created at '/tmp/libeufin-ebics-keys-$TIMESTAMP.pdf'``. 66 67 Once the bank has received and processed this document you can continue. 68 69 Get bank keys 70 ------------- 71 72 Assuming that the configuration file exists at ``$CONFIG_FILE``, the following 73 command will finish the EBICS setup process: 74 75 .. code-block:: console 76 77 $ libeufin-nexus ebics-setup -c "$CONFIG_FILE" 78 79 The EBICS setup is finished once the bank keys have been accepted. 80 81 Make sure this bank keys are accessible to the user running ``libeufin-nexus``, for the default services you should run: 82 83 .. code-block:: console 84 85 $ chown libeufin-nexus:libeufin-nexus /var/lib/libeufin-nexus/bank-ebics-keys.json