BankStatement Class

Properties   Methods   Events   Config Settings   Errors  

The BankStatement class is a single class that supports the SignOn and Bank Statement Download functions of Open Financial eXchange, as described by the OFX Specification version 1.0.2.

Syntax

BankStatement

Remarks

The BankStatement class adds bank statement download functionality to your desktop application, or allows your web application to fetch a user's bank statement without having to redirect to another website. All downloads are done using a secure HTTPS Post to send account sign-on information to a financial institution. The class receives the secure response and parses the response into its properties.

To use the BankStatement class first identify the financial institution by setting the FIId, FIOrganization and FIUrl, properties. Next identify the OFX user and application by setting the OFXUser, OFXPassword, OFXAppId and OFXAppVersion properties. Next set the BankId, AccountId and AccountType properties to the appropriate values to identify the account for which you wish to download a statement. You may also set StartDate and EndDate properties to constrain the transaction list.

Once you have finished setting the properties that describe the statement you wish to download, use the GetStatement method to build and transmit the request automatically. When the response returns, the transaction properties will be populated automatically, as well as the StartDate, EndDate, AvailableBalance, LedgerBalance and any other data the bank statement includes.

The transaction properties (TxAmount, TxCheckNumber TxDatePosted, TxFITID, TxMemo, TxPayeeName, and TxType) may be imagined as arrays, so that the getter function for each property takes as its argument the index of a transaction in the list.

For example, TxAmount(0) gives the amount of the first transaction for the last statement downloaded.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AccountId Property (BankStatement Class)

The account number used for the next statement download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccountId();
int SetAccountId(const char* lpszAccountId);

Unicode (Windows)
LPWSTR GetAccountId();
INT SetAccountId(LPCWSTR lpszAccountId);

char* inebank_bankstatement_getaccountid(void* lpObj);
int inebank_bankstatement_setaccountid(void* lpObj, const char* lpszAccountId);

QString GetAccountId();
int SetAccountId(QString qsAccountId);

Default Value

""

Remarks

This is the account number for which the user wishes to download a statement. For checking and savings accounts, this is the number that appears at the bottom of the user's checks or deposit slips, to the right of the routing number.

Data Type

String

AccountType Property (BankStatement Class)

Indicates the type of bank account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAccountType();
int SetAccountType(int iAccountType);

Unicode (Windows)
INT GetAccountType();
INT SetAccountType(INT iAccountType);

AT_CHECKING(0), 
AT_SAVINGS(1), 
AT_MONEY_MARKET(2), 
AT_LINE_OF_CREDIT(3), 
AT_CREDIT_CARD(4)

int inebank_bankstatement_getaccounttype(void* lpObj);
int inebank_bankstatement_setaccounttype(void* lpObj, int iAccountType);

int GetAccountType();
int SetAccountType(int iAccountType);

Default Value

0

Remarks

This property uses the following four values:

• atChecking (0)
• atSavings (1)
• atMoneyMarket (2)
• atLineOfCredit (3)

Data Type

Integer

AvailableBalance Property (BankStatement Class)

Amount of the available balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAvailableBalance();

Unicode (Windows)
LPWSTR GetAvailableBalance();

char* inebank_bankstatement_getavailablebalance(void* lpObj);

QString GetAvailableBalance();

Default Value

""

Remarks

This is the amount of money available from a given account.

For bank accounts, LedgerBalance represents the last balance recorded in official documents. AvailableBalance represents the value in the ledger balance once all temporary authorizations, such as ATM withdrawals, have posted to the ledger. Any positive value means that funds are available while negative values mean that the account is overdrawn.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

This property is read-only.

Data Type

String

AvailableBalanceDate Property (BankStatement Class)

Date of the available balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAvailableBalanceDate();

Unicode (Windows)
LPWSTR GetAvailableBalanceDate();

char* inebank_bankstatement_getavailablebalancedate(void* lpObj);

QString GetAvailableBalanceDate();

Default Value

""

Remarks

This is the date as of which the account balance is valid.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is read-only.

Data Type

String

BankId Property (BankStatement Class)

Number that identifies the bank.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBankId();
int SetBankId(const char* lpszBankId);

Unicode (Windows)
LPWSTR GetBankId();
INT SetBankId(LPCWSTR lpszBankId);

char* inebank_bankstatement_getbankid(void* lpObj);
int inebank_bankstatement_setbankid(void* lpObj, const char* lpszBankId);

QString GetBankId();
int SetBankId(QString qsBankId);

Default Value

""

Remarks

The meaning of this string differs with the location of the bank.

Data Type

String

ClosingDetailCount Property (BankStatement Class)

The number of records in the ClosingDetail arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClosingDetailCount();

Unicode (Windows)
INT GetClosingDetailCount();

int inebank_bankstatement_getclosingdetailcount(void* lpObj);

int GetClosingDetailCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClosingDetailAggregate
• ClosingDetailBalanceClosing
• ClosingDetailBalanceOpening
• ClosingDetailDateClose
• ClosingDetailDateEnd
• ClosingDetailDateOpen
• ClosingDetailDateStart
• ClosingDetailFITID
• ClosingDetailImageRef
• ClosingDetailImageRefType
• ClosingDetailTotalCredit
• ClosingDetailTotalDebit
• ClosingDetailTotalFees
• ClosingDetailTotalInterest

The array indices start at 0 and end at ClosingDetailCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ClosingDetailAggregate Property (BankStatement Class)

