BillPayment Class

Properties   Methods   Events   Config 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 inebank.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.

Method List

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

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.

Config Settings

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

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

Whether 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

Whether to automatically detect and use firewall system settings, if available.

firewall_type Property

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

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

firewall_host Property

The name or IP address of the 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

The name or IP address of the 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

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

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

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

0

Remarks

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

A username if authentication is to be used when 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

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property 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.

lost_sync Property

Whether the token in the synchronization request is older.

Syntax

def get_lost_sync() -> bool: ...

lost_sync = property(get_lost_sync, None)

Default Value

FALSE

Remarks

The lost_sync will be returned in the server response after a synchronization request has been sent (when the synchronize method was called). This indicates whether the Token in the synchronization request is older than the earliest entry in the server's history table. If True, some responses have been lost. Otherwise, the token in the synchronization request is newer than or matches a token in the server's history table.

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.

payee_account Property

User's account number with the payee.

Syntax

def get_payee_account() -> str: ...
def set_payee_account(value: str) -> None: ...

payee_account = property(get_payee_account, set_payee_account)

Default Value

""

Remarks

User's account number with the payee. This string uniquely identifies the customer in the payee (biller) system.

This is optional and applicable only when the payee_id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

payee_addr1 Property

Payee's address line 1.

Syntax

def get_payee_addr1() -> str: ...
def set_payee_addr1(value: str) -> None: ...

payee_addr1 = property(get_payee_addr1, set_payee_addr1)

Default Value

""

Remarks

Payee's address line 1.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

payee_addr2 Property

Payee's address line 2.

Syntax

def get_payee_addr2() -> str: ...
def set_payee_addr2(value: str) -> None: ...

payee_addr2 = property(get_payee_addr2, set_payee_addr2)

Default Value

""

Remarks

Payee's address line 2.

This is optional and applicable only when the payee_id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

payee_addr3 Property

Payee's address line 3.

Syntax

def get_payee_addr3() -> str: ...
def set_payee_addr3(value: str) -> None: ...

payee_addr3 = property(get_payee_addr3, set_payee_addr3)

Default Value

""

Remarks

Payee's address line 3.

This is optional and applicable only when the payee_id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

payee_aggregate Property

Wrapper for payee details.

Syntax

def get_payee_aggregate() -> str: ...
def set_payee_aggregate(value: str) -> None: ...

payee_aggregate = property(get_payee_aggregate, set_payee_aggregate)

Default Value

""

Remarks

Wrapper for payee details.

This string consists of all the payee's properties payee_id, payee_name, payee_addr1, payee_addr2, payee_addr3, payee_city, payee_state, payee_postal_code, payee_country, payee_phone, payee_id_scope, payee_days_to_pay, payee_list_id, payee_account of the payee.

When the synchronize_payees is called, the on_sync_payees event is fired for each payee in the payee list. Among other payee data returned through this event's parameters, there is also a PayeeAggregate parameter.

When sending a payment request (by calling pay_bill) to an existing payee in the list returned via the payee synchronization request, and when the payee_id is unknown or not assigned, instead of setting all payee's properties, the user can set the payee_aggregate to the value of PayeeAggregate returned for that payee from the on_sync_payees event. When the payee_aggregate is set to this value, all payee's properties are populated with the corresponding values in the aggregate.

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.

payee_city Property

Payee's city.

Syntax

def get_payee_city() -> str: ...
def set_payee_city(value: str) -> None: ...

payee_city = property(get_payee_city, set_payee_city)

Default Value

""

Remarks

Payee's city.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

payee_country Property

Payee's country.

Syntax

def get_payee_country() -> str: ...
def set_payee_country(value: str) -> None: ...

payee_country = property(get_payee_country, set_payee_country)

Default Value

"USA"

Remarks

Payee's country. This is a 3 letter country code as representation of a country name (ISO/DIS-3166 3-letter country code standard).

This is optional and applicable only when the payee_id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

payee_days_to_pay Property

Minimum number of business days required to complete the payment transaction to this payee.

Syntax

def get_payee_days_to_pay() -> str: ...

payee_days_to_pay = property(get_payee_days_to_pay, None)

Default Value

""

Remarks

Minimum number of business days required to complete the payment transaction to this payee.

This property is read-only.

payee_id Property

Server-assigned payee identifier.

Syntax

def get_payee_id() -> str: ...
def set_payee_id(value: str) -> None: ...

payee_id = property(get_payee_id, set_payee_id)

Default Value

""

Remarks

Server-assigned payee identifier.

The payee_id is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either payee_id or payee full information should be provided in a payment request, but not both.

Payee full information can be provided in the request by setting either the payee_aggregate or payee details represented by required properties: payee_name, payee_addr1, payee_city, payee_state, payee_postal_code, payee_phone, and optional properties: payee_addr2, payee_addr3, payee_country, payee_account.

The payee_id might be populated when: either a payment request (pay_bill method is called) or an add payee request (add_payee method is called) has been sent to the payment server, or when the payee_aggregate has been set.

payee_id_scope Property

Scope of the payee Id .

Syntax

def get_payee_id_scope() -> str: ...

payee_id_scope = property(get_payee_id_scope, None)

Default Value

""

Remarks

