PayBill Method
Pays a bill to a given payee.
Syntax
billpayment.payBill([callback])
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for this method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
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:
| FIUrl | (required) |
| FIId | (required) |
| FIOrganization | (required) |
| OFXAppId | (required) |
| OFXAppVersion | (required) |
| OFXUser | (required) |
| OFXPassword | (required) |
| Payment | (required) |
| Payee | (required) |
Payee information can be provided in the request by either setting each Payee property, or by setting the PayeeAggregate property, the value of which can be retrieved after submitting a payee synchronization request (by calling the SynchronizePayees method).
Even when PayeeAggregate property has been set, the user can still set any payee field to values different from the ones that are populated via PayeeAggregate. 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:
| PaymentCurrencyCode | |
| PaymentId | |
| PaymentStatus | |
| PaymentDateProcessed | |
| PaymentCheckNumber | |
| PayeeDaysToPay | |
| PayeeIdScope | |
| all input values for amount, bank account information, and payee information are echoed in the response |