World Pay TCMP Retail Transaction UML


Added On:  06/26/15 
Module:  UniCharge 
Type:  Entity  Status:  Active 
Java Class:  WorldPayTcmpRetailTransaction 
Available Fields:
Added On:  06/26/15
SQL Column:  ACCOUNT_TYPE
Java Field:  accountType
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Type of account. See specification of the processor for more information about available account types.
Added On:  07/10/15
SQL Column:  ACTION_CODE
Java Field:  actionCode
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
Response code of the processor.
Added On:  06/26/15
SQL Column:  ADDITIONAL_AMOUNT_FIELD
Java Field:  additionalAmountField
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Cashback amount for ATM/debit, EBT cash benefit and check transactions or convenience fee for quasi-cash merchants.
Added On:  07/10/15
SQL Column:  ADDITIONAL_RECEIPT_DATA
Java Field:  additionalReceiptData
Status:  Active
SQL Type:  varchar(164)
Java Type:  String
Attributes:
Additional receipt data returned from the host is varied depending on the transaction type.
Added On:  07/10/15
SQL Column:  AMOUNT_OF_CASH_BACK_AUTHORIZED
Java Field:  amountOfCashBackAuthorized
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Amount of cashback authorized.
Debit data. Only returned on ATM or debit transactions.
Added On:  06/26/15
SQL Column:  APPLICATION_TYPE
Java Field:  applicationType
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Type of application used for the transaction.
Added On:  07/10/15
SQL Column:  AUTH_SOURCE
Java Field:  authSource
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
This value is used to indicate the source for the authorization response.
Added On:  06/26/15
SQL Column:  AUTHORIZATION_CODE
Java Field:  authorizationCode
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Returned from authorizing network for pre-auth and sale requests. Echoed from request for all others.
Added On:  07/10/15
SQL Column:  AVS_RESULT_CODE
Java Field:  avsResultCode
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
AVS result code. See the specification of the processor for more information.
Added On:  06/26/15
SQL Column:  BATCH_NUMBER
Java Field:  batchNumber
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
Generated by terminal application whenever a new batch is opened. New batches should be based on the current date and current batch count number.
Added On:  10/20/15
SQL Column:  
Java Field:  billingAccountNumber
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
The merchant/cardholder billing account number.

'For PINless-Debit transactions only.'
Added On:  06/26/15
SQL Column:  CARD_HOLDER_ID_METHOD
Java Field:  cardHolderIdMethod
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Method used to identify the cardholder:
  • Space - Not specified
  • 1 - Signature
  • 2 - PIN
  • 3 - Self-service terminal
  • 4 - MOTO/ eCommerce
  • 5 - Self-service terminal - Limited amount
  • 6 - Automated Teller Machine (ATM)
Added On:  07/10/15
SQL Column:  CASH_ACCOUNT_BALANCE
Java Field:  cashAccountBalance
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Available amount of cash on the cardholder's account.
EBT data. Only returned on EBT transactions.
Added On:  06/26/15
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:  10/20/15
SQL Column:  CLINIC_AMOUNT
Java Field:  clinicAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Used for FSA transaction.
Added On:  07/10/15
SQL Column:  CREDIT_ACI_AUTHORIZATION_CHARACTERISTICS_INDICATOR
Java Field:  creditAciAuthorizationCharacteristicsIndicator
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Credit ACI authorization characteristics indicator (VISA only).
Credit data. Only returned on credit transactions.
Added On:  06/26/15
SQL Column:  CUSTOMER_ADDRESS
Java Field:  customerAddress
Status:  Active
SQL Type:  varchar(20)
Java Type:  String
Attributes:
Street address associated with customer account.
Added On:  06/26/15
SQL Column:  CUSTOMER_ZIP_CODE
Java Field:  customerZipCode
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
ZIP/postal code of the address associated with customer account.
Added On:  06/17/16
SQL Column:  
Java Field:  cvv
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  07/10/15
SQL Column:  CVV2_RESULT_CODE
Java Field:  cvv2ResultCode
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Card verification value (CVV2/CID) result code. See the specification of the processor for more information.
Added On:  07/10/15
SQL Column:  DEBIT_BALANCE
Java Field:  debitBalance
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Debit data. Only returned on ATM or debit transactions.
Added On:  10/20/15
SQL Column:  DENTAL_AMOUNT
Java Field:  dentalAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Used for FSA transaction.
Added On:  10/20/15
SQL Column:  DESCRIPTION
Java Field:  description
Status:  Active
SQL Type:  varchar(50)
Java Type:  String
Attributes:
The merchant/cardholder description or name.

