nexus-ebics-setup.rst (2873B)
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 .. _core-config: 13 14 .. code-block:: ini 15 16 [nexus-ebics] 17 CURRENCY = CHF 18 19 # Bank 20 HOST_BASE_URL = https://ebics.postfinance.ch/ebics/ebics.aspx 21 BANK_DIALECT = postfinance 22 23 # EBICS IDs 24 HOST_ID = PFEBICS 25 USER_ID = PFC00563 26 PARTNER_ID = PFC00563 27 28 # Account information 29 IBAN = CH7789144474425692816 30 BIC = POFICHBEXXX 31 NAME = John Smith S.A. 32 33 .. note:: 34 Refer to the manpage ``libeufin-nexus.conf(5)`` 35 for the full array of configuration values. 36 37 .. warning:: 38 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. 39 40 Reuse existing client keys 41 -------------------------- 42 43 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). 44 45 Make sure this file is accessible to the user running ``libeufin-nexus``, for the default services you should run: 46 47 .. code-block:: console 48 49 $ chown libeufin-nexus:libeufin-nexus /var/lib/libeufin-nexus/client-ebics-keys.json 50 51 Create new client keys 52 ---------------------- 53 54 Assuming that the configuration file exists at ``$CONFIG_FILE``, the following 55 command should start the EBICS setup process: 56 57 .. code-block:: console 58 59 $ libeufin-nexus ebics-setup -c "$CONFIG_FILE" 60 61 If the previous command failed when running EBICS INI with an error code of 62 ``EBICS_INVALID_USER_OR_USER_STATE``, you need to confirm your keys to your bank to 63 activate your account. 64 65 To that end, the previous run should have left a PDF document that you can 66 print, sign and send to the bank. Look for the message that looks like ``PDF 67 file with keys created at '/tmp/libeufin-ebics-keys-$TIMESTAMP.pdf'``. 68 69 Once the bank has received and processed this document you can continue. 70 71 Get bank keys 72 ------------- 73 74 Assuming that the configuration file exists at ``$CONFIG_FILE``, the following 75 command will finish the EBICS setup process: 76 77 .. code-block:: console 78 79 $ libeufin-nexus ebics-setup -c "$CONFIG_FILE" 80 81 The EBICS setup is finished once the bank keys have been accepted. 82 83 Make sure this bank keys are accessible to the user running ``libeufin-nexus``, for the default services you should run: 84 85 .. code-block:: console 86 87 $ chown libeufin-nexus:libeufin-nexus /var/lib/libeufin-nexus/bank-ebics-keys.json