IPWorks OFX 2020 Python Edition

Questions / Feedback?

BillPayment Class

Properties   Methods   Events   Configuration Settings   Errors  

The BillPayment control is a single class that supports the SignOn and Payment functions of Open Financial Exchange, as described by OFX Specification 1.x and 2.x.

Syntax

class ipworksofx.BillPayment

Remarks

Payment requests can be used to schedule individual payments and to modify or delete payments if necessary.

To use the BillPayment class, first provide ofx_app_id, and ofx_app_version properties, your FI information (by setting the fi_organization, fi_id and fi_url properties), your login information (ofx_user, ofx_password).

Next:

Finally, call the pay_bill method. If the biller does not exist in the payee list, the payment request will also set up that payee adding it to your payee list.

Upon successful response, the payment_id, payment_status and payment_date_processed properties will be populated indicating the status of your payment. If the payee didn't exist in your payee list, and if your FI supports assigning id to payees, the payee_id and payee_list_id assigned to that payer might also be returned in the server response.

Between the time a payment is scheduled and the time the server processes the payment, the user can request changes to the parameters of that payment. For example, the payment_amount or payment_date_due of the payment can be modified. To modify a scheduled payment identified by PaymentId, the modify_payment method can be called where the PaymentId identifies the targeted payment. When this method is called, the full contents of the payment request must be specified, including both modified and unmodified data. All data can be modified except payee_name and payee_id. Depending on the server, the response might include the date on which server actually processed this payment, or if it failed due to insufficient funds.

To cancel a scheduled payment identified by PaymentId, the cancel_payment method must be called.

Obtaining the status for a payment identified by PaymentId can be done by calling the get_status method.

Bill payments are subject to synchronization which can be done by calling the synchronize_payments method.

Property List


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

fi_idFinancial institution identifier.
fi_organizationFinancial institution organization name.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the TCP port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
fi_urlFinancial institution URL.
lost_syncWhether the token in the synchronization request is older.
ofx_access_keyAccess key value received after a MFA authentication in a previous signon.
ofx_app_idOFX application identifier.
ofx_app_versionOFX application version.
ofx_passwordUser's password.
ofx_requestThe current OFX request aggregate.
ofx_responseThe current OFX response aggregate.
ofx_userUser's id.
ofx_versionOFX API version.
payee_accountUser's account number with the payee.
payee_addr1Payee's address line 1.
payee_addr2Payee's address line 2.
payee_addr3Payee's address line 3.
payee_aggregateWrapper for payee details.
payee_cityPayee's city.
payee_countryPayee's country.
payee_days_to_payMinimum number of business days required to complete the payment transaction to this payee.
payee_idServer-assigned payee identifier.
payee_id_scopeScope of the payee Id .
payee_list_idServer-assigned payee list record ID for this payee.
payee_nameName of the payee to whom the given Id or ListId corresponds.
payee_phonePayee's phone.
payee_postal_codePayee's postal code.
payee_statePayee's state This is required to be provided in : a payment request if payee detailed information is used to identify the payee (i.
payment_aggregateWrapper for a payment details.
payment_amountPayment amount.
payment_bill_refBiller-supplied reference information when paying a bill, if available.
payment_check_numberCheck number assigned by the server to this payment.
payment_currency_codeDefault currency code for this transaction.
payment_date_dueProcessing date requested by user for the payment to be sent.
payment_date_processedPayment processing date.
payment_from_account_idAccount number from which the money for this payment is drawn.
payment_from_account_typeIndicates the type of account from which the money for this payment is drawn.
payment_from_bank_idNumber that identifies the bank where the money is to be withdrawn.
payment_idTransaction Id assigned by the server to the payment.
payment_memoMemo attached to this payment from the customer to payee.
payment_payee_accountUser's account number with the payee this payment was sent to.
payment_payee_aggregateWrapper for the payee details this payment was sent to.
payment_payee_idServer-assigned identifier to the payee this payment was sent to.
payment_payee_list_idServer-assigned payee list record ID for the payee this payment was sent to.
payment_statusPayment processing status.
payment_to_account_idAccount number to which the money for this payment is sent.
payment_to_account_typeIndicates the type of account to which this payment is sent.
payment_to_bank_idNumber that identifies the bank where the money is to be deposited.
payment_tx_typeTransaction type performed on the payment being synchronized.
ssl_accept_server_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_encodedThe certificate (PEM/base64 encoded).
ssl_cert_storeThe name of the certificate store for the client certificate.
ssl_cert_store_passwordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ssl_cert_store_typeThe type of certificate store for this certificate.
ssl_cert_subjectThe subject of the certificate used for client authentication.
ssl_server_cert_encodedThe certificate (PEM/base64 encoded).
sync_payee_countThe number of records in the SyncPayee arrays.
sync_payee_accountUser's account number with the payee.
sync_payee_addr1Payee's address line 1.
sync_payee_addr2Payee's address line 2.
sync_payee_addr3Payee's address line 3.
sync_payee_aggregateWrapper for payee details.
sync_payee_cityPayee's city.
sync_payee_countryPayee's country.
sync_payee_days_to_payMinimum number of business days required to complete the payment transaction to this payee.
sync_payee_idServer-assigned payee identifier.
sync_payee_id_scopeScope of the payee Id .
sync_payee_list_idServer-assigned payee list record ID for this payee.
sync_payee_nameName of the payee to whom the given Id or ListId corresponds.
sync_payee_phonePayee's phone.
sync_payee_postal_codePayee's postal code.
sync_payee_statePayee's state This is required to be provided in : a payment request if payee detailed information is used to identify the payee (i.
sync_payee_tx_typeTransaction type performed on the payee being synchronized.
sync_payment_countThe number of records in the SyncPayment arrays.
sync_payment_aggregateWrapper for a payment details.
sync_payment_amountPayment amount.
sync_payment_bill_refBiller-supplied reference information when paying a bill, if available.
sync_payment_check_numberCheck number assigned by the server to this payment.
sync_payment_currency_codeDefault currency code for this transaction.
sync_payment_date_dueProcessing date requested by user for the payment to be sent.
sync_payment_date_processedPayment processing date.
sync_payment_idTransaction Id assigned by the server to the payment.
sync_payment_memoMemo attached to this payment from the customer to payee.
sync_payment_payee_accountUser's account number with the payee this payment was sent to.
sync_payment_payee_aggregateWrapper for the payee details this payment was sent to.
sync_payment_payee_idServer-assigned identifier to the payee this payment was sent to.
sync_payment_payee_list_idServer-assigned payee list record ID for the payee this payment was sent to.
sync_payment_statusPayment processing status.
sync_payment_tx_typeTransaction type performed on the payment being synchronized.
timeoutA timeout for the class.

Method List


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

add_payeeAdd a payee to server's payee list.
cancel_paymentCancels a scheduled bill payment.
configSets or retrieves a configuration setting.
delete_payeeDeletes a payee identified by ListId from the server payee list.
get_statusObtains the current processing status of a payment.
modify_payeeModifies a payee identified by ListId that already exists in the payee list.
modify_paymentModifies a scheduled payment.
pay_billPays a bill to a given payee.
resetReset the internal state of the class and all properties to their default values.
synchronize_payeesSynchronizes payees on the client side with payees on record on the server side.
synchronize_paymentsSynchronizes bills paid on the client side with paid bills on record on the server side.

Event List


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

on_connection_statusFired to indicate changes in connection state.
on_errorInformation about errors during data delivery.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_sync_payeesFired for each payee included in the synchronization response.
on_sync_paymentsFired for each payment transaction included in the synchronization response.

Configuration Settings


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

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]