View source for AqBanking

<!-- Translators: Add your language to this table. -->
{| class="wikitable" style="margin: auto;"
! scope="row"|Languages
| [[de/Online-Banking|Deutsch]]
<!--| [[es/{{PAGENAME}}|Español]]
| [[fr/{{PAGENAME}}|Français]]
| [[He/גנוקאש|עִברִית]]
| [[pt/{{PAGENAME}}|Português]]
| [[Zh-hans/{{PAGENAME}}|简体中文]] -->
|}
Online Banking is in GnuCash realized by the package AqBanking—''' Aquamaniac's Banking''' by Martin Preuß. It contains several ''tools'', a ''library'' and a few separate ''helper libraries''.

At [{{URL:AB}} aquamaniac.de] ([https://translate.google.com/translate?hl=de&sl=auto&tl=en&u=https%3A%2F%2Fwww.aquamaniac.de%2Frdm%2F machine translation])  are availabe:
* the most recent versions inclusive manual,
* the most recent infos, user tips … in the [{{URL:AB}}rdm/projects/aqbanking/wiki AqBanking Wiki],
* the [{{URL:AB-ML}}listinfo/aqbanking-user Mailinglist aqbanking-user], and finally
* to report problems a [{{URL:AB}}rdm/projects/aqbanking/issues bugtracker]—but before you should have read [{{URL:AB}}rdm/projects/aqbanking/wiki/Bugreports AqBanking: Fehler oder Probleme melden]!
:;Note:In times of heavy spam registration is disabled. Then ask on its mailing list.

==Coverage==
Currently offered methods:
* bidirectional, sending of orders possible:
** the german ''Financial Transaction Services'' ('''[https://www.hbci-zka.de/ FinTS]''') standard with
*** classical '''''h'''ome '''b'''anking '''c'''ommon '''i'''nterface'' (HBCI) by asymetric key encryption or
*** modern ''PIN/TAN'' (2 step authentication) methods;
** ''Electronic Banking Internet Communication Standard'' '''[https://en.wikipedia.org/wiki/Electronic_Banking_Internet_Communication_Standard EBICS]''', availabe for business clients in AT, CH, DE and FR,
*: but because neither AqBanking nor GnuCash devs have access to an test server, upload is ''currently not implemented''. The AqBanking team is searching for users, who volunteer to test on implementing the upload. 
* unidirectional, query only:
** '''[[Setting up OFXDirectConnect|OFX Direct Connect]]''', used mainly in the US, and
** since AqBanking 5.7.8.0stable '''Paypal'''.
The recent ''stable'' GnuCash {{Version}} bundles contain Aqbanking {{AqB_Version}}, the nightly ''test'' versions {{AqB Version nightly}}.
:;Source: [{{URL:AB}}rdm/projects/aqbanking/wiki/AqBanking6#Aktueller-Status-der-Backends-in-AqBanking6]

== Compatibility ==
[[GnuCash]] compiles with many available versions of <tt>AqBanking</tt> and it's helper library <tt>Gwenhywfar</tt>, except for combinations of new gnucash with old aqbanking and vice versa.

=== Determinating the Versions ===
To see your current versions, use the command {{Shell Versions}} or, if you are using a [[Flatpak]]: {{Flatpak Versions}}
In this example you can see, that the user had built a more recent version of GnuCash, but the nightly Flatpak had a more recent AqBanking than her distribution.

== FinTS ==
This is only an overview mainly for developers. Detailed user instructions are in German: [[De/Online-Banking]]
=== HBCI/FinTS Security Type ===
AqBanking for FinTS/HBCI needs the definition of a "security medium". Depending on the FinTS/HBCI version, there is a range of choices for this:
;Single step authentication:
:;HBCI 1: self-generated asymetric keypair with 
::* public part given to the bank
::* private part stored on your harddisk, USB stick or floppy disk
::supported on all OS, but many banks dropped single step authentication.
;Two step authentication:
:*You have always to log in your session with your fixed ''Personal Identification number'' (PIN).
:*Then each transaction needs authentication with an own ''Transaction Authentification Number'' (TAN).
::To avoid Man-in-the-middle (MITM) attacks the TANs are ideally transmitted to you over a different medium.
::The way the TAN is generated varies by method:
:;HBCI 2, FinTS 3: PIN/TAN comes in several flavours:
:::;PIN/TAN (classic): no longer supported by the banks! <s>from a simple ''paper list'': you can enter any ''unused'' TAN: supported on all OS</s>
:::;iTAN: no longer supported by the banks! <s>from an indexed ''paper list'': the bank challenges TAN[i]: supported on all OS</s>
:::;mTAN: TAN per SMS on your ''mobile'': supported on all OS
::;chipTAN: The TAN is generated by a chip, which is today integrated in the bank card. You need a card reader to communicate with the chip. Some readers are stand alone devices, but others are connected with your computer. To access the connected readers the library <tt>libchipcard</tt> from the AqBanking family is required.
:::;Warning!:[https://www.redteam-pentesting.de/en//publications/mitm-chiptan-comfort Man-in-the-Middle Attacks against the chipTAN comfort Online Banking System]
:::;manual:
:::;several optical methods: Since version 4.3 GC supported the flickering image. <s>GC does not generate the flickering image, but you can manually enter the displayed number in your ''TAN generator''. [{{BugURL}}/show_bug.cgi?id=667490 Bug 667490 - Support image-based TAN methods QR, photoTAN, and chipTAN optical "Flicker code"]</s>
::::; Flicker code: The number is transferred in nibbles plus parity bit by an animated gif.
::::; QR code: can be decoded by smartphones.
::::; Photo TAN: The TAN is sent as a photo.
:;Tip: There is a more precise description: [{{URL:AB}}rdm/projects/aqbanking/wiki/ImplementTanMethods Aqbanking Wiki: Implement Tan Methods]
:;Note: For this standard methods some banks use own names created by their marketing department like sm@rtTAN.
.

=== FinTS Test Server ===
There are no currently documented instructions. There is no known test account with a testing bank server. To our knowledge anyone who wants to test this needs an account at a German bank. Sorry for that.

== Debugging ==
If there are any problems during the HBCI or OFX connection, here are further options for debugging:
# In Gnucash in <tt>Edit->Preferences->Online Banking</tt>:
## Disable <tt>Close log window when finished</tt><ref>This setting affects only GnuCash's dialogs—<tt>Action->…</tt>. Most dialogs of <tt>Tools->Online Banking Setup</tt> are provided by AqBanings library Gwenhywfar.</ref> ,
## enable <tt>Verbose debug messages</tt>. Since Gnucash 2.3.x this is related to AQBANKING_LOGLEVEL.
# To see much more '''log messages''' of aqbanking, you can set several [https://en.wikipedia.org/wiki/Environment_variable environment variables] either before starting gnucash or in the shell script gnucash or gnucash.bat. For example, in a Unix shell you would type <SyntaxHighlight lang="sh>
# General:
export GWEN_LOGLEVEL=info # usually only developers need this sometimes.
export AQBANKING_LOGLEVEL=info
# For OFX:
export AQOFX_LOG_COMM=1 # Warning: Will reveal passwords!
export AQOFXCONNECT_LOGLEVEL=info
# For FinTS/HBCI:
export AQHBCI_LOGLEVEL=info # Warning: Will reveal passwords!
</SyntaxHighlight> For <tt>AQOFX_LOG_COMM</tt> see [[Setting_up_OFXDirectConnect#Enabling_the_OFX_Log]],
::other possible values to all other of these variables are 
::*<tt>debug</tt> (more verbose) or 
::*<tt>warn</tt> (less verbose) or 
::*<tt>error</tt> (even less verbose, default value).
:However, the Gwenhywfar log messages are all sent to ''stdout'' or ''stderr'', which on [[Windows]] by default isn't available. To make these available on Windows, you need to change the exetype of ''gnucash-bin.exe'' from "Windows" to "Console", see [[Windows Debugging#Changing the Exetype to See Console Output]].
:AQBanking log messages are intercepted by a GnuCash callback and added to the [[Trace_file]]. '''N.B.:''' That callback does a second filter on log level so it's necessary to set the AQBanking log level in GnuCash as well as setting the <tt>AQBANKING_LOGLEVEL</tt> by passing the argument <tt>--log aqbanking=xxx</tt> to GnuCash, e.g. <syntaxhighlight lang="sh">
AQBANKING_LOGLEVEL=info gnucash --log aqbanking=info
</syntaxhighlight> or adjust your [[Logging|logging configuration]].

* Keep in mind that there are many many many different bank servers on this world, and every one of them might behave slightly differently. Hence, if you report a bug, please also state which '''bank server''' you are using (IP address and bank name).
* If there is a '''crash''', it would be good to provide a stack trace of the crash, see [[Stack Trace]].

=== Log Location ===
As for aqbanking up to version 5.x.x:
AqBanking stores log files for '''HBCI''' under Linux in
:<tt>~/.aqbanking/backends/aqhbci/data/banks/<country code>/<Bank ID>/logs/*</tt>, with
:''.aqbanking'' a hidden directory in the user's home directory,
:''<country code>'' your ISO country code such as "de",
:''<Bank ID>'' the name or the routing number of your bank (in German: BLZ).

To enable logging of the '''OFX''' communication to <code>/tmp/ofx.log</code> (with warnings about revealing passwords), see [[Setting up OFXDirectConnect in GnuCash 2#Enabling the OFX Log]].

;Anonymization of log files: Before you show your log files to anybody, you should replace ''passworda'', ''PINs'', ''TANs'' and other secrets by <code>X</code>es. Before publishing them e.g. sending to a mailing list, replace also your ''account number''. In theory this can also be done with <syntaxhighlight lang="sh">
aqhbci-tool4 logfile -i $INPUTLOGFILE -o $OUTPUTLOGFILE
</syntaxhighlight> But verify that the program did not miss some.

=== Config Location ===
Most parts are stored by the setup assistent below 
:;Posix: <tt>$HOME/.aqbanking/</tt>
:;Flatpak: <tt>~/.var/app/org.gnucash.Gnucash/aqbanking</tt>. 

Gnucash stores only an ''association'' in the account's slots in the '''data file'''.
Example from an uncompressed xml file:{{HBCI_Frame}}
:;account-id: The account number.
:;account-uid: AQBanking's internal id for the account.
:;bank-code: The national bank id: In the US it's the Routing ID.
:;trans-retrieval: Timestamp for the last time a retrieval attempt was made for this account.

=== GnuCash, Aqbanking or Other Error ===
* If you can execute an operation successful with the ''<tt>aqbanking</tt> command line tools'', but not with <tt>gnucash</tt>, it is obvisious a GnuCash issue.
* Else the issue might be in
# your settings,
# the bank's configuration,
# AqBanking.
Which Aqbanking CLI tools exist? {{Aqbanking Tools con}}
:<tt>aqbanking-cli</tt> serves for executing online actions after configuration. 
:<tt>aqbanking-config</tt> covers the general part of the configuration, while the others configure the  backend specific parts.

== References ==

* AqBanking:
** [{{URL:AB}} Homepage] mostly in german, includes a
*** [{{URL:AB}}rdm/projects/aqbanking/wiki wiki],
*** [{{URL:AB-ML}}listinfo/aqbanking-user mailing list] and
*** [{{URL:AB}}rdm/projects/aqbanking/issues bug tracker].
** [https://sourceforge.net/projects/aqbanking/ @ Sourceforge] outdated
* EBICS: [http://www.ebics.org/technical-information/ Technical Information]
* The former Home Banking Common Interface (HBCI) got complemented by PIN/TAN and is now called FinTS - Financial Transaction Services:
** [https://www.hbci-zka.de/ FinTS - Financial Transaction Services] (former HBCI) specifications, including error codes ... in German.
** <s>[https://www.hbci-zka.de/institute/institut_auswahl.htm Search FinTS capable institutes] and their specific settings</s> is no longer public available.
<!-- Fell  is still searching for another source
, requires 
*** former german routing number ("Bankleitzahl") or 
*** name ("Institut") and place ("Ort") -->
:;Tip: use https://translate.google.com to get a usable translation of the pages.

=== Git Repositories ===
AqBanking Git repositories of source code can be found here (mirrored at  ):
<syntaxhighlight lang="sh">
git clone https://git.aquamaniac.de/git/aqbanking   # the library
git clone https://git.aquamaniac.de/git/gwenhywfar  # its OS abstraction layer as dependency
git clone https://git.aquamaniac.de/git/libchipcard # optional for the use of chipcard readers
</syntaxhighlight>
There are also gitweb browser interfaces at 
:http://git.aqbanking.de/gitweb/?p=gwenhywfar.git , 
:http://git.aqbanking.de/gitweb/?p=aqbanking.git .

==== Unofficial GitHub Mirrors ====
Some community members set up (unofficial) github mirrors:

:;Christian Stimmig
::https://github.com/cstim/aqbanking
::https://github.com/cstim/gwenhywfar
::There is also a continuous integration build test of gwenhywfar here: https://travis-ci.org/cstim/gwenhywfar

:;Felix Schwarz, Lukas Matt
::https://github.com/aqbanking/gwenhywfar
::https://github.com/aqbanking/aqbanking
::https://github.com/aqbanking/libchipcard
::A bot script updates the "github.com/aqbanking" mirror on a daily basis so it should always be up-to-date.

=== Currently Unsupported Open Standards ===
;Note: The methods supported by AqBanking create a ''direct connection'' between you, the customer, and your bank. In contrast the 'Access to Account  ('''XS2A''') Open Banking Framework' serves to allow a FinTech ''in your name'' a connection to your bank. Some consider that as dangerous.

While many banks still think ''Security by obscurity'' is a good concept, in some countries they are changing their opinion:
;AU: https://www.finder.com.au/open-banking
;GB (UK): https://www.openbanking.org.uk/