Scope of the payee payee_id.

Possible values are:

This property is read-only.

payee_list_id Property

Server-assigned payee list record ID for this payee.

Syntax

def get_payee_list_id() -> str: ...
def set_payee_list_id(value: str) -> None: ...

payee_list_id = property(get_payee_list_id, set_payee_list_id)

Default Value

""

Remarks

Server-assigned payee list record ID for this payee.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a payee_id, the payee_list_id is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a payee_id to this payee.

It is assigned by the server to that payee when an add payee request (via add_payee method) or bill payment request (via pay_bill method) has been sent.

The value of payee_list_id is used as parameter when the modify_payee or delete_payee methods are called (when modifying or deleting a payee). In all other payment requests is optional.

payee_name Property

Name of the payee to whom the given Id or ListId corresponds.

Syntax

def get_payee_name() -> str: ...
def set_payee_name(value: str) -> None: ...

payee_name = property(get_payee_name, set_payee_name)

Default Value

""

Remarks

Name of the payee to whom the given payee_id or payee_list_id corresponds. This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

After sending payment or add/modify payee requests, if the returned payee_id_scope is GLOBAL, the payee_name will contain the standard payee name returned by the server.

payee_phone Property

Payee's phone.

Syntax

def get_payee_phone() -> str: ...
def set_payee_phone(value: str) -> None: ...

payee_phone = property(get_payee_phone, set_payee_phone)

Default Value

""

Remarks

Payee's phone.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

payee_postal_code Property

Payee's postal code.

Syntax

def get_payee_postal_code() -> str: ...
def set_payee_postal_code(value: str) -> None: ...

payee_postal_code = property(get_payee_postal_code, set_payee_postal_code)

Default Value

""

Remarks

Payee's postal code.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

payee_state Property

Payee's state This is required to be provided in : a payment request if payee detailed information is used to identify the payee (i.

Syntax

def get_payee_state() -> str: ...
def set_payee_state(value: str) -> None: ...

payee_state = property(get_payee_state, set_payee_state)

Default Value

""

Remarks

Payee's state

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

payment_aggregate Property

Wrapper for a payment details.

Syntax

def get_payment_aggregate() -> str: ...

payment_aggregate = property(get_payment_aggregate, None)

Default Value

""

Remarks

Wrapper for a payment details.

This string consists of all the payment's properties payment_id, payment_status, payment_amount, payment_from_bank_id, payment_from_account_id, payment_from_account_type, payment_memo, payment_check_number, etc..

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 property is read-only.

payment_amount Property

Payment amount.

Syntax

def get_payment_amount() -> str: ...
def set_payment_amount(value: str) -> None: ...

payment_amount = property(get_payment_amount, set_payment_amount)

Default Value

""

Remarks

Payment amount. This is to be provided when sending a bill payment request.

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.

payment_bill_ref Property

Biller-supplied reference information when paying a bill, if available.

Syntax

def get_payment_bill_ref() -> str: ...
def set_payment_bill_ref(value: str) -> None: ...

payment_bill_ref = property(get_payment_bill_ref, set_payment_bill_ref)

Default Value

""

Remarks

Biller-supplied reference information when paying a bill, if available.

This is optional when submitting a payment request.

payment_check_number Property

Check number assigned by the server to this payment.

Syntax

def get_payment_check_number() -> str: ...

payment_check_number = property(get_payment_check_number, None)

Default Value

""

Remarks

Check number assigned by the server to this payment.

This will be returned in the server response (if available) when the request succeeds.

This property is read-only.

payment_currency_code Property

Default currency code for this transaction.

Syntax

def get_payment_currency_code() -> str: ...

payment_currency_code = property(get_payment_currency_code, None)

Default Value

""

Remarks

Default currency code for this transaction.

This indicates the currency in which the payment will be carried out.

This property is read-only.

payment_date_due Property

Processing date requested by user for the payment to be sent.

Syntax

def get_payment_date_due() -> str: ...
def set_payment_date_due(value: str) -> None: ...

payment_date_due = property(get_payment_date_due, set_payment_date_due)

Default Value

""

Remarks

Processing date requested by user for the payment to be sent.

This is required to be provided in any bill payment or payment modification requests.

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.

payment_date_processed Property

Payment processing date.

Syntax

def get_payment_date_processed() -> str: ...

payment_date_processed = property(get_payment_date_processed, None)

Default Value

""

Remarks

Payment processing date.

This indicates the date when the event described by payment_status occurs.

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.

payment_from_account_id Property

Account number from which the money for this payment is drawn.

Syntax

def get_payment_from_account_id() -> str: ...
def set_payment_from_account_id(value: str) -> None: ...

payment_from_account_id = property(get_payment_from_account_id, set_payment_from_account_id)

Default Value

""

Remarks

Account number from which the money for this payment is drawn.

This is an account number for a typical bank, such as one that might appear on a check, a bank card, or a credit card with that bank.

It is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when pay_bill or modify_payment methods are called).

If payment_from_account_type is set to CreditCard, the payment_from_account_id should be a credit card account number.

payment_from_account_type Property

Indicates the type of account from which the money for this payment is drawn.

Syntax

def get_payment_from_account_type() -> int: ...
def set_payment_from_account_type(value: int) -> None: ...

