Mercury Pay Auth Retail Transaction UML


Added On:  12/28/12 
Module:  UniCharge 
Type:  Entity  Status:  Active 
Java Class:  MercuryPayAuthRetailTransaction 
Mercury Pay specific low-level representation of Retail Transaction produced by Forward Transformation Process within Authorization Process.
During Generation Process, Mercury Pay specific interchange message is generated from this object for authorization. Consequently, all fields of the object are mapped into message segments/elements.
Added On:  06/16/16
SQL Column:  
Java Field:  acctNo
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  12/28/12
SQL Column:  ACQ_REF_DATA
Java Field:  acqRefData
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
This is a transaction routing and market data (allow up to 200 Alpha-numeric characters in length) and is required to be submitted with all PreAuthCapture request, with ReverseFSASale and used in conjunction with a VoidSale for Reversals.
When submitted it is always included in the <TranInfo> data node.
Added On:  12/28/12
SQL Column:  ADDRESS
Java Field:  address
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Added On:  12/28/12
SQL Column:  AMOUNT_AUTHORIZE
Java Field:  amountAuthorize
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Sum of authorization.
Added On:  01/16/13
SQL Column:  AMOUNT_BALANCE
Java Field:  amountBalance
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Amount available on the card balance.
Added On:  01/09/13
SQL Column:  AMOUNT_CASHBACK
Java Field:  amountCashback
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Amount of change after the purchase, issued in cash.
Added On:  01/09/13
SQL Column:  AMOUNT_GRATUITY
Java Field:  amountGratuity
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Amount of tips.
Added On:  01/21/13
SQL Column:  AMOUNT_PRESCRIPTION
Java Field:  amountPrescription
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Added On:  12/28/12
SQL Column:  AMOUNT_PURCHASE
Java Field:  amountPurchase
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Amount of purchased goods
Added On:  12/28/12
SQL Column:  AUTH_CODE
Java Field:  authCode
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Authorization Code returned by the processor.
Added On:  12/28/12
SQL Column:  AVS_DATA
Java Field:  avsData
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
This is referred to as Address Verification Service (AVS).

Though not impacting the actual authorization approval, a better processing rate is achieved for some (retail, QSR,) merchants if address information is supplied when the card is not swiped.
Added On:  12/28/12
SQL Column:  AVS_RESPONSE
Java Field:  avsResponse
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
The Response Code to the Address Verification Service.
Added On:  12/28/12
SQL Column:  CAPTURE_STATUS
Java Field:  captureStatus
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Will inform the POS if the transaction was "Captured" or "NotCaptured."
Added On:  12/28/12
SQL Column:  CARD_TYPE
Java Field:  cardType
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Reflect the card type entered submitted ("VISA" "M/C" "AMEX" "DCLB" "DCVR" "JCB" "DEBIT" "FSA" "FSADebit" "OTHER")
Added On:  12/28/12
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:  12/28/12
SQL Column:  CMD_STATUS
Java Field:  cmdStatus
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Status, received if there are transactions with the same amount and on the same card.

Indicates the outcome of the command:
“Approved” = transaction approved by payment processor;
“Declined” = transaction declined by payment processor;
“Success” =command completed successfully;
“Error” =error processing command.
Added On:  12/28/12
SQL Column:  CUSTOMER_CODE
Java Field:  customerCode
Status:  Active
SQL Type:  varchar(24)
Java Type:  String
Attributes:
The actual PO number, the merchant’s zip code, or the transaction invoice number, will sufficient to meet the Level II reporting requirements.
Added On:  06/16/16
SQL Column:  
Java Field:  cvvData
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  12/28/12
SQL Column:  CVV_RESULT
Java Field:  cvvResult
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
A code that reflects the outcome of the CVV2/CVC2 check.

Added On:  12/28/12
SQL Column:  DSIX_RETURN_CODE
Java Field:  dsixReturnCode
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Server specific or DSIClientX specific TCP/IP six digit codes corresponding to a single or dynamic or variable message text.
Added On:  06/16/16
SQL Column:  
Java Field:  dukpt
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/16/16
SQL Column:  
Java Field:  expDate
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  12/28/12
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:  12/28/12
SQL Column:  INVOICE_NO
Java Field:  invoiceNo
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
The locally generated always incrementing individual transaction number.
Added On:  12/28/12
SQL Column:  MEMO
Java Field:  memo
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Required field in all ActiveX and WebServices integrations
Added On:  12/28/12
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:  12/28/12
SQL Column:  MERCHANT_ID
Java Field:  merchantId
Status:  Active
SQL Type:  varchar(24)
Java Type:  String
Attributes:
Merchant identifier, assigned by processor.

