TransferStatus Property
Processing status code of the bank transfer being initiated, modified, canceled or synchronized.
Syntax
banktransfer.getTransferStatus([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 getTransferStatus([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 setTransferStatus([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
Processing status code of the bank transfer being initiated, modified, canceled or synchronized.
This is returned in the server response when the TransferFunds, ModifyTransfer, CancelTransfer and SynchronizeTransfers methods are called.
If the server provides this information, the possible values are:
Value | Description |
WILLPROCESSON | Transfer will be processed on TransferDateProcessed |
POSTEDON | Transfer was posted on TransferDateProcessed |
NOFUNDSON | There were insufficient funds to make transfer on TransferDateProcessed |
CANCELEDON | Transfer request was cancelled by the user |
FAILEDON | Unable to make transfer for unspecified reasons on TransferDateProcessed |
This property is read-only and not available at design time.
Data Type
String