TransferId Property

Server-assigned id of the bank transfer being initiated, modified or synchronized.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
char* GetTransferId();
int SetTransferId(const char* lpszTransferId);

Unicode (Windows)
LPWSTR GetTransferId();
INT SetTransferId(LPCWSTR lpszTransferId);

@property (nonatomic,readwrite,assign,getter=transferId,setter=setTransferId:) NSString* transferId;
- (NSString*)transferId;
- (void)setTransferId:(NSString*)newTransferId;

#define PID_BANKTRANSFER_TRANSFERID 49

IPWORKSOFX_EXTERNAL void* IPWORKSOFX_CALL IPWorksOFX_BankTransfer_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSOFX_EXTERNAL int IPWORKSOFX_CALL IPWorksOFX_BankTransfer_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

""

Remarks

Server-assigned id of the bank transfer being initiated, modified or synchronized.

The TransferId uniquely identifies a transfer. This is assigned by the server when the transfer is initiated (when the TransferFunds method is called.

As a unique transfer identifier, the TransferId is required to be provided (as parameter) when a transfer modification or cancellation requests are submitted (i.e., when ModifyTransfer or CancelTransfer methods are called) for a scheduled transfer.

This is also required to be provided when submitting the same request types via the OFXBatch class (for each transfer that is going to be part of the batch).

It is also returned for each payment being synchronized when the SynchronizeTransfers method is called.

This property is not available at design time.

Data Type

String