Aggregates are pieces of XML taken from the financial institution's original response.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailAggregate(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailAggregate(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailaggregate(void* lpObj, int closingdetailindex);

QString GetClosingDetailAggregate(int iClosingDetailIndex);

Default Value

""

Remarks

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

This aggregate describes a statement closing information. It contains data (elements and values) associated with the following properties:

• ClosingDetailFITID
• ClosingDetailDateStart
• ClosingDetailDateEnd
• ClosingDetailDateOpen
• ClosingDetailDateClose
• ClosingDetailDateDue (applicable to credit card accounts only)
• ClosingDetailBalanceOpening
• ClosingDetailBalanceClosing
• ClosingDetailTotalInterest (not applicable to credit card accounts)
• ClosingDetailTotalFees
• ClosingDetailTotalCredit
• ClosingDetailTotalDebit
• ClosingDetailCreditLimit (applicable to credit card accounts only)
• ClosingDetailImageRef
• ClosingDetailImageRefType

For each aggregate returned, clients can retrieve corresponding transactions by using ClosingDetailDateStart and ClosingDetailDateEnd in a statement download request (when calling GetStatement method).

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailBalanceClosing Property (BankStatement Class)

Closing statement balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailBalanceClosing(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailBalanceClosing(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailbalanceclosing(void* lpObj, int closingdetailindex);

QString GetClosingDetailBalanceClosing(int iClosingDetailIndex);

Default Value

""

Remarks

Closing statement balance.

This is not applicable for loan accounts.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailBalanceOpening Property (BankStatement Class)

Opening statement balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailBalanceOpening(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailBalanceOpening(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailbalanceopening(void* lpObj, int closingdetailindex);

QString GetClosingDetailBalanceOpening(int iClosingDetailIndex);

Default Value

""

Remarks

Opening statement balance.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailDateClose Property (BankStatement Class)

Closing statement date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailDateClose(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailDateClose(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetaildateclose(void* lpObj, int closingdetailindex);

QString GetClosingDetailDateClose(int iClosingDetailIndex);

Default Value

""

Remarks

Closing statement date.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailDateEnd Property (BankStatement Class)

End date of transaction data for this statement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailDateEnd(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailDateEnd(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetaildateend(void* lpObj, int closingdetailindex);

QString GetClosingDetailDateEnd(int iClosingDetailIndex);

Default Value

""

Remarks

End date of transaction data for this statement. A client should be able to use this date when requesting individual transactions that match this statement.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailDateOpen Property (BankStatement Class)

Opening statement date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailDateOpen(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailDateOpen(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetaildateopen(void* lpObj, int closingdetailindex);

QString GetClosingDetailDateOpen(int iClosingDetailIndex);

Default Value

""

Remarks

Opening statement date.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailDateStart Property (BankStatement Class)

Start date of transaction data for this statement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailDateStart(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailDateStart(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetaildatestart(void* lpObj, int closingdetailindex);

QString GetClosingDetailDateStart(int iClosingDetailIndex);

Default Value

""

Remarks

Start date of transaction data for this statement. A client should be able to use this date when requesting individual transactions that match this statement.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailFITID Property (BankStatement Class)

Unique identifier assigned by financial institution to identify this particular statement closing information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailFITID(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailFITID(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailfitid(void* lpObj, int closingdetailindex);

QString GetClosingDetailFITID(int iClosingDetailIndex);

Default Value

""

Remarks

Unique identifier assigned by financial institution to identify this particular statement closing information. This id provides a way for the client to distinguish one closing statement from another.

This is always returned in the server response for each statement.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailImageRef Property (BankStatement Class)

Server specified unique identifier for the statement closing image.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailImageRef(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailImageRef(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailimageref(void* lpObj, int closingdetailindex);

QString GetClosingDetailImageRef(int iClosingDetailIndex);

Default Value

""

Remarks

Server specified unique identifier for the statement closing image.

This can be either image identifier (to be used during the request to retrieve the actual image when the GetImage method is called) or URL, depending on the value of ClosingDetailImageRefType.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailImageRefType Property (BankStatement Class)

Type of retrieval method for actual statement closing image.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailImageRefType(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailImageRefType(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailimagereftype(void* lpObj, int closingdetailindex);

QString GetClosingDetailImageRefType(int iClosingDetailIndex);

Default Value

""

Remarks

Type of retrieval method for actual statement closing image.

If ClosingDetailImageRef is returned in the response, this can be either image identifier (to be used during the request for the image when the GetImage method is called) or a URL.

Possible values for ClosingDetailImageRefType are:

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailTotalCredit Property (BankStatement Class)

Total credit posted on the account for this statement (period indicated by DateStart and DateEnd ).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailTotalCredit(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailTotalCredit(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailtotalcredit(void* lpObj, int closingdetailindex);

QString GetClosingDetailTotalCredit(int iClosingDetailIndex);

Default Value

""

Remarks

Total credit posted on the account for this statement (period indicated by ClosingDetailDateStart and ClosingDetailDateEnd).

In a bank statement (checking, savings or money market account), this represents total of deposits and credits, including interest. In a credit card statement, this represents total of payments and credits.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailTotalDebit Property (BankStatement Class)

Total of debit posted on the account for this statement (period indicated by DateStart and DateEnd ).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailTotalDebit(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailTotalDebit(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailtotaldebit(void* lpObj, int closingdetailindex);

QString GetClosingDetailTotalDebit(int iClosingDetailIndex);

Default Value

""

Remarks

Total of debit posted on the account for this statement (period indicated by ClosingDetailDateStart and ClosingDetailDateEnd).

In a bank statement (checking, savings or money market account), this represents total of checks and debits, including fees. In a credit card statement, this represents total of payments and credits.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailTotalFees Property (BankStatement Class)

Total fees.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailTotalFees(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailTotalFees(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailtotalfees(void* lpObj, int closingdetailindex);

QString GetClosingDetailTotalFees(int iClosingDetailIndex);

Default Value

""

Remarks

Total fees.

In a bank statement (checking, savings or money market account), this represents total of all fees. While in a credit card statement, this represents finance charge.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

ClosingDetailTotalInterest Property (BankStatement Class)

Total interest.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetClosingDetailTotalInterest(int iClosingDetailIndex);

Unicode (Windows)
LPWSTR GetClosingDetailTotalInterest(INT iClosingDetailIndex);

char* inebank_bankstatement_getclosingdetailtotalinterest(void* lpObj, int closingdetailindex);

QString GetClosingDetailTotalInterest(int iClosingDetailIndex);

Default Value

""

Remarks

Total interest.

For bank or investment accounts, this indicates total interest posted on the account for this statement (period indicated by ClosingDetailDateStart and ClosingDetailDateEnd).

For loan accounts, this indicates total interest paid year to date.

This is not applicable for credit card accounts.

The ClosingDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ClosingDetailCount property.

This property is read-only and not available at design time.

Data Type

String

CurrencyCode Property (BankStatement Class)

Default currency code for this statement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCurrencyCode();

Unicode (Windows)
LPWSTR GetCurrencyCode();

char* inebank_bankstatement_getcurrencycode(void* lpObj);

QString GetCurrencyCode();

Default Value

""

Remarks

Indicates how to interpret the monetary amounts in the current statement. This is a 3-character ISO-4217 currency code, such as USD and EUR.

This property is read-only.

Data Type

String

EndDate Property (BankStatement Class)

End date of statement requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEndDate();
int SetEndDate(const char* lpszEndDate);

Unicode (Windows)
LPWSTR GetEndDate();
INT SetEndDate(LPCWSTR lpszEndDate);

char* inebank_bankstatement_getenddate(void* lpObj);
int inebank_bankstatement_setenddate(void* lpObj, const char* lpszEndDate);

QString GetEndDate();
int SetEndDate(QString qsEndDate);

Default Value

""

Remarks

This is a string representing the date at which to stop listing transactions on the statement. Use this property and StartDate to constrain the list of transactions retrieved when calling GetStatement.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

Data Type

String

FIId Property (BankStatement Class)

Financial institution identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIId();
int SetFIId(const char* lpszFIId);

Unicode (Windows)
LPWSTR GetFIId();
INT SetFIId(LPCWSTR lpszFIId);

char* inebank_bankstatement_getfiid(void* lpObj);
int inebank_bankstatement_setfiid(void* lpObj, const char* lpszFIId);

QString GetFIId();
int SetFIId(QString qsFIId);

Default Value

""

Remarks

FIId holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

Data Type

String

FIOrganization Property (BankStatement Class)

Financial institution organization name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIOrganization();
int SetFIOrganization(const char* lpszFIOrganization);

Unicode (Windows)
LPWSTR GetFIOrganization();
INT SetFIOrganization(LPCWSTR lpszFIOrganization);

char* inebank_bankstatement_getfiorganization(void* lpObj);
int inebank_bankstatement_setfiorganization(void* lpObj, const char* lpszFIOrganization);

QString GetFIOrganization();
int SetFIOrganization(QString qsFIOrganization);

Default Value

""

Remarks

This is the name of the OFX Financial Institution and is used during signon. Each organization has a unique FIId that must also be used at signon.

Data Type

String

FirewallAutoDetect Property (BankStatement Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int inebank_bankstatement_getfirewallautodetect(void* lpObj);
int inebank_bankstatement_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (BankStatement Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int inebank_bankstatement_getfirewalltype(void* lpObj);
int inebank_bankstatement_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (BankStatement Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* inebank_bankstatement_getfirewallhost(void* lpObj);
int inebank_bankstatement_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (BankStatement Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* inebank_bankstatement_getfirewallpassword(void* lpObj);
int inebank_bankstatement_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (BankStatement Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int inebank_bankstatement_getfirewallport(void* lpObj);
int inebank_bankstatement_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (BankStatement Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* inebank_bankstatement_getfirewalluser(void* lpObj);
int inebank_bankstatement_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FIUrl Property (BankStatement Class)

Financial institution URL.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFIUrl();
int SetFIUrl(const char* lpszFIUrl);

Unicode (Windows)
LPWSTR GetFIUrl();
INT SetFIUrl(LPCWSTR lpszFIUrl);

char* inebank_bankstatement_getfiurl(void* lpObj);
int inebank_bankstatement_setfiurl(void* lpObj, const char* lpszFIUrl);

QString GetFIUrl();
int SetFIUrl(QString qsFIUrl);

Default Value

""

Remarks

This is the URL of the OFX Financial Institution to which the class will signon and fetch data.

Data Type

String

ImageFileName Property (BankStatement Class)

Filename and location to save the image content of a transaction or statement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetImageFileName();
int SetImageFileName(const char* lpszImageFileName);

Unicode (Windows)
LPWSTR GetImageFileName();
INT SetImageFileName(LPCWSTR lpszImageFileName);

char* inebank_bankstatement_getimagefilename(void* lpObj);
int inebank_bankstatement_setimagefilename(void* lpObj, const char* lpszImageFileName);

QString GetImageFileName();
int SetImageFileName(QString qsImageFileName);

Default Value

""

Remarks

When calling the GetImage method, the image content is returned by that method. If you want the image content to be written to disk, you can set the ImageFileName to a desired file name without specifying the type. The file type will be set automatically depending on the image type supported by the server. Possible image types are: jpeg, tiff, png, pdf.

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

Note: Image download is available only for OFX version 2.1.1. When this method is called, the OFXVersion is automatically set to '211'.

Data Type

String

IncludeImages Property (BankStatement Class)

Whether the server has to return data for bank transactions or closing statements images.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIncludeImages();
int SetIncludeImages(int bIncludeImages);

Unicode (Windows)
BOOL GetIncludeImages();
INT SetIncludeImages(BOOL bIncludeImages);

int inebank_bankstatement_getincludeimages(void* lpObj);
int inebank_bankstatement_setincludeimages(void* lpObj, int bIncludeImages);

bool GetIncludeImages();
int SetIncludeImages(bool bIncludeImages);

Default Value

FALSE

Remarks

If False (default value), the server will not return any image references in the response.

Otherwise, if the FI supports image download service :

• when the GetStatement method is called, the server will return the image references for each transaction (e.g., check image).
• when the GetClosingInfo method is called, the server will return a reference to the statement closing information image.

These references can then be used as parameters when the GetImage method is called.

This is optional and supported in OFX 2.1.1 version only (i.e., if this is requested, the OFXVersion should be set to '211').

Note: Clients may request images in statement download and/or closing requests in various message sets. But not all FIs support image download. Prior to requesting these images, clients must verify that support exists on the server for image download. This is indicated by the presence of the IMAGEMSGSET aggregate in the profile response, as well as the IMAGEPROF aggregate in the profile response for the specific message set in question.

For instance, if a client wishes to request transaction images in the banking statement download request, the client must verify the presence of IMAGEMSGSET in the profile as well as transaction image support in the IMAGEPROF aggregate in the BANKMSGSET in the profile. Image download requests are allowed only in OFX 2.1.1 in the Banking, Credit Card, Loan and Investments message sets.

To verify whether your FI supports this service, you should check its profile (by calling the GetProfile method in FIProfile class) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

Data Type

Boolean

LedgerBalance Property (BankStatement Class)

Amount of the ledger balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLedgerBalance();

Unicode (Windows)
LPWSTR GetLedgerBalance();

char* inebank_bankstatement_getledgerbalance(void* lpObj);

QString GetLedgerBalance();

Default Value

""

Remarks

This value reflects the account balance as posted in the financial institution's records.

For bank accounts, LedgerBalance represents the last balance recorded in official documents. AvailableBalance represents the value in the ledger balance once all temporary authorizations, such as ATM withdrawals, have posted to the ledger. Any positive value means that funds are available while negative values mean that the account is overdrawn.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

This property is read-only.

Data Type

String

LedgerBalanceDate Property (BankStatement Class)

Date of the ledger balance.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLedgerBalanceDate();

Unicode (Windows)
LPWSTR GetLedgerBalanceDate();

char* inebank_bankstatement_getledgerbalancedate(void* lpObj);

QString GetLedgerBalanceDate();

Default Value

""

Remarks

This is the date, as of which, the ledger balance is valid.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is read-only.

Data Type

String

OFXAccessKey Property (BankStatement Class)

Access key value received after a MFA authentication in a previous signon.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAccessKey();
int SetOFXAccessKey(const char* lpszOFXAccessKey);

Unicode (Windows)
LPWSTR GetOFXAccessKey();
INT SetOFXAccessKey(LPCWSTR lpszOFXAccessKey);

char* inebank_bankstatement_getofxaccesskey(void* lpObj);
int inebank_bankstatement_setofxaccesskey(void* lpObj, const char* lpszOFXAccessKey);

QString GetOFXAccessKey();
int SetOFXAccessKey(QString qsOFXAccessKey);

Default Value

""

Remarks

This might be returned in the server response after a MFA authentication (i.e. MFA challenge question/answer pairs were validated by the server when the SendChallengeAnswers method in FIProfile class was called).

To prevent servers from needing to authenticate the user in each OFX request, the server may respond to a correct set of challenge answers with a OFXAccessKey on the signon response (when the SendChallengeAnswers method in FIProfile class was called).

The server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the OFXAccessKey it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request again (by calling the RequestChallengeQuestions method in FIProfile class). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (BankStatement Class)

OFX application identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAppId();
int SetOFXAppId(const char* lpszOFXAppId);

Unicode (Windows)
LPWSTR GetOFXAppId();
INT SetOFXAppId(LPCWSTR lpszOFXAppId);

char* inebank_bankstatement_getofxappid(void* lpObj);
int inebank_bankstatement_setofxappid(void* lpObj, const char* lpszOFXAppId);

QString GetOFXAppId();
int SetOFXAppId(QString qsOFXAppId);

Default Value

""

Remarks

This is the unique identifier of the user's OFX application.

Data Type

String

OFXAppVersion Property (BankStatement Class)

OFX application version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXAppVersion();
int SetOFXAppVersion(const char* lpszOFXAppVersion);

Unicode (Windows)
LPWSTR GetOFXAppVersion();
INT SetOFXAppVersion(LPCWSTR lpszOFXAppVersion);

char* inebank_bankstatement_getofxappversion(void* lpObj);
int inebank_bankstatement_setofxappversion(void* lpObj, const char* lpszOFXAppVersion);

QString GetOFXAppVersion();
int SetOFXAppVersion(QString qsOFXAppVersion);

Default Value

""

Remarks

This is the version of the user's OFX application.

Data Type

String

OFXPassword Property (BankStatement Class)

User's password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXPassword();
int SetOFXPassword(const char* lpszOFXPassword);

Unicode (Windows)
LPWSTR GetOFXPassword();
INT SetOFXPassword(LPCWSTR lpszOFXPassword);

char* inebank_bankstatement_getofxpassword(void* lpObj);
int inebank_bankstatement_setofxpassword(void* lpObj, const char* lpszOFXPassword);

QString GetOFXPassword();
int SetOFXPassword(QString qsOFXPassword);

Default Value

""

Remarks

This is the password used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXRequest Property (BankStatement Class)

The current OFX request aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXRequest();

Unicode (Windows)
LPWSTR GetOFXRequest();

char* inebank_bankstatement_getofxrequest(void* lpObj);

QString GetOFXRequest();

Default Value

""

Remarks

Polling OFXRequest will cause the class to generate and return an OFX request aggregate.

This property is read-only and not available at design time.

Data Type

String

OFXResponse Property (BankStatement Class)

The current OFX response aggregate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXResponse();
int SetOFXResponse(const char* lpszOFXResponse);

Unicode (Windows)
LPWSTR GetOFXResponse();
INT SetOFXResponse(LPCWSTR lpszOFXResponse);

char* inebank_bankstatement_getofxresponse(void* lpObj);
int inebank_bankstatement_setofxresponse(void* lpObj, const char* lpszOFXResponse);

QString GetOFXResponse();
int SetOFXResponse(QString qsOFXResponse);

Default Value

""

Remarks

This can be used especially for debugging purposes. This can also be used to parse an OFX Response. To do so, you can set the OFX Response data (in string format) to OFXResponse. Once set, the supplied OFX data will be parsed and will populate the same read-only properties that ReadOFXDataFile does.

This property is not available at design time.

Data Type

String

OFXUser Property (BankStatement Class)

User's id.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXUser();
int SetOFXUser(const char* lpszOFXUser);

Unicode (Windows)
LPWSTR GetOFXUser();
INT SetOFXUser(LPCWSTR lpszOFXUser);

char* inebank_bankstatement_getofxuser(void* lpObj);
int inebank_bankstatement_setofxuser(void* lpObj, const char* lpszOFXUser);

QString GetOFXUser();
int SetOFXUser(QString qsOFXUser);

Default Value

""

Remarks

This is the UserID used when signing on to the OFX Financial Institution's service.

Data Type

String

OFXVersion Property (BankStatement Class)

OFX API version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOFXVersion();
int SetOFXVersion(const char* lpszOFXVersion);

Unicode (Windows)
LPWSTR GetOFXVersion();
INT SetOFXVersion(LPCWSTR lpszOFXVersion);

char* inebank_bankstatement_getofxversion(void* lpObj);
int inebank_bankstatement_setofxversion(void* lpObj, const char* lpszOFXVersion);

QString GetOFXVersion();
int SetOFXVersion(QString qsOFXVersion);

Default Value

"102"

Remarks

This is the OFX API version used in all requests sent to your FI server (such as 1.0.2, 2.0.1, 2.1.1, etc.). Valid values: 102, 103, 200, 201, 203, 210, 211. Note that not all OFX Versions are supported by FIs.

Note: If the OFXVersion is set to 1x, the request and the response are going to be in SGML format. If set to 2x, the request will be in XML format (the response format depends on the FI's server capabilities). Note that if the OFX FI server does not support version 2x, the server will return an error (such as 'Bad Request').

Certain services are available only for a specific OFX version. For example, image download, is available only in OFX version 2.1.1.

Data Type

String

SSLAcceptServerCertEncoded Property (BankStatement Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int inebank_bankstatement_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int inebank_bankstatement_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (BankStatement Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int inebank_bankstatement_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int inebank_bankstatement_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (BankStatement Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int inebank_bankstatement_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int inebank_bankstatement_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (BankStatement Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* inebank_bankstatement_getsslcertstorepassword(void* lpObj);
int inebank_bankstatement_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (BankStatement Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int inebank_bankstatement_getsslcertstoretype(void* lpObj);
int inebank_bankstatement_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (BankStatement Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* inebank_bankstatement_getsslcertsubject(void* lpObj);
int inebank_bankstatement_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (BankStatement Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int inebank_bankstatement_getsslprovider(void* lpObj);
int inebank_bankstatement_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (BankStatement Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int inebank_bankstatement_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

StartDate Property (BankStatement Class)

Start date of requested transaction list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetStartDate();
int SetStartDate(const char* lpszStartDate);

Unicode (Windows)
LPWSTR GetStartDate();
INT SetStartDate(LPCWSTR lpszStartDate);

char* inebank_bankstatement_getstartdate(void* lpObj);
int inebank_bankstatement_setstartdate(void* lpObj, const char* lpszStartDate);

QString GetStartDate();
int SetStartDate(QString qsStartDate);

Default Value

""

Remarks

This is a string representing the date at which to start listing transactions on the statement. Use this property and EndDate to constrain the list of transactions retrieved when calling GetStatement. When provided in the request, StartDate value will be echoed in the server's response.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

Data Type

String

Timeout Property (BankStatement Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int inebank_bankstatement_gettimeout(void* lpObj);
int inebank_bankstatement_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TxCount Property (BankStatement Class)

The number of records in the Tx arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTxCount();

Unicode (Windows)
INT GetTxCount();

int inebank_bankstatement_gettxcount(void* lpObj);

int GetTxCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• TxAggregate
• TxAmount
• TxCheckNumber
• TxDate
• TxDatePosted
• TxFITID
• TxImageRef
• TxImageRefType
• TxMemo
• TxPayeeName
• TxType
• TxTypeDescription

The array indices start at 0 and end at TxCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

TxAggregate Property (BankStatement Class)

Wrapper for a bank transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxAggregate(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxAggregate(INT iTxIndex);

char* inebank_bankstatement_gettxaggregate(void* lpObj, int txindex);

QString GetTxAggregate(int iTxIndex);

Default Value

""

Remarks

Wrapper for a bank transaction.

Each bank transaction aggregate contains data (elements and values) associated with the following properties:

• TxAmount
• TxCheckNumber
• TxDatePosted
• TxFITID
• TxMemo
• TxPayeeName
• TxType
• TxImageRef
• TxImageRefType

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of OFXVersion that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxAmount Property (BankStatement Class)

This is the amount of money exchanged during a given transaction.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxAmount(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxAmount(INT iTxIndex);

char* inebank_bankstatement_gettxamount(void* lpObj, int txindex);

QString GetTxAmount(int iTxIndex);

Default Value

""

Remarks

This is the amount of money exchanged during a given transaction.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting. .

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxCheckNumber Property (BankStatement Class)

The check number as found on the original check.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxCheckNumber(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxCheckNumber(INT iTxIndex);

char* inebank_bankstatement_gettxchecknumber(void* lpObj, int txindex);

QString GetTxCheckNumber(int iTxIndex);

Default Value

""

Remarks

The check number as found on the original check. Some stores that use electronic checks may put a randomly generated value in This property.

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxDate Property (BankStatement Class)

This is the date the transaction was made by the account holder as recorded by the financial institution, stored as a string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxDate(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxDate(INT iTxIndex);

char* inebank_bankstatement_gettxdate(void* lpObj, int txindex);

QString GetTxDate(int iTxIndex);

Default Value

""

Remarks

This is the date the transaction was made by the account holder as recorded by the financial institution, stored as a string.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

Note: this property is optional. This is not applicable to loan accounts. If the server's response does not contain this information, querying this property will return an empty string.

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxDatePosted Property (BankStatement Class)

This is the date the transaction was posted to the financial institution, stored as a string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxDatePosted(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxDatePosted(INT iTxIndex);

char* inebank_bankstatement_gettxdateposted(void* lpObj, int txindex);

QString GetTxDatePosted(int iTxIndex);

Default Value

""

Remarks

This is the date the transaction was posted to the financial institution, stored as a string.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxFITID Property (BankStatement Class)

Transaction Id assigned by the financial institution.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxFITID(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxFITID(INT iTxIndex);

char* inebank_bankstatement_gettxfitid(void* lpObj, int txindex);

QString GetTxFITID(int iTxIndex);

Default Value

""

Remarks

Transaction Id assigned by the financial institution.

This is a unique id number that the financial institution uses to identify a particular transaction. Its primary purpose is to allow a client to detect duplicate responses, whether the server previously downloaded the transaction.

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxImageRef Property (BankStatement Class)

Server specified unique identifier for the transaction image.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxImageRef(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxImageRef(INT iTxIndex);

char* inebank_bankstatement_gettximageref(void* lpObj, int txindex);

QString GetTxImageRef(int iTxIndex);

Default Value

""

Remarks

Server specified unique identifier for the transaction image.

This can be either image identifier (to be used during the request to retrieve the actual image when the GetImage method is called) or URL, depending on the value of TxImageRefType.

Note: This is not applicable for credit card accounts.

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxImageRefType Property (BankStatement Class)

Type of retrieval method for actual transaction image.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxImageRefType(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxImageRefType(INT iTxIndex);

char* inebank_bankstatement_gettximagereftype(void* lpObj, int txindex);

QString GetTxImageRefType(int iTxIndex);

Default Value

""

Remarks

Type of retrieval method for actual transaction image.

If TxImageRef is returned in the response, this can be either image identifier (to be used during the request for the image when the GetImage method is called) or a URL.

Possible values for TxImageRefType are:

Note: This is not applicable for credit card accounts.

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxMemo Property (BankStatement Class)

The memo property stores a notice from the payee to the customer as a string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxMemo(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxMemo(INT iTxIndex);

char* inebank_bankstatement_gettxmemo(void* lpObj, int txindex);

QString GetTxMemo(int iTxIndex);

Default Value

""

Remarks

The memo property stores a notice from the payee to the customer as a string.

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxPayeeName Property (BankStatement Class)

If This property has a value, the NAME element replaces the entire PAYEE aggregate in the request XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxPayeeName(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxPayeeName(INT iTxIndex);

char* inebank_bankstatement_gettxpayeename(void* lpObj, int txindex);

QString GetTxPayeeName(int iTxIndex);

Default Value

""

Remarks

If This property has a value, the NAME element replaces the entire PAYEE aggregate in the request XML.

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

TxType Property (BankStatement Class)

This is the type of transaction that was made on the account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTxType(int iTxIndex);

Unicode (Windows)
INT GetTxType(INT iTxIndex);

TT_CREDIT(0), 
TT_DEBIT(1), 
TT_INTEREST(2), 
TT_DIVIDEND(3), 
TT_FIFEE(4), 
TT_SERVICE_CHARGE(5), 
TT_DEPOSIT(6), 
TT_ATM(7), 
TT_POINT_OF_SALE(8), 
TT_TRANSFER(9), 
TT_CHECK(10), 
TT_PAYMENT(11), 
TT_CASH(12), 
TT_DIRECT_DEPOSIT(13), 
TT_DIRECT_DEBIT(14), 
TT_REPEAT_PAYMENT(15), 
TT_LATE_FEE(16), 
TT_ADVANCE(17), 
TT_BALLOON(18), 
TT_OTHER(255)

int inebank_bankstatement_gettxtype(void* lpObj, int txindex);

int GetTxType(int iTxIndex);

Default Value

0

Remarks

This is the type of transaction that was made on the account. The effect on the account balance depends upon the sign of the amount, not upon the value of this transaction.

For example, if the amount is negative and the type is a credit, a negative credit is applied to the account. If the amount is negative and the type is debit, the amount is still debited from the account. A positive amount indicates the addition of money to the account, regardless of the type.

The types and their meanings are as follows:

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

Integer

TxTypeDescription Property (BankStatement Class)

A description of the transaction type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTxTypeDescription(int iTxIndex);

Unicode (Windows)
LPWSTR GetTxTypeDescription(INT iTxIndex);

char* inebank_bankstatement_gettxtypedescription(void* lpObj, int txindex);

QString GetTxTypeDescription(int iTxIndex);

Default Value

"Credit"

Remarks

A description of the transaction type. This is a string representation of the value returned by the TxType property.

The values translate as follows:

The types and their meanings are as follows:

The TxIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TxCount property.

This property is read-only and not available at design time.

Data Type

String

Config Method (BankStatement Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* inebank_bankstatement_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetClosingInfo Method (BankStatement Class)

Download a statement closing information for a bank account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClosingInfo();

Unicode (Windows)
INT GetClosingInfo();

int inebank_bankstatement_getclosinginfo(void* lpObj);

int GetClosingInfo();

Remarks

This function generates the Signon and Bank Statement Closing Information request page, submits it to the financial institution via secure HTTPS Post, receives and parses the closing statement information (that typically appears as part of a paper statement).

This information includes opening and closing dates and balances for a statement period, as well as a detailed breakdown of debits, credits, fees, and interest that are usually part of a paper statement. In addition to this information, you will also receive a date range for transactions that correspond to the closing statement. You can use this date range to retrieve transactions through statement download request (by calling the GetStatement method).

The following properties should be set when this method is called:

• FIId (required)
• FIOrganization (required)
• FIUrl (required)
• OFXAppId (required)
• OFXAppVersion (required)
• OFXVersion (required if 2.x OFX version is the one supported by your FI)
• OFXUser (required)
• OFXPassword (required)
• BankId (required)
• AccountId (required)
• AccountType (required)

The client can also specify a date range (by setting the StartDate and EndDate properties) to limit the number of closing information aggregates that the server returns. If the client does not specify a date range, the server returns as many closing information aggregates as it can (which will be stored in ClosingDetails).

If you want the server to return an image reference for each statement closing information, and if the server supports this service, you will have to set the IncludeImages to True.

The following read-only properties are populated as a result of parsing the statement response:

• CurrencyCode
• ClosingDetails

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetImage Method (BankStatement Class)

Request and retrieve a check or statement image (if available).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetImage(const char* lpszImageRef, const char* lpszImageRefType, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetImage(LPCWSTR lpszImageRef, LPCWSTR lpszImageRefType, LPINT lpSize = NULL);

char* inebank_bankstatement_getimage(void* lpObj, const char* lpszImageRef, const char* lpszImageRefType, int *lpSize);

QByteArray GetImage(const QString& qsImageRef, const QString& qsImageRefType);

Remarks

This function generates the Signon and Download Image request page, submits it to the financial institution via secure HTTPS Post.

The requested image of a check or statement closing information is identified by ImageRef parameter. The type of this image reference should be specified by ImageRefType parameter.

Possible values and their meanings for the ImageRefType parameter are:

If you want the server to return image references for each transaction or statement closing information, and if the server supports image download service via OFX, you will have to set the IncludeImages to True when either GetStatement or GetClosingInfo method is called.

If available, then you can access that particular image by calling the GetImage method, where ImageRef parameter value is set to the image reference stored in TxImageRef (or ClosingDetailImageRef) and the ImageRefType parameter is set to the respective TxImageRefType (or ClosingDetailImageRefType) corresponding to the requested check or statement.

Upon successful response, the image content will be returned by this method. If you want the image to be saved to a file, you can set the ImageFileName to a desired name without specifying the type. The file type will be set automatically depending on the image type supported by the server. Possible image types are: jpeg, tiff, png, pdf.

Otherwise, the class will throw an error.

Image download is available only for OFX version 2.1.1. When this method is called, the OFXVersion is automatically set to '211'.

Note: Clients may request images in statement download and/or closing requests in various message sets. But not all FIs support image download. Prior to requesting these images, clients must verify that support exists on the server for image download. This is indicated by the presence of the IMAGEMSGSET aggregate in the profile response, as well as the IMAGEPROF aggregate in the profile response for the specific message set in question.

For instance, if a client wishes to request transaction images in the banking statement download request, the client must verify the presence of IMAGEMSGSET in the profile as well as transaction image support in the IMAGEPROF aggregate in the BANKMSGSET in the profile. Image download requests are allowed only in OFX 2.1.1 in the Banking, Credit Card, Loan and Investments message sets.

To verify whether your FI supports this service, you should check its profile (by calling the GetProfile method in FIProfile class) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetStatement Method (BankStatement Class)

Download a bank statement.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetStatement();

Unicode (Windows)
INT GetStatement();

int inebank_bankstatement_getstatement(void* lpObj);

int GetStatement();

Remarks

This function generates the Signon and Bank Statement request page, submits it to the financial institution via secure HTTPS Post, receives and parses the bank statement. Individual transactions are downloaded with the statement.

The following properties should be set when this method is called:

• FIId (required)
• FIOrganization (required)
• FIUrl (required)
• OFXAppId (required)
• OFXAppVersion (required)
• OFXVersion (required if 2.x OFX version is the one supported by your FI)
• OFXUser (required)
• OFXPassword (required)
• BankId (required)
• AccountId (required)
• AccountType (required)

You may constrain this transaction list by setting the StartDate and EndDate properties. The server will use default values if no dates are supplied.

If you want the server to return image references for each transaction, and if the server supports this service, you will have to set the IncludeImages to True.

The following read-only properties are populated as a result of parsing the statement response:

• AvailableBalance
• AvailableBalanceDate
• LedgerBalance
• LedgerBalanceDate
• CurrencyCode
• Transactions

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReadOFXDataFile Method (BankStatement Class)

Reads an OFX response from a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadOFXDataFile(const char* lpszFileName);

Unicode (Windows)
INT ReadOFXDataFile(LPCWSTR lpszFileName);

int inebank_bankstatement_readofxdatafile(void* lpObj, const char* lpszFileName);

int ReadOFXDataFile(const QString& qsFileName);

Remarks

This method reads a previously recorded OFX response from a file, including HTTP and OFX headers.

The following read-only properties are populated as a result of parsing the data file:

• AvailableBalance
• AvailableBalanceDate
• LedgerBalance
• LedgerBalanceDate
• CurrencyCode
• Transactions
• ClosingDetails

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (BankStatement Class)

Reset the internal state of the class and all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int inebank_bankstatement_reset(void* lpObj);

int Reset();

Remarks

The Reset method does not have any parameters and does not return any value.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

WriteOFXDataFile Method (BankStatement Class)

Writes the OFX response sent by the server to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int WriteOFXDataFile(const char* lpszFileName);

Unicode (Windows)
INT WriteOFXDataFile(LPCWSTR lpszFileName);

int inebank_bankstatement_writeofxdatafile(void* lpObj, const char* lpszFileName);

int WriteOFXDataFile(const QString& qsFileName);

Remarks

This method records the entire OFX response, including HTTP and OFX headers to a file. This file can later be read and parsed by the ReadOFXDataFile method as though it were a live response.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ConnectionStatus Event (BankStatement Class)

This event is fired to indicate changes in the connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(BankStatementConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} BankStatementConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(BankStatementConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} BankStatementConnectionStatusEventParams;

#define EID_BANKSTATEMENT_CONNECTIONSTATUS 1

virtual INT INEBANK_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

class BankStatementConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(BankStatementConnectionStatusEventParams *e);

// Or, subclass BankStatement and override this emitter function.
virtual int FireConnectionStatus(BankStatementConnectionStatusEventParams *e) {...}

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Error Event (BankStatement Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(BankStatementErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} BankStatementErrorEventParams;


Unicode (Windows)
virtual INT FireError(BankStatementErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} BankStatementErrorEventParams;

#define EID_BANKSTATEMENT_ERROR 2

virtual INT INEBANK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class BankStatementErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(BankStatementErrorEventParams *e);

// Or, subclass BankStatement and override this emitter function.
virtual int FireError(BankStatementErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (BankStatement Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(BankStatementSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} BankStatementSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(BankStatementSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} BankStatementSSLServerAuthenticationEventParams;

#define EID_BANKSTATEMENT_SSLSERVERAUTHENTICATION 3

virtual INT INEBANK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class BankStatementSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(BankStatementSSLServerAuthenticationEventParams *e);

// Or, subclass BankStatement and override this emitter function.
virtual int FireSSLServerAuthentication(BankStatementSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (BankStatement Class)

Shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(BankStatementSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} BankStatementSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(BankStatementSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} BankStatementSSLStatusEventParams;

#define EID_BANKSTATEMENT_SSLSTATUS 4

virtual INT INEBANK_CALL FireSSLStatus(LPSTR &lpszMessage);

class BankStatementSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(BankStatementSSLStatusEventParams *e);

// Or, subclass BankStatement and override this emitter function.
virtual int FireSSLStatus(BankStatementSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (BankStatement Class)