E-Banking Integrator V4 - Online Help
E-Banking Integrator V4
Questions / Feedback?

InvStatement Bean

Properties   Methods   Events   Configuration Settings   Errors  

The InvStatement component is a single component that supports the SignOn and Investment Statement Download functions of Open Financial eXchange, as described by the OFX Specification version 1.0.2.

Syntax

InEBank.Invstatement

Remarks

This bean adds detailed investment account statement download functionality to your desktop application, or allows your web application to fetch a user's investment 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 InvStatement bean receives the secure response and parses the response into its properties.

To use the InvStatement bean 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 BrokerId and AccountId properties to the appropriate values to identify the account for which you wish to download a statement.

The following properties provide additional control over the request:

IncludeTransactionsWhether you want the investment transactions to be included in the statement download.
StartDateTo constrain the investment transaction list.
EndDateTo constrain the investment transaction list.
IncludePositionsWhether you want the positions to be included in the statement download.
AsOfDateTo constrain the positions list.
IncludeOpenOrdersWhether you want the open orders to be included in the statement download.
IncludeBalancesWhether you want the account balances to be included in the statement download.

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(s) properties will be populated automatically, together with StartDate, EndDate and any other data the investment statement includes.

The server's response consists of five blocks of information:

  • Transactions: a combination of bank transaction detail records and investment transaction detail records. Transactions only within the specified start and stop dates are sent.
  • Positions: positions a user has at a brokerage. Each statement response contains a complete set of position records, even if no transactions occurred in the requested statement period for a particular holding.
  • Balances: current balances typically reported on an FI statement, such as cash balance or buying power. They can also convey other items of interest, such as current interest rates.
  • Open Orders: current open trading orders that a user has at a brokerage.
  • Securities: any security referenced in either transactions, positions, or open orders.

Property List


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

AccountIdThe account number used for the next statement download.
AsOfDateDate for returned list of positions.
AvailableCashCash balance across all sub-accounts.
BalancesA list of balances in an investment statement for the date range ( StartDate and EndDate ) selected.
BrokerIdUnique identifier for the FI.
BuyingPowerBuying power.
ClosingDetailsA list of investment statement closing information for the date range ( StartDate and EndDate ) selected.
CurrencyCodeDefault currency code for this statement.
EndDateEnd date of requested transaction list.
FIIdFinancial institution identifier.
FIOrganizationFinancial institution organization name.
FirewallA set of properties related to firewall access.
FIUrlFinancial institution URL.
ImageFileNameFilename and location to save the image content of a transaction or statement.
IncludeBalancesSpecifies whether or not to include balances in the statement download.
IncludeImagesWhether the server has to return data for bank transactions or closing statements images.
IncludeOpenOrdersSpecifies whether or not to include open orders in the response.
IncludePositionsSpecifies whether or not to include positions in the statement download.
IncludeTransactionsWhether to include transactions in the statement download.
MarginBalanceMargin balance.
MarketingInfoMarketing information (at most one).
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.
OpenOrdersA list of open orders in an investment statement for the date range ( StartDate and EndDate ) selected.
PositionsA list of positions in an investment statement for the date range ( StartDate and EndDate ) selected.
SecuritiesA list of securities in an investment statement for the date range ( StartDate and EndDate ) selected.
ShortBalanceMarket value of all short positions.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
StartDateStart date of requested transaction list.
StatementDateDate and time for the statement download.
TimeoutA timeout for the component.
TransactionsA list of transactions in an investment statement for the date range ( StartDate and EndDate ) selected.

Method List


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

configSets or retrieves a configuration setting .
getClosingInfoDownload a statement closing information for an investment account.
getImageRequest and retrieve a check or statement image (if available).
getStatementDownloads statement for an investment account.
readOFXDataFileReads an OFX response from a file.
resetReset the internal state of the component 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 bean 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 bean with short descriptions. Click on the links for further details.

CurrencyFormatThe format to be used for returning currency values.
OFXDateFormatThe date format as required by OFX FI server.
DateFormatThe format to be used for input and output dates.
GetResponseVarParses additional information out of the response.
NewPasswordNew password for the current OFX user.
OFXLogLog file for the OFX transaction.
ServerMessageServer message if a warning or other information returned.
ClientUIdUnique ID identifying OFX Client.
UserCred1AAdditional user credential required by server.
UserCred2AAdditional user credential required by server.
AuthTokenAuthentication token required for this signon session only.
CorrectFITID[i]The FITID of a previously sent transaction corrected by the current one.
CorrectAction[i]The action taken to a previously sent transaction corrected by the current one.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
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.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
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.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component 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.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
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 TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
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).
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 4.0.6240.0