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:
- set payment (payment_from_bank_id, payment_from_account_id, and payment_from_account_type properties to the values corresponding to the account from which you wish to pay the bill, payment_amount to the desired amount, payment_date_due to the date payment has to be processed);
- set payee (by providing either payee_id or: payee full information (via payee_aggregate or by setting each payee property such as payee_name, payee_addr1, payee_phone, payee_list_id (if assigned by the server) and payee_account to your account id with that biller;
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_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 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. |
lost_sync | Whether the token in the synchronization request is older. |
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. |
payee_account | User's account number with the payee. |
payee_addr1 | Payee's address line 1. |
payee_addr2 | Payee's address line 2. |
payee_addr3 | Payee's address line 3. |
payee_aggregate | Wrapper for payee details. |
payee_city | Payee's city. |
payee_country | Payee's country. |
payee_days_to_pay | Minimum number of business days required to complete the payment transaction to this payee. |
payee_id | Server-assigned payee identifier. |
payee_id_scope | Scope of the payee Id . |
payee_list_id | Server-assigned payee list record ID for this payee. |
payee_name | Name of the payee to whom the given Id or ListId corresponds. |
payee_phone | Payee's phone. |
payee_postal_code | Payee's postal code. |
payee_state | Payee's state This is required to be provided in : a payment request if payee detailed information is used to identify the payee (i. |
payment_aggregate | Wrapper for a payment details. |
payment_amount | Payment amount. |
payment_bill_ref | Biller-supplied reference information when paying a bill, if available. |
payment_check_number | Check number assigned by the server to this payment. |
payment_currency_code | Default currency code for this transaction. |
payment_date_due | Processing date requested by user for the payment to be sent. |
payment_date_processed | Payment processing date. |
payment_from_account_id | Account number from which the money for this payment is drawn. |
payment_from_account_type | Indicates the type of account from which the money for this payment is drawn. |
payment_from_bank_id | Number that identifies the bank where the money is to be withdrawn. |
payment_id | Transaction Id assigned by the server to the payment. |
payment_memo | Memo attached to this payment from the customer to payee. |
payment_payee_account | User's account number with the payee this payment was sent to. |
payment_payee_aggregate | Wrapper for the payee details this payment was sent to. |
payment_payee_id | Server-assigned identifier to the payee this payment was sent to. |
payment_payee_list_id | Server-assigned payee list record ID for the payee this payment was sent to. |
payment_status | Payment processing status. |
payment_to_account_id | Account number to which the money for this payment is sent. |
payment_to_account_type | Indicates the type of account to which this payment is sent. |
payment_to_bank_id | Number that identifies the bank where the money is to be deposited. |
payment_tx_type | Transaction type performed on the payment being synchronized. |
ssl_accept_server_cert_encoded | The certificate (PEM/base64 encoded). |
ssl_cert_encoded | The certificate (PEM/base64 encoded). |
ssl_cert_store | The name of the certificate store for the client certificate. |
ssl_cert_store_password | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
ssl_cert_store_type | The type of certificate store for this certificate. |
ssl_cert_subject | The subject of the certificate used for client authentication. |
ssl_server_cert_encoded | The certificate (PEM/base64 encoded). |
sync_payee_count | The number of records in the SyncPayee arrays. |
sync_payee_account | User's account number with the payee. |
sync_payee_addr1 | Payee's address line 1. |
sync_payee_addr2 | Payee's address line 2. |
sync_payee_addr3 | Payee's address line 3. |
sync_payee_aggregate | Wrapper for payee details. |
sync_payee_city | Payee's city. |
sync_payee_country | Payee's country. |
sync_payee_days_to_pay | Minimum number of business days required to complete the payment transaction to this payee. |
sync_payee_id | Server-assigned payee identifier. |
sync_payee_id_scope | Scope of the payee Id . |
sync_payee_list_id | Server-assigned payee list record ID for this payee. |
sync_payee_name | Name of the payee to whom the given Id or ListId corresponds. |
sync_payee_phone | Payee's phone. |
sync_payee_postal_code | Payee's postal code. |
sync_payee_state | Payee'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_type | Transaction type performed on the payee being synchronized. |
sync_payment_count | The number of records in the SyncPayment arrays. |
sync_payment_aggregate | Wrapper for a payment details. |
sync_payment_amount | Payment amount. |
sync_payment_bill_ref | Biller-supplied reference information when paying a bill, if available. |
sync_payment_check_number | Check number assigned by the server to this payment. |
sync_payment_currency_code | Default currency code for this transaction. |
sync_payment_date_due | Processing date requested by user for the payment to be sent. |
sync_payment_date_processed | Payment processing date. |
sync_payment_id | Transaction Id assigned by the server to the payment. |
sync_payment_memo | Memo attached to this payment from the customer to payee. |
sync_payment_payee_account | User's account number with the payee this payment was sent to. |
sync_payment_payee_aggregate | Wrapper for the payee details this payment was sent to. |
sync_payment_payee_id | Server-assigned identifier to the payee this payment was sent to. |
sync_payment_payee_list_id | Server-assigned payee list record ID for the payee this payment was sent to. |
sync_payment_status | Payment processing status. |
sync_payment_tx_type | Transaction type performed on the payment being synchronized. |
timeout | A 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_payee | Add a payee to server's payee list. |
cancel_payment | Cancels a scheduled bill payment. |
config | Sets or retrieves a configuration setting. |
delete_payee | Deletes a payee identified by ListId from the server payee list. |
get_status | Obtains the current processing status of a payment. |
modify_payee | Modifies a payee identified by ListId that already exists in the payee list. |
modify_payment | Modifies a scheduled payment. |
pay_bill | Pays a bill to a given payee. |
reset | Reset the internal state of the class and all properties to their default values. |
synchronize_payees | Synchronizes payees on the client side with payees on record on the server side. |
synchronize_payments | Synchronizes 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_status | Fired to indicate changes in 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. |
on_sync_payees | Fired for each payee included in the synchronization response. |
on_sync_payments | Fired 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.
AuthToken | Authentication token required for this signon session only. |
ClientUId | Unique ID identifying OFX Client. |
CorrectAction[i] | The action taken to a previously sent transaction corrected by the current one. |
CorrectFITID[i] | The FITID of a previously sent transaction corrected by the current one. |
CurrencyFormat | The format to be used for returning currency values. |
DateFormat | The format to be used for input and output dates. |
GetResponseVar | Parses additional information out of the response. |
NewPassword | New password for the current OFX user. |
OFXDateFormat | The date format as required by OFX FI server. |
OFXLog | Log file for the OFX transaction. |
ServerMessage | Server message if a warning or other information returned. |
UserCred1A | Additional user credential required by server. |
UserCred2A | Additional user credential required by server. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |