BankTransfer Class
Properties Methods Events Configuration Settings Errors
The BankTransfer class is a single class that supports the SignOn and Intrabank/Interbank Funds Transfer functions of Open Financial Exchange, as described by Specification 1.0.2.
Class Name
IPWorksOFX_BankTransfer
Procedural Interface
ipworksofx_banktransfer_open(); ipworksofx_banktransfer_close($res); ipworksofx_banktransfer_register_callback($res, $id, $function); ipworksofx_banktransfer_get_last_error($res); ipworksofx_banktransfer_get_last_error_code($res); ipworksofx_banktransfer_set($res, $id, $index, $value); ipworksofx_banktransfer_get($res, $id, $index); ipworksofx_banktransfer_do_canceltransfer($res, $transferid); ipworksofx_banktransfer_do_config($res, $configurationstring); ipworksofx_banktransfer_do_modifytransfer($res, $transferid); ipworksofx_banktransfer_do_reset($res); ipworksofx_banktransfer_do_synchronizetransfers($res, $token); ipworksofx_banktransfer_do_transferfunds($res);
Remarks
The BankTransfer class 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 TransferFromBankId, TransferFromAccountId, TransferFromAccountType, and for international banks also TransferFromBranchId and TransferFromAccountKey properties;
- destination account where the funds will be deposited to, by setting TransferToBankId (if requesting interbank transfer), TransferToAccountId, TransferToAccountType, and for international banks also TransferToBranchId and TransferToAccountKey;
- transfer amount by setting TransferAmount to the desired value;
- transfer date by setting TransferDateDue (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 TransferId. In this case, it should also indicate the expected posting date of the transfer stored in TransferDatePosted.
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 TransferDatePosted. In this case, synchronization is not required.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
FIId | Financial institution identifier. |
FIOrganization | Financial institution organization name. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
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. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
SyncTransferCount | The number of records in the SyncTransfer arrays. |
SyncTransferAggregate | Wrapper for a bank transfer being initiated, modified or synchronized. |
SyncTransferAmount | Amount of the bank transfer being initiated, modified or synchronized. |
SyncTransferDateDue | Date the bank transfer (being initiated, modified or synchronized) is scheduled to be sent. |
SyncTransferDatePosted | Posted date of the bank transfer being initiated, modified or synchronized. |
SyncTransferDateProcessed | Transfer processing date. |
SyncTransferDateProjected | Projected date of the transfer. |
SyncTransferFromAccountId | Account number where the transfer (being initiated, modified or synchronized) is originating from. |
SyncTransferId | Server-assigned id of the bank transfer being initiated, modified or synchronized. |
SyncTransferStatus | Processing status code of the bank transfer being initiated, modified, canceled or synchronized. |
SyncTransferToAccountId | Account number where the bank transfer ((being initiated, modified or synchronized) is made to. |
SyncTransferTxType | Transaction type of the bank transfer being synchronized. |
Timeout | A timeout for the class. |
TransferAmount | Amount of the bank transfer being initiated, modified or synchronized. |
TransferCurrencyCode | Default currency code for this transaction. |
TransferDateDue | Date the bank transfer (being initiated, modified or synchronized) is scheduled to be sent. |
TransferDatePosted | Posted date of the bank transfer being initiated, modified or synchronized. |
TransferDateProcessed | Transfer processing date. |
TransferFromAccountId | Account number where the transfer (being initiated, modified or synchronized) is originating from. |
TransferFromAccountKey | Checksum for the bank where money has to be withdrawn (international banks only). |
TransferFromAccountType | Type of account where the transfer is originating from. |
TransferFromBankId | Number that identifies the bank where the transfer is originating from. |
TransferFromBranchId | Identifier for the bank where the transfer is originating from (international banks only). |
TransferId | Server-assigned id of the bank transfer being initiated, modified or synchronized. |
TransferStatus | Processing status code of the bank transfer being initiated, modified, canceled or synchronized. |
TransferToAccountId | Account number where the bank transfer ((being initiated, modified or synchronized) is made to. |
TransferToAccountKey | Checksum for the bank where money has to be deposited to (international banks only). |
TransferToAccountType | Type of account where money has to be deposited to. |
TransferToBankId | Number that identifies the bank where money has to be deposited to. |
TransferToBranchId | Identifier for the bank where money has to be deposited to (international banks only). |
Method List
The following is the full list of the methods of the class 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 class 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 class 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 class 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. |
AuthToken | Authentication token required for this signon session only. |
ClientUId | Unique ID identifying OFX Client. |
CorrectAction[i] | The action taken to a previously sent transaction corrected by the current one. |
CorrectFITID[i] | The FITID of a previously sent transaction corrected by the current one. |
CurrencyFormat | The format to be used for returning currency values. |
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. |
OFXDateFormat | The date format as required by OFX FI server. |
OFXLog | Log file for the OFX transaction. |
ServerMessage | Server message if a warning or other information returned. |
UserCred1A | Additional user credential required by server. |
UserCred2A | Additional user credential required by server. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
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. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
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. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class 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. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
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 port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
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). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
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. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |