HPG Auth Retail Transaction UML


Added On:  02/16/13 
Module:  UniCharge 
Type:  Entity  Status:  Active 
Java Class:  HpgAuthRetailTransaction 
HPG specific low-level representation of Retail Transaction produced by Forward Transformation Process within Authorization Process.
During Generation Process, HPG specific interchange message is generated from this object for authorization. Consequently, all fields of the object are mapped into message segments/elements.
Added On:  01/09/14
SQL Column:  ACCOUNT_NUMBER
Java Field:  accountNumber
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Account Number being paid.
This field is optional.

When Tokenization is not available and encryption is allowed on the server, the field contains encrypted credit card number or bank account number.
Note: if encryption is not allowed on the server and tokenization is not properly configured, transactions will fail and will not be either processed or persisted.
Added On:  02/16/13
SQL Column:  ADDRESS_LINE1
Java Field:  addressLine1
Status:  Active
SQL Type:  varchar(90)
Java Type:  String
Attributes:
Mailing address of the cardholder (street line).
Added On:  02/16/13
SQL Column:  AUTH_CODE
Java Field:  authCode
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
The authorization code sent from the CC Processor.
Added On:  02/16/13
SQL Column:  AUTH_REFERENCE
Java Field:  authReference
Status:  Active
SQL Type:  varchar(36)
Java Type:  String
Attributes:
The additional reference sent from the CC Processor.
Added On:  02/16/13
SQL Column:  BASE_AMOUNT
Java Field:  baseAmount
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
The original amount authorized. (Does NOT include convenience fee).
Added On:  02/16/13
SQL Column:  BASE_AMOUNT_AUTHORIZED
Java Field:  baseAmountAuthorized
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
The original amount authorized. (Does NOT include convenience fee).
Added On:  06/14/16
SQL Column:  
Java Field:  cardExpiration
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Represents the expiration date of the card used in the transaction. Usually printed on it's front side. Format: MMYY.
Added On:  06/14/16
SQL Column:  
Java Field:  cardNumber
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Credit card number.
Added On:  06/14/16
SQL Column:  
Java Field:  cardSwipeData
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/14/16
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:  05/15/13
SQL Column:  CITY
Java Field:  city
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
City of the merchant's mailing address.
Added On:  02/16/13
SQL Column:  CONV_FEE_AMOUNT
Java Field:  convFeeAmount
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
The amount of the convenience fee of this transaction (Can be $0.00)
Added On:  02/16/13
SQL Column:  CONV_FEE_AMOUNT_AUTHORIZED
Java Field:  convFeeAmountAuthorized
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
The amount of the convenience fee of this transaction (Can be $0.00).
Added On:  01/20/15
SQL Column:  CUSTOM_STRING001
Java Field:  customString001
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Added On:  06/14/16
SQL Column:  
Java Field:  cvv
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  09/27/13
SQL Column:  FEE_AMOUNT
Java Field:  feeAmount
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
The amount of the convenience fee, can be 0.00.
Added On:  02/16/13
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:  02/16/13
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:  02/16/13
SQL Column:  NAME_ON_CARD
Java Field:  nameOnCard
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Name of the cardholder written on the credit card.
Added On:  02/16/13
SQL Column:  ORIGIN
Java Field:  origin
Status:  Active
SQL Type:  varchar(25)
Java Type:  String
Attributes:
The Origin to apply the payment to.
This field is provided by HPG Implementation.
Added On:  05/15/13
SQL Column:  PHONE
Java Field:  phone
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Phone of the merchant's mailing address.
Added On:  02/16/13
SQL Column:  REFERENCE
Java Field:  reference
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
Not used by API, it is returned in the result information to assist with Async calls or tracking.
Added On:  02/16/13
SQL Column:  RESPONSE_CODE
Java Field:  responseCode
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
Gateway generated response code.

0 – Success
100 – Failure
Added On:  02/16/13
SQL Column:  RESPONSE_MESSAGE
Java Field:  responseMessage
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
Gateway generated response message.

A description of the response if there was an error.
Added On:  02/16/13
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:  05/15/13
SQL Column:  STATE
Java Field:  state
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
State of the merchant's mailing address.
Added On:  02/16/13
SQL Column:  TOTAL_AMOUNT
Java Field:  totalAmount
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Total amount of authorization (including base amount and convenience fee amount).
Added On:  02/16/13
SQL Column:  TOTAL_AMOUNT_AUTHORIZED
Java Field:  totalAmountAuthorized
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Total фmount of authorization (including base amount and convenience fee amount).
Added On:  09/27/13
SQL Column:  TRANSACTION_TYPE
Java Field:  transactionType
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Type of the original transaction.
Added On:  02/16/13
SQL Column:  UNIQUE_ID
Java Field:  uniqueId
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Unique identifier for transaction.
This field is required for voids.
Added On:  02/16/13
SQL Column:  ZIP_CODE
Java Field:  zipCode
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
ZIP code of the mailing address of the cardholder. Max 5 characters.