DeletePayee Method
Deletes a payee identified by ListId from the server payee list.
Syntax
ANSI (Cross Platform) int DeletePayee(const char* lpszListId); Unicode (Windows) INT DeletePayee(LPCWSTR lpszListId);
- (void)deletePayee:(NSString*)listId;
#define MID_BILLPAYMENT_DELETEPAYEE 5 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 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 PayeeListId).
The following properties should be set when this method is called:
| FIUrl | (required) |
| FIId | (required) |
| FIOrganization | (required) |
| OFXAppId | (required) |
| OFXAppVersion | (required) |
| OFXUser | (required) |
| OFXPassword | (required) |
Upon successful response, the server will return the PayeeListId that echoes the ListId input parameter.
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.)