STS Auth Retail Transaction UML


Added On:  07/30/14 
Module:  UniCharge 
Type:  Entity  Status:  Active 
Java Class:  StsAuthRetailTransaction 
STS specific low-level representation of Retail Transaction produced by Forward Transformation Process within Authorization Process.
During Generation Process, STS specific interchange message is generated from this object for authorization. Consequently, all fields of the object are mapped into message segments/elements.
Added On:  07/30/14
SQL Column:  ACTION_CODE
Java Field:  actionCode
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
The Action_Code tells what type of transaction you are sending.

Reffer to the STS Provider's Specification for more detailes.
Added On:  07/30/14
SQL Column:  ADDR1
Java Field:  addr1
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Cardholder's street address.
Added On:  07/30/14
SQL Column:  AMOUNT_BALANCE
Java Field:  amountBalance
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
This value is the remaining balance.
Added On:  07/30/14
SQL Column:  APPROVED_AMOUNT
Java Field:  approvedAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Amount approved (Can be less than requested amount – partial approval.)
This field only appears in response to action code 19 transactions.
Added On:  07/30/14
SQL Column:  AUTH_REFERENCE
Java Field:  authReference
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Authorization number returned when response code = 00. Use this number for follow-on requests such as Void or Add Tip.
Added On:  07/30/14
SQL Column:  BUSINESS_TYPE
Java Field:  businessType
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
R = Retail/Other;
F = Restaurant.
Default is R.
Added On:  09/12/14
SQL Column:  
Java Field:  cardNumber
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
The number of the credit card or bank account.
Added On:  07/30/14
SQL Column:  CHARGE_TRANSACTION_FK
Java Field:  chargeTransaction
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
References Charge Transaction
Attributes:
Reference to the entity that represents real-time financial transaction.
Added On:  07/30/14
SQL Column:  CITY
Java Field:  city
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Cardholder's City.
Added On:  07/30/14
SQL Column:  EMAIL_ADDR
Java Field:  emailAddr
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Cardholder's email address.
Added On:  09/12/14
SQL Column:  
Java Field:  expirationDate
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  07/30/14
SQL Column:  FIRST_NAME
Java Field:  firstName
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Cardholder's first name.
This field will have one space in it if the name is not in the database.
Added On:  07/30/14
SQL Column:  ID
Java Field:  id
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Identifier / Primary Key
Attributes: Unique, Required, CreateOnly, ReadOnly
Identifier of the object used for references; auto-incremented integer value.
Added On:  07/30/14
SQL Column:  LAST_NAME
Java Field:  lastName
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Cardholder's last name.
This field will have one space in it if the name is not in the database.
Added On:  07/30/14
SQL Column:  LIFE_POINTS_BALANCE
Java Field:  lifePointsBalance
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
No implied decimal.
Only returned for loyalty transaction requests. Required for loyalty requests.

Example: 200 = two hundred.
Added On:  07/30/14
SQL Column:  MERCHANT_ACCOUNT_CODE
Java Field:  merchantAccountCode
Status:  Active
SQL Type:  int(11)
Java Type:  Integer
Attributes: Required
Code of Merchant Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
Added On:  07/30/14
SQL Column:  MERCHANT_NUMBER
Java Field:  merchantNumber
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Merchant number assigned by processor or MSP.
Added On:  07/30/14
SQL Column:  MISC_MESSAGE
Java Field:  miscMessage
Status:  Active
SQL Type:  varchar(255)
Java Type:  String
Attributes:
This field can be used to give the merchant additional messages to display on receipts, etc. i.e. a Rewards Message.
Added On:  07/30/14
SQL Column:  PHONE1
Java Field:  phone1
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
Cardholder's primary phone number.
Added On:  07/30/14
SQL Column:  POINTS_AMOUNT
Java Field:  pointsAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
The amount of points of loyalty, present on card.

No Decimals implied.
Required for Action Codes 03 and 04.

Example: 20000 = 20 thousand.
Added On:  07/30/14
SQL Column:  POINTS_BALANCE
Java Field:  pointsBalance
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
No implied decimal.
Only returned for loyalty transaction requests. Required for loyalty requests.

Example: 200 = two hundred.
Added On:  07/30/14
SQL Column:  POS_ENTRY_MODE
Java Field:  posEntryMode
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
S = Swiped;
M = Manual.

Required except for Action Code 12 (Totals Inquiry).
Added On:  07/30/14
SQL Column:  RESPONSE_CODE
Java Field:  responseCode
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Each two digit response code maps to a specific response, i.e.

00 = Approved/Captured.
01 = Decline/Error
Added On:  07/30/14
SQL Column:  RESPONSE_TEXT
Java Field:  responseText
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Text associated with the transaction approval or decline Response_Code.
Added On:  07/30/14
SQL Column:  RETAIL_TRANSACTION_CYCLE_FK
Java Field:  retailTransactionCycle
Status:  Active
SQL Type:  bigint(20)
Java Type:  Long
Attributes:
Reference to the entity that represents a group of real-time transactions which must be settled together.
Added On:  07/30/14
SQL Column:  STATE
Java Field:  state
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Cardholder's State or Provence.
Added On:  07/30/14
SQL Column:  TERMINAL_ID
Java Field:  terminalId
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
Terminal ID assigned by processor or MSP.
Added On:  07/30/14
SQL Column:  TICKET
Java Field:  ticket
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Ticket or invoice number from your system.
Added On:  07/30/14
SQL Column:  TIP_AMOUNT
Java Field:  tipAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
The amount of given tips.
Decimal number is required.

Example: $200.00.
Added On:  09/12/14
SQL Column:  
Java Field:  trackData1
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  09/12/14
SQL Column:  
Java Field:  trackData2
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  07/30/14
SQL Column:  TRANS_DATE_TIME
Java Field:  transDateTime
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Fixed date (month, day, year) and time (hour, minute, second) of transaction.

MMDDYYhhmmss.
Added On:  07/30/14
SQL Column:  TRANS_TYPE
Java Field:  transType
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Default is N.

N = Non-loyalty;
L = Loyalty.

NA for transactions that don’t include a Points amount.
Added On:  07/30/14
SQL Column:  TRANSACTION_AMOUNT
Java Field:  transactionAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
The amount of transaction.
Required for Action Codes 01, 02, 06, 07, 08 and 11.
Decimal number is required.

Example: $200.00.
Added On:  07/30/14
SQL Column:  TRANSACTION_ID
Java Field:  transactionId
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
This number is populated by the POS system (you) and is echoed back to you in the host response.
Added On:  07/30/14
SQL Column:  ZIP
Java Field:  zip
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Cardholder's postal code.