CCStatement Component [E-Banking Integrator V3]
Properties
Methods
Events
Configuration Settings
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.
NOTE: What follows is a very short description of the component interfaces.
For more information, please consult the help files that come with the respective package.
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 (Transactions, Transactions, Transactions, Transactions, Transactions, and Transactions) 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, Transactions(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.
| |
| Config | Sets or retrieves a configuration setting. |
| GetClosingInfo | Download a credit card statement closing information. |
| GetImage | Request and retrieve a statement closing information image (if available). |
| GetStatement | Downloads statement for a credit card account. |
| ReadOFXDataFile | Reads an OFX response from a file. |
| Reset | Reset the internal state of the component and all properties to their default values. |
| WriteOFXDataFile | Writes the OFX response sent by the server to a file. |
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.
Configuration Settings
The following is a list of configuration settings for the component with short
descriptions. Click on the links for further details.
| |
| Overwrite | Determines whether image files will be overwritten. |
| CurrencyFormat | The format to be used for returning currency values. |
| OFXDateFormat | The date format as required by OFX FI server. |
| DateFormat | The format to be used for input and output dates. |
| NewPassword | New password for the current OFX user. |
| OFXLog | Log file for the OFX transaction. |
| ServerMessage | Server message if a warning or other information returned. |
| ClientUId | Unique ID identifying OFX Client. |
| UserCred1A | Additional user credential required by server. |
| UserCred2A | Additional user credential required by server. |
| AuthToken | Authentication token required for this signon session only. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| Authorization | The Authorization string to be sent to the server. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxHeaders | Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired. |
| MaxHTTPCookies | Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired. |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| UseIPv6 | Whether or not to use IPv6. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallListener | If true, the component binds to a SOCKS firewall as a server (IPPort only). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| FirewallType | Determines the type of firewall to connect through. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
