SyncTransferDateDue Property

Date the bank transfer (being initiated, modified or synchronized) is scheduled to be sent.

Syntax

 banktransfer.getSyncTransferDateDue(index, [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 getSyncTransferDateDue([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 setSyncTransferDateDue([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

Date the bank transfer (being initiated, modified or synchronized) is scheduled to be sent.

This can be provided when sending a bank transfer request (initiating or modifying a transfer when either TransferFunds or ModifyTransfer methods are called. In these cases, if the SyncTransferDateDue is not specified in the request, the transfer is considered immediate by the server and it occurs as soon as possible. However, this is required for scheduled transfers.

This is also returned in the server response when these methods are called. However, the value may have been adjusted by the server. For example, the server may adjust due date to comply with non-processing days. If a client sends a request to make a transfer on July 4 and July 4 happens to be a non-processing day, the due date in the response may be July 4 (because the server hasn't adjusted it yet), July 5 (because this server rolls dates forward), or some other date. For this reason, the SyncTransferDateDue should be inspected as well.

It may also be returned for each payment being synchronized (when the SynchronizeTransfers methods is called) only if it was specified in the original bank transfer request. These values should be inspected as well as might be different from their original values (for the same reason mentioned above).

Note: Immediate intrabank funds transfers cannot be canceled as they are already committed.

All input dates should be entered in the format specified by DateFormat. For example, if the DateFormat is set to "MM/dd/yyyy hh:mm:ss" (default value), an input date should look like: 09/30/2009 12:00:00 AM.

This format specifies also how the returned dates are going to get parsed.

The size of the array is controlled by the SyncTransferCount property.

This property is read-only and not available at design time.

Data Type

String