IPWorks OFX 2020 Python Edition

Questions / Feedback?

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:

fi_url (required)
fi_id (required)
fi_organization (required)
ofx_app_id (required)
ofx_app_version (required)
ofx_user (required)
ofx_password (required)
payment (required)
payee (required)

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:

payment_currency_code
payment_id
payment_status
payment_date_processed
payment_check_number
payee_days_to_pay
payee_id_scope
all input values for amount, bank account information, and payee information are echoed in the response

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