ModifyPayee Method
Modifies a payee identified by ListId that already exists in the payee list.
Syntax
ANSI (Cross Platform) int ModifyPayee(const char* lpszPayeeListId); Unicode (Windows) INT ModifyPayee(LPCWSTR lpszPayeeListId);
- (void)modifyPayee:(NSString*)payeeListId;
#define MID_BILLPAYMENT_MODIFYPAYEE 7 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 Payee Modification request, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.
When modifying a payee by calling the ModifyPayee method, the user must specify the changed and unchanged payee information (i.e., all the properties that were specified when the payee was first added to the server list).
The ListId parameter identifies the payee to be modified. This is the id returned by the server at the time the payee was added to the payee list.
The response normally just echoes the values passed in the request. However, when a change had already occurred in the server to the payee information (for example a change in the payee's lead time, indicated by PayeeDaysToPay), the response will include this information as well.
If the response indicates either that a payee now has a payee ID (a non-empty PayeeId is returned in the response) or no longer has one (an empty PayeeId is returned), then the user now becomes aware that this ID cannot be used as an appropriate form of designating the payee in any future payment requests to that payee.
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.)