BankStatement Class

Properties Methods Events Config Settings Errors

The BankStatement class is a single class that supports the SignOn and Bank Statement Download functions of Open Financial eXchange, as described by the OFX Specification version 1.0.2.

Syntax

class inebank.BankStatement

Remarks

The BankStatement class adds bank statement download functionality to your desktop application, or allows your web application to fetch a user's bank statement without having to redirect to another website. All downloads are done using a secure HTTPS Post to send account sign-on information to a financial institution. The class receives the secure response and parses the response into its properties.

To use the BankStatement class first identify the financial institution by setting the fi_id, fi_organization and fi_url, properties. Next identify the OFX user and application by setting the ofx_user, ofx_password, ofx_app_id and ofx_app_version properties. Next set the bank_id, account_id and account_type properties to the appropriate values to identify the account for which you wish to download a statement. You may also set start_date and end_date properties to constrain the transaction list.

Once you have finished setting the properties that describe the statement you wish to download, use the get_statement method to build and transmit the request automatically. When the response returns, the transaction properties will be populated automatically, as well as the start_date, end_date, available_balance, ledger_balance and any other data the bank statement includes.

The transaction properties (tx_amount, tx_check_number tx_date_posted, tx_fitid, tx_memo, tx_payee_name, and tx_type) may be imagined as arrays, so that the getter function for each property takes as its argument the index of a transaction in the list.

For example, tx_amount(0) gives the amount of the first transaction for the last statement downloaded.

Note: the financial institution usually returns amounts as a string that includes the sign (+/-) of the amount. However, the server may sometimes leave out a particular field if it is not required by the OFX specification. To avoid confusion that can be caused by returning integers, the class will return all amount types as a string, with the empty string ("") for fields not returned by the server.

Where there is a value returned by the server, the class will attempt to convert the string into a format that can be easily parsed into an integer value. This behavior can be controlled by the CurrencyFormat config setting.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


account_id	The account number used for the next statement download.
account_type	Indicates the type of bank account.
available_balance	Amount of the available balance.
available_balance_date	Date of the available balance.
bank_id	Number that identifies the bank.
closing_detail_count	The number of records in the ClosingDetail arrays.
closing_detail_aggregate	Aggregates are pieces of XML taken from the financial institution's original response.
closing_detail_balance_closing	Closing statement balance.
closing_detail_balance_opening	Opening statement balance.
closing_detail_date_close	Closing statement date.
closing_detail_date_end	End date of transaction data for this statement.
closing_detail_date_open	Opening statement date.
closing_detail_date_start	Start date of transaction data for this statement.
closing_detail_fitid	Unique identifier assigned by financial institution to identify this particular statement closing information.
closing_detail_image_ref	Server specified unique identifier for the statement closing image.
closing_detail_image_ref_type	Type of retrieval method for actual statement closing image.
closing_detail_total_credit	Total credit posted on the account for this statement (period indicated by DateStart and DateEnd ).
closing_detail_total_debit	Total of debit posted on the account for this statement (period indicated by DateStart and DateEnd ).
closing_detail_total_fees	Total fees.
closing_detail_total_interest	Total interest.
currency_code	Default currency code for this statement.
end_date	End date of statement requested.
fi_id	Financial institution identifier.
fi_organization	Financial institution organization name.
firewall_auto_detect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type	This property determines the type of firewall to connect through.
firewall_host	This property contains the name or IP address of firewall (optional).
firewall_password	This property contains a password if authentication is to be used when connecting through the firewall.
firewall_port	This property contains the transmission control protocol (TCP) port for the firewall Host .
firewall_user	This property contains a user name if authentication is to be used connecting through a firewall.
fi_url	Financial institution URL.
image_file_name	Filename and location to save the image content of a transaction or statement.
include_images	Whether the server has to return data for bank transactions or closing statements images.
ledger_balance	Amount of the ledger balance.
ledger_balance_date	Date of the ledger balance.
ofx_access_key	Access key value received after a MFA authentication in a previous signon.
ofx_app_id	OFX application identifier.
ofx_app_version	OFX application version.
ofx_password	User's password.
ofx_request	The current OFX request aggregate.
ofx_response	The current OFX response aggregate.
ofx_user	User's id.
ofx_version	OFX API version.
ssl_accept_server_cert_encoded	This is the certificate (PEM/base64 encoded).
ssl_cert_encoded	This is the certificate (PEM/base64 encoded).
ssl_cert_store	This is the name of the certificate store for the client certificate.
ssl_cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_type	This is the type of certificate store for this certificate.
ssl_cert_subject	This is the subject of the certificate used for client authentication.
ssl_provider	This specifies the SSL/TLS implementation to use.
ssl_server_cert_encoded	This is the certificate (PEM/base64 encoded).
start_date	Start date of requested transaction list.
timeout	A timeout for the class.
tx_count	The number of records in the Tx arrays.
tx_aggregate	Wrapper for a bank transaction.
tx_amount	This is the amount of money exchanged during a given transaction.
tx_check_number	The check number as found on the original check.
tx_date	This is the date the transaction was made by the account holder as recorded by the financial institution, stored as a string.
tx_date_posted	This is the date the transaction was posted to the financial institution, stored as a string.
tx_fitid	Transaction Id assigned by the financial institution.
tx_image_ref	Server specified unique identifier for the transaction image.
tx_image_ref_type	Type of retrieval method for actual transaction image.
tx_memo	The memo property stores a notice from the payee to the customer as a string.
tx_payee_name	If This property has a value, the NAME element replaces the entire PAYEE aggregate in the request XML.
tx_type	This is the type of transaction that was made on the account.
tx_type_description	A description of the transaction type.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


config	Sets or retrieves a configuration setting.
get_closing_info	Download a statement closing information for a bank account.
get_image	Request and retrieve a check or statement image (if available).
get_statement	Download a bank statement.
read_ofx_data_file	Reads an OFX response from a file.
reset	Reset the internal state of the class and all properties to their default values.
write_ofx_data_file	Writes the OFX response sent by the server to a file.

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_status	This event is fired to indicate changes in the connection state.
on_error	Information about errors during data delivery.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


BankIdPresent	Determines whether Bank Id should be present in the request.
Overwrite	Determines whether image files will be overwritten.
StatementCount	The statement count in a multi-statement OFX response.
StatementIndex	The statement index in a multi-statement OFX response.
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.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
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.
SSLCheckOCSP	Whether to use OCSP to check the status of 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.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
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.
MaskSensitive	Whether sensitive data is masked in log messages.
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.

