For a typical batch management request the client must provide the following information:
Field
Type
Length (chars)
Description
Example
Card terminal support
msgLength
String
4
A 4-digit number padded with leading zeros indicating message length minus 4 (including any separators). The request will be rejected if the correct message length is not provided.
‘0063’
sessionId
String
6
A unique number to control integrity of session sequence.
‘002690’
msgType
String
3
‘500’
‘500’
command
String
5
Specifies the request action. “open” to create a new batch, “close” to close the batch
‘open’
batchName
String
variable up to 20
When opening a new batch, this parameter will be used as the batch name. If no value is provided, the batch will be named automatically. When closing a batch, this parameter will be used in order to find an open batch with this name. If no value is provided, the currently active batch will be closed.
'name'
batchId
String
variable up to 50
This parameter is used only when closing a batch and tries to close the batch with this specific UUID./td>
‘d3fdc9c5-2975-4612-bf52-8c43cd2eb1ba’
The above information elements must be joined into one single string using ‘|’ as a separator. i.e.
The table below summarizes the contents of the response.
Field
Length (chars)
Description
Example
Card terminal support
msgLength
4
A 4-digit number padded with leading zeros indicating the length of the message that follows (including separators). Note that this is the total number of bytes and not of characters (in some languages, some characters consist of 2 bytes).
'0063'
sessionId
6
A unique number to control integrity of session sequence.
'002690'
msgType
3
‘500’
‘500’
command
5
Specifies the request action. “open” to create a new batch, “close” to close the batch
'open'
respCodeResp
2
Approval status. '00' indicates approval. All other values indicate failure codes. See failure code table at the end.
'00'
respMessageResp
variable up to 60
A string containing information on how the transaction was made, the card holder verification method used, the RRN and the Auth.code provided by the host.
'00'
batchName
variable up to 20
When opening a new batch, this parameter will be used as the batch name. If no value is provided, the batch will be named automatically.
When closing a batch, this parameter will be used in order to find an open batch with this name. If no value is provided, the currently active batch will be closed.
'name'
batchId
variable up to 50
This parameter is used only when closing a batch and tries to close the batch with this specific UUID.
‘d3fdc9c5-2975-4612-bf52-8c43cd2eb1ba’
Get Support
If you have any questions about our solutions, or questions about how to integrate with our solutions, please refer to our Get Support page.