Modules
	HBCI Account Extensions
	HBCI-specific user functions.

	HBCI Message Engine
	HBCI-specific message engine extension.

	HBCI User Extensions
	HBCI-specific user functions.

Enumerations
enum	AQHBCI_NEWUSER_DIALOG_CODE { AqHBCI_NewUserDialog_CodeGeneric =0, AqHBCI_NewUserDialog_CodeExistingPinTan, AqHBCI_NewUserDialog_CodeCreateKeyFile, AqHBCI_NewUserDialog_CodeExistingKeyFile, AqHBCI_NewUserDialog_CodeCreateChipcard, AqHBCI_NewUserDialog_CodeExistingChipcard }

Functions
AQHBCI_API AB_PROVIDER *	AH_Provider_new (AB_BANKING ab, const char name)

AQHBCI_API int	AH_Provider_CreateKeys (AB_PROVIDER pro, AB_USER u, int nounmount)

AQHBCI_API int	AH_Provider_Test (AB_PROVIDER *pro)

Informative Functions
AQHBCI_API const char *	AH_Provider_GetProductName (const AB_PROVIDER *pro)

AQHBCI_API const char *	AH_Provider_GetProductVersion (const AB_PROVIDER *pro)

Server Interactive Functions
Functions in this group are used from setup wizards or tools. They send requests to the server (including opening and closing of the progress dialog by calling AB_Banking_ProgressStart etc).
AQHBCI_API int	AH_Provider_GetAccounts (AB_PROVIDER pro, AB_USER u, AB_IMEXPORTER_CONTEXT *ctx, int withProgress, int nounmount, int doLock)

AQHBCI_API int	AH_Provider_GetSysId (AB_PROVIDER pro, AB_USER u, AB_IMEXPORTER_CONTEXT *ctx, int withProgress, int nounmount, int doLock)

AQHBCI_API int	AH_Provider_GetServerKeys (AB_PROVIDER pro, AB_USER u, AB_IMEXPORTER_CONTEXT *ctx, int withProgress, int nounmount, int doLock)

AQHBCI_API int	AH_Provider_SendUserKeys (AB_PROVIDER pro, AB_USER u, AB_IMEXPORTER_CONTEXT *ctx, int withProgress, int nounmount, int doLock)

AQHBCI_API int	AH_Provider_SendUserKeys2 (AB_PROVIDER pro, AB_USER u, AB_IMEXPORTER_CONTEXT *ctx, int withAuthKey, int withProgress, int nounmount, int doLock)

AQHBCI_API int	AH_Provider_GetCert (AB_PROVIDER pro, AB_USER u, int withProgress, int nounmount, int doLock)

AQHBCI_API int	AH_Provider_GetItanModes (AB_PROVIDER pro, AB_USER u, AB_IMEXPORTER_CONTEXT *ctx, int withProgress, int nounmount, int doLock)

AQHBCI_API int	AH_Provider_ChangePin (AB_PROVIDER pro, AB_USER u, AB_IMEXPORTER_CONTEXT *ctx, int withProgress, int nounmount, int doLock)

AQHBCI_API int	AH_Provider_GetAccountSepaInfo (AB_PROVIDER pro, AB_ACCOUNT_LIST2 al, AB_IMEXPORTER_CONTEXT *ctx, int withProgress, int nounmount, int doLock)

Generating Ini-Letters
INI letters are used in RDH mode only. They are used to verify the public server keys and to create a letter to be sent to the bank for verification of the public user keys.
AQHBCI_API int	AH_Provider_GetIniLetterTxt (AB_PROVIDER pro, AB_USER u, int useBankKey, int variant, GWEN_BUFFER *lbuf, int nounmount)

AQHBCI_API int	AH_Provider_GetIniLetterHtml (AB_PROVIDER pro, AB_USER u, int useBankKey, int variant, GWEN_BUFFER *lbuf, int nounmount)

Detailed Description

AqHBCI supports the German HBCI (Homebanking Computer Interface) protocol for online banking. It currently supports version 2.01, 2.10 and 2.20 of the HBCI specification.