account_id Property

The account number used for the next statement download.

Syntax

def get_account_id() -> str: ...
def set_account_id(value: str) -> None: ...

account_id = property(get_account_id, set_account_id)

Default Value

Remarks

This is the account number for which the user wishes to download a statement. For checking and savings accounts, this is the number that appears at the bottom of the user's checks or deposit slips, to the right of the routing number.

account_type Property

Indicates the type of bank account.

Syntax

def get_account_type() -> int: ...
def set_account_type(value: int) -> None: ...

account_type = property(get_account_type, set_account_type)

Default Value

Remarks

This property uses the following four values:

atChecking (0)
atSavings (1)
atMoneyMarket (2)
atLineOfCredit (3)

available_balance Property

Amount of the available balance.

Syntax

def get_available_balance() -> str: ...

available_balance = property(get_available_balance, None)

Default Value

Remarks

This is the amount of money available from a given account.

For bank accounts, ledger_balance represents the last balance recorded in official documents. available_balance represents the value in the ledger balance once all temporary authorizations, such as ATM withdrawals, have posted to the ledger. Any positive value means that funds are available while negative values mean that the account is overdrawn.

This property is read-only.

available_balance_date Property

Date of the available balance.

Syntax

def get_available_balance_date() -> str: ...

available_balance_date = property(get_available_balance_date, None)

Default Value

Remarks

This is the date as of which the account balance is valid.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

This property is read-only.

bank_id Property

Number that identifies the bank.

Syntax

def get_bank_id() -> str: ...
def set_bank_id(value: str) -> None: ...

bank_id = property(get_bank_id, set_bank_id)

Default Value

Remarks

The meaning of this string differs with the location of the bank.


BEL	Bank code
CAN	Routing and transit number
CHE	Clearing number
DEU	Bankleitzahl
ESP	Entidad
FRA	Banque
GBR	Sort code
ITA	ABI
NLD	Not used; contents of this field are ignored
USA	Routing and transit number.

closing_detail_count Property

The number of records in the ClosingDetail arrays.

Syntax

def get_closing_detail_count() -> int: ...

