IPWorks OFX 2020 Python Edition

Questions / Feedback?

CCStatement Class

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

class ipworksofx.CCStatement

Remarks

The CCStatement class adds credit card statement download functionality to your desktop application, or allows your web application to fetch a user's credit card 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 CCStatement 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. To identify the account, set the card_number property to the credit card 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 start_date, end_date, available_balance, ledger_balance and any other data the bank statement includes.

The transaction properties (tx_amount, 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.

available_balanceAmount of the available balance.
available_balance_dateDate of the available balance.
card_numberCredit card number.
closing_detail_countThe number of records in the ClosingDetail arrays.
closing_detail_aggregateAggregates are pieces of XML taken from the financial institution's original response.
closing_detail_balance_closingClosing statement balance.
closing_detail_balance_openingOpening statement balance.
closing_detail_credit_limitCurrent credit limit.
closing_detail_date_closeClosing statement date.
closing_detail_date_dueNext payment due date.
closing_detail_date_endEnd date of transaction data for this statement.
closing_detail_date_openOpening statement date.
closing_detail_date_startStart date of transaction data for this statement.
closing_detail_fitidUnique identifier assigned by financial institution to identify this particular statement closing information.
closing_detail_image_refServer specified unique identifier for the statement closing image.
closing_detail_image_ref_typeType of retrieval method for actual statement closing image.
closing_detail_minimum_paymentNext minimum amount due.
closing_detail_total_creditTotal credit posted on the account for this statement (period indicated by DateStart and DateEnd ).
closing_detail_total_debitTotal of debit posted on the account for this statement (period indicated by DateStart and DateEnd ).
closing_detail_total_feesTotal fees.
currency_codeDefault currency code for this statement.
end_dateEnd date of statement requested.
fi_idFinancial institution identifier.
fi_organizationFinancial institution organization name.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the TCP port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
fi_urlFinancial institution URL.
image_file_nameFilename and location to save the image content of a closing statement.
include_imagesWhether the server has to return data for closing statements images.
ledger_balanceAmount of the ledger balance.
ledger_balance_dateDate of the ledger balance.
ofx_access_keyAccess key value received after a MFA authentication in a previous signon.
ofx_app_idOFX application identifier.
ofx_app_versionOFX application version.
ofx_passwordUser's password.
ofx_requestThe current OFX request aggregate.
ofx_responseThe current OFX response aggregate.
ofx_userUser's id.
ofx_versionOFX API version.
ssl_accept_server_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_storeThe name of the certificate store for the client certificate.
ssl_cert_store_passwordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ssl_cert_store_typeThe type of certificate store for this certificate.
ssl_cert_subjectThe subject of the certificate used for client authentication.
ssl_server_cert_encodedThe certificate (PEM/base64 encoded).
start_dateStart date of requested transaction list.
timeoutA timeout for the class.
tx_countThe number of records in the Tx arrays.
tx_aggregateWrapper for a bank transaction.
tx_amountThis is the amount of money exchanged during a given transaction.
tx_dateThis is the date the transaction was made by the account holder as recorded by the financial institution, stored as a string.
tx_date_postedThis is the date the transaction was posted to the financial institution, stored as a string.
tx_fitidTransaction Id assigned by the financial institution.
tx_memoThe memo property stores a notice from the payee to the customer as a string.
tx_payee_nameIf This property has a value, the NAME element replaces the entire PAYEE aggregate in the request XML.
tx_typeThis is the type of transaction that was made on the account.
tx_type_descriptionA 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.

configSets or retrieves a configuration setting.
get_closing_infoDownload a credit card statement closing information.
get_imageRequest and retrieve a statement closing information image (if available).
get_statementDownloads statement for a credit card account.
read_ofx_data_fileReads an OFX response from a file.
resetReset the internal state of the class and all properties to their default values.
write_ofx_data_fileWrites 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_statusFired to indicate changes in connection state.
on_errorInformation about errors during data delivery.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.

Configuration Settings


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

OverwriteDetermines whether image files will be overwritten.
StatementCountThe statement count in a multi-statement OFX response.
StatementIndexThe statement index in a multi-statement OFX response.
AuthTokenAuthentication token required for this signon session only.
ClientUIdUnique ID identifying OFX Client.
CorrectAction[i]The action taken to a previously sent transaction corrected by the current one.
CorrectFITID[i]The FITID of a previously sent transaction corrected by the current one.
CurrencyFormatThe format to be used for returning currency values.
DateFormatThe format to be used for input and output dates.
GetResponseVarParses additional information out of the response.
NewPasswordNew password for the current OFX user.
OFXDateFormatThe date format as required by OFX FI server.
OFXLogLog file for the OFX transaction.
ServerMessageServer message if a warning or other information returned.
UserCred1AAdditional user credential required by server.
UserCred2AAdditional user credential required by server.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

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