ModifyTransfer Method

Modifies a scheduled transfer.

Syntax

ANSI (Cross Platform)
int ModifyTransfer(const char* lpszTransferId);

Unicode (Windows)
INT ModifyTransfer(LPCWSTR lpszTransferId);
- (void)modifyTransfer:(NSString*)transferId;
#define MID_BANKTRANSFER_MODIFYTRANSFER 4

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 Modification request page, submits it to the financial institution via secure HTTP Post, receives the response, and parses it.

Only scheduled transfers can be modified, not the immediate ones.

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

When modifying a scheduled transfer by calling the ModifyTransfer method, the user should provide all the fields for source and destination account that were specified when the transfer was initiated (when the TransferFunds method was called), and not just the fields that are to be modified).

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)
Transfer (required)

The response normally just echoes the values passed in the request. However, if the status of a scheduled transfer changes in any way, the user should expect to receive modification responses when they synchronize with the server. For example, when a server completes a transfer, the status of the transfer goes from pending to posted. This status change will be included in the server response.

Please check your FI profile to see if they provide this service (transfer modification).

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.)

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 C++ Edition - Version 20.0 [Build 7941]