CancelTransfer Method
Cancels a scheduled transfer.
Syntax
ANSI (Cross Platform) int CancelTransfer(const char* lpszTransferId); Unicode (Windows) INT CancelTransfer(LPCWSTR lpszTransferId);
- (void)cancelTransfer:(NSString*)transferId;
#define MID_BANKTRANSFER_CANCELTRANSFER 2 IPWORKSOFX_EXTERNAL int IPWORKSOFX_CALL IPWorksOFX_BankTransfer_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
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.
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.)