Enumeration Type Documentation

◆ AQHBCI_NEWUSER_DIALOG_CODE

enum AQHBCI_NEWUSER_DIALOG_CODE

This enum can be used as argument to AB_Provider_GetNewUserDialog

Enumerator
AqHBCI_NewUserDialog_CodeGeneric
AqHBCI_NewUserDialog_CodeExistingPinTan
AqHBCI_NewUserDialog_CodeCreateKeyFile
AqHBCI_NewUserDialog_CodeExistingKeyFile
AqHBCI_NewUserDialog_CodeCreateChipcard
AqHBCI_NewUserDialog_CodeExistingChipcard

Definition at line 40 of file aqhbci/provider.h.

Function Documentation

◆ AH_Provider_ChangePin()

AQHBCI_API int AH_Provider_ChangePin	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		AB_IMEXPORTER_CONTEXT *	ctx,
		int	withProgress,
		int	nounmount,
		int	doLock
	)

Ask the user for a new PIN and make the server change the PIN to the newly entered one.

Parameters

pro	pointer to the HBCI provider
u	user for which the pin is to be changed
nounmount	if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

◆ AH_Provider_CreateKeys()

AQHBCI_API int AH_Provider_CreateKeys	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		int	nounmount
	)

◆ AH_Provider_GetAccounts()

AQHBCI_API int AH_Provider_GetAccounts	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		AB_IMEXPORTER_CONTEXT *	ctx,
		int	withProgress,
		int	nounmount,
		int	doLock
	)

Retrieve a list of accounts. Not all banks support this. If the bank does then the retrieved accounts are automatically added to AqBanking.

Parameters

pro	pointer to the HBCI provider
u	user for which the list of accounts is to be received
nounmount	if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

◆ AH_Provider_GetAccountSepaInfo()

AQHBCI_API int AH_Provider_GetAccountSepaInfo	(	AB_PROVIDER *	pro,
		AB_ACCOUNT_LIST2 *	al,
		AB_IMEXPORTER_CONTEXT *	ctx,
		int	withProgress,
		int	nounmount,
		int	doLock
	)

Request SEPA information for a given account. This info is then stored within the AqBanking account information (IBAN, BIC).

Parameters

pro	pointer to the HBCI provider
a	account for which the info is to be requested
nounmount	if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

◆ AH_Provider_GetCert()

AQHBCI_API int AH_Provider_GetCert	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		int	withProgress,
		int	nounmount,
		int	doLock
	)

Retrieve the SSL certificate for the given user. This is only needed for PIN/TAN mode.

Parameters

pro	pointer to the HBCI provider
u	user for which the SSL certificate is to be received
nounmount	if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

◆ AH_Provider_GetIniLetterHtml()

AQHBCI_API int AH_Provider_GetIniLetterHtml	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		int	useBankKey,
		int	variant,
		GWEN_BUFFER *	lbuf,
		int	nounmount
	)

Creates a HTML version of the INI letter. This function needs to mount the medium so the user will be ask for the pin.

Parameters

pro	provider
u	user for which the iniletter is to be created
useBankKey	if !=0 create an iniletter for the bank key
variant	use 1 for RDH1, 2 for RDH2-10 (or 0 for autoselection)
lbuf	buffer to write the iniletter to
nounmount	if !=0 the CryptToken will not be unmounted after use

◆ AH_Provider_GetIniLetterTxt()

AQHBCI_API int AH_Provider_GetIniLetterTxt	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		int	useBankKey,
		int	variant,
		GWEN_BUFFER *	lbuf,
		int	nounmount
	)

Creates a text version of the INI letter. This function needs to mount the medium so the user will be ask for the pin.

Parameters

pro	provider
u	user for which the iniletter is to be created
useBankKey	if !=0 create an iniletter for the bank key
variant	use 1 for RDH1, 2 for RDH2-10 (or 0 for autoselection)
lbuf	buffer to write the iniletter to
nounmount	if !=0 the CryptToken will not be unmounted after use

◆ AH_Provider_GetItanModes()

