TSYSHCBatchMgrResponse Type

Contains the response to the batch management request.

Remarks

This type contains the results of an adjustment transaction made with the TSYSHCBatchMgr bean. The fields contained by this type are listed below.

Fields

BatchNumber
int

Contains the incrementing ID assigned by TSYS to identify a merchant batch.

The batch number that is returned by the host is the current batch number. This will typically the same batch number used by TSYSHCBatchMgr to close the batch.

Note that if CaptureMode is set to Delay, Hold, or Capture the value here may not necessarily be the final batch number when captured. See CaptureMode for more details.

CloseDate
String

The date that the batch was closed (in MMDDYY format).

Note that this indicates when the batch close began, rather than when the batch close completed. The date is local based on the host-stored time zone differential. If this value is not available, the time will be in Pacific time.

CloseTime
String

The time that the batch was closed (in HHMMSS format).

Note that this indicates when the batch close began, rather than when the batch close completed. The time is local based on the host-stored time zone differential. If this value is not available, the time will be in Pacific time.

Code
String

Indicates the status of the close batch request.

This field contains the response code indicating the status of a batch management request. The Point of Sale (POS) system must evaluate this response code and NOT the Text to determine nature of a response message. A response code of "00" represents a successful request. All other response codes represent non-approved requests.


Response Code	Response Text	Definition
00	"ACCEPTED" or "DATA RETRIEVED"	If CloseBatch is called response text will be "ACCEPTED", otherwise it will be "DATA RETRIEVED".
01	"EXCEEDED LIMIT"	The requested batch or transaction was not in the allowable limits (current, previous, or last 5 batches).
02	"COULD NOT FIND"	The host system could not find the batch or the transaction that was requested.
03	"NOT ALLOWED"	An invalid request was entered.
04	"SYSTEM ERROR"	The host system was not able to process the request due to some internal issue, maintenance, or other system error.
05	"ALREADY CLOSED"	During a batch close request, the batch was already found to have been closed. A batch summary will be provided with the pertinent information.
06	"NOT IN BATCH"	The requested Adjustment or Void was not in the current batch.

Status
String

The current status of the batch in an inquiry.

A value of "O" indicates that the batch is still open. A value of "C" indicates that the batch has been closed and sent on to the settlement system.

Text
String

Text information that describes each response code.

This field contains a 32-character response or display text message. This message is used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message. VisaNet will translate the response according to the merchant's selected language. The English-language response text messages are listed in the table of contents.

Constructors

public TSYSHCBatchMgrResponse();