CCStatement Component

Properties   Methods   Events   Config Settings   Errors  

The CCStatement component is a single component that supports the SignOn and Credit Card Statement Download functions of Open Financial eXchange, as described by OFX Specification version 1.0.2.

Syntax

TiboCCStatement

Remarks

The CCStatement component adds credit card statement download functionality to your desktop application, or allows your web application to fetch a user's credit card 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 component receives the secure response and parses the response into its properties.

To use the CCStatement component 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. To identify the account, set the CardNumber property to the credit card 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 StartDate, EndDate, AvailableBalance, LedgerBalance and any other data the bank statement includes.

The transaction properties (TxAmount, 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 component 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 component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AvailableBalance Property (CCStatement Component)

Amount of the available balance.

Syntax

__property String AvailableBalance = { read=FAvailableBalance };

Default Value

""

Remarks

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

Credit card balances differ from bank account balances in that they are always negative. Since credit is money-on-loan and must be paid back, it is best thought of as a negative. The LedgerBalance reflects how much money the user has already spent under that account and must pay back to the financial institution. AvailableBalance indicates how much more money is available to the user to borrow until they must pay the ledger 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 component 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 component 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 (CCStatement Component)

Date of the available balance.

Syntax

__property String AvailableBalanceDate = { read=FAvailableBalanceDate };

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

CardNumber Property (CCStatement Component)

Credit card number.

Syntax

__property String CardNumber = { read=FCardNumber, write=FSetCardNumber };

Default Value

""

Remarks

This string contains the full credit card number, without dashes or spaces.

Some financial institutions, such as American Express, use the account number instead of the credit card number. This can be queried using the Account component or found on a recent card statement.

Data Type

String

ClosingDetailCount Property (CCStatement Component)

The number of records in the ClosingDetail arrays.

Syntax

__property int ClosingDetailCount = { read=FClosingDetailCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ClosingDetailAggregate
• ClosingDetailBalanceClosing
• ClosingDetailBalanceOpening
• ClosingDetailCreditLimit
• ClosingDetailDateClose
• ClosingDetailDateDue
• ClosingDetailDateEnd
• ClosingDetailDateOpen
• ClosingDetailDateStart
• ClosingDetailFITID
• ClosingDetailImageRef
• ClosingDetailImageRefType
• ClosingDetailMinimumPayment
• ClosingDetailTotalCredit
• ClosingDetailTotalDebit
• ClosingDetailTotalFees

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 (CCStatement Component)

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

Syntax

__property String ClosingDetailAggregate[int ClosingDetailIndex] = { read=FClosingDetailAggregate };

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

Closing statement balance.

Syntax

__property String ClosingDetailBalanceClosing[int ClosingDetailIndex] = { read=FClosingDetailBalanceClosing };

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 component 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 component 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 (CCStatement Component)

Opening statement balance.

Syntax

__property String ClosingDetailBalanceOpening[int ClosingDetailIndex] = { read=FClosingDetailBalanceOpening };

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 component 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 component 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

ClosingDetailCreditLimit Property (CCStatement Component)

Current credit limit.

Syntax

__property String ClosingDetailCreditLimit[int ClosingDetailIndex] = { read=FClosingDetailCreditLimit };

Default Value

""

Remarks

Current credit limit.

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 component 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 component 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 is applicable for credit card accounts only.

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 (CCStatement Component)

Closing statement date.

Syntax

__property String ClosingDetailDateClose[int ClosingDetailIndex] = { read=FClosingDetailDateClose };

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

ClosingDetailDateDue Property (CCStatement Component)

Next payment due date.

Syntax

__property String ClosingDetailDateDue[int ClosingDetailIndex] = { read=FClosingDetailDateDue };

Default Value

""

Remarks

Next payment due date. This is applicable to credit card and loan accounts only.

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 (CCStatement Component)

End date of transaction data for this statement.

Syntax

__property String ClosingDetailDateEnd[int ClosingDetailIndex] = { read=FClosingDetailDateEnd };

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 (CCStatement Component)

Opening statement date.

Syntax

__property String ClosingDetailDateOpen[int ClosingDetailIndex] = { read=FClosingDetailDateOpen };

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 (CCStatement Component)

Start date of transaction data for this statement.

Syntax

__property String ClosingDetailDateStart[int ClosingDetailIndex] = { read=FClosingDetailDateStart };

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 (CCStatement Component)

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

Syntax

__property String ClosingDetailFITID[int ClosingDetailIndex] = { read=FClosingDetailFITID };

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 (CCStatement Component)

Server specified unique identifier for the statement closing image.

Syntax

__property String ClosingDetailImageRef[int ClosingDetailIndex] = { read=FClosingDetailImageRef };

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 (CCStatement Component)

Type of retrieval method for actual statement closing image.

Syntax

__property String ClosingDetailImageRefType[int ClosingDetailIndex] = { read=FClosingDetailImageRefType };

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

ClosingDetailMinimumPayment Property (CCStatement Component)

Next minimum amount due.

Syntax

__property String ClosingDetailMinimumPayment[int ClosingDetailIndex] = { read=FClosingDetailMinimumPayment };

Default Value

""

Remarks

Next minimum amount due. This is applicable to credit card and loan accounts only.

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 component 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 component 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

ClosingDetailTotalCredit Property (CCStatement Component)

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

Syntax

__property String ClosingDetailTotalCredit[int ClosingDetailIndex] = { read=FClosingDetailTotalCredit };

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 (CCStatement Component)

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

Syntax

__property String ClosingDetailTotalDebit[int ClosingDetailIndex] = { read=FClosingDetailTotalDebit };

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 (CCStatement Component)

Total fees.

Syntax

__property String ClosingDetailTotalFees[int ClosingDetailIndex] = { read=FClosingDetailTotalFees };

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 component 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 component 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

CurrencyCode Property (CCStatement Component)

Default currency code for this statement.

Syntax

__property String CurrencyCode = { read=FCurrencyCode };

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 (CCStatement Component)

End date of statement requested.

Syntax

__property String EndDate = { read=FEndDate, write=FSetEndDate };

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 (CCStatement Component)

Financial institution identifier.

Syntax

__property String FIId = { read=FFIId, write=FSetFIId };

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 (CCStatement Component)

Financial institution organization name.

Syntax

__property String FIOrganization = { read=FFIOrganization, write=FSetFIOrganization };

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 (CCStatement Component)

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

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (CCStatement Component)

This property determines the type of firewall to connect through.

Syntax

__property TiboCCStatementFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TiboCCStatementFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

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

Data Type

Integer

FirewallHost Property (CCStatement Component)

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

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

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 component raises an exception.

Data Type

String

FirewallPassword Property (CCStatement Component)

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

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

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 component raises an exception.

Data Type

String

FirewallPort Property (CCStatement Component)

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

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

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 (CCStatement Component)

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

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

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 component raises an exception.

Data Type

String

FIUrl Property (CCStatement Component)

Financial institution URL.

Syntax

__property String FIUrl = { read=FFIUrl, write=FSetFIUrl };

Default Value

""

Remarks

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

Data Type

String

ImageFileName Property (CCStatement Component)

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

Syntax

__property String ImageFileName = { read=FImageFileName, write=FSetImageFileName };

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 (CCStatement Component)

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

Syntax

__property bool IncludeImages = { read=FIncludeImages, write=FSetIncludeImages };

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 GetClosingInfo method is called, the server will return a reference to each statement closing information image. These references can then be used as parameters when the GetImage method is called.

The image references for credit card transactions are not available via OFX.

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

Data Type

Boolean

LedgerBalance Property (CCStatement Component)

Amount of the ledger balance.

Syntax

__property String LedgerBalance = { read=FLedgerBalance };

Default Value

""

Remarks

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

Credit card balances differ from bank account balances in that they are always negative. Since credit is money-on-loan and must be paid back, it is best thought of as a negative. The LedgerBalance reflects how much money the user has already spent under that account and must pay back to the financial institution. AvailableBalance indicates how much more money is available to the user to borrow until they must pay the ledger 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 component 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 component 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 (CCStatement Component)

Date of the ledger balance.

Syntax

__property String LedgerBalanceDate = { read=FLedgerBalanceDate };

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 (CCStatement Component)

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

Syntax

__property String OFXAccessKey = { read=FOFXAccessKey, write=FSetOFXAccessKey };

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

Data Type

String

OFXAppId Property (CCStatement Component)

OFX application identifier.

Syntax

__property String OFXAppId = { read=FOFXAppId, write=FSetOFXAppId };

Default Value

""

Remarks

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

Data Type

String

OFXAppVersion Property (CCStatement Component)

OFX application version.

Syntax

__property String OFXAppVersion = { read=FOFXAppVersion, write=FSetOFXAppVersion };

Default Value

""

Remarks

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

Data Type

String

OFXPassword Property (CCStatement Component)

User's password.

Syntax

__property String OFXPassword = { read=FOFXPassword, write=FSetOFXPassword };

Default Value

""

Remarks

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

Data Type

String

OFXRequest Property (CCStatement Component)

The current OFX request aggregate.

Syntax

__property String OFXRequest = { read=FOFXRequest };

Default Value

""

Remarks

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

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

Data Type

String

OFXResponse Property (CCStatement Component)

The current OFX response aggregate.

Syntax

__property String OFXResponse = { read=FOFXResponse, write=FSetOFXResponse };

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 (CCStatement Component)

User's id.

Syntax

__property String OFXUser = { read=FOFXUser, write=FSetOFXUser };

Default Value

""

Remarks

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

Data Type

String

OFXVersion Property (CCStatement Component)

OFX API version.

Syntax

__property String OFXVersion = { read=FOFXVersion, write=FSetOFXVersion };

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 (CCStatement Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

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

Byte Array

SSLCertEncoded Property (CCStatement Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

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

Byte Array

SSLCertStore Property (CCStatement Component)

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

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

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

Byte Array

SSLCertStorePassword Property (CCStatement Component)

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

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

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 (CCStatement Component)

This is the type of certificate store for this certificate.

Syntax

__property TiboCCStatementSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TiboCCStatementSSLCertStoreTypes {
  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

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (CCStatement Component)

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

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

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 (CCStatement Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TiboCCStatementSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TiboCCStatementSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

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 component 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 component 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 (CCStatement Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

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

Byte Array

StartDate Property (CCStatement Component)

Start date of requested transaction list.

Syntax

__property String StartDate = { read=FStartDate, write=FSetStartDate };

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 (CCStatement Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

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

The component 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 component raises an exception.

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 (CCStatement Component)

The number of records in the Tx arrays.

Syntax

__property int TxCount = { read=FTxCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TxAggregate
• TxAmount
• TxDate
• TxDatePosted
• TxFITID
• 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 (CCStatement Component)

Wrapper for a bank transaction.

Syntax

__property String TxAggregate[int TxIndex] = { read=FTxAggregate };

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

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

Syntax

__property String TxAmount[int TxIndex] = { read=FTxAmount };

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 component 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 component 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

TxDate Property (CCStatement Component)

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

Syntax

__property String TxDate[int TxIndex] = { read=FTxDate };

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 (CCStatement Component)

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

Syntax

__property String TxDatePosted[int TxIndex] = { read=FTxDatePosted };

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 (CCStatement Component)

Transaction Id assigned by the financial institution.

Syntax

__property String TxFITID[int TxIndex] = { read=FTxFITID };

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

TxMemo Property (CCStatement Component)

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

Syntax

__property String TxMemo[int TxIndex] = { read=FTxMemo };

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 (CCStatement Component)

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

Syntax

__property String TxPayeeName[int TxIndex] = { read=FTxPayeeName };

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 (CCStatement Component)

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

Syntax

__property TiboCCStatementTxTypes TxType[int TxIndex] = { read=FTxType };

enum TiboCCStatementTxTypes {
  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

ttCredit

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 (CCStatement Component)

A description of the transaction type.

Syntax

__property String TxTypeDescription[int TxIndex] = { read=FTxTypeDescription };

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 (CCStatement Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

Download a credit card statement closing information.

Syntax

void __fastcall GetClosingInfo();

Remarks

This function generates the Signon and CC 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)
• CardNumber (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 (CCStatement Component)

Request and retrieve a statement closing information image (if available).

Syntax

DynamicArray<Byte> __fastcall GetImage(String ImageRef, String 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 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 statement closing information, and if the server supports image download service via OFX, you will have to set the IncludeImages to True when the 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 the ClosingDetailImageRef and the ImageRefType parameter is set to the respective ClosingDetailImageRefType (corresponding to the requested 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 component 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 component) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

GetStatement Method (CCStatement Component)

Downloads statement for a credit card account.

Syntax

void __fastcall GetStatement();

Remarks

This method generates the Signon and Credit Card Statement request page, submits it to the financial institution via secure HTTPS Post, and receives and parses the bank 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)
• CardNumber (required)

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

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

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

ReadOFXDataFile Method (CCStatement Component)

Reads an OFX response from a file.

Syntax

void __fastcall ReadOFXDataFile(String 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 (CCStatement Component)

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

Syntax

void __fastcall Reset();

Remarks

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

WriteOFXDataFile Method (CCStatement Component)

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

Syntax

void __fastcall WriteOFXDataFile(String 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 (CCStatement Component)

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

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TiboCCStatementConnectionStatusEventParams;
typedef void __fastcall (__closure *TiboCCStatementConnectionStatusEvent)(System::TObject* Sender, TiboCCStatementConnectionStatusEventParams *e);
__property TiboCCStatementConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

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 (CCStatement Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TiboCCStatementErrorEventParams;
typedef void __fastcall (__closure *TiboCCStatementErrorEvent)(System::TObject* Sender, TiboCCStatementErrorEventParams *e);
__property TiboCCStatementErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 (CCStatement Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TiboCCStatementSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TiboCCStatementSSLServerAuthenticationEvent)(System::TObject* Sender, TiboCCStatementSSLServerAuthenticationEventParams *e);
__property TiboCCStatementSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

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 (CCStatement Component)

Shows the progress of the secure connection.

Syntax

typedef struct {
  String Message;
} TiboCCStatementSSLStatusEventParams;
typedef void __fastcall (__closure *TiboCCStatementSSLStatusEvent)(System::TObject* Sender, TiboCCStatementSSLStatusEventParams *e);
__property TiboCCStatementSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

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

Config Settings (CCStatement Component)

-----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 (CCStatement Component)

OFX Errors

	2000   Required field missing from server response.
	2001   OFX server error. Description follows.
	2002   Invalid OFX response.
	2003   OFX response contains unknown element tags.

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

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (can't find namespace).
	203   Unknown attribute prefix (can't find namespace).
	204   Invalid XML markup.
	205   Invalid end state for parser.
	206   Document contains unbalanced elements.
	207   Invalid XPath.
	208   No such child.
	209   Top element does not match start of path.
	210   DOM tree unavailable (set BuildDOM to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.

HTTP Errors

	118   Firewall Error. Error description contains detailed message.
	143   Busy executing current method.
	151   HTTP protocol error. The error message has the server response.
	152   No server specified in URL
	153   Specified URLScheme is invalid.
	155   Range operation is not supported by server.
	156   Invalid cookie index (out of range).
	301   Interrupted.
	302   Can't open AttachedFile.

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

TCPClient Errors

	100   You cannot change the RemotePort at this time. A connection is in progress.
	101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	102   The RemoteHost address is invalid (0.0.0.0).
	104   Already connected. If you want to reconnect, close the current connection first.
	106   You cannot change the LocalPort at this time. A connection is in progress.
	107   You cannot change the LocalHost at this time. A connection is in progress.
	112   You cannot change MaxLineLength at this time. A connection is in progress.
	116   RemotePort cannot be zero. Please specify a valid service port number.
	117   You cannot change the UseConnection option while the component is active.
	135   Operation would block.
	201   Timeout.
	211   Action impossible in control's present state.
	212   Action impossible while not connected.
	213   Action impossible while listening.
	301   Timeout.
	302   Could not open file.
	434   Unable to convert string to selected CodePage.
	1105   Already connecting. If you want to reconnect, close the current connection first.
	1117   You need to connect first.
	1119   You cannot change the LocalHost at this time. A connection is in progress.
	1120   Connection dropped by remote host.

SSL Errors

	270   Cannot load specified security library.
	271   Cannot open certificate store.
	272   Cannot find specified certificate.
	273   Cannot acquire security credentials.
	274   Cannot find certificate chain.
	275   Cannot verify certificate chain.
	276   Error during handshake.
	280   Error verifying certificate.
	281   Could not find client certificate.
	282   Could not find server certificate.
	283   Error encrypting data.
	284   Error decrypting data.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).