Search: 
Available in: OFX | QUICKBOOKS
Account Component [IBiz E-Banking Integrator V2]

Properties   Methods   Events   Configuration Settings  

The Account component is a single component that supports the SignOn and Account Information function of Open Financial Exchange, as described by Specification 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 Account component supports the Account information request sent to the server to identify and describe a precise list of the account information and available services for each account accessible by the signed-on user.

However, the interpretation of this request depends on the FI. At a minimum, the server provides information about all accounts that it can activate for one or more OFX services. To give the user a complete picture of his relationship with an FI, FIs can give information on other accounts, even if those accounts are available only for limited OFX services. Please note that some service providers do not have prior knowledge of user account information. This is reported in their profile (you can use the FIProfile component for this). FIs can provide limited information on accounts that would not ordinarily be suitable to OFX services

To get this list of service-specific account identification and detailed information on each one, you can call the GetInfo method.

First, identify the signon required information:

Next, specify the LastUpdate, which indicates the last time the server updated the information. The server sends the entire account information response if the LastUpdate is older.

The accounts might be bank accounts, credit card accounts, or investment accounts. This service-specific is indicated by AccServiceType. The following properties will be populated automatically (if applicable for the type of account) for each account aggregate returned in the response: LastUpdate, AccAggregate, AccServiceType, AccBankId, AccBranchId, AccId, AccKey, AccType, AccStatus, AccDescription, AccPhone, AccSupportDownload, AccIsTransferSource, AccIsTransferDestination, AccUSProductType, AccChecking.

The availability and possible values for of the above listed properties depend on the AccServiceType and are described in details under each property description.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

AccAggregate Set of account aggregates in this response.
AccBankId Unique identifier for the FI.
AccBranchId Bank identifier for international banks.
AccChecking Whether the account has check writing privileges (applicable for investment accounts only).
AccCount The number of account aggregates in the response.
AccDescription Description of the account.
AccId The account number.
AccIsTransferDestination Whether the account is enabled as a destination for an intra-bank or inter-bank transfer.
AccIsTransferSource Whether the account is enabled as a source for an intra-bank or inter-bank transfer.
AccKey Checksum for international banks.
AccPhone Telephone number for the account.
AccServiceType Service-specific account type.
AccStatus Service status on this account.
AccSupportDownload Whether the account supports transaction detail downloads.
AccType Account type.
AccUSProductType Classification of account (applicable for investment accounts only).
FIId Financial institution identifier.
FIOrganization Financial institution organization name.
FIUrl Financial institution URL.
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
LastUpdate Date and time of last update to account information on the server.
OFXAppId OFX application identifier.
OFXAppVersion OFX application version.
OFXPassword User's password.
OFXRequest The current OFX request aggregate.
OFXResponse The current OFX response aggregate.
OFXUser User's id.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of the server certificate for the last established connection.
Timeout A timeout for the component.

Method List


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

Config Sets or retrieves a component configuration setting.
GetInfo Identifies and describes all of the accounts accessible by the signed-on user.
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 complete descriptions.

ConnectionStatus Fired to indicate changes in connection state.
Error Information about errors during data delivery.
SSLServerAuthentication Fired after the server presents its certificate to the client.
SSLStatus Shows the progress of the secure connection.

Configuration Settings


The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
CurrencyFormat The format to be used for returning currency values.
DateFormat The format to be used for returning and parsing date strings.
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
NewPassword New password for the current OFX user.
OFXLog Log file for the OFX transaction.
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).
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic 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 Basic authentication is to be used for the proxy.
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
ServerMessage Server message if a warning or other information returned.
SocketHandle The handle of the main socket used by the component.
UseWinInet If set, the WinInet API is used for retrieving the URL
UseWinInetCookies Controls whether to send and accept cookies when making http requests through WinInet
UserAgent Information about the user agent (browser).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.