LoanStatement Class

Properties   Methods   Events   Configuration Settings   Errors  

The LoanStatement class is a single class that supports the SignOn and Loan Statement Download functions of Open Financial eXchange, as described by the OFX Specification version 2.1.

Class Name

IPWorksOFX_LoanStatement

Procedural Interface

 ipworksofx_loanstatement_open();
 ipworksofx_loanstatement_close($res);
 ipworksofx_loanstatement_register_callback($res, $id, $function);
 ipworksofx_loanstatement_get_last_error($res);
 ipworksofx_loanstatement_get_last_error_code($res);
 ipworksofx_loanstatement_set($res, $id, $index, $value);
 ipworksofx_loanstatement_get($res, $id, $index);
 ipworksofx_loanstatement_do_config($res, $configurationstring);
 ipworksofx_loanstatement_do_getclosinginfo($res);
 ipworksofx_loanstatement_do_getimage($res, $imageref, $imagereftype);
 ipworksofx_loanstatement_do_getstatement($res);
 ipworksofx_loanstatement_do_readofxdatafile($res, $filename);
 ipworksofx_loanstatement_do_reset($res);
 ipworksofx_loanstatement_do_writeofxdatafile($res, $filename);

Remarks

The LoanStatement class adds loan statement download functionality to your desktop application, or allows your web application to fetch a user's loan 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 class receives the secure response and parses the response into its properties.

To use the LoanStatement 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. Next, set the AccountId and AccountType properties to the appropriate values to identify the account for which you wish to download a loan 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 the StartDate, EndDate, AvailableBalance, PrincipalBalance, and any other data the loan statement includes.

The transaction properties (TxAmount, TxCheckNumber TxDatePosted, TxFITID, TxMemo, TxPayeeName, and TxType, etc.) 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, TxAmount(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 class 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 class 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.

Note: Loan Statement Download is supported only in OFX Versions 2.1.0 and 2.1.1. If your FI does not support this OFX version, then you will not be able to use this class.

Property List


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

AccountIdThe account number used for the next statement download.
AccountTypeIndicates the type of the loan account.
AvailableBalanceAmount of the available balance.
AvailableBalanceDateDate of the available balance.
ClosingDetailCountThe number of records in the ClosingDetail arrays.
ClosingDetailAggregateAggregates are pieces of XML taken from the financial institution's original response.
ClosingDetailBalanceOpeningOpening statement balance.
ClosingDetailDateCloseClosing statement date.
ClosingDetailDateDueNext payment due date.
ClosingDetailDateEndEnd date of transaction data for this statement.
ClosingDetailDateOpenOpening statement date.
ClosingDetailDateStartStart date of transaction data for this statement.
ClosingDetailFITIDUnique identifier assigned by financial institution to identify this particular statement closing information.
ClosingDetailImageRefServer specified unique identifier for the statement closing image.
ClosingDetailImageRefTypeType of retrieval method for actual statement closing image.
ClosingDetailMinimumPaymentNext minimum amount due.
ClosingDetailTotalInterestTotal interest.
CurrencyCodeDefault currency code for this statement.
EndDateEnd date of statement requested.
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.
ImageFileNameFilename and location to save the image content of a transaction or statement.
IncludeImagesWhether the server has to return data for bank transactions or closing statements images.
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.
PrincipalBalanceAmount of the loan principal balance for the current statement.
PrincipalBalanceDateDate and time of the current loan principal balance.
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).
StartDateStart date of requested transaction list.
TimeoutA timeout for the class.
TotalPrincipalLTDTotal principal paid loan to date.
TotalPrincipalYTDTotal principal paid year to date.
TxCountThe number of records in the Tx arrays.
TxAggregateWrapper for a bank transaction.
TxAmountThis is the amount of money exchanged during a given transaction.
TxCheckNumberThe check number as found on the original check.
TxDatePostedThis is the date the transaction was posted to the financial institution, stored as a string.
TxEscrowThis is the total amount of payment applied to Escrow.
TxFITIDTransaction Id assigned by the financial institution.
TxImageRefServer specified unique identifier for the transaction image.
TxImageRefTypeType of retrieval method for actual transaction image.
TxInterestThis is the amount of payment applied to Interest.
TxMemoThe memo property stores a notice from the payee to the customer as a string.
TxPayeeNameIf This property has a value, the NAME element replaces the entire PAYEE aggregate in the request XML.
TxPrincipalThis is the amount of payment applied to Principal.
TxTypeThis is the type of transaction that was made on the account.
TxTypeDescriptionA description of the transaction type.

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.
GetClosingInfoDownload a statement closing information for a bank account.
GetImageRequest and retrieve a check or statement image (if available).
GetStatementDownload a loan statement.
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.

MarketingInfoMarketing information regarding the current loan.
OverwriteDetermines whether image files will be overwritten.
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]