Search: 
Available in: OFX
BankTransfer Component [IBiz E-Banking Integrator V2]

Properties   Methods   Events   Configuration Settings  

The BankTransfer component is a single component that supports the SignOn and Intrabank 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 funds transfer between two accounts at the same financial institution (intrabank) when the source account, destination account, amount and date of transfer are specified. The date is optional and it should be provided only for scheduled transfers.

Funds transfer requests can be immediate or scheduled.

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

First, identify the:

Next, specify the:

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 TransferId and indicate the expected posting date of the transfer stored in TransferDate.

The transfer confirmation can be retrieved at a later time through a synchronization request (by calling SyncTransfers 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 DatePosted. In this case, synchronization is not required.

Upon successful response, the following properties will be populated automatically: DefaultCurrency, TransferId, either ProjectedTransferDate or DatePosted, TransferStatus, and TransferDate.

Property List


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

Amount Transfer amount.
BankId Number that identifies the bank where the transfer is taking place between accounts.
DatePosted Actual date of the transfer.
DefaultCurrency Default currency for this transfer transaction.
DueDate Date the transfer has to be sent.
FIId Financial institution identifier.
FIOrganization Financial institution organization name.
FIUrl Financial institution URL.
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
FromAccountId Account number from which the money for this payment is drawn.
FromAccountKey Checksum for the bank where money has to be withdrawn (international banks only).
FromAccountType Indicates the type of account from which the money for this payment is drawn.
FromBranchId Identifier for the bank money has to be withdrawn (international banks only).
LostSync Whether the token in the synchronization request is older.
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.
ProjectedTransferDate Projected date of the transfer.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of the server certificate for the last established connection.
Timeout A timeout for the component.
ToAccountId Account number to which the money for this payment is sent.
ToAccountKey Checksum for the bank where money has to be deposited (international banks only).
ToAccountType Indicates the type of account to which this payment is sent.
ToBranchId Identifier for the bank money has to be deposited to (international banks only).
TransferDate Transfer processing date.
TransferId ID assigned by the server to the transfer.
TransferStatus Transfer processing status code.

Method List


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

CancelTransfer Cancels a scheduled transfer.
Config Sets or retrieves a component configuration setting.
ModifyTransfer Modifies a scheduled transfer.
Reset Reset the internal state of the component and all properties to their default values.
SyncTransfers 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 Financial Institution.

Event List


The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

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 complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
CurrencyFormat The format to be used for returning currency values.
DateFormat The format to be used for returning and parsing date strings.
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
NewPassword New password for the current OFX user.
OFXLog Log file for the OFX transaction.
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).
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic 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 Basic authentication is to be used for the proxy.
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
ServerMessage Server message if a warning or other information returned.
SocketHandle The handle of the main socket used by the component.
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
UserAgent Information about the user agent (browser).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.