Heartland Portico Retail File Batch


Parent:    File Batch
Added On:  04/29/13 
Module:  UniCharge 
Type:  Entity  Status:  Active 
Java Class:  HeartlandPorticoRetailFileBatch 
Heartland Portico specific File Batch representation for the settlement process. It represents a group of Heartland Portico Capture Retail Transaction objects that are settled together as a group within a single file.
During Generation Process, Heartland Portico Retail File Batch is converted into a settlement file, which is then registered into File Store for further processing.
Added On:  04/29/13
SQL Column:  BATCH_ID
Java Field:  batchId
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Batch identifier assigned by the Portico Gateway.
Exact Match
Added On:  04/29/13
SQL Column:  BATCH_SEQ_NBR
Java Field:  batchSeqNbr
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Batch Sequence Number; incremented with each batch opened by a device.
Exact Match.
Added On:  04/29/13
SQL Column:  DEVELOPER_ID
Java Field:  developerId
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Developer Identifier, field length is exactly 6 characters. NOTE: Even though this field is optional in the schema, it is now required for all new certifications.
Added On:  04/29/13
SQL Column:  DEVICE_ID
Java Field:  deviceId
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Device identifier, assigned by Heartland Payment Systems during registration.
Added On:  05/29/13
SQL Column:  GATEWAY_RSP_CODE
Java Field:  gatewayRspCode
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
Response code returned by the Portico Gateway.
Added On:  05/29/13
SQL Column:  GATEWAY_RSP_MSG
Java Field:  gatewayRspMsg
Status:  Active
SQL Type:  varchar(250)
Java Type:  String
Attributes:
Response message returned by the Portico Gateway.
Added On:  05/29/13
SQL Column:  GATEWAY_TXN_ID
Java Field:  gatewayTxnId
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Transaction identifier.

Assigned by the Portico Gateway.
Added On:  04/29/13
SQL Column:  LICENSE_ID
Java Field:  licenseId
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
License identifier, assigned by Heartland Payment Systems Administrator during registration.
Added On:  06/10/16
SQL Column:  
Java Field:  password
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  05/29/13
SQL Column:  RSP_DT
Java Field:  rspDt
Status:  Active
SQL Type:  varchar(27)
Java Type:  String
Attributes:
The transaction response date and time in the merchant’s time zone that is stored on the Portico Gateway.
This is expected to be used for printing date and time on receipts.
Added On:  04/29/13
SQL Column:  SITE_ID
Java Field:  siteId
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Site identifier, assigned by Heartland Payment Systems during registration.
Added On:  04/29/13
SQL Column:  SITE_TRACE
Java Field:  siteTrace
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Specified by client and echoed in the response for validation.
Maximum characters = 30
Added On:  06/07/13
SQL Column:  TOTAL_AMOUNT
Java Field:  totalAmount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Sum of transaction amounts in the batch.
Added On:  04/29/13
SQL Column:  TOTAL_AMT
Java Field:  totalAmt
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Total transaction amount in the batch.

Total digits = 12 (10 before the decimal and 2 after)
Added On:  06/07/13
SQL Column:  TOTAL_COUNT
Java Field:  totalCount
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes:
Number of transactions in the batch.
Added On:  04/29/13
SQL Column:  TXN_CNT
Java Field:  txnCnt
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Number of transactions in the batch.
Added On:  04/29/13
SQL Column:  USER_NAME
Java Field:  userName
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
User name, assigned by Heartland Payment Systems Administrator during registration.
Added On:  04/29/13
SQL Column:  VERSION_NBR
Java Field:  versionNbr
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
POS Version Number

The field length is exactly four characters.

NOTE:
Even though this field is optional in the schema, it is now required for all new certifications.