AQHBCI_API int AH_Provider_GetItanModes	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		AB_IMEXPORTER_CONTEXT *	ctx,
		int	withProgress,
		int	nounmount,
		int	doLock
	)

Ask the server for the list of supported iTAN modes. Not all servers support iTAN so it is ok for the server to not report any modes.

Parameters

pro	pointer to the HBCI provider
u	user for which the list of iTAN modes is to be received
nounmount	if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

◆ AH_Provider_GetProductName()

AQHBCI_API const char* AH_Provider_GetProductName ( const AB_PROVIDER * pro )

◆ AH_Provider_GetProductVersion()

AQHBCI_API const char* AH_Provider_GetProductVersion ( const AB_PROVIDER * pro )

◆ AH_Provider_GetServerKeys()

AQHBCI_API int AH_Provider_GetServerKeys	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		AB_IMEXPORTER_CONTEXT *	ctx,
		int	withProgress,
		int	nounmount,
		int	doLock
	)

Retrieve the public server keys for the given user. This is only needed for PIN/TAN and for RDH mode.

Parameters

pro	pointer to the HBCI provider
u	user for which the public keys are to be received
nounmount	if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

◆ AH_Provider_GetSysId()

AQHBCI_API int AH_Provider_GetSysId	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		AB_IMEXPORTER_CONTEXT *	ctx,
		int	withProgress,
		int	nounmount,
		int	doLock
	)

Retrieve the system id for the given user. This is only needed for PIN/TAN and for RDH mode.

Parameters

pro	pointer to the HBCI provider
u	user for which the system id is to be received
nounmount	if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

◆ AH_Provider_new()

AQHBCI_API AB_PROVIDER* AH_Provider_new	(	AB_BANKING *	ab,
		const char *	name
	)

◆ AH_Provider_SendUserKeys()

AQHBCI_API int AH_Provider_SendUserKeys	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		AB_IMEXPORTER_CONTEXT *	ctx,
		int	withProgress,
		int	nounmount,
		int	doLock
	)

Send the public keys of the given user. This is only needed for PIN/TAN and for RDH mode.

Parameters

pro	pointer to the HBCI provider
u	user for which the public keys are to be sent
nounmount	if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

◆ AH_Provider_SendUserKeys2()

AQHBCI_API int AH_Provider_SendUserKeys2	(	AB_PROVIDER *	pro,
		AB_USER *	u,
		AB_IMEXPORTER_CONTEXT *	ctx,
		int	withAuthKey,
		int	withProgress,
		int	nounmount,
		int	doLock
	)

Send the public keys of the given user. This is only needed for PIN/TAN and for RDH mode. In addition to AH_Provider_SendUserKeys this function also sends the authentication key if requested.

Parameters

pro	pointer to the HBCI provider
u	user for which the public keys are to be sent
nounmount	if !=0 then the user's medium is not unmounted in the end. This is used by setup wizards to avoid having to enter a pin too often.

◆ AH_Provider_Test()

AQHBCI_API int AH_Provider_Test ( AB_PROVIDER * pro )

Modules

Enumerations

Functions

Informative Functions

Server Interactive Functions

Generating Ini-Letters

Detailed Description

Enumeration Type Documentation

◆ AQHBCI_NEWUSER_DIALOG_CODE

Function Documentation

◆ AH_Provider_ChangePin()

◆ AH_Provider_CreateKeys()

◆ AH_Provider_GetAccounts()

◆ AH_Provider_GetAccountSepaInfo()

◆ AH_Provider_GetCert()

◆ AH_Provider_GetIniLetterHtml()

◆ AH_Provider_GetIniLetterTxt()

◆ AH_Provider_GetItanModes()

◆ AH_Provider_GetProductName()

◆ AH_Provider_GetProductVersion()

◆ AH_Provider_GetServerKeys()

◆ AH_Provider_GetSysId()

◆ AH_Provider_new()

◆ AH_Provider_SendUserKeys()

◆ AH_Provider_SendUserKeys2()

◆ AH_Provider_Test()