BankStatement Control

Properties   Methods   Events   Config Settings   Errors  

The BankStatement control is a single control 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 control 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 control receives the secure response and parses the response into its properties.

To use the BankStatement control 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 control 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 control 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 control with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AccountId Property (BankStatement Control)

The account number used for the next statement download.

Syntax

bankstatementcontrol.AccountId[=string]

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 Control)

Indicates the type of bank account.

Syntax

bankstatementcontrol.AccountType[=integer]

Possible Values

atChecking(0), 
atSavings(1), 
atMoneyMarket(2), 
atLineOfCredit(3), 
atCreditCard(4)

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 Control)

Amount of the available balance.

Syntax

bankstatementcontrol.AvailableBalance

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 control 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 control 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 Control)

Date of the available balance.

Syntax

bankstatementcontrol.AvailableBalanceDate

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 Control)

Number that identifies the bank.

Syntax

bankstatementcontrol.BankId[=string]

Default Value

""

Remarks

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

Data Type

String

ClosingDetailCount Property (BankStatement Control)

The number of records in the ClosingDetail arrays.

Syntax

bankstatementcontrol.ClosingDetailCount

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 Control)

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

Syntax

bankstatementcontrol.ClosingDetailAggregate(ClosingDetailIndex)

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 control's properties. However, some of these elements, and/or their potential values, may not be supported by the control. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate control 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 control 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 Control)

Closing statement balance.

Syntax

bankstatementcontrol.ClosingDetailBalanceClosing(ClosingDetailIndex)

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 control 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 control 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 Control)

Opening statement balance.

Syntax

bankstatementcontrol.ClosingDetailBalanceOpening(ClosingDetailIndex)

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 control 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 control 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 Control)

Closing statement date.

Syntax

bankstatementcontrol.ClosingDetailDateClose(ClosingDetailIndex)

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 Control)

End date of transaction data for this statement.

Syntax

bankstatementcontrol.ClosingDetailDateEnd(ClosingDetailIndex)

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 Control)

Opening statement date.

Syntax

bankstatementcontrol.ClosingDetailDateOpen(ClosingDetailIndex)

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 Control)

Start date of transaction data for this statement.

Syntax

bankstatementcontrol.ClosingDetailDateStart(ClosingDetailIndex)

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 Control)

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

Syntax

bankstatementcontrol.ClosingDetailFITID(ClosingDetailIndex)

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 Control)

Server specified unique identifier for the statement closing image.

Syntax

bankstatementcontrol.ClosingDetailImageRef(ClosingDetailIndex)

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 Control)

Type of retrieval method for actual statement closing image.

Syntax

bankstatementcontrol.ClosingDetailImageRefType(ClosingDetailIndex)

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 Control)

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

Syntax

bankstatementcontrol.ClosingDetailTotalCredit(ClosingDetailIndex)

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 Control)

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

Syntax

bankstatementcontrol.ClosingDetailTotalDebit(ClosingDetailIndex)

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 Control)

Total fees.

Syntax

bankstatementcontrol.ClosingDetailTotalFees(ClosingDetailIndex)

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 control 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 control 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 Control)

Total interest.

Syntax

bankstatementcontrol.ClosingDetailTotalInterest(ClosingDetailIndex)

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 Control)

Default currency code for this statement.

Syntax

bankstatementcontrol.CurrencyCode

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 Control)

End date of statement requested.

Syntax

bankstatementcontrol.EndDate[=string]

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 Control)

Financial institution identifier.

Syntax

bankstatementcontrol.FIId[=string]

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 Control)

Financial institution organization name.

Syntax

bankstatementcontrol.FIOrganization[=string]

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 Control)

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

Syntax

bankstatementcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (BankStatement Control)

This property determines the type of firewall to connect through.

Syntax

bankstatementcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

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 Control)

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

Syntax

bankstatementcontrol.FirewallHost[=string]

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 control fails with an error.

Data Type

String

FirewallPassword Property (BankStatement Control)

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

Syntax

bankstatementcontrol.FirewallPassword[=string]

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 control fails with an error.

Data Type

String

FirewallPort Property (BankStatement Control)

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