payment_from_account_type = property(get_payment_from_account_type, set_payment_from_account_type)

Default Value

0

Remarks

Indicates the type of account from which the money for this payment is drawn.

This is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when pay_bill or modify_payment methods are called).

This property uses the following four values:

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

payment_from_bank_id Property

Number that identifies the bank where the money is to be withdrawn.

Syntax

def get_payment_from_bank_id() -> str: ...
def set_payment_from_bank_id(value: str) -> None: ...

payment_from_bank_id = property(get_payment_from_bank_id, set_payment_from_bank_id)

Default Value

""

Remarks

Number that identifies the bank where the money is to be withdrawn.

This is required to be provided when a bill payment request has been made.

payment_id Property

Transaction Id assigned by the server to the payment.

Syntax

def get_payment_id() -> str: ...
def set_payment_id(value: str) -> None: ...

payment_id = property(get_payment_id, set_payment_id)

Default Value

""

Remarks

Transaction Id assigned by the server to the payment.

The payment_id is returned after a bill payment request (when calling the pay_bill method, which can be either a single payment or a recurring payment model).

This identifier value can be used as reference to this payment or model in any modification or cancellation request (as parameter when the modify_payment or cancel_payment methods are called).

payment_memo Property

Memo attached to this payment from the customer to payee.

Syntax

def get_payment_memo() -> str: ...
def set_payment_memo(value: str) -> None: ...

payment_memo = property(get_payment_memo, set_payment_memo)

Default Value

""

Remarks

Memo attached to this payment from the customer to payee.

This is optional when submitting a payment request.

payment_payee_account Property

User's account number with the payee this payment was sent to.

Syntax

def get_payment_payee_account() -> str: ...

payment_payee_account = property(get_payment_payee_account, None)

Default Value

""

Remarks

User's account number with the payee this payment was sent to.

This string uniquely identifies the customer in the payee (biller) system.

This property is read-only.

payment_payee_aggregate Property

Wrapper for the payee details this payment was sent to.

Syntax

def get_payment_payee_aggregate() -> str: ...

payment_payee_aggregate = property(get_payment_payee_aggregate, None)

Default Value

""

Remarks

Wrapper for the payee details this payment was sent to.

This string consists of these payee's data: name, address, city, state, country, postal code, country and phone.

When the synchronize_payments is called, the on_sync_payments event is fired for each payment in the payment list. Among other payment data returned through this event's parameters, there is also a PayeeAggregate parameter.

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 property is read-only.

payment_payee_id Property

Server-assigned identifier to the payee this payment was sent to.

Syntax

def get_payment_payee_id() -> str: ...

payment_payee_id = property(get_payment_payee_id, None)

Default Value

""

Remarks

Server-assigned identifier to the payee this payment was sent to.

The payment_payee_id is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either payment_payee_aggregate or payment_payee_id can be returned in the response, but not both.

This property is read-only.

payment_payee_list_id Property

Server-assigned payee list record ID for the payee this payment was sent to.

Syntax

def get_payment_payee_list_id() -> str: ...

payment_payee_list_id = property(get_payment_payee_list_id, None)

Default Value

""

Remarks

Server-assigned payee list record ID for the payee this payment was sent to.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a payment_payee_id, the payment_payee_list_id is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a payment_payee_id to this payee.

This is assigned by the server to that payee when an add payee request (via add_payee method) or bill payment request (via pay_bill method) has been sent.

This property is read-only.

payment_status Property

Payment processing status.

Syntax

def get_payment_status() -> str: ...

payment_status = property(get_payment_status, None)

Default Value

""

Remarks

Payment processing status.

The possible values of this property are as follows:

This property is read-only.

payment_to_account_id Property

Account number to which the money for this payment is sent.

Syntax

def get_payment_to_account_id() -> str: ...
def set_payment_to_account_id(value: str) -> None: ...

payment_to_account_id = property(get_payment_to_account_id, set_payment_to_account_id)

Default Value

""

Remarks

Account number to which the money for this payment is sent.

This is an account number for a typical bank, such as one that might appear on a check, a bank card, or a credit card with this bank.

It is optional to be provided when a bill payment or payment modification request is sent to the server (i.e., when pay_bill or modify_payment methods are called).

If payment_to_account_type is set to CreditCard, the payment_to_account_id should be a credit card account number.

This is optional, but if it is provided in the request, Payee detailed information is required to be provided as well (by providing payee details, such as name, address, phone, etc.) and not via payee_id.

payment_to_account_type Property

Indicates the type of account to which this payment is sent.

Syntax

def get_payment_to_account_type() -> int: ...
def set_payment_to_account_type(value: int) -> None: ...

payment_to_account_type = property(get_payment_to_account_type, set_payment_to_account_type)

Default Value

0

Remarks

Indicates the type of account to which this payment is sent.

This is required to be provided when a bill payment or payment modification request is sent to the server (i.e., when pay_bill or modify_payment methods are called).

This property uses the following four values:

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

This is optional, but if it is provided in the request, Payee detailed information is required to be provided as well (by providing payee details, such as name, address, phone, etc.) and not via payee_id.

payment_to_bank_id Property

Number that identifies the bank where the money is to be deposited.

Syntax

