BatchSequenceNumber Property

Starting sequence number for the transactions in this batch.

Syntax

 fdmssettle.getBatchSequenceNumber([callback])
 fdmssettle.setBatchSequenceNumber( batchSequenceNumber, [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 getBatchSequenceNumber([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 setBatchSequenceNumber([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

A batch settlement is made up of many separate transaction packets. The class creates these packets and posts them one-by-one to the Datawire VXN, where they are then routed to the FDMS payment processor. Each of these packets sent to Datawire must contain a unique transaction sequence identifier. This property contains the beginning sequence number, which the class will increment for each individual data payload sent in the batch settlement. It need not be numeric - the class will append a dash and then the sequence number for each packet. For instance: If you set the BatchSequenceNumber to "Batch5", each record will be sent with the sequence number "Batch5-0", "Batch5-1", "Batch5-2", etcetera, until each record in the batch has been sent.

Data Type

String