CancelTransfer Method
Cancels a scheduled transfer.
Syntax
banktransfer.cancelTransfer(transferId, [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 Transfer Cancellation request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.
The TransferId parameter identifies the transfer to be canceled. This is the id assigned and returned by the server at the time the transfer was scheduled (that was stored in TransferId).
The following properties should be set when this method is called:
| FIUrl | (required) |
| FIId | (required) |
| FIOrganization | (required) |
| OFXAppId | (required) |
| OFXAppVersion | (required) |
| OFXVersion | (required if 2.x OFX version is the one supported by your FI) |
| OFXUser | (required) |
| OFXPassword | (required) |
Upon successful response, the server will return the TransferId which echoes the TransferId.