def get_payment_to_bank_id() -> str: ...
def set_payment_to_bank_id(value: str) -> None: ...

payment_to_bank_id = property(get_payment_to_bank_id, set_payment_to_bank_id)

Default Value

""

Remarks

Number that identifies the bank where the money is to be deposited.

This is optional, but if it is provided in the request, Payee detailed information is required to be provided as well (by providing payee details, such as name, address, phone, etc.) and not via payee_id.

payment_tx_type Property

Transaction type performed on the payment being synchronized.

Syntax

def get_payment_tx_type() -> str: ...

payment_tx_type = property(get_payment_tx_type, None)

Default Value

""

Remarks

Transaction type performed on the payment being synchronized.

This is applicable to payment synchronization requests only. Possible values and their meanings are as follows:

This property is read-only.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_accept_server_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_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_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_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

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:

ssl_accept_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

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

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

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

ssl_accept_server_cert_encoded Property

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

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_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

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

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 designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 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

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

0

Remarks

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:

ssl_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

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

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

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

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

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

ssl_cert_encoded Property

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

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_provider Property

The Secure Sockets Layer/Transport Layer Security (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

0

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 as follows:

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_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

ssl_server_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_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

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.

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

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:

This property is read-only.

ssl_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

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

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a 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 as follows:

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

This property is read-only.

ssl_server_cert_encoded Property

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

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.

sync_payee_count Property

The number of records in the SyncPayee arrays.

Syntax

def get_sync_payee_count() -> int: ...

sync_payee_count = property(get_sync_payee_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• sync_payee_account
• sync_payee_addr1
• sync_payee_addr2
• sync_payee_addr3
• sync_payee_aggregate
• sync_payee_city
• sync_payee_country
• sync_payee_days_to_pay
• sync_payee_id
• sync_payee_id_scope
• sync_payee_list_id
• sync_payee_name
• sync_payee_phone
• sync_payee_postal_code
• sync_payee_state
• sync_payee_tx_type

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

This property is read-only.

sync_payee_account Property

User's account number with the payee.

Syntax

def get_sync_payee_account(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

User's account number with the payee. This string uniquely identifies the customer in the payee (biller) system.

This is optional and applicable only when the payee_id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_addr1 Property

Payee's address line 1.

Syntax

def get_sync_payee_addr1(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Payee's address line 1.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_addr2 Property

Payee's address line 2.

Syntax

def get_sync_payee_addr2(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Payee's address line 2.

This is optional and applicable only when the payee_id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_addr3 Property

Payee's address line 3.

Syntax

def get_sync_payee_addr3(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Payee's address line 3.

This is optional and applicable only when the payee_id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_aggregate Property

Wrapper for payee details.

Syntax

def get_sync_payee_aggregate(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for payee details.

This string consists of all the payee's properties sync_payee_id, sync_payee_name, sync_payee_addr1, sync_payee_addr2, sync_payee_addr3, sync_payee_city, sync_payee_state, sync_payee_postal_code, sync_payee_country, sync_payee_phone, sync_payee_id_scope, sync_payee_days_to_pay, sync_payee_list_id, sync_payee_account of the payee.

When the synchronize_payees is called, the on_sync_payees event is fired for each payee in the payee list. Among other payee data returned through this event's parameters, there is also a PayeeAggregate parameter.

When sending a payment request (by calling pay_bill) to an existing payee in the list returned via the payee synchronization request, and when the sync_payee_id is unknown or not assigned, instead of setting all payee's properties, the user can set the sync_payee_aggregate to the value of PayeeAggregate returned for that payee from the on_sync_payees event. When the sync_payee_aggregate is set to this value, all payee's properties are populated with the corresponding values in the aggregate.

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.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_city Property

Payee's city.

Syntax

def get_sync_payee_city(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Payee's city.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_country Property

Payee's country.

Syntax

def get_sync_payee_country(sync_payee_index: int) -> str: ...

Default Value

"USA"

Remarks

Payee's country. This is a 3 letter country code as representation of a country name (ISO/DIS-3166 3-letter country code standard).

This is optional and applicable only when the payee_id is not provided in the request. In this case, the payee detailed information is used to identify the payee in a payment request, or when adding or modifying a payee.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_days_to_pay Property

Minimum number of business days required to complete the payment transaction to this payee.

Syntax

def get_sync_payee_days_to_pay(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Minimum number of business days required to complete the payment transaction to this payee.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_id Property

Server-assigned payee identifier.

Syntax

def get_sync_payee_id(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Server-assigned payee identifier.

The sync_payee_id is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either sync_payee_id or payee full information should be provided in a payment request, but not both.

Payee full information can be provided in the request by setting either the sync_payee_aggregate or payee details represented by required properties: sync_payee_name, sync_payee_addr1, sync_payee_city, sync_payee_state, sync_payee_postal_code, sync_payee_phone, and optional properties: sync_payee_addr2, sync_payee_addr3, sync_payee_country, sync_payee_account.

The sync_payee_id might be populated when: either a payment request (pay_bill method is called) or an add payee request (add_payee method is called) has been sent to the payment server, or when the sync_payee_aggregate has been set.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_id_scope Property

Scope of the payee Id .

Syntax

def get_sync_payee_id_scope(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Scope of the payee sync_payee_id.

Possible values are:

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_list_id Property

Server-assigned payee list record ID for this payee.

Syntax

def get_sync_payee_list_id(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Server-assigned payee list record ID for this payee.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a sync_payee_id, the sync_payee_list_id is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a sync_payee_id to this payee.

It is assigned by the server to that payee when an add payee request (via add_payee method) or bill payment request (via pay_bill method) has been sent.

The value of sync_payee_list_id is used as parameter when the modify_payee or delete_payee methods are called (when modifying or deleting a payee). In all other payment requests is optional.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_name Property

Name of the payee to whom the given Id or ListId corresponds.

Syntax

def get_sync_payee_name(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Name of the payee to whom the given sync_payee_id or sync_payee_list_id corresponds. This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

After sending payment or add/modify payee requests, if the returned sync_payee_id_scope is GLOBAL, the sync_payee_name will contain the standard payee name returned by the server.

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_phone Property

Payee's phone.

Syntax

def get_sync_payee_phone(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Payee's phone.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_postal_code Property

Payee's postal code.

Syntax

def get_sync_payee_postal_code(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Payee's postal code.

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_state Property

Payee's state This is required to be provided in : a payment request if payee detailed information is used to identify the payee (i.

Syntax

def get_sync_payee_state(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Payee's state

This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when payee_id is not provided in the request when either pay_bill or modify_payment methods are called);
• adding or modifying a payee (when the add_payee or modify_payee methods are called).

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payee_tx_type Property

Transaction type performed on the payee being synchronized.

Syntax

def get_sync_payee_tx_type(sync_payee_index: int) -> str: ...

Default Value

""

Remarks

Transaction type performed on the payee being synchronized.

This is applicable to payee synchronization requests only. Possible values and their meanings are as follows:

The sync_payee_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payee_count property.

This property is read-only.

sync_payment_count Property

The number of records in the SyncPayment arrays.

Syntax

def get_sync_payment_count() -> int: ...

sync_payment_count = property(get_sync_payment_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• sync_payment_aggregate
• sync_payment_amount
• sync_payment_bill_ref
• sync_payment_check_number
• sync_payment_currency_code
• sync_payment_date_due
• sync_payment_date_processed
• sync_payment_id
• sync_payment_memo
• sync_payment_payee_account
• sync_payment_payee_aggregate
• sync_payment_payee_id
• sync_payment_payee_list_id
• sync_payment_status
• sync_payment_tx_type

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

This property is read-only.

sync_payment_aggregate Property

Wrapper for a payment details.

Syntax

def get_sync_payment_aggregate(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for a payment details.

This string consists of all the payment's properties sync_payment_id, sync_payment_status, sync_payment_amount, sync_payment_from_bank_id, sync_payment_from_account_id, sync_payment_from_account_type, sync_payment_memo, sync_payment_check_number, etc..

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.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_amount Property

Payment amount.

Syntax

def get_sync_payment_amount(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Payment amount. This is to be provided when sending a bill payment request.

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.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_bill_ref Property

Biller-supplied reference information when paying a bill, if available.

Syntax

def get_sync_payment_bill_ref(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Biller-supplied reference information when paying a bill, if available.

This is optional when submitting a payment request.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_check_number Property

Check number assigned by the server to this payment.

Syntax

def get_sync_payment_check_number(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Check number assigned by the server to this payment.

This will be returned in the server response (if available) when the request succeeds.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_currency_code Property

Default currency code for this transaction.

Syntax

def get_sync_payment_currency_code(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Default currency code for this transaction.

This indicates the currency in which the payment will be carried out.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_date_due Property

Processing date requested by user for the payment to be sent.

Syntax

def get_sync_payment_date_due(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Processing date requested by user for the payment to be sent.

This is required to be provided in any bill payment or payment modification requests.

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.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_date_processed Property

Payment processing date.

Syntax

def get_sync_payment_date_processed(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Payment processing date.

This indicates the date when the event described by sync_payment_status occurs.

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.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_id Property

Transaction Id assigned by the server to the payment.

Syntax

def get_sync_payment_id(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Transaction Id assigned by the server to the payment.

The sync_payment_id is returned after a bill payment request (when calling the pay_bill method, which can be either a single payment or a recurring payment model).

This identifier value can be used as reference to this payment or model in any modification or cancellation request (as parameter when the modify_payment or cancel_payment methods are called).

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_memo Property

Memo attached to this payment from the customer to payee.

Syntax

def get_sync_payment_memo(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Memo attached to this payment from the customer to payee.

This is optional when submitting a payment request.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_payee_account Property

User's account number with the payee this payment was sent to.

Syntax

def get_sync_payment_payee_account(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

User's account number with the payee this payment was sent to.

This string uniquely identifies the customer in the payee (biller) system.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_payee_aggregate Property

Wrapper for the payee details this payment was sent to.

Syntax

def get_sync_payment_payee_aggregate(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Wrapper for the payee details this payment was sent to.

This string consists of these payee's data: name, address, city, state, country, postal code, country and phone.

When the synchronize_payments is called, the on_sync_payments event is fired for each payment in the payment list. Among other payment data returned through this event's parameters, there is also a PayeeAggregate parameter.

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.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_payee_id Property

Server-assigned identifier to the payee this payment was sent to.

Syntax

def get_sync_payment_payee_id(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Server-assigned identifier to the payee this payment was sent to.

The sync_payment_payee_id is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either sync_payment_payee_aggregate or sync_payment_payee_id can be returned in the response, but not both.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_payee_list_id Property

Server-assigned payee list record ID for the payee this payment was sent to.

Syntax

def get_sync_payment_payee_list_id(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Server-assigned payee list record ID for the payee this payment was sent to.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a sync_payment_payee_id, the sync_payment_payee_list_id is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a sync_payment_payee_id to this payee.

This is assigned by the server to that payee when an add payee request (via add_payee method) or bill payment request (via pay_bill method) has been sent.

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_status Property

Payment processing status.

Syntax

def get_sync_payment_status(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Payment processing status.

The possible values of this property are as follows:

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

sync_payment_tx_type Property

Transaction type performed on the payment being synchronized.

Syntax

def get_sync_payment_tx_type(sync_payment_index: int) -> str: ...

Default Value

""

Remarks

Transaction type performed on the payment being synchronized.

This is applicable to payment synchronization requests only. Possible values and their meanings are as follows:

The sync_payment_index parameter specifies the index of the item in the array. The size of the array is controlled by the sync_payment_count property.

This property is read-only.

timeout Property

The timeout for the class.

Syntax

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

timeout = property(get_timeout, set_timeout)

Default Value

60

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.

Note: By default, all timeouts are inactivity timeouts, that is, 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.

add_payee Method

Add a payee to server's payee list.

Syntax

def add_payee() -> None: ...

Remarks

This function generates the Signon and Add Payee request, submits it to the financial institution via HTTP, receives the response, and parses it.

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

Upon a successful reply, the following read-only properties are populated as a result of parsing the server response:

cancel_payment Method

Cancels a scheduled bill payment.

Syntax

def cancel_payment(payment_id: str) -> None: ...

Remarks

This function generates the Signon and Payment Cancellation request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The PaymentId parameter identifies the payment to be canceled. This is the id assigned and returned by the server at the time the payment was scheduled (that was stored in payment_id).

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

Upon successful response, the server will return the payment_id which echoes the PaymentId.

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.

delete_payee Method

Deletes a payee identified by ListId from the server payee list.

Syntax

def delete_payee(list_id: str) -> None: ...

Remarks

This function generates the Signon and Delete Payee request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The ListId parameter identifies the payee to be deleted. This is the id returned by the server at the time the payee was added to the payee list (that was stored in payee_list_id).

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

Upon successful response, the server will return the payee_list_id that echoes the ListId input parameter.

get_status Method

Obtains the current processing status of a payment.

Syntax

def get_status(payment_id: str) -> None: ...

Remarks

The PaymentId parameter identifies the payment you want to obtain the status for. This is the id returned by the server at the time the payment was scheduled (that was stored in payment_id).

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

Upon successful response, the server will return the following:

modify_payee Method

Modifies a payee identified by ListId that already exists in the payee list.

Syntax

def modify_payee(payee_list_id: str) -> None: ...

Remarks

This function generates the Signon and Payee Modification request, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

When modifying a payee by calling the modify_payee method, the user must specify the changed and unchanged payee information (i.e., all the properties that were specified when the payee was first added to the server list).

The ListId parameter identifies the payee to be modified. This is the id returned by the server at the time the payee was added to the payee list.

The response normally just echoes the values passed in the request. However, when a change had already occurred in the server to the payee information (for example a change in the payee's lead time, indicated by payee_days_to_pay), the response will include this information as well.

If the response indicates either that a payee now has a payee ID (a non-empty payee_id is returned in the response) or no longer has one (an empty payee_id is returned), then the user now becomes aware that this ID cannot be used as an appropriate form of designating the payee in any future payment requests to that payee.

modify_payment Method

Modifies a scheduled payment.

Syntax

def modify_payment(payment_id: str) -> None: ...

Remarks

This function generates the Signon and Payment Modification request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The PaymentId parameter identifies the targeted payment to be modified. This is the id assigned and returned by the server at the time the payment was scheduled (that was stored in payment_id).

Between the time the client schedules a payment and the time the server processes the payment, the client may request changes (if the server allows it) to certain parameters of that payment. For example, the payment_amount or payment_date_due of the payment can be modified. This can be done by calling the modify_payment method. The request must specify the full contents of the payment request, including both modified and unmodified data.

The user should provide all the fields that were specified when the payment to be modified was created (when the pay_bill method was called) and the payee_list_id if this was assigned. All data can be modified except the payee_name and payee_id.

The response normally just echoes the values passed in the request. However, if the status of a scheduled payment changes in any way, the user should expect to receive modification responses when synchronizing with the server by calling synchronize method. For example, when a server completes a payment, the status of the payment goes from pending to posted. This status change will be included in the server response.

Please check your FI profile to see if they provide this service (bill payment modification).

pay_bill Method

Pays a bill to a given payee.

Syntax

def pay_bill() -> None: ...

Remarks

This function generates the Signon and Bill Payment request page, submits it to the financial institution via HTTP, receives the response, and parses it.

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

Payee information can be provided in the request by either setting each Payee property, or by setting the payee_aggregate property, the value of which can be retrieved after submitting a payee synchronization request (by calling the synchronize_payees method).

Even when payee_aggregate property has been set, the user can still set any payee field to values different from the ones that are populated via payee_aggregate. When this happens, the server will consider this payment request as payee modification request as well. As result, that payee will be modified in the payment system accordingly.

Upon a successful reply, the following read-only properties are populated as a result of parsing the server response:

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.

synchronize_payees Method

Synchronizes payees on the client side with payees on record on the server side.

Syntax

def synchronize_payees(token: str) -> str: ...

Remarks

Users of OFX Payments need to be able to obtain the current list of payees stored on the server that is configured for use in payments. In a "pay some" system, users are sometimes required to explicitly configure the payees to whom the system will make payments. This can be done by means of a telephone call to the payments provider or through other methods such as add_payee or pay_bill. It is only necessary to enter each payee once. In other systems, the payments provider can elect to store a list of all payees that the user has paid. This is a convenience to the client. It allows payees set up on one client to be accessible from a user's other clients. In this case, payee list synchronization provides a way for the payee to become accessible to the client software when the FI completes the setup.

The list can contain payees with or without payee IDs. An important function of the payee list is to communicate payee changes from the server to the client. This includes changes in processing date parameters and conversion of a payee to a standard payee.

Once added to the list, the payment system makes payments by the payee list ID. This makes it clear to a client when the user is adding to a payee list, and when he or she modifies an existing payee on the list. Although the messages make it clear whether a client is trying to add a new payee, a careful server will check for exact matches on payee adds and not create new payee list entries unnecessarily.

"Pay-any" systems can perform background processing that matches billing addresses with standard payees. When this occurs the server can update the relevant payee lists, and update the clients when they synchronize with the modified list data. Each payee entry in the list can also include a list of the user's accounts with that payee. This further reduces the data entry required by a user to make a payment, and facilitates the implementation of lightweight clients.

In order to accomplish these tasks, the user has to submit a synchronization request by calling synchronize_payees method to insure that it has an accurate copy of the server data that is relevant to the client application. The intent of this request is to address the following scenarios in which the client might lose synchronization with the server:

• Payees relevant to the client's application state have been added, deleted, or modified by a second client. For example, a user might enter or change payees from more than one PC or application.
• A communications session between the client and server was interrupted or completed abnormally. As a result, the client does not have responses from the server indicating that all the payees were received and processed.

If this request is submitted for the first time to the server, the Token parameter has to be 0. In this case, servers should send all available history, allowing a new client (for example) to know about work done by other clients. If a user's account has never been used with OFX, the server returns no history.

Unless the synchronization is a refresh request (see below), in all subsequent requests, this has to be the previous value of Token this method returned (i.e., received for this type of synchronization request from the server). This will serve as the user's own endpoint. When the server supplies a response, it supplies a new endpoint (Token) as well. A token needs to be unique only within payments for the specified account.

A brand new client, or a client that lost synchronization, might want to learn about mot recent payee list by submitting a payee synchronization refresh (i.e., wants a set of changes, rather than asking the server to send everything it knows).

A client can request a refresh of current state by calling the synchronize_payees method, where Token parameter is set to REFRESH (not case sensitive). The response will reflect the current state. For example, if you create a payee and then modify it three times, even if this history would have been available for a regular synchronization, on a synchronization refresh request the servers should only send a single add that reflects the current state.

If the response contains a list of payees, then the sync_payees property will be populated and on_sync_payees event will be fired for each payee. A single payee has a single payee_id and/or payee_list_id, but it can undergo several state changes over its life and thus might have several entries in the token history.

synchronize_payments Method

Synchronizes bills paid on the client side with paid bills on record on the server side.

Syntax

def synchronize_payments(token: str) -> str: ...

Remarks

The bill payment synchronization request (as all other bill payment requests: add, modify, cancel) is applicable for bank accounts only and not for the credit card accounts.

Users of OFX Payments need to be able to obtain the current status of transactions previously sent to the server for processing. For example, once the user schedules a payment and the payment date has passed, the user might want to verify that the server made the payment as directed. Additionally, OFX allows for interactions with the server through multiple clients. This means, for example, that the user can perform some transactions from a home PC and others from an office computer with each session incorporating the activities performed on the other. In order to accomplish these tasks, the user has to submit a synchronization request by calling synchronize_payments method to insure that it has an accurate copy of the server data that is relevant to the client application. The intent of this request is to address three scenarios in which the client might lose synchronization with the server:

• A transaction has changed its state based on processing actions on the server. For example, a scheduled payment has passed its due date and has been paid or rejected.
• Transactions relevant to the client's application state have been added, deleted, or modified by a second client. For example, a user might enter or change transactions from more than one PC or application.
• A communications session between the client and server was interrupted or completed abnormally. As a result the client does not have responses from the server indicating that all the transactions were received and processed.

If this request is submitted for the first time to the server, the Token parameter has to be 0. In this case, servers should send all available history, allowing a new client (for example) to know about work done by other clients. If a user's account has never been used with OFX, the server returns no history.

Unless the synchronization is a refresh request (see below), in all subsequent requests, this has to be the previous value of Token this method returned (i.e., received for this type of synchronization request from the server). This will serve as the user's own endpoint. When the server supplies a response, it supplies a new endpoint (Token) as well. A token needs to be unique only within payments for the specified account.

A brand new client, or a client that lost synchronization, might want to learn about in-progress payments by submitting a synchronization refresh of the payment requests (i.e., wants a set of changes, rather than asking the server to send everything it knows). It would almost certainly want to do a synchronization refresh of the recurring payment models, because these often live for months or years.

A client can request a refresh of current state by calling the synchronize_payments where Token parameter is set to REFRESH (not case sensitive). The response will reflect the current state. For example, if you create a payment and then modify it three times, even if this history would have been available for a regular synchronization, on a synchronization refresh request the servers should only send a single add that reflects the current state.

The following properties have to be set when this method is called:

Upon a successful reply, if the response contains payment aggregates, then the sync_payments property will be populated and on_sync_payments event will be fired for each payment transaction. A single payment has a single payment_id, but it can undergo several state changes over its life and thus might have several entries in the token history.

on_connection_status Event

Fired to indicate changes in the connection state.

Syntax

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

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

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

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

Remarks

This 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:

on_error Event

Fired when information is available about errors during data delivery.

Syntax

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

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

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

Remarks

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

The ErrorCode parameter contains an error code, and the Description parameter 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 BillPaymentSSLServerAuthenticationEventParams(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 BillPayment:
@property
def on_ssl_server_authentication() -> Callable[[BillPaymentSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[BillPaymentSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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

Fired when secure connection progress messages are available.

Syntax

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

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

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_sync_payees Event

Fired for each payee included in the synchronization response.

Syntax

class BillPaymentSyncPayeesEventParams(object):
  @property
  def payee_aggregate() -> str: ...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# In class BillPayment:
@property
def on_sync_payees() -> Callable[[BillPaymentSyncPayeesEventParams], None]: ...
@on_sync_payees.setter
def on_sync_payees(event_hook: Callable[[BillPaymentSyncPayeesEventParams], None]) -> None: ...

Remarks

When this event is fired for each payee included in the response (if any), the following are returned for each payee identified by PayeeListId:

• PayeeAggregate contains the complete aggregate for a payee.
• PayeeTxType indicates the payee transaction type, if this is added, modified or deleted (possible values: ADDED, MODIFIED, DELETED).
• PayeeId contains the server-assigned id of a payee.
• PayeeIdScope contains Scope of a payee ID in the payee list (GLOBAL, USER), where GLOBAL = payee ID valid across the entire payment system USER = payee ID valid with all FI accounts set up for the user's payments account.
• PayeeListId contains the list record id of a payee in the payee list.
• PayeeAccount contains the account the user has with a payee in the payee list.
• PayeeName contains the name of a payee in the payee list.
• PayeeAddr1 contains the street address (line 1) of a payee in the payee list.
• PayeeAddr2 contains the address line 2 of a payee in the payee list.
• PayeeAddr3 contains the address line 3 of a payee in the payee list.
• PayeeCity contains the city name of a payee in the payee list.
• PayeeState contains the state name of a payee in the payee list.
• PayeePostalCode contains the postal code of a payee in the payee list.
• PayeeCountry contains the country name of a payee in the payee list.
• PayeePhone contains the phone number of a payee in the payee list.

If what you need is not returned through this event parameters, you can always parse each PayeeAggregate using our OFXAggregate component.

on_sync_payments Event

Fired for each payment transaction included in the synchronization response.

Syntax

class BillPaymentSyncPaymentsEventParams(object):
  @property
  def payment_aggregate() -> str: ...

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

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

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

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

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

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

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

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

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

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

# In class BillPayment:
@property
def on_sync_payments() -> Callable[[BillPaymentSyncPaymentsEventParams], None]: ...
@on_sync_payments.setter
def on_sync_payments(event_hook: Callable[[BillPaymentSyncPaymentsEventParams], None]) -> None: ...

Remarks

When this event is fired for each payment transaction included in the response (if any), the following are returned for each payment transaction identified by PaymentId:

• PaymentAggregate contains the aggregate for a payment transaction.
• PaymentTxType indicates the payment transaction type, if this is added, modified or canceled (possible values: ADDED, MODIFIED, CANCELLED).
• PaymentId contains the server id of a transaction in the list of payment transactions (if any) returned in the synchronization response.
• PayeeId contains the id of the payee the payment has been sent to.
• PayeeListId contains the list id of the payee the payment has been sent to.
• PayeeAccount contains the account the user has with the payee the payment has been sent to.
• PayeeAggregate contains the info aggregate (name and address details) of the payee the payment has been sent to.
• PaymentAmount contains the amount of a payment transaction.
• FromAccountId contains the account number a payment has been sent from.
• PaymentStatus contains the status of a payment transaction.
• PaymentDate contains the date of a payment transaction.

If what you need is not returned through this event, you can always parse each PaymentAggregate using our OFXAggregate component.

BillPayment Config Settings

OFX Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

BillPayment Errors

OFX Errors

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

XML Errors

HTTP Errors

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

TCPClient Errors

SSL Errors

TCP/IP Errors