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

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:

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

FIIdFinancial institution identifier.
FIOrganizationFinancial institution organization name.
FirewallA set of properties related to firewall access.
FIUrlFinancial institution URL.
LostSyncWhether the token in the synchronization request is older.
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.
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.
SyncTransfersA list of bank transfers being synchronized.
TimeoutA timeout for the component.
TransferIdentifies 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.

cancelTransferCancels a scheduled transfer.
configSets or retrieves a configuration setting .
modifyTransferModifies a scheduled transfer.
resetReset the internal state of the component and all properties to their default values.
synchronizeTransfersSynchronizes transfers on the client side with transfers on record on the server side.
transferFundsTransfers 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.

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.
SyncTransfersFired 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.

BatchTransferTypeTransfer request type when an intrabank or interbank transfer is part of a multiple request (batch).
TransferTypeTransfer request type for a specified transaction.
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