Syntax

bankstatementcontrol.FirewallPort[=integer]

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 Control)

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

Syntax

bankstatementcontrol.FirewallUser[=string]

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 control fails with an error.

Data Type

String

FIUrl Property (BankStatement Control)

Financial institution URL.

Syntax

bankstatementcontrol.FIUrl[=string]

Default Value

""

Remarks

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

Data Type

String

ImageFileName Property (BankStatement Control)

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

Syntax

bankstatementcontrol.ImageFileName[=string]

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 Control)

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

Syntax

bankstatementcontrol.IncludeImages[=boolean]

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 control) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

Data Type

Boolean

LedgerBalance Property (BankStatement Control)

Amount of the ledger balance.

Syntax

bankstatementcontrol.LedgerBalance

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 control 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 control 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 Control)

Date of the ledger balance.

Syntax

bankstatementcontrol.LedgerBalanceDate

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 Control)

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

Syntax

bankstatementcontrol.OFXAccessKey[=string]

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 control 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 control 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 control). This allows the server to determine the lifetime of the OFXAccessKey.

Data Type

String

OFXAppId Property (BankStatement Control)

OFX application identifier.

Syntax

bankstatementcontrol.OFXAppId[=string]

Default Value

""

Remarks

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

Data Type

String

OFXAppVersion Property (BankStatement Control)

OFX application version.

Syntax

bankstatementcontrol.OFXAppVersion[=string]

Default Value

""

Remarks

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

Data Type

String

OFXPassword Property (BankStatement Control)

User's password.

Syntax

bankstatementcontrol.OFXPassword[=string]

Default Value

""

Remarks

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

Data Type

String

OFXRequest Property (BankStatement Control)

The current OFX request aggregate.

Syntax

bankstatementcontrol.OFXRequest

Default Value

""

Remarks

Polling OFXRequest will cause the control 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 Control)

The current OFX response aggregate.

Syntax

bankstatementcontrol.OFXResponse[=string]

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 Control)

User's id.

Syntax

bankstatementcontrol.OFXUser[=string]

Default Value

""

Remarks

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

Data Type

String

OFXVersion Property (BankStatement Control)

OFX API version.

Syntax

bankstatementcontrol.OFXVersion[=string]

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 Control)

This is the certificate (PEM/base64 encoded).

Syntax

bankstatementcontrol.SSLAcceptServerCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (BankStatement Control)

This is the certificate (PEM/base64 encoded).

Syntax

bankstatementcontrol.SSLCertEncoded[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (BankStatement Control)

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

Syntax

bankstatementcontrol.SSLCertStore[=string]

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).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (BankStatement Control)

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

Syntax

bankstatementcontrol.SSLCertStorePassword[=string]

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 Control)

This is the type of certificate store for this certificate.

Syntax

bankstatementcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (BankStatement Control)

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

Syntax

bankstatementcontrol.SSLCertSubject[=string]

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 Control)

This specifies the SSL/TLS implementation to use.

Syntax

bankstatementcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

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 control 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 control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (BankStatement Control)

This is the certificate (PEM/base64 encoded).

Syntax

bankstatementcontrol.SSLServerCertEncoded

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

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

Data Type

Binary String

StartDate Property (BankStatement Control)

Start date of requested transaction list.

Syntax

bankstatementcontrol.StartDate[=string]

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 Control)

A timeout for the control.

Syntax

bankstatementcontrol.Timeout[=integer]

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 control will wait for the operation to complete before returning control.

The control 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 control 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 Control)

The number of records in the Tx arrays.

Syntax

bankstatementcontrol.TxCount

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 Control)

Wrapper for a bank transaction.

Syntax

bankstatementcontrol.TxAggregate(TxIndex)

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 control's properties. However, some of these elements, and/or their potential values, may not be supported by the control. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate control 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 control 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 Control)

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

Syntax

bankstatementcontrol.TxAmount(TxIndex)

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 control 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 control 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 Control)

The check number as found on the original check.

Syntax

bankstatementcontrol.TxCheckNumber(TxIndex)

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 Control)

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

Syntax

