FIProfile Class

Properties   Methods   Events   Configuration Settings   Errors  

The FIProfile control is a single class that supports the SignOn and FI Profile functions of Open Financial eXchange, as described by the OFX Specification version 1.0.2.

Class Name

IPWorksOFX_FIProfile

Procedural Interface

 ipworksofx_fiprofile_open();
 ipworksofx_fiprofile_close($res);
 ipworksofx_fiprofile_register_callback($res, $id, $function);
 ipworksofx_fiprofile_get_last_error($res);
 ipworksofx_fiprofile_get_last_error_code($res);
 ipworksofx_fiprofile_set($res, $id, $index, $value);
 ipworksofx_fiprofile_get($res, $id, $index);
 ipworksofx_fiprofile_do_config($res, $configurationstring);
 ipworksofx_fiprofile_do_getprofile($res);
 ipworksofx_fiprofile_do_readofxdatafile($res, $filename);
 ipworksofx_fiprofile_do_requestchallengequestions($res);
 ipworksofx_fiprofile_do_reset($res);
 ipworksofx_fiprofile_do_sendchallengeanswers($res);
 ipworksofx_fiprofile_do_writeofxdatafile($res, $filename);

Remarks

The FIProfile class provides the ability to download an OFX Financial Institution Profile. These profiles contain information about how to communicate with the financial institution, such as what message sets are supported and what URLs to post to for them as well as the type of data that is supported for sign on.

To use the FIProfile class, 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. Use the ClientRouting property to notify the server as to the client's routing capabilities. Finally, set the LastUpdate property to the date of the most recent profile request. Then just call the GetProfile method to retrieve the financial institution's profile.

To determine whether the client has the latest version of the FI profile, the server checks the date and time passed by the client in LastUpdate. If the client has the latest version of the FI profile, the server does not return a profile specific response. In this case, the ServerMessage will contain the message returned by the server (such as: 'Up to date', etc.).

Property List


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

ChallengeQuestionCountThe number of records in the Challenge arrays.
ChallengeAggregateWrapper for a MFA challenge question.
ChallengeAnswerUser's answer to the challenge question identified by QuestionId .
ChallengeQuestionThe textual challenge question.
ChallengeQuestionIdIdentifier for the challenge question.
ClientRoutingClient routing capabilities of the Financial Institution.
FIAddress1Street address.
FIAddress2Street address.
FIAddress3Street address.
FICityCity.
FICountryCountry.
FICustomerServicePhonePhone number for Customer Service.
FIEmailAddressEmail address for contacting the Financial Institution.
FIHomePageHome web page for general information about the Financial Institution.
FIIdFinancial institution identifier.
FINameName.
FIOrganizationFinancial institution organization name.
FIPostalCodePostal Code.
FIProfileDateThe date the current profile was posted.
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.
FIStateState.
FITechSupportPhonePhone number for Technical Support.
FIUrlFinancial institution URL.
LastUpdateDate and time of the last profile update.
MessageSetCountThe number of records in the MessageSet arrays.
MessageSetAggregateWrapper for a message set.
MessageSetClosingInfoAvailabilityThis is an indicator of the Financial Institution's statement closing information capabilities.
MessageSetClosingInfoImageThis is an indicator of the Financial Institution's statement closing image capabilities.
MessageSetLanguageLanguages the server supports.
MessageSetNameName of a message set supported by the given FI.
MessageSetRecoveryThis is an indicator of the Financial Institution's error-recovery capabilities.
MessageSetRefreshIf true, the server can support Synchronized Refresh.
MessageSetSecurityLevelSecurity level of the Message Set.
MessageSetServiceProviderIf the OFX server has been outsourced to a service provider other than the Financial Institution, then the name of that provider should appear here.
MessageSetSignOnRealmThis is the name of the SignOn realm used by this message set.
MessageSetSyncModeLevel of synchronization offered by the server for this message set.
MessageSetTransportSecurityIt indicates whether any security measures are taken at the Transport Layer for this message set.
MessageSetTxImageIt indicates whether FI supports transaction image download for this message set.
MessageSetURLThis is the address of the server to which OFX (HTTP) connections are made for this particular message set.
MessageSetVersionThis version number corresponds to the version of the OFX Specification which the server uses for the message set.
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.
SignOnInfoCountThe number of records in the SignOn arrays.
SignOnAggregateWrapper for signon information.
SignOnAuthTokenText label for the Authentication Token.
SignOnAuthTokenFirstIndicates whether server requires clients to send the Authentication Token as part of first signon.
SignOnAuthTokenUrlURL where Authentication Token information is provided by the institution operating the OFX server.
SignOnCaseSensitiveIndicates whether the password is case-sensitive or not.
SignOnCharTypeType of characters the password can contain.
SignOnClientUIdReqIndicates whether the Client Unique Identifier is required to be included in the signon.
SignOnMaxPwdLengthMaximum number of characters a SignOn password on this server can have.
SignOnMFAChallengeFirstIndicates whether the Multi-Factor Authentication (MFA) challenge is required to be included in the first signon to this server.
SignOnMFAChallengeReqIndicates whether the Multi-Factor Authentication (MFA) challenge is required by this FI server.
SignOnMinPwdLengthMinimum number of characters a SignOn password on this server can have.
SignOnPINChangeIt indicates whether the server accepts any PIN Change Requests at all.
SignOnPINChangeFirstIndicates whether server requires clients to change password as part of first signon.
SignOnRealmSignOn realm used by this message set.
SignOnSpacesIt indicates whether the password can contain whitespaces.
SignOnSpecialIt indicates whether the password can contain special characters.
SignOnUserCred1QText prompt for user credential.
SignOnUserCred2QText prompt for user credential.
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.
GetProfileDownload the message set profile for a given Financial Institution.
ReadOFXDataFileReads an OFX response from a file.
RequestChallengeQuestionsDownload the challenge questions when Multi-Factor Authentication (MFA) is required.
ResetReset the internal state of the class and all properties to their default values.
SendChallengeAnswersSend the answers to challenge questions for a Multi-Factor Authentication (MFA).
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]