Account Class
Properties Methods Events Configuration Settings Errors
The Account class is a single class that supports the SignOn and Account Information function of Open Financial Exchange, as described by Specification 1.0.2.
Syntax
Account
Remarks
The Account class 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 class 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:
- OFX user and application by setting the OFXUser, OFXPassword, OFXAppId and OFXAppVersion properties;
- financial institution by setting the FIId, FIOrganization and FIUrl properties.
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
- Accounts
The availability and possible values for the Accounts 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 class with short descriptions. Click on the links for further details.
AccCount | The number of records in the Acc arrays. |
AccType | Indicates the type of account. |
AccAggregate | Wrapper for an account information. |
AccBankId | If the returned ServiceType is BANK, the BankId indicates routing and transit number of the account. |
AccBranchId | This is applicable for bank accounts only (neither credit card, nor investment accounts). |
AccChecking | Whether the account has check writing privileges (applicable for investment accounts only). |
AccDescription | This is optional to be returned in the response and applicable to all service types (BANK, INVESTMENT, CREDITCARD). |
AccId | This is the account number available at the current FI. |
AccIsTransferDestination | This is not applicable for investment accounts (i. |
AccIsTransferSource | This is not applicable for investment accounts (i. |
AccKey | This is not applicable for investment accounts (i. |
AccPhone | Telephone number for the account. |
AccServiceType | Service-specific account type. |
AccStatus | The status of the current account. |
AccSupportDownload | True if account supports transaction detail downloads. |
AccUSProductType | The USProductType classifies investment accounts according to their account type. |
FIId | Financial institution identifier. |
FIOrganization | Financial institution organization name. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
FIUrl | Financial institution URL. |
LastUpdate | Date and time of last update to account information on the server. |
OFXAccessKey | Access key value received after a MFA authentication in a previous signon. |
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. |
OFXVersion | OFX API version. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
Timeout | A timeout for the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a 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 class 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 class with short descriptions. Click on the links for further details.
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 class with short descriptions. Click on the links for further details.
AuthToken | Authentication token required for this signon session only. |
ClientUId | Unique ID identifying OFX Client. |
CorrectAction[i] | The action taken to a previously sent transaction corrected by the current one. |
CorrectFITID[i] | The FITID of a previously sent transaction corrected by the current one. |
CurrencyFormat | The format to be used for returning currency values. |
DateFormat | The format to be used for input and output dates. |
GetResponseVar | Parses additional information out of the response. |
NewPassword | New password for the current OFX user. |
OFXDateFormat | The date format as required by OFX FI server. |
OFXLog | Log file for the OFX transaction. |
ServerMessage | Server message if a warning or other information returned. |
UserCred1A | Additional user credential required by server. |
UserCred2A | Additional user credential required by server. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
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. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
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). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |