syncTransferId (property)
Server-assigned id of the bank transfer being initiated, modified or synchronized.
Syntax
- (NSString*)syncTransferId:(int)syncTransferIndex;
public func syncTransferId(syncTransferIndex: Int32) throws -> String
Default Value
""
Remarks
Server-assigned id of the bank transfer being initiated, modified or synchronized.
The SyncTransferId 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 SyncTransferId 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.
The SyncTransferIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SyncTransferCount property.
This property is read-only.