TransferFromBranchId Property

Identifier for the bank where the transfer is originating from (international banks only).

Syntax

 banktransfer.getTransferFromBranchId([callback])
 banktransfer.setTransferFromBranchId( transferFromBranchId, [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 getTransferFromBranchId([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 setTransferFromBranchId([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

Identifier for the bank where the transfer is originating from (international banks only).

This is optional to be provided when initiating or modifying a transfer (i.e., when TransferFunds or ModifyTransfer methods are called).

The TransferFromBranchId is applicable for international banks only, and if this applies, it can be provided in the request only if TransferFromAccountType is set to a value different than CreditCard. Otherwise, it should not be set.

This property is not available at design time.

Data Type

String