BankTransfer Bean
Properties Methods Events Configuration Settings Errors
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.
Syntax
InEBank.Banktransfer
Remarks
The BankTransfer bean 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.
- source account you wish to transfer the funds from, by setting FromBankId, FromAccountId, FromAccountType, and for international banks also FromBranchId and FromAccountKey properties;
- destination account where the funds will be deposited to, by setting ToBankId (if requesting interbank transfer), ToAccountId, ToAccountType, and for international banks also ToBranchId and ToAccountKey;
- transfer amount by setting Amount to the desired value;
- transfer date by setting DateDue (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 Id. In this case, it should also indicate the expected posting date of the transfer stored in DatePosted.
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 DatePosted. In this case, synchronization is not required.
Property List
The following is the full list of the properties of the bean 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 bean 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 bean 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 bean with short descriptions. Click on the links for further details.
BatchTransferType | Transfer request type when an intrabank or interbank transfer is part of a multiple request (batch). |
TransferType | Transfer request type for a specified transaction. |
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. |
GetResponseVar | Parses additional information out of the response. |
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. |
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. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
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. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
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. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
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). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
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. |