'For PINless-debit transactions only.'
Added On:  06/26/15
SQL Column:  DEVICE_IDENTIFIER
Java Field:  deviceIdentifier
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Immidiately follows the terminal identification field and allows to utilize the same terminal identification number for locations with multiple terminals. Must be uniques for each POS terminal and should be 00 for standalone POS terminals.
Added On:  06/17/16
SQL Column:  
Java Field:  dukpt
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/26/15
SQL Column:  EBT_AUTHORIZATION_CODE
Java Field:  ebtAuthorizationCode
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
EBT authorization code.
Offline EBT approval data. Required for all EBT voice authorized transactions.
Added On:  06/26/15
SQL Column:  EBT_VOUCHER_NUMBER
Java Field:  ebtVoucherNumber
Status:  Active
SQL Type:  varchar(15)
Java Type:  String
Attributes:
EBT voucher number.
Offline EBT approval data. Required for all EBT voice authorized transactions.
Added On:  10/20/15
SQL Column:  EMAIL
Java Field:  email
Status:  Active
SQL Type:  varchar(60)
Java Type:  String
Attributes:
Email address of the merchant.
Added On:  10/20/15
SQL Column:  
Java Field:  emvData
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
EMV data information.

Refer to the specification of the provider for detailed information.
Added On:  06/17/16
SQL Column:  
Java Field:  emvResponse71
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/17/16
SQL Column:  
Java Field:  emvResponse72
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/17/16
SQL Column:  
Java Field:  emvResponse91
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/17/16
SQL Column:  
Java Field:  encryptedPinBlock
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/26/15
SQL Column:  ENTRY_METHOD
Java Field:  entryMethod
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Reports how the specific transaction was submitted.
Added On:  07/10/15
SQL Column:  FCS_NUMBER
Java Field:  fcsNumber
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
EBT data. Only returned on EBT transactions.
Added On:  07/10/15
SQL Column:  FEE_AMT_FOR_DEBIT
Java Field:  feeAmtForDebit
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
Fee amount for debit.
Debit data. Only returned on ATM or debit transactions.
Added On:  07/10/15
SQL Column:  FOOD_ACCOUNT_BALANCE
Java Field:  foodAccountBalance
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Food account balance.
EBT data. Only reurned on EBT transactions.
Added On:  10/20/15
SQL Column:  HEALTHCARE_AMOUNT
Java Field:  healthcareAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Used for FSA transactions.
Added On:  06/26/15
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:  10/20/15
SQL Column:  INVOICE_NUMBER
Java Field:  invoiceNumber
Status:  Active
SQL Type:  varchar(17)
Java Type:  String
Attributes:
Merchant's reference number. This field is required for PIN-less debit transactions.
Added On:  06/26/15
SQL Column:  LOCAL_TRANSACTION_DATE
Java Field:  localTransactionDate
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Default transaction date (YYMMDD). During the settlement upload it must contain the value returned in the original authorization response if the transaction was authorized online, if not - it must contain a POS device generated date.
Added On:  06/26/15
SQL Column:  LOCAL_TRANSACTION_TIME
Java Field:  localTransactionTime
Status:  Active
SQL Type:  varchar(6)
Java Type:  String
Attributes:
Default transaction time in 24-hour format (HHMMSS). During the settlement upload it must contain the value returned in the original authorization response if the transaction was authorized online, if not - it must contain a POS device generated date.
Added On:  06/26/15
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:  06/26/15
SQL Column:  MESSAGE_NUMBER
Java Field:  messageNumber
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
Message sequence number.

