AddPayee Method
Add a payee to server's payee list.
Syntax
ANSI (Cross Platform) int AddPayee(); Unicode (Windows) INT AddPayee();
- (void)addPayee;
#define MID_BILLPAYMENT_ADDPAYEE 2 IPWORKSOFX_EXTERNAL int IPWORKSOFX_CALL IPWorksOFX_BillPayment_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
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:
| FIUrl | (required) |
| FIId | (required) |
| FIOrganization | (required) |
| OFXAppId | (required) |
| OFXAppVersion | (required) |
| OFXUser | (required) |
| OFXPassword | (required) |
| Payee | (required) |
| PaymentToBankId | (optional) |
| PaymentToAccountId | (optional) |
| PaymentToAccountType | (optional) |
Upon a successful reply, the following read-only properties are populated as a result of parsing the server response:
| PayeeId | (optional) |
| PayeeListId | (always returned) |
| PayeeDaysToPay | (always returned) |
| PayeeIdScope | (optional) |
| all input values for payee (name, address, phone, account) and destination bank account are echoed in the response |
Error Handling (C++)
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.)