bankstatementcontrol.TxDate(TxIndex)

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 Control)

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

Syntax

bankstatementcontrol.TxDatePosted(TxIndex)

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 Control)

Transaction Id assigned by the financial institution.

Syntax

bankstatementcontrol.TxFITID(TxIndex)

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 Control)

Server specified unique identifier for the transaction image.

Syntax

bankstatementcontrol.TxImageRef(TxIndex)

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 Control)

Type of retrieval method for actual transaction image.

Syntax

bankstatementcontrol.TxImageRefType(TxIndex)

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 Control)

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

Syntax

bankstatementcontrol.TxMemo(TxIndex)

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 Control)

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

Syntax

bankstatementcontrol.TxPayeeName(TxIndex)

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 Control)

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

Syntax

bankstatementcontrol.TxType(TxIndex)

Possible Values

ttCredit(0), 
ttDebit(1), 
ttInterest(2), 
ttDividend(3), 
ttFIFee(4), 
ttServiceCharge(5), 
ttDeposit(6), 
ttATM(7), 
ttPointOfSale(8), 
ttTransfer(9), 
ttCheck(10), 
ttPayment(11), 
ttCash(12), 
ttDirectDeposit(13), 
ttDirectDebit(14), 
ttRepeatPayment(15), 
ttLateFee(16), 
ttAdvance(17), 
ttBalloon(18), 
ttOther(255)

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 Control)

A description of the transaction type.

Syntax

bankstatementcontrol.TxTypeDescription(TxIndex)

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 Control)

Sets or retrieves a configuration setting.

Syntax

bankstatementcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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.

GetClosingInfo Method (BankStatement Control)

Download a statement closing information for a bank account.

Syntax

bankstatementcontrol.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

GetImage Method (BankStatement Control)

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

Syntax

bankstatementcontrol.GetImage ImageRef, ImageRefType

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 control 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 control) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

GetStatement Method (BankStatement Control)

Download a bank statement.

Syntax

bankstatementcontrol.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

ReadOFXDataFile Method (BankStatement Control)

Reads an OFX response from a file.

Syntax

bankstatementcontrol.ReadOFXDataFile FileName

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

Reset Method (BankStatement Control)

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

Syntax

bankstatementcontrol.Reset 

Remarks

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

WriteOFXDataFile Method (BankStatement Control)

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

Syntax

bankstatementcontrol.WriteOFXDataFile FileName

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.

ConnectionStatus Event (BankStatement Control)

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

Syntax

Sub bankstatementcontrol_ConnectionStatus(ConnectionEvent As String, StatusCode As Integer, Description As String)

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. The corresponding Visual Basic error code can be obtained by adding 15001 to this value.

Error Event (BankStatement Control)

Information about errors during data delivery.

Syntax

Sub bankstatementcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control 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 Control)

Fired after the server presents its certificate to the client.

Syntax

Sub bankstatementcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

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 Control)

Shows the progress of the secure connection.

Syntax

Sub bankstatementcontrol_SSLStatus(Message As String)

Remarks

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

Config Settings (BankStatement Control)

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Trappable Errors (BankStatement Control)

OFX Errors

	22001    Required field missing from server response.
	22002    OFX server error. Description follows.
	22003    Invalid OFX response.
	22004    OFX response contains unknown element tags.

The control may also return one of the following error codes, which are inherited from other controls.