The typical format for a Mercury Merchant ID combines an 11 digit numeric value, separated with an ‘=’ and a 6 digit alpha value as in: 884300XXXXX=ABCDEF.. Is returned without the "Nick Name" in the response.
Added On:  12/28/12
SQL Column:  NAME
Java Field:  name
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Name of the provider account.

Generated automatically by default. Comprised of a merchant account code followed by the type of provider profile for which it is defined.
Added On:  12/28/12
SQL Column:  OPERATOR_ID
Java Field:  operatorId
Status:  Active
SQL Type:  varchar(30)
Java Type:  String
Attributes:
Identifier of the operator carrying the transaction.
Added On:  12/28/12
SQL Column:  PARTIAL_AUTH
Java Field:  partialAuth
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
Use of the data element will “allow” a partial approval if the balance on the card is less than the purchase amount requested.
The transaction will approve for the authorized balance amount available on the card and will not decline the transaction.
Added On:  06/16/16
SQL Column:  
Java Field:  password
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/16/16
SQL Column:  
Java Field:  pinBlock
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  12/28/12
SQL Column:  PROCESS_DATA
Java Field:  processData
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Transaction routing and market data (allow up to 200 Alpha-numeric characters in length) and is required to be submitted with all PreAuthCapture request, with ReverseFSASale and used in conjunction with a VoidSale for Reversals. When submitted it is always included in the <TranInfo> data node.
Added On:  01/09/13
SQL Column:  RECORD_NO
Java Field:  recordNo
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Mercury's proprietary tokenization method. This is the returned token reference.

A RecordNo will be requested with two tags:
1. the Frequency of the token requested ("OneTime" or "Recurring")
2. either a request for token ("RecordNumberRequested") or the actual token returned in the original response.
Added On:  12/28/12
SQL Column:  REF_NO
Java Field:  refNo
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
A transaction reference value returned in the transaction response and indicates that an approved transaction has been “referenced” and is added to the current batch file.

This field is used as a “filler value” on the initial request until an actual host value is returned indicating the transaction is now in the batch file; a true RefNo is returned on the response and logged at the host for all completed transactions.
Added On:  12/28/12
SQL Column:  RESPONSE_ORIGIN
Java Field:  responseOrigin
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Added On:  12/28/12
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:  12/28/12
SQL Column:  RETURN_CODE
Java Field:  returnCode
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Identifies the any error type.
Value will be zero if transaction processed normally.

See Return Codes for possible values.
Added On:  12/28/12
SQL Column:  STATUS
Java Field:  status
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Indicates the outcome of the command:
"Success" = Command completed successfully
"Error" = Error processing command by processor
Added On:  12/28/12
SQL Column:  TAX
Java Field:  tax
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Commission fee for card payment

The purchase amount tag will be the total charge, including tax.
The tax field breaks out the tax amount for Level II reporting purposes only.
Added On:  01/21/13
SQL Column:  TERMINAL_ID
Java Field:  terminalId
Status:  Active
SQL Type:  varchar(24)
Java Type:  String
Attributes:
TerminalID is never used on MercuryPay; always use TerminalName if requiring a terminal identifier
Added On:  12/28/12
SQL Column:  TEXT_RESPONSE
Java Field:  textResponse
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Optional response message from the processor about the transaction status.
Added On:  06/16/16
SQL Column:  
Java Field:  track1
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/16/16
SQL Column:  
Java Field:  track2
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  12/28/12
SQL Column:  TRAN_CODE
Java Field:  tranCode
Status:  Active
SQL Type:  varchar(40)
Java Type:  String
Attributes:
The actual transactions run (as in Sale, Return, Balance, etc.) under these specific tenders.
Added On:  12/28/12
SQL Column:  TRAN_TYPE
Java Field:  tranType
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Transaction Types include Credit, Debit, EBT, FSA, Gift/Prepaid, Loyalty, Admin, Canadian Debit /EMV and CheckAuth.
Added On:  12/28/12
SQL Column:  USER_TRACE_DATA
Java Field:  userTraceData
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
Сertain information associated with the authorization.
Added On:  01/27/13
SQL Column:  VOUCHER_NUMBER
Java Field:  voucherNumber
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
Added On:  12/28/12
SQL Column:  ZIP
Java Field:  zip
Status:  Active
SQL Type:  varchar(5)
Java Type:  String
Attributes:
ZIP Code.