BatchNumber Property

Sequence number of this batch transaction.

Syntax

 tsyssettle.getBatchNumber([callback])
 tsyssettle.setBatchNumber( batchNumber, [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 getBatchNumber([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 setBatchNumber([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

This property contains a three digit batch sequence number generated by the Point of Sale (POS) device. The batch number must be within the range "001" to "999". If the POS device is automatically incrementing the batch number, it should automatically advance the number from "999" to "001"("000" is invalid). Batch numbers must not be reused or repeated within 5 consecutive days.

This is a Header Property, and needs to be set once for a single Batch Settlement transaction.

If the transaction is successful, the ResponseCode will contain "GB", which indicates a "Good Batch". You should check that the ResponseNetDeposit and ResponseRecordCount match the BatchNetDeposit and BatchRecordCount properties.

If the transaction is not successful and you receive an "RB" ResponseCode (indicating a "Rejected Batch") the class fails with an error. You may inspect the ErrorData. ErrorDataFieldNumber, ErrorRecordType, ErrorSequenceNumber, and ErrorType properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the BatchNumber must be set to the same value that was originally used. It is critical that the same BatchNumber value is used to avoid duplicate charges.

Data Type

Integer