XML Errors

	20102    Invalid attribute index.
	20103    No attributes available.
	20104    Invalid namespace index.
	20105    No namespaces available.
	20106    Invalid element index.
	20107    No elements available.
	20108    Attribute does not exist.
	20202    Unbalanced element tag.
	20203    Unknown element prefix (can't find namespace).
	20204    Unknown attribute prefix (can't find namespace).
	20205    Invalid XML markup.
	20206    Invalid end state for parser.
	20207    Document contains unbalanced elements.
	20208    Invalid XPath.
	20209    No such child.
	20210    Top element does not match start of path.
	20211    DOM tree unavailable (set BuildDOM to true and reparse).
	20303    Can't open file.
	20402    Invalid XML would be generated.
	20403    An invalid XML name has been specified.

HTTP Errors

	20119    Firewall Error. Error description contains detailed message.
	20144    Busy executing current method.
	20152    HTTP protocol error. The error message has the server response.
	20153    No server specified in URL
	20154    Specified URLScheme is invalid.
	20156    Range operation is not supported by server.
	20157    Invalid cookie index (out of range).
	20302    Interrupted.
	20303    Can't open AttachedFile.

The control may also return one of the following error codes, which are inherited from other controls.

TCPClient Errors

	20101    You cannot change the RemotePort at this time. A connection is in progress.
	20102    You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	20103    The RemoteHost address is invalid (0.0.0.0).
	20105    Already connected. If you want to reconnect, close the current connection first.
	20107    You cannot change the LocalPort at this time. A connection is in progress.
	20108    You cannot change the LocalHost at this time. A connection is in progress.
	20113    You cannot change MaxLineLength at this time. A connection is in progress.
	20117    RemotePort cannot be zero. Please specify a valid service port number.
	20118    You cannot change the UseConnection option while the control is active.
	20136    Operation would block.
	20202    Timeout.
	20212    Action impossible in control's present state.
	20213    Action impossible while not connected.
	20214    Action impossible while listening.
	20302    Timeout.
	20303    Could not open file.
	20435    Unable to convert string to selected CodePage.
	21106    Already connecting. If you want to reconnect, close the current connection first.
	21118    You need to connect first.
	21120    You cannot change the LocalHost at this time. A connection is in progress.
	21121    Connection dropped by remote host.

SSL Errors

	20271    Cannot load specified security library.
	20272    Cannot open certificate store.
	20273    Cannot find specified certificate.
	20274    Cannot acquire security credentials.
	20275    Cannot find certificate chain.
	20276    Cannot verify certificate chain.
	20277    Error during handshake.
	20281    Error verifying certificate.
	20282    Could not find client certificate.
	20283    Could not find server certificate.
	20284    Error encrypting data.
	20285    Error decrypting data.

TCP/IP Errors

	25005    [10004] Interrupted system call.
	25010    [10009] Bad file number.
	25014    [10013] Access denied.
	25015    [10014] Bad address.
	25023    [10022] Invalid argument.
	25025    [10024] Too many open files.
	25036    [10035] Operation would block.
	25037    [10036] Operation now in progress.
	25038    [10037] Operation already in progress.
	25039    [10038] Socket operation on non-socket.
	25040    [10039] Destination address required.
	25041    [10040] Message too long.
	25042    [10041] Protocol wrong type for socket.
	25043    [10042] Bad protocol option.
	25044    [10043] Protocol not supported.
	25045    [10044] Socket type not supported.
	25046    [10045] Operation not supported on socket.
	25047    [10046] Protocol family not supported.
	25048    [10047] Address family not supported by protocol family.
	25049    [10048] Address already in use.
	25050    [10049] Can't assign requested address.
	25051    [10050] Network is down.
	25052    [10051] Network is unreachable.
	25053    [10052] Net dropped connection or reset.
	25054    [10053] Software caused connection abort.
	25055    [10054] Connection reset by peer.
	25056    [10055] No buffer space available.
	25057    [10056] Socket is already connected.
	25058    [10057] Socket is not connected.
	25059    [10058] Can't send after socket shutdown.
	25060    [10059] Too many references, can't splice.
	25061    [10060] Connection timed out.
	25062    [10061] Connection refused.
	25063    [10062] Too many levels of symbolic links.
	25064    [10063] File name too long.
	25065    [10064] Host is down.
	25066    [10065] No route to host.
	25067    [10066] Directory not empty
	25068    [10067] Too many processes.
	25069    [10068] Too many users.
	25070    [10069] Disc Quota Exceeded.
	25071    [10070] Stale NFS file handle.
	25072    [10071] Too many levels of remote in path.
	25092    [10091] Network subsystem is unavailable.
	25093    [10092] WINSOCK DLL Version out of range.
	25094    [10093] Winsock not loaded yet.
	26002    [11001] Host not found.
	26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	26005    [11004] Valid name, no data record (check DNS setup).