Should increment by one for each terminal message so that a unique number is generated for each authorization request, regardless of outcome of the transaction. Terminal software should validate that the message sequence number in the response matches message sequence number in the request. This number must be reset to the starting value of 0001 after reaching the maximum value of 9999.
Added On:  06/26/15
SQL Column:  MISCELLANEOUS_MERCHANT_ID
Java Field:  miscellaneousMerchantId
Status:  Active
SQL Type:  varchar(17)
Java Type:  String
Attributes:
Invoice/order number for credit, debit and EBT transactions.
ACH processing. Required for ACH transactions.
Added On:  10/20/15
SQL Column:  
Java Field:  miscellaneousProcessingData
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Required for Check processing, ACH transactions and PIN-less Debit transactions.

Data requirements vary by check processing/ACH service and consist of one or more of the data elements.
Added On:  06/26/15
SQL Column:  MOTO_ECOMMERCE_FLAG
Java Field:  motoEcommerceFlag
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Indicates the type of industry.
Added On:  06/26/15
SQL Column:  OVERRIDING_SIC_CODE
Java Field:  overridingSicCode
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
Overriding SIC code.
Added On:  06/26/15
SQL Column:  PARTIAL_AUTHORIZATION_SUPPORT
Java Field:  partialAuthorizationSupport
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Indicates whether terminal support partial authorization responses.
Added On:  10/20/15
SQL Column:  PHONE_NUMBER
Java Field:  phoneNumber
Status:  Active
SQL Type:  varchar(10)
Java Type:  String
Attributes:
Phone number of the merchant for discussing any processing issues.
Added On:  10/20/15
SQL Column:  POSTAL_ADDRESS
Java Field:  postalAddress
Status:  Active
SQL Type:  varchar(128)
Java Type:  String
Attributes:
Postal address of the merchant.
Added On:  10/20/15
SQL Column:  POSTAL_ZIP_CODE
Java Field:  postalZipCode
Status:  Active
SQL Type:  varchar(9)
Java Type:  String
Attributes:
Postal or ZIP code of the merchant's mailing address.
Added On:  10/20/15
SQL Column:  PRESCRIPTION_AMOUNT
Java Field:  prescriptionAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Used for FSA transaction.
Added On:  06/26/15
SQL Column:  PROCESSING_TYPE
Java Field:  processingType
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Type of transaction processing.
Two types are available:
  • Terminal Capture
  • Host Capture
Added On:  07/10/15
SQL Column:  PURCHASE_CARD_INDICATOR
Java Field:  purchaseCardIndicator
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Purchase card indicator. Five values are available:
  • B - Business card;
  • R - Corporate card;
  • S - Purchase card;
  • O - Non-commercial card;
  • space - Purchase card not supported.

Credit data. Only returned on credit transactions.
Added On:  06/26/15
SQL Column:  REQUEST_TYPE
Java Field:  requestType
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Type of request.
Added On:  07/10/15
SQL Column:  RESPONSE_LITERAL
Java Field:  responseLiteral
Status:  Active
SQL Type:  varchar(16)
Java Type:  String
Attributes:
Response message from the processor generated by the gateway.
Added On:  06/26/15
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:  10/20/15
SQL Column:  
Java Field:  retailVariableData
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Retail variable data.
Data format depends on the transaction type.
Added On:  06/26/15
SQL Column:  RETRIEVAL_BILLABLE_EVENT_DATA
Java Field:  retrievalBillableEventData
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
Retrieval data format.
Added On:  07/10/15
SQL Column:  RETRIEVAL_DATA
Java Field:  retrievalData
Status:  Active
SQL Type:  varchar(100)
Java Type:  String
Attributes:
Various retrieval data. See specification of the processor for more information.
Added On:  06/26/15
SQL Column:  SEQUENCE_NUMBER
Java Field:  sequenceNumber
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
Numeric, generated by the terminal application. Two types are available:
  • message sequence number;
  • transaction sequence number.
