CancelPayment Method

Cancels a scheduled bill payment.

Syntax

billpayment.cancelPayment(paymentId, [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 Payment Cancellation request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

The PaymentId parameter identifies the payment to be canceled. This is the id assigned and returned by the server at the time the payment was scheduled (that was stored in PaymentId).

The following properties should be set when this method is called:

Upon successful response, the server will return the PaymentId which echoes the PaymentId.