TransferId Property

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

Syntax

 banktransfer.getTransferId([callback])
 banktransfer.setTransferId( transferId, [callback])

Default Value

""

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 the getTransferId([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setTransferId([callback]) 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

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