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.

Class Name

IPWorksOFX_Account

Procedural Interface

 ipworksofx_account_open();
 ipworksofx_account_close($res);
 ipworksofx_account_register_callback($res, $id, $function);
 ipworksofx_account_get_last_error($res);
 ipworksofx_account_get_last_error_code($res);
 ipworksofx_account_set($res, $id, $index, $value);
 ipworksofx_account_get($res, $id, $index);
 ipworksofx_account_do_config($res, $configurationstring);
 ipworksofx_account_do_getinfo($res);
 ipworksofx_account_do_readofxdatafile($res, $filename);
 ipworksofx_account_do_reset($res);
 ipworksofx_account_do_writeofxdatafile($res, $filename);

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:

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:

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.

AccCountThe number of records in the Acc arrays.
AccTypeIndicates the type of account.
AccAggregateWrapper for an account information.
AccBankIdIf the returned ServiceType is BANK, the BankId indicates routing and transit number of the account.
AccBranchIdThis is applicable for bank accounts only (neither credit card, nor investment accounts).
AccCheckingWhether the account has check writing privileges (applicable for investment accounts only).
AccDescriptionThis is optional to be returned in the response and applicable to all service types (BANK, INVESTMENT, CREDITCARD).
AccIdThis is the account number available at the current FI.
AccIsTransferDestinationThis is not applicable for investment accounts (i.
AccIsTransferSourceThis is not applicable for investment accounts (i.
AccKeyThis is not applicable for investment accounts (i.
AccPhoneTelephone number for the account.
AccServiceTypeService-specific account type.
AccStatusThe status of the current account.
AccSupportDownloadTrue if account supports transaction detail downloads.
AccUSProductTypeThe USProductType classifies investment accounts according to their account type.
FIIdFinancial institution identifier.
FIOrganizationFinancial institution organization name.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FIUrlFinancial institution URL.
LastUpdateDate and time of last update to account information on the server.
OFXAccessKeyAccess key value received after a MFA authentication in a previous signon.
OFXAppIdOFX application identifier.
OFXAppVersionOFX application version.
OFXPasswordUser's password.
OFXRequestThe current OFX request aggregate.
OFXResponseThe current OFX response aggregate.
OFXUserUser's id.
OFXVersionOFX API version.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA 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.

ConfigSets or retrieves a configuration setting.
GetInfoIdentifies and describes all of the accounts accessible by the signed-on user.
ReadOFXDataFileReads an OFX response from a file.
ResetReset the internal state of the class and all properties to their default values.
WriteOFXDataFileWrites 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.

ConnectionStatusFired to indicate changes in connection state.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

AuthTokenAuthentication token required for this signon session only.
ClientUIdUnique 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.
CurrencyFormatThe format to be used for returning currency values.
DateFormatThe format to be used for input and output dates.
GetResponseVarParses additional information out of the response.
NewPasswordNew password for the current OFX user.
OFXDateFormatThe date format as required by OFX FI server.
OFXLogLog file for the OFX transaction.
ServerMessageServer message if a warning or other information returned.
UserCred1AAdditional user credential required by server.
UserCred2AAdditional user credential required by server.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 PHP Edition - Version 20.0 [Build 7941]