closing_detail_count = property(get_closing_detail_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

closing_detail_aggregate
closing_detail_balance_closing
closing_detail_balance_opening
closing_detail_date_close
closing_detail_date_end
closing_detail_date_open
closing_detail_date_start
closing_detail_fitid
closing_detail_image_ref
closing_detail_image_ref_type
closing_detail_total_credit
closing_detail_total_debit
closing_detail_total_fees
closing_detail_total_interest

The array indices start at 0 and end at closing_detail_count - 1.

This property is read-only.

closing_detail_aggregate Property

Aggregates are pieces of XML taken from the financial institution's original response.

Syntax

def get_closing_detail_aggregate(closing_detail_index: int) -> str: ...

Default Value

Remarks

Aggregates are pieces of XML taken from the financial institution's original response. They contain elements that correspond to many of the class's properties. However, some of these elements, and/or their potential values, may not be supported by the class. Any user who wishes to use unsupported fields may use this aggregate property to parse out the desired data either via our OFXAggregate class or any other means.

Note: The original data from the server is returned as SGML or XML (depending on the value of ofx_version that FI supports. If the original data is returned in SGML format, the class internally manipulates these responses into the equivalent XML format by inserting close element tags (e.g., "</ACCTID>") into the data as it comes from the server.

This aggregate describes a statement closing information. It contains data (elements and values) associated with the following properties:

closing_detail_fitid
closing_detail_date_start
closing_detail_date_end
closing_detail_date_open
closing_detail_date_close
closing_detail_date_due (applicable to credit card accounts only)
closing_detail_balance_opening
closing_detail_balance_closing
closing_detail_total_interest (not applicable to credit card accounts)
closing_detail_total_fees
closing_detail_total_credit
closing_detail_total_debit
closing_detail_credit_limit (applicable to credit card accounts only)
closing_detail_image_ref
closing_detail_image_ref_type

For each aggregate returned, clients can retrieve corresponding transactions by using closing_detail_date_start and closing_detail_date_end in a statement download request (when calling GetStatement method).

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_balance_closing Property

Closing statement balance.

Syntax

def get_closing_detail_balance_closing(closing_detail_index: int) -> str: ...

Default Value

Remarks

Closing statement balance.

This is not applicable for loan accounts.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_balance_opening Property

Opening statement balance.

Syntax

def get_closing_detail_balance_opening(closing_detail_index: int) -> str: ...

Default Value

Remarks

Opening statement balance.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_date_close Property

Closing statement date.

Syntax

def get_closing_detail_date_close(closing_detail_index: int) -> str: ...

Default Value

Remarks

Closing statement date.

This format specifies also how the returned dates are going to get parsed.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_date_end Property

End date of transaction data for this statement.

Syntax

def get_closing_detail_date_end(closing_detail_index: int) -> str: ...

Default Value

Remarks

End date of transaction data for this statement. A client should be able to use this date when requesting individual transactions that match this statement.

This format specifies also how the returned dates are going to get parsed.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_date_open Property

Opening statement date.

Syntax

def get_closing_detail_date_open(closing_detail_index: int) -> str: ...

Default Value

Remarks

Opening statement date.

This format specifies also how the returned dates are going to get parsed.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_date_start Property

Start date of transaction data for this statement.

Syntax

def get_closing_detail_date_start(closing_detail_index: int) -> str: ...

Default Value

Remarks

Start date of transaction data for this statement. A client should be able to use this date when requesting individual transactions that match this statement.

This format specifies also how the returned dates are going to get parsed.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_fitid Property

Unique identifier assigned by financial institution to identify this particular statement closing information.

Syntax

def get_closing_detail_fitid(closing_detail_index: int) -> str: ...

Default Value

Remarks

Unique identifier assigned by financial institution to identify this particular statement closing information. This id provides a way for the client to distinguish one closing statement from another.

This is always returned in the server response for each statement.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_image_ref Property

Server specified unique identifier for the statement closing image.

Syntax

def get_closing_detail_image_ref(closing_detail_index: int) -> str: ...

Default Value

Remarks

Server specified unique identifier for the statement closing image.

This can be either image identifier (to be used during the request to retrieve the actual image when the get_image method is called) or URL, depending on the value of closing_detail_image_ref_type.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_image_ref_type Property

Type of retrieval method for actual statement closing image.

Syntax

def get_closing_detail_image_ref_type(closing_detail_index: int) -> str: ...

Default Value

Remarks

Type of retrieval method for actual statement closing image.

If closing_detail_image_ref is returned in the response, this can be either image identifier (to be used during the request for the image when the get_image method is called) or a URL.

Possible values for closing_detail_image_ref_type are:


Value	Meaning
OPAQUE	Requires the client to send a separate OFX request to access the image. The image can be retrieved by calling the get_image method where closing_detail_image_ref will be the parameter value for this method.
URL	The image is accessed directly via the URL provided. The client will not provide authentication and will simply follow the URL provided.
FORMURL	The image is accessed directly via an encoded URL. The client will send authentication to the server.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_total_credit Property

Total credit posted on the account for this statement (period indicated by DateStart and DateEnd ).

Syntax

def get_closing_detail_total_credit(closing_detail_index: int) -> str: ...

Default Value

Remarks

Total credit posted on the account for this statement (period indicated by closing_detail_date_start and closing_detail_date_end).

In a bank statement (checking, savings or money market account), this represents total of deposits and credits, including interest. In a credit card statement, this represents total of payments and credits.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_total_debit Property

Total of debit posted on the account for this statement (period indicated by DateStart and DateEnd ).

Syntax

def get_closing_detail_total_debit(closing_detail_index: int) -> str: ...

Default Value

Remarks

Total of debit posted on the account for this statement (period indicated by closing_detail_date_start and closing_detail_date_end).

In a bank statement (checking, savings or money market account), this represents total of checks and debits, including fees. In a credit card statement, this represents total of payments and credits.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_total_fees Property

Total fees.

Syntax

def get_closing_detail_total_fees(closing_detail_index: int) -> str: ...

Default Value

Remarks

Total fees.

In a bank statement (checking, savings or money market account), this represents total of all fees. While in a credit card statement, this represents finance charge.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

closing_detail_total_interest Property

Total interest.

Syntax

def get_closing_detail_total_interest(closing_detail_index: int) -> str: ...

Default Value

Remarks

Total interest.

For bank or investment accounts, this indicates total interest posted on the account for this statement (period indicated by closing_detail_date_start and closing_detail_date_end).

For loan accounts, this indicates total interest paid year to date.

This is not applicable for credit card accounts.

The closing_detail_index parameter specifies the index of the item in the array. The size of the array is controlled by the closing_detail_count property.

This property is read-only.

currency_code Property

Default currency code for this statement.

Syntax

def get_currency_code() -> str: ...

currency_code = property(get_currency_code, None)

Default Value

Remarks

Indicates how to interpret the monetary amounts in the current statement. This is a 3-character ISO-4217 currency code, such as USD and EUR.

This property is read-only.

end_date Property

End date of statement requested.

Syntax

def get_end_date() -> str: ...
def set_end_date(value: str) -> None: ...

end_date = property(get_end_date, set_end_date)

Default Value

Remarks

This is a string representing the date at which to stop listing transactions on the statement. Use this property and start_date to constrain the list of transactions retrieved when calling get_statement.

This format specifies also how the returned dates are going to get parsed.

fi_id Property

Financial institution identifier.

Syntax

def get_fi_id() -> str: ...
def set_fi_id(value: str) -> None: ...

fi_id = property(get_fi_id, set_fi_id)

Default Value

Remarks

fi_id holds the identifier of the OFX Financial Institution and is used during signon. This value is unique for each organization name.

fi_organization Property

Financial institution organization name.

Syntax

def get_fi_organization() -> str: ...
def set_fi_organization(value: str) -> None: ...

fi_organization = property(get_fi_organization, set_fi_organization)

Default Value

Remarks

This is the name of the OFX Financial Institution and is used during signon. Each organization has a unique fi_id that must also be used at signon.

firewall_auto_detect Property

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. firewall_port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. firewall_port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. firewall_port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. firewall_port is set to 1080.

firewall_host Property

This property contains the name or IP address of firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

Remarks

This property contains the transmission control protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

fi_url Property

Financial institution URL.

Syntax

def get_fi_url() -> str: ...
def set_fi_url(value: str) -> None: ...

fi_url = property(get_fi_url, set_fi_url)

Default Value

Remarks

This is the URL of the OFX Financial Institution to which the class will signon and fetch data.

image_file_name Property

Filename and location to save the image content of a transaction or statement.

Syntax

def get_image_file_name() -> str: ...
def set_image_file_name(value: str) -> None: ...

image_file_name = property(get_image_file_name, set_image_file_name)

Default Value

Remarks

When calling the get_image method, the image content is returned by that method. If you want the image content to be written to disk, you can set the image_file_name to a desired file name without specifying the type. The file type will be set automatically depending on the image type supported by the server. Possible image types are: jpeg, tiff, png, pdf.

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

Note: Image download is available only for OFX version 2.1.1. When this method is called, the ofx_version is automatically set to '211'.

include_images Property

Whether the server has to return data for bank transactions or closing statements images.

Syntax

def get_include_images() -> bool: ...
def set_include_images(value: bool) -> None: ...

include_images = property(get_include_images, set_include_images)

Default Value

FALSE

Remarks

If False (default value), the server will not return any image references in the response.

Otherwise, if the FI supports image download service :

when the get_statement method is called, the server will return the image references for each transaction (e.g., check image).
when the get_closing_info method is called, the server will return a reference to the statement closing information image.

These references can then be used as parameters when the get_image method is called.

This is optional and supported in OFX 2.1.1 version only (i.e., if this is requested, the ofx_version should be set to '211').

Note: Clients may request images in statement download and/or closing requests in various message sets. But not all FIs support image download. Prior to requesting these images, clients must verify that support exists on the server for image download. This is indicated by the presence of the IMAGEMSGSET aggregate in the profile response, as well as the IMAGEPROF aggregate in the profile response for the specific message set in question.

For instance, if a client wishes to request transaction images in the banking statement download request, the client must verify the presence of IMAGEMSGSET in the profile as well as transaction image support in the IMAGEPROF aggregate in the BANKMSGSET in the profile. Image download requests are allowed only in OFX 2.1.1 in the Banking, Credit Card, Loan and Investments message sets.

To verify whether your FI supports this service, you should check its profile (by calling the GetProfile method in FIProfile class) and check the values of FIMessageSetTxImage and FIMessageSetClosingInfoImage for each message set (bank, credit card, loan and investment).

ledger_balance Property

Amount of the ledger balance.

Syntax

def get_ledger_balance() -> str: ...

ledger_balance = property(get_ledger_balance, None)

Default Value

Remarks

This value reflects the account balance as posted in the financial institution's records.

This property is read-only.

ledger_balance_date Property

Date of the ledger balance.

Syntax

def get_ledger_balance_date() -> str: ...

ledger_balance_date = property(get_ledger_balance_date, None)

Default Value

Remarks

This is the date, as of which, the ledger balance is valid.

This format specifies also how the returned dates are going to get parsed.

This property is read-only.

ofx_access_key Property

Access key value received after a MFA authentication in a previous signon.

Syntax

def get_ofx_access_key() -> str: ...
def set_ofx_access_key(value: str) -> None: ...

ofx_access_key = property(get_ofx_access_key, set_ofx_access_key)

Default Value

Remarks

This might be returned in the server response after a MFA authentication (i.e. MFA challenge question/answer pairs were validated by the server when the send_challenge_answers method in FIProfile class was called).

To prevent servers from needing to authenticate the user in each OFX request, the server may respond to a correct set of challenge answers with a ofx_access_key on the signon response (when the send_challenge_answers method in FIProfile class was called).

The server determines the contents of this optional element. On each subsequent signon request, the client will send the last value of the ofx_access_key it has received, even after the end of the current session. The server has the option to respond to any subsequent request with a 3000 error code, requiring the client to send the MFA challenge questions request again (by calling the request_challenge_questions method in FIProfile class). This allows the server to determine the lifetime of the ofx_access_key.

ofx_app_id Property

OFX application identifier.

Syntax

def get_ofx_app_id() -> str: ...
def set_ofx_app_id(value: str) -> None: ...

ofx_app_id = property(get_ofx_app_id, set_ofx_app_id)

Default Value

Remarks

This is the unique identifier of the user's OFX application.

ofx_app_version Property

OFX application version.

Syntax

def get_ofx_app_version() -> str: ...
def set_ofx_app_version(value: str) -> None: ...

ofx_app_version = property(get_ofx_app_version, set_ofx_app_version)

Default Value

Remarks

This is the version of the user's OFX application.

ofx_password Property

User's password.

Syntax

def get_ofx_password() -> str: ...
def set_ofx_password(value: str) -> None: ...

ofx_password = property(get_ofx_password, set_ofx_password)

Default Value

Remarks

This is the password used when signing on to the OFX Financial Institution's service.

ofx_request Property

The current OFX request aggregate.

Syntax

def get_ofx_request() -> str: ...

ofx_request = property(get_ofx_request, None)

Default Value

Remarks

Polling ofx_request will cause the class to generate and return an OFX request aggregate.

This property is read-only.

ofx_response Property

The current OFX response aggregate.

Syntax

def get_ofx_response() -> str: ...
def set_ofx_response(value: str) -> None: ...

ofx_response = property(get_ofx_response, set_ofx_response)

Default Value

Remarks

This can be used especially for debugging purposes. This can also be used to parse an OFX Response. To do so, you can set the OFX Response data (in string format) to ofx_response. Once set, the supplied OFX data will be parsed and will populate the same read-only properties that read_ofx_data_file does.

ofx_user Property

User's id.

Syntax

def get_ofx_user() -> str: ...
def set_ofx_user(value: str) -> None: ...

ofx_user = property(get_ofx_user, set_ofx_user)

Default Value

Remarks

This is the UserID used when signing on to the OFX Financial Institution's service.

ofx_version Property

OFX API version.

Syntax

def get_ofx_version() -> str: ...
def set_ofx_version(value: str) -> None: ...

ofx_version = property(get_ofx_version, set_ofx_version)

Default Value

"102"

Remarks

This is the OFX API version used in all requests sent to your FI server (such as 1.0.2, 2.0.1, 2.1.1, etc.). Valid values: 102, 103, 200, 201, 203, 210, 211. Note that not all OFX Versions are supported by FIs.

Note: If the ofx_version is set to 1x, the request and the response are going to be in SGML format. If set to 2x, the request will be in XML format (the response format depends on the FI's server capabilities). Note that if the OFX FI server does not support version 2x, the server will return an error (such as 'Bad Request').

Certain services are available only for a specific OFX version. For example, image download, is available only in OFX version 2.1.1.

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_cert_store Property

This is the name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to `cstPKCS11`, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

ssl_cert_subject Property

This is the subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

ssl_provider Property

This specifies the SSL/TLS implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

ssl_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

start_date Property

Start date of requested transaction list.

Syntax

def get_start_date() -> str: ...
def set_start_date(value: str) -> None: ...

start_date = property(get_start_date, set_start_date)

Default Value

Remarks

This is a string representing the date at which to start listing transactions on the statement. Use this property and end_date to constrain the list of transactions retrieved when calling get_statement. When provided in the request, start_date value will be echoed in the server's response.

This format specifies also how the returned dates are going to get parsed.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

tx_count Property

The number of records in the Tx arrays.

Syntax

def get_tx_count() -> int: ...

tx_count = property(get_tx_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

tx_aggregate
tx_amount
tx_check_number
tx_date
tx_date_posted
tx_fitid
tx_image_ref
tx_image_ref_type
tx_memo
tx_payee_name
tx_type
tx_type_description

The array indices start at 0 and end at tx_count - 1.

This property is read-only.

tx_aggregate Property

Wrapper for a bank transaction.

Syntax

def get_tx_aggregate(tx_index: int) -> str: ...

Default Value

Remarks

Wrapper for a bank transaction.

Each bank transaction aggregate contains data (elements and values) associated with the following properties:

tx_amount
tx_check_number
tx_date_posted
tx_fitid
tx_memo
tx_payee_name
tx_type
tx_image_ref
tx_image_ref_type

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_amount Property

This is the amount of money exchanged during a given transaction.

Syntax

def get_tx_amount(tx_index: int) -> str: ...

Default Value

Remarks

This is the amount of money exchanged during a given transaction.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_check_number Property

The check number as found on the original check.

Syntax

def get_tx_check_number(tx_index: int) -> str: ...

Default Value

Remarks

The check number as found on the original check. Some stores that use electronic checks may put a randomly generated value in This property.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_date Property

This is the date the transaction was made by the account holder as recorded by the financial institution, stored as a string.

Syntax

def get_tx_date(tx_index: int) -> str: ...

Default Value

Remarks

This is the date the transaction was made by the account holder as recorded by the financial institution, stored as a string.

This format specifies also how the returned dates are going to get parsed.

Note: this property is optional. This is not applicable to loan accounts. If the server's response does not contain this information, querying this property will return an empty string.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_date_posted Property

This is the date the transaction was posted to the financial institution, stored as a string.

Syntax

def get_tx_date_posted(tx_index: int) -> str: ...

Default Value

Remarks

This is the date the transaction was posted to the financial institution, stored as a string.

This format specifies also how the returned dates are going to get parsed.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_fitid Property

Transaction Id assigned by the financial institution.

Syntax

def get_tx_fitid(tx_index: int) -> str: ...

Default Value

Remarks

Transaction Id assigned by the financial institution.

This is a unique id number that the financial institution uses to identify a particular transaction. Its primary purpose is to allow a client to detect duplicate responses, whether the server previously downloaded the transaction.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_image_ref Property

Server specified unique identifier for the transaction image.

Syntax

def get_tx_image_ref(tx_index: int) -> str: ...

Default Value

Remarks

Server specified unique identifier for the transaction image.

This can be either image identifier (to be used during the request to retrieve the actual image when the get_image method is called) or URL, depending on the value of tx_image_ref_type.

Note: This is not applicable for credit card accounts.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_image_ref_type Property

Type of retrieval method for actual transaction image.

Syntax

def get_tx_image_ref_type(tx_index: int) -> str: ...

Default Value

Remarks

Type of retrieval method for actual transaction image.

If tx_image_ref is returned in the response, this can be either image identifier (to be used during the request for the image when the get_image method is called) or a URL.

Possible values for tx_image_ref_type are:


Value	Meaning
OPAQUE	Requires the client to send a separate OFX request to access the image. The image can be retrieved by calling the get_image method where tx_image_ref will be the parameter value for this method.
URL	The image is accessed directly via the URL provided. The client will not provide authentication and will simply follow the URL provided.
FORMURL	The image is accessed directly via an encoded URL. The client will send authentication to the server.

Note: This is not applicable for credit card accounts.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_memo Property

The memo property stores a notice from the payee to the customer as a string.

Syntax

def get_tx_memo(tx_index: int) -> str: ...

Default Value

Remarks

The memo property stores a notice from the payee to the customer as a string.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_payee_name Property

If This property has a value, the NAME element replaces the entire PAYEE aggregate in the request XML.

Syntax

def get_tx_payee_name(tx_index: int) -> str: ...

Default Value

Remarks

If This property has a value, the NAME element replaces the entire PAYEE aggregate in the request XML.

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_type Property

This is the type of transaction that was made on the account.

Syntax

def get_tx_type(tx_index: int) -> int: ...

Default Value

Remarks

This is the type of transaction that was made on the account. The effect on the account balance depends upon the sign of the amount, not upon the value of this transaction.

For example, if the amount is negative and the type is a credit, a negative credit is applied to the account. If the amount is negative and the type is debit, the amount is still debited from the account. A positive amount indicates the addition of money to the account, regardless of the type.

The types and their meanings are as follows:


ttCredit (0)	Generic credit
ttDebit (1)	Generic debit
ttInterest (2)	Interest earned or paid (note: depends on signage of amount)
ttDividend (3)	Dividend
ttFIFee (4)	FI fee
ttServiceCharge (5)	Service charge
ttDeposit (6)	Deposit
ttATM (7)	ATM debit or credit (note: depends on signage of amount)
ttPointOfSale (8)	Point of sale debit or credit (note: depends on signage of amount)
ttTransfer (9)	Transfer
ttCheck (10)	Check
ttPayment (11)	Payment
ttCash (12)	Cash withdrawal
ttDirectDeposit (13)	Direct deposit
ttDirectDebit (14)	Merchant initiated debit
ttRepeatPayment (15)	Repeating payment/standing order
ttLateFee (16)	Late Fee (note: applicable to loan accounts only)
ttAdvance (17)	Cash Advance which adds to Principal Balance (note: applicable to loan accounts only)
ttBalloon (18)	Payment of Balloon Amount (note: applicable to loan accounts only)
ttOther (255)	Other (note: see tx_memo for a possible transaction description)

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

tx_type_description Property

A description of the transaction type.

Syntax

def get_tx_type_description(tx_index: int) -> str: ...

Default Value

"Credit"

Remarks

A description of the transaction type. This is a string representation of the value returned by the tx_type property.

The values translate as follows:

The types and their meanings are as follows:


ttCredit (0)	Credit
ttDebit (1)	Debit
ttInterest (2)	Interest
ttDivident (3)	Dividend
ttFIFee (4)	FI Fee
ttServiceCharge (5)	Service Charge
ttDeposit (6)	Deposit
ttATM (7)	ATM
ttPointOfSale (8)	Point of Sale
ttTransfer (9)	Transfer
ttCheck (10)	Check
ttPayment (11)	Payment
ttCash (12)	Cash Withdrawal
ttDirectDeposit (13)	Direct Deposit
ttDirectDebit (14)	Direct Debit
ttRepeatPayment (15)	Repeat Payment
ttLateFee (16)	Late Fee (note: applicable to loan accounts only)
ttAdvance (17)	Cash Advance which adds to Principal Balance (note: applicable to loan accounts only)
ttBalloon (18)	Payment of Balloon Amount (note: applicable to loan accounts only)
ttOther (255)	Other

The tx_index parameter specifies the index of the item in the array. The size of the array is controlled by the tx_count property.

This property is read-only.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

get_closing_info Method

Download a statement closing information for a bank account.

Syntax

def get_closing_info() -> None: ...

Remarks

This function generates the Signon and Bank Statement Closing Information request page, submits it to the financial institution via secure HTTPS Post, receives and parses the closing statement information (that typically appears as part of a paper statement).

This information includes opening and closing dates and balances for a statement period, as well as a detailed breakdown of debits, credits, fees, and interest that are usually part of a paper statement. In addition to this information, you will also receive a date range for transactions that correspond to the closing statement. You can use this date range to retrieve transactions through statement download request (by calling the get_statement method).

The following properties should be set when this method is called:

fi_id (required)
fi_organization (required)
fi_url (required)
ofx_app_id (required)
ofx_app_version (required)
ofx_version (required if 2.x OFX version is the one supported by your FI)
ofx_user (required)
ofx_password (required)
bank_id (required)
account_id (required)
account_type (required)

The client can also specify a date range (by setting the start_date and end_date properties) to limit the number of closing information aggregates that the server returns. If the client does not specify a date range, the server returns as many closing information aggregates as it can (which will be stored in closing_details).

If you want the server to return an image reference for each statement closing information, and if the server supports this service, you will have to set the include_images to True.

The following read-only properties are populated as a result of parsing the statement response:

currency_code
closing_details

get_image Method

Request and retrieve a check or statement image (if available).

Syntax

def get_image(image_ref: str, image_ref_type: str) -> bytes: ...

Remarks

This function generates the Signon and Download Image request page, submits it to the financial institution via secure HTTPS Post.

The requested image of a check or statement closing information is identified by ImageRef parameter. The type of this image reference should be specified by ImageRefType parameter.

Possible values and their meanings for the ImageRefType parameter are:


OPAQUE (default value)	The class will send an OFX request to access this image. This request will be in the form of a normal OFX request (complete with Signon) and the login credentials are required to authenticate the client. However, whereas the request file contains typical OFX syntax, the successful response returned is in the form of raw bytes. If a failure condition occurs, the class will return an error with a specific message.
URL	The URL identifies a service on an FI server that can accept an image request and produce a response. The class issues an HTTP request (over SSL) to the URL specified by the ImageRef parameter. The client will then authenticate. Once this authentication takes place, the image can be displayed
FORMURL	The class issues an HTTP request (over SSL), with encoded data specified in the URL retrieved from the ImageRef parameter. The image can then be displayed.

If you want the server to return image references for each transaction or statement closing information, and if the server supports image download service via OFX, you will have to set the include_images to True when either get_statement or get_closing_info method is called.

If available, then you can access that particular image by calling the GetImage method, where ImageRef parameter value is set to the image reference stored in tx_image_ref (or closing_detail_image_ref) and the ImageRefType parameter is set to the respective tx_image_ref_type (or closing_detail_image_ref_type) corresponding to the requested check or statement.

Upon successful response, the image content will be returned by this method. If you want the image to be saved to a file, you can set the image_file_name to a desired name without specifying the type. The file type will be set automatically depending on the image type supported by the server. Possible image types are: jpeg, tiff, png, pdf.

Otherwise, the class will throw an error.

Image download is available only for OFX version 2.1.1. When this method is called, the ofx_version is automatically set to '211'.

get_statement Method

Download a bank statement.

Syntax

def get_statement() -> None: ...

Remarks

This function generates the Signon and Bank Statement request page, submits it to the financial institution via secure HTTPS Post, receives and parses the bank statement. Individual transactions are downloaded with the statement.

The following properties should be set when this method is called:

fi_id (required)
fi_organization (required)
fi_url (required)
ofx_app_id (required)
ofx_app_version (required)
ofx_version (required if 2.x OFX version is the one supported by your FI)
ofx_user (required)
ofx_password (required)
bank_id (required)
account_id (required)
account_type (required)

You may constrain this transaction list by setting the start_date and end_date properties. The server will use default values if no dates are supplied.

If you want the server to return image references for each transaction, and if the server supports this service, you will have to set the include_images to True.

The following read-only properties are populated as a result of parsing the statement response:

available_balance
available_balance_date
ledger_balance
ledger_balance_date
currency_code
transactions

read_ofx_data_file Method

Reads an OFX response from a file.

Syntax

def read_ofx_data_file(file_name: str) -> None: ...

Remarks

This method reads a previously recorded OFX response from a file, including HTTP and OFX headers.

The following read-only properties are populated as a result of parsing the data file:

available_balance
available_balance_date
ledger_balance
ledger_balance_date
currency_code
transactions
closing_details

reset Method

Reset the internal state of the class and all properties to their default values.

Syntax

def reset() -> None: ...

Remarks

The Reset method does not have any parameters and does not return any value.

write_ofx_data_file Method

Writes the OFX response sent by the server to a file.

Syntax

def write_ofx_data_file(file_name: str) -> None: ...

Remarks

This method records the entire OFX response, including HTTP and OFX headers to a file. This file can later be read and parsed by the read_ofx_data_file method as though it were a live response.

on_connection_status Event

This event is fired to indicate changes in the connection state.

Syntax

class BankStatementConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class BankStatement:
@property
def on_connection_status() -> Callable[[BankStatementConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[BankStatementConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:


	Firewall connection complete.
	Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

on_error Event

Information about errors during data delivery.

Syntax

class BankStatementErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class BankStatement:
@property
def on_error() -> Callable[[BankStatementErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[BankStatementErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class BankStatementSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class BankStatement:
@property
def on_ssl_server_authentication() -> Callable[[BankStatementSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[BankStatementSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class BankStatementSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class BankStatement:
@property
def on_ssl_status() -> Callable[[BankStatementSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[BankStatementSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

BankStatement Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

BankStatement Config Settings

BankIdPresent: Determines whether Bank Id should be present in the request.

If True (default value) the bank_id is required to be provided in the request. Most of FI OFX servers require the bank_id to be present in a statement download request. If your FI OFX server does not require this, you will have to set the BankIdPresent to False.

Note: This is done since the error message returned by most of FI OFX servers return a non-descriptive error message if the bank_id is required and not present.

Overwrite: Determines whether image files will be overwritten.

If True (default value) the check or statement image files are overwritten. Otherwise, an error is returned if the file exist.

StatementCount: The statement count in a multi-statement OFX response.

This configuration setting will return the total statement count when multiple statements are returned from the FI server within the same OFX response. For an example please see StatementIndex.

StatementIndex: The statement index in a multi-statement OFX response.

This is applicable only when multiple statements are returned from the FI server within the same OFX response. Below is an example of using this configuration setting in conjuction with StatementCount to parse multiple statments from a single file. Bankstatement bstatement = new Bankstatement(); string file = @"C:\temp\ofx\StatementCountIndexTest2.txt"; bstatement.ReadOFXDataFile(file); int statmentCount = Int32.Parse(bstatement.Config("StatementCount")); Debug.WriteLine(statmentCount + " statements."); for (int x = 0; x < statmentCount; x++) { Debug.WriteLine("---Displaying Information for Statment #" + x + "---"); bstatement.Config("StatementIndex=" + x); bstatement.ReadOFXDataFile(file); foreach (TransactionDetail td in bstatement.Transactions) { Debug.WriteLine(td.DatePosted + " - " + td.Amount); } }

OFX Config Settings

AuthToken: Authentication token required for this signon session only.

This credential is provided to the user out of band.

In the profile response, if sign_on_auth_token_first is True, then AuthToken should be sent in the very first signon.

ClientUId: Unique ID identifying OFX Client.

In the profile response, if sign_on_client_u_id_req is True, then ClientUId should be set and included in all future requests.

CorrectAction[i]: The action taken to a previously sent transaction corrected by the current one.

If present in the list of transactions response, this represents the action taken to a previously sent transaction that is corrected by this record. Possible values are: REPLACE or DELETE. REPLACE replaces the transaction that it corrects referenced by CorrectFITID[i];. DELETE deletes it. This is applicable to statement download components only.

CorrectFITID[i]: The FITID of a previously sent transaction corrected by the current one.

If present in the list of transactions response, this represents the FITID of a previously sent transaction that is corrected by this record. Based on the value of CorrectAction[i];, this transaction replaces or deletes the transaction that it corrects. This is applicable to statement download components only.

CurrencyFormat: The format to be used for returning currency values.

If this is set to a non-empty string, the class will attempt to use the value as a pattern to format all currency strings returned from the server. You may use any of the system's default number formatting strings.

DateFormat: The format to be used for input and output dates.

This format is used for input and output dates. You may use any of the system's default date formatting strings.

When submitting the request: all your input dates should be entered in a format specified by DateFormat and the class will convert those to OFXDateFormat right before sending the request.

For example, if you set a date to '2000.01.01' (by first setting the DateFormat to 'yyyy.MM.dd'), for a EST timezone, the class will convert it to '20000101000000.000[-5:EST]' (format specified by OFXDateFormat).

When parsing the response: if DateFormat is set to a non-empty string, the class will attempt to use the value as a pattern to format all date strings as they are returned. Otherwise, the system's default value will be used for formatting.

If the DateFormat is set to the special value "OFXDATE": During input:, any values you supply to date properties are passed to the server directly with no changes; During output: all dates will be returned in the OFX format as it was provided by the server without performing any modifications.

GetResponseVar: Parses additional information out of the response.

Any additional response information contained within the OFX response that is not available via the Response fields, may be retrieved with this GetResponseVar config.

To obtain a response value, pass the XPath to the value you wish to receive. For instance, if the OFX response contains: "<OFX><SIGNONMSGSRSV1><SONRS><STATUS><CODE>0<SEVERITY>INFO</STATUS><DTSERVER>20120104223836.575<LANGUAGE>ENG"

Then calling GetResponseVar("/OFX/SIGNONMSGSRVSV1/LANGUAGE") will return "ENG".

NewPassword: New password for the current OFX user.

Setting NewPassword to a non-empty value will cause the class to issue a password change request during sign-on along with the regular current OFX request. After the request is sent, this value will be cleared.

The correct current password is needed as well during signon request and must be supplied through the ofx_password. Upon successful reply from the server, the NewPassword used becomes the new password.

OFXDateFormat: The date format as required by OFX FI server.

Most of OFX FI servers, accept the default format, where the offset (G) and timezone (Z) are specified. However, there might still be some servers that do not accept that part. In such cases, you will have to set the OFXDateFormat to "YYYYMMddHHmmss.xxx" and GMT will be assumed as the default value.

Your input dates should be entered in a format specified by DateFormat and the class will convert those to OFXDateFormat (format that OFX FI server recognizes) right before sending the request.

OFXLog: Log file for the OFX transaction.

This setting records the OFX communication, but without including HTTP headers, to a file.

Please note that read_ofx_data_file will not be able to parse this file because of the OFX request content present. If only the response of the server is required, please look at the write_ofx_data_file method instead.

ServerMessage: Server message if a warning or other information returned.

When sending a transaction request to a FI, their server with return either a successful reply or an error. However, even when a transaction is successful, a warning or other server messages might still be returned and are to be treated as informational notes only.

UserCred1A: Additional user credential required by server.

In the profile response, if sign_on_user_cred_1q is present, then UserCred1A should be set (as the answer to question identified by sign_on_user_cred_1q) and it should be included in all future requests as part of the signon.

UserCred2A: Additional user credential required by server.

In the profile response, if sign_on_user_cred_2q is present, then UserCred2A should be set (as the answer to question identified by sign_on_user_cred_2q) and it should be included in all future requests as part of the signon.

HTTP Config Settings

AcceptEncoding: Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression: This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when http_version is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append: Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False.

Authorization: The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

BytesTransferred: Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the on_transfer event, by BytesTransferred.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest: Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL: If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects: Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new url for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new url is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

0 - Never
1 - Always
2 - Same Scheme

GetOn302Redirect: If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing: HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion: The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

"1.0"
"1.1" (default)
"2.0"
"3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince: A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive: Determines whether the HTTP connection is closed after completion of the request.

If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting other_headers to Connection: Keep-Alive. If False, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is False.

KerberosSPN: The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel: The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the on_log event. Possible values are as follows:


0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data are logged.
3 (Debug)	Debug data are logged.

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

MaxRedirectAttempts: Limits the number of redirects that are followed in a request.

When follow_redirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion: The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders: Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization: The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme.

ProxyAuthScheme: The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword: A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort: Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer: Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser: A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders: The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusLine: The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData: The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit: The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders: The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest: The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding: Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs: Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient: Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL: Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and proxy_auto_detect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent: Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout: Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost: Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort: The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType: Determines the type of firewall to connect through.

The appropriate values are as follows:


0	No firewall (default setting).
1	Connect through a tunneling proxy. FirewallPort is set to 80.
2	Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3	Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10	Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser: A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger: When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime: Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost: The name of the local host through which connections are initiated or accepted.

The local_host setting contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

LocalPort: The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength: The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.

If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate: The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList: A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay: Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6: Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:


0	IPv4 Only
1	IPv6 Only
2	IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets: Controls whether SSL packets are logged when using the internal security API.

When ssl_provider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if ssl_provider is set to Platform.

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the class is the same.

SSLCACertFilePaths: The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts: A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL: Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP: Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when ssl_provider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when ssl_provider is set to Internal:

obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");

Possible values when ssl_provider is set to Internal include:

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:


TLS1.3	12288 (Hex 3000)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.

In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

The platform provider is only available on Windows 11 / Windows Server 2022 and up.
SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is True by default, but can be set to False to disable the extension.

This setting is only applicable when ssl_provider is set to Internal.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the on_ssl_server_authentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when ssl_provider is set to Internal.

SSLNegotiatedCipher: Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength: Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite: Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion: Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts: A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when ssl_provider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData: Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize: The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize: The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitive: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to True to mask sensitive data. The default is True.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation.

When set to False, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to True tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

BankStatement Errors

OFX Errors

2000   Required field missing from server response.
2001   OFX server error. Description follows.
2002   Invalid OFX response.
2003   OFX response contains unknown element tags.

The class may also return one of the following error codes, which are inherited from other classes.

XML Errors

101   Invalid attribute index.
102   No attributes available.
103   Invalid namespace index.
104   No namespaces available.
105   Invalid element index.
106   No elements available.
107   Attribute does not exist.
201   Unbalanced element tag.
202   Unknown element prefix (can't find namespace).
203   Unknown attribute prefix (can't find namespace).
204   Invalid XML markup.
205   Invalid end state for parser.
206   Document contains unbalanced elements.
207   Invalid xpath.
208   No such child.
209   Top element does not match start of path.
210   DOM tree unavailable (set build_dom to true and reparse).
302   Can't open file.
401   Invalid XML would be generated.
402   An invalid XML name has been specified.

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in url
153   Specified url_scheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open attached_file.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

100   You cannot change the remote_port at this time. A connection is in progress.
101   You cannot change the remote_host (Server) at this time. A connection is in progress.
102   The remote_host address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the local_port at this time. A connection is in progress.
107   You cannot change the local_host at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   remote_port cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).


	2000 Required field missing from server response.
	2001 OFX server error. Description follows.
	2002 Invalid OFX response.
	2003 OFX response contains unknown element tags.


	101 Invalid attribute index.
	102 No attributes available.
	103 Invalid namespace index.
	104 No namespaces available.
	105 Invalid element index.
	106 No elements available.
	107 Attribute does not exist.
	201 Unbalanced element tag.
	202 Unknown element prefix (can't find namespace).
	203 Unknown attribute prefix (can't find namespace).
	204 Invalid XML markup.
	205 Invalid end state for parser.
	206 Document contains unbalanced elements.
	207 Invalid xpath.
	208 No such child.
	209 Top element does not match start of path.
	210 DOM tree unavailable (set build_dom to true and reparse).
	302 Can't open file.
	401 Invalid XML would be generated.
	402 An invalid XML name has been specified.


	118 Firewall Error. Error description contains detailed message.
	143 Busy executing current method.
	151 HTTP protocol error. The error message has the server response.
	152 No server specified in url
	153 Specified url_scheme is invalid.
	155 Range operation is not supported by server.
	156 Invalid cookie index (out of range).
	301 Interrupted.
	302 Can't open attached_file.


	100 You cannot change the remote_port at this time. A connection is in progress.
	101 You cannot change the remote_host (Server) at this time. A connection is in progress.
	102 The remote_host address is invalid (0.0.0.0).
	104 Already connected. If you want to reconnect, close the current connection first.
	106 You cannot change the local_port at this time. A connection is in progress.
	107 You cannot change the local_host at this time. A connection is in progress.
	112 You cannot change MaxLineLength at this time. A connection is in progress.
	116 remote_port cannot be zero. Please specify a valid service port number.
	117 You cannot change the UseConnection option while the class is active.
	135 Operation would block.
	201 Timeout.
	211 Action impossible in control's present state.
	212 Action impossible while not connected.
	213 Action impossible while listening.
	301 Timeout.
	302 Could not open file.
	434 Unable to convert string to selected CodePage.
	1105 Already connecting. If you want to reconnect, close the current connection first.
	1117 You need to connect first.
	1119 You cannot change the LocalHost at this time. A connection is in progress.
	1120 Connection dropped by remote host.


	270 Cannot load specified security library.
	271 Cannot open certificate store.
	272 Cannot find specified certificate.
	273 Cannot acquire security credentials.
	274 Cannot find certificate chain.
	275 Cannot verify certificate chain.
	276 Error during handshake.
	280 Error verifying certificate.
	281 Could not find client certificate.
	282 Could not find server certificate.
	283 Error encrypting data.
	284 Error decrypting data.


	10004 [10004] Interrupted system call.
	10009 [10009] Bad file number.
	10013 [10013] Access denied.
	10014 [10014] Bad address.
	10022 [10022] Invalid argument.
	10024 [10024] Too many open files.
	10035 [10035] Operation would block.
	10036 [10036] Operation now in progress.
	10037 [10037] Operation already in progress.
	10038 [10038] Socket operation on non-socket.
	10039 [10039] Destination address required.
	10040 [10040] Message too long.
	10041 [10041] Protocol wrong type for socket.
	10042 [10042] Bad protocol option.
	10043 [10043] Protocol not supported.
	10044 [10044] Socket type not supported.
	10045 [10045] Operation not supported on socket.
	10046 [10046] Protocol family not supported.
	10047 [10047] Address family not supported by protocol family.
	10048 [10048] Address already in use.
	10049 [10049] Can't assign requested address.
	10050 [10050] Network is down.
	10051 [10051] Network is unreachable.
	10052 [10052] Net dropped connection or reset.
	10053 [10053] Software caused connection abort.
	10054 [10054] Connection reset by peer.
	10055 [10055] No buffer space available.
	10056 [10056] Socket is already connected.
	10057 [10057] Socket is not connected.
	10058 [10058] Can't send after socket shutdown.
	10059 [10059] Too many references, can't splice.
	10060 [10060] Connection timed out.
	10061 [10061] Connection refused.
	10062 [10062] Too many levels of symbolic links.
	10063 [10063] File name too long.
	10064 [10064] Host is down.
	10065 [10065] No route to host.
	10066 [10066] Directory not empty
	10067 [10067] Too many processes.
	10068 [10068] Too many users.
	10069 [10069] Disc Quota Exceeded.
	10070 [10070] Stale NFS file handle.
	10071 [10071] Too many levels of remote in path.
	10091 [10091] Network subsystem is unavailable.
	10092 [10092] WINSOCK DLL Version out of range.
	10093 [10093] Winsock not loaded yet.
	11001 [11001] Host not found.
	11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004 [11004] Valid name, no data record (check DNS setup).