IPWorks OFX 2020 Python Edition

Questions / Feedback?

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.

Syntax

class ipworksofx.BankTransfer

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 transfer_funds 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 transfer_id. In this case, it should also indicate the expected posting date of the transfer stored in transfer_date_posted.

The transfer confirmation can be retrieved at a later time through a synchronization request (by calling synchronize_transfers 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_date_posted. 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.

fi_idFinancial institution identifier.
fi_organizationFinancial institution organization name.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the TCP port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
fi_urlFinancial institution URL.
lost_syncWhether the token in the synchronization request is older.
ofx_access_keyAccess key value received after a MFA authentication in a previous signon.
ofx_app_idOFX application identifier.
ofx_app_versionOFX application version.
ofx_passwordUser's password.
ofx_requestThe current OFX request aggregate.
ofx_responseThe current OFX response aggregate.
ofx_userUser's id.
ofx_versionOFX API version.
ssl_accept_server_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_storeThe name of the certificate store for the client certificate.
ssl_cert_store_passwordIf 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.
ssl_cert_store_typeThe type of certificate store for this certificate.
ssl_cert_subjectThe subject of the certificate used for client authentication.
ssl_server_cert_encodedThe certificate (PEM/base64 encoded).
sync_transfer_countThe number of records in the SyncTransfer arrays.
sync_transfer_aggregateWrapper for a bank transfer being initiated, modified or synchronized.
sync_transfer_amountAmount of the bank transfer being initiated, modified or synchronized.
sync_transfer_date_dueDate the bank transfer (being initiated, modified or synchronized) is scheduled to be sent.
sync_transfer_date_postedPosted date of the bank transfer being initiated, modified or synchronized.
sync_transfer_date_processedTransfer processing date.
sync_transfer_date_projectedProjected date of the transfer.
sync_transfer_from_account_idAccount number where the transfer (being initiated, modified or synchronized) is originating from.
sync_transfer_idServer-assigned id of the bank transfer being initiated, modified or synchronized.
sync_transfer_statusProcessing status code of the bank transfer being initiated, modified, canceled or synchronized.
sync_transfer_to_account_idAccount number where the bank transfer ((being initiated, modified or synchronized) is made to.
sync_transfer_tx_typeTransaction type of the bank transfer being synchronized.
timeoutA timeout for the class.
transfer_amountAmount of the bank transfer being initiated, modified or synchronized.
transfer_currency_codeDefault currency code for this transaction.
transfer_date_dueDate the bank transfer (being initiated, modified or synchronized) is scheduled to be sent.
transfer_date_postedPosted date of the bank transfer being initiated, modified or synchronized.
transfer_date_processedTransfer processing date.
transfer_from_account_idAccount number where the transfer (being initiated, modified or synchronized) is originating from.
transfer_from_account_keyChecksum for the bank where money has to be withdrawn (international banks only).
transfer_from_account_typeType of account where the transfer is originating from.
transfer_from_bank_idNumber that identifies the bank where the transfer is originating from.
transfer_from_branch_idIdentifier for the bank where the transfer is originating from (international banks only).
transfer_idServer-assigned id of the bank transfer being initiated, modified or synchronized.
transfer_statusProcessing status code of the bank transfer being initiated, modified, canceled or synchronized.
transfer_to_account_idAccount number where the bank transfer ((being initiated, modified or synchronized) is made to.
transfer_to_account_keyChecksum for the bank where money has to be deposited to (international banks only).
transfer_to_account_typeType of account where money has to be deposited to.
transfer_to_bank_idNumber that identifies the bank where money has to be deposited to.
transfer_to_branch_idIdentifier 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.

cancel_transferCancels a scheduled transfer.
configSets or retrieves a configuration setting.
modify_transferModifies a scheduled transfer.
resetReset the internal state of the class and all properties to their default values.
synchronize_transfersSynchronizes transfers on the client side with transfers on record on the server side.
transfer_fundsTransfers 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.

on_connection_statusFired to indicate changes in connection state.
on_errorInformation about errors during data delivery.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_sync_transfersFired 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.

BatchTransferTypeTransfer request type when an intrabank or interbank transfer is part of a multiple request (batch).
TransferTypeTransfer request type for a specified transaction.
AuthTokenAuthentication token required for this signon session only.
ClientUIdUnique 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.
CurrencyFormatThe format to be used for returning currency values.
DateFormatThe format to be used for input and output dates.
GetResponseVarParses additional information out of the response.
NewPasswordNew password for the current OFX user.
OFXDateFormatThe date format as required by OFX FI server.
OFXLogLog file for the OFX transaction.
ServerMessageServer message if a warning or other information returned.
UserCred1AAdditional user credential required by server.
UserCred2AAdditional user credential required by server.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
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.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
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.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class 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.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
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 port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
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).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
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.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 Python Edition - Version 20.0 [Build 7941]