DeletePayee Method

Deletes a payee identified by ListId from the server payee list.

Syntax

billpayment.deletePayee(listId, [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 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:

Upon successful response, the server will return the PayeeListId that echoes the ListId input parameter.