Properties   Methods   Events   Configuration Settings  

The BankTransfer component is a single component that supports the SignOn and Intrabank/Interbank Funds Transfer functions of Open Financial Exchange, as described by Specification 1.0.2.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The BankTransfer component supports immediate or scheduled intrabank (between two accounts at the same financial institution) and interbank (between two accounts at different financial institutions).

The fund transfer request designates source and destination accounts and the amount of the transfer. The FI must be able to authenticate the source account. The user can schedule the transfers for a future date or request an immediate transfer. The user can modify or cancel scheduled transfers, but not immediate transfers.

Interbank funds transfers differ from intrabank funds transfers in the following respects:

• the routing and transit number of the destination account differs from the source account;
• at the discretion of the FI, the destination account can be subject to pre-notification;
• source and destination accounts must be enabled for the Automated Clearing House (ACH);

To make transfer, the TransferFunds method should be called and the following information should be provided in the request.

First, identify the:

• 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:

• source account you wish to transfer the funds from, by setting Transfer, Transfer, Transfer, and for international banks also Transfer and Transfer properties;
• destination account where the funds will be deposited to, by setting Transfer (if requesting interbank transfer), Transfer, Transfer, and for international banks also Transfer and Transfer;
• transfer amount by setting Transfer to the desired value;
• transfer date by setting Transfer (if requesting a scheduled transfer, not an immediate one);

When the response returns, the server cannot provide complete confirmation for the transfer. The server can confirm only that it received the transfer instruction, and possibly, whether it validated the accounts, amount, and date specified in the transfer. When the transfer status is not provided in the server response, then the server should confirm that it accepted the instructions by issuing a Transfer. In this case, it should also indicate the expected posting date of the transfer stored in Transfer.

The transfer confirmation can be retrieved at a later time through a synchronization request (by calling SynchronizeTransfers method).

If the request is for an immediate transfer and the server can perform the transfer in real time, the server should indicate whether the transfer succeeded and should return the date of the transfer in Transfer. In this case, synchronization is not required.

Property List

---

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

FIId	Financial institution identifier.
FIOrganization	Financial institution organization name.
Firewall	A set of properties related to firewall access.
FIUrl	Financial institution URL.
LostSync	Whether the token in the synchronization request is older.
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
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLServerCert	The server certificate for the last established connection.
SyncTransfers	A list of bank transfers being synchronized.
Timeout	A timeout for the component.
Transfer	Identifies the bank transfer to be initiated or modified.

Method List

---

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

CancelTransfer	Cancels a scheduled transfer.
Config	Sets or retrieves a configuration setting.
ModifyTransfer	Modifies a scheduled transfer.
Reset	Reset the internal state of the component and all properties to their default values.
SynchronizeTransfers	Synchronizes transfers on the client side with transfers on record on the server side.
TransferFunds	Transfers money from one account to another within the same or different Financial Institution(s).

Event List

---

The following is the full list of the events fired by the component 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.
SyncTransfers	Fired for each intrabank transfer transaction included in the synchronization response.

Configuration Settings

---

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

CurrencyFormat	The format to be used for returning currency values
OFXDateFormat	The date format as required by OFX FI server
DateFormat	The format to be used for input and output dates
NewPassword	New password for the current OFX user
OFXLog	Log file for the OFX transaction
ServerMessage	Server message if a warning or other information returned
ClientUId	Unique ID identifying OFX Client
UserCred1A	Additional user credential required by server
UserCred2A	Additional user credential required by server
AuthToken	Authentication token required for this signon session only
AcceptEncoding	Used to tell the server which types of content encodings the client supports
AllowHTTPCompression	This property enables HTTP compression for receiving data
Authorization	The Authorization string to be sent to the server
EncodeURL	If set to true the URL will be encoded by the component
GetOn302Redirect	If set to true the component will perform a GET on the new location
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document
KeepAlive	Determines whether the HTTP connection is closed after completion of the request
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
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
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component
UsePlatformHTTPClient	Whether or not to use the platform HTTP client
UserAgent	Information about the user agent (browser)
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making HTTP requests through WinInet
MaxLineLength	The maximum amount of data to accumulate when no EOL is found
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHost	Name or IP address of firewall (optional)
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall
FirewallPort	The TCP port for the FirewallHost;
FirewallUser	A user name if authentication is to be used connecting through a firewall
FirewallType	Determines the type of firewall to connect through
TcpNoDelay	Whether or not to delay when sending packets
ReuseSSLSession	Determines if the SSL session is reused
SSLCipherStrength	The minimum cipher strength used for bulk encryption
SSLEnabledProtocols	Used to enable/disable the supported security protocols
SSLProvider	The name of the security provider to use
SSLSecurityFlags	Flags that control certificate verification
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)
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
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only)