Added On:  06/26/15
SQL Column:  SIC_OVERRIDE_FLAG
Java Field:  sicOverrideFlag
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Indicates what type of SIC is used. Two values are available:

Y - Override existing SIC;
N - Use existing SIC code.
Added On:  06/17/16
SQL Column:  
Java Field:  singleDesEncryptedPinBlock
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  06/26/15
SQL Column:  TERMINAL_IDENTIFICATION
Java Field:  terminalIdentification
Status:  Active
SQL Type:  varchar(24)
Java Type:  String
Attributes:
Comprised of a:
  • 15-byte numeric merchant number
  • 8-byte numeric terminal number
  • 1-byte numeric check digit

These numbers are assigned by WorldPay. The terminal identification number in the host response must match the terminal identification in the host request message for the transaction to be valid.
Added On:  06/26/15
SQL Column:  TERMINAL_INPUT_CAPABILITIES
Java Field:  terminalInputCapabilities
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Describes tha highest level of transaction input the terminal is capable of.
Added On:  06/26/15
SQL Column:  TOTAL_AMOUNT
Java Field:  totalAmount
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
Amount including any cashback requested.
Added On:  07/10/15
SQL Column:  TOTAL_AMOUNT_AUTHORIZED
Java Field:  totalAmountAuthorized
Status:  Active
SQL Type:  varchar(8)
Java Type:  String
Attributes:
For ATM, debit, EBT and check transactions: Includes any casback amount specified in the request, but does not include fee amount charged to the customer.
For terminals supporting partial authorization: May be less than the originally requested amount.
Added On:  06/17/16
SQL Column:  
Java Field:  track
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  07/10/15
SQL Column:  TRAN_TYPE_IDENTIFIER
Java Field:  tranTypeIdentifier
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Transaction type identifier.
Credit data. Only returned on credit transactions.
Added On:  07/10/15
SQL Column:  TRAN_TYPE_SPECIFIC_DATA
Java Field:  tranTypeSpecificData
Status:  Active
SQL Type:  varchar(99)
Java Type:  String
Attributes:
Data format depends on the transaction type.
Added On:  06/26/15
SQL Column:  TRANS_TYPE_IDENTIFIER
Java Field:  transTypeIdentifier
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Indicates type of the transaction.
Added On:  06/26/15
SQL Column:  TRANSACTION_CODE
Java Field:  transactionCode
Status:  Active
SQL Type:  varchar(2)
Java Type:  String
Attributes:
Type of processed transaction.
Added On:  10/20/15
SQL Column:  TRANSIT_AMOUNT
Java Field:  transitAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Used for FSA transaction.
Added On:  06/17/16
SQL Column:  
Java Field:  trippleDesEncryptedPinBlock
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  07/10/15
SQL Column:  UCAF_CAVV_RESULT_CODE
Java Field:  ucafCavvResultCode
Status:  Active
SQL Type:  varchar(3)
Java Type:  String
Attributes:
UCAF/CAVV result code. See the specification of the processor for more information.
Added On:  07/10/15
SQL Column:  VALIDATION_CODE
Java Field:  validationCode
Status:  Active
SQL Type:  varchar(4)
Java Type:  String
Attributes:
Validation code (VISA only).
Added On:  07/06/15
SQL Column:  VERIFIED_VISA_MASTER_CARD_INDICATOR
Java Field:  verifiedVisaMasterCardIndicator
Status:  Active
SQL Type:  varchar(1)
Java Type:  String
Attributes:
Verified by Visa / Master Card secure ID.
Fraud prevention data. Used for manually entered credit transactions only.
Added On:  06/17/16
SQL Column:  
Java Field:  verifiedVisaMasterCardData
Status:  Active
SQL Type:  
Java Type:  String
Attributes: Transient
Added On:  10/20/15
SQL Column:  VISION_AMOUNT
Java Field:  visionAmount
Status:  Active
SQL Type:  varchar(12)
Java Type:  String
Attributes:
Used for FSA transaction.