PayBill Method
Pays a bill to a given payee.
Syntax
int PayBill();
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 |
Error Handling
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)