Elavon4 Capture Retail Transaction UML
Added On: 10/17/12
Module: UniCharge
Type: Entity
Status: Active
Java Class: Elavon4CaptureRetailTransaction
Added On: 10/17/12
SQL Column: ACCOUNT_LEVEL_PROCESSING
Java Field: accountLevelProcessing
Status: Active
SQL Type: varchar(2)
Java Type: String
The ALP response code returned from authorization.
Added On: 04/08/15
SQL Column: APPLICATION_CRYPTOGRAM
Java Field: applicationCryptogram
Status: Active
SQL Type: varchar(16)
Java Type: String
This cryptogram value is returned by the Chip (ICC) in response to a “Generate AC” command.
Added On: 04/08/15
SQL Column: APPLICATION_EXPIRATION_DATE
Java Field: applicationExpirationDate
Status: Active
SQL Type: varchar(6)
Java Type: String
This value is used to identify the date after which the application expires.
Added On: 04/08/15
SQL Column: APPLICATION_INTERCHANGE_PROFILE
Java Field: applicationInterchangeProfile
Status: Active
SQL Type: varchar(4)
Java Type: String
This value is used to indicate the capabilities of the card to support specific functions within the application.
Added On: 04/08/15
SQL Column: APPLICATION_TRANSACTION_COUNTER
Java Field: applicationTransactionCounter
Status: Active
SQL Type: varchar(4)
Java Type: String
This is an incrementing counter value that is managed by the application in the chip card.
Added On: 10/17/12
SQL Column: APPROVAL_CODE
Java Field: approvalCode
Status: Active
SQL Type: varchar(6)
Java Type: String
This field contains the Approval Code for an approved transaction.
Note: If the Response Code on the auth. is not equal to "AA" or “AP” the contents of this field are ignored.
Added On: 10/17/12
SQL Column: AUTH_SOURCE_CODE
Java Field: authSourceCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Code indicating authorization source:
Visa = Valid values are 0,1,2,3,4,5
E = Force
9 = Return
Added On: 04/08/15
SQL Column: AUTHORIZATION_CURRENCY_CODE
Java Field: authorizationCurrencyCode
Status: Active
SQL Type: varchar(3)
Java Type: String
This value is used to indicate the currency code of the transaction according to the ISO 4217 standard.
Added On: 10/17/12
SQL Column: AUTHORIZATION_DATE
Java Field: authorizationDate
Status: Active
SQL Type: varchar(8)
Java Type: String
This value is the date which the transaction was authorized. For offline transactions, this value should be set to the date when the transaction occurs.
Added On: 10/17/12
SQL Column: AUTHORIZATION_TIME
Java Field: authorizationTime
Status: Active
SQL Type: varchar(6)
Java Type: String
This value is the time which the transaction was authorized. For offline transactions, this value should be set to the time when the transaction occurs.
Added On: 04/08/15
SQL Column: AUTHORIZED_AMOUNT
Java Field: authorizedAmount
Status: Active
SQL Type: varchar(12)
Java Type: String
This value is used to identify the total authorized amount for the authorization request. If the Partial authorization flag is enabled, this amount may be less than the requested amount. The decimal is implied. ($1 is sent as 100 and 1¢ is sent as 1).
Added On: 10/17/12
SQL Column: AVS_RESULT
Java Field: avsResult
Status: Active
SQL Type: varchar(1)
Java Type: String
This value contains the address verification response code returned in response message as a result of an AVS Request. It is also a required value for a terminal-based settlement, if returned in the authorization response.
Added On: 10/17/12
SQL Column:
Java Field: cardNumber
Status: Active
SQL Type:
Java Type: String
The number of the credit card or bank account.
Added On: 10/17/12
SQL Column: CARD_PRESENT_INDICATOR
Java Field: cardPresentIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
Indicates whether the card is present at the moment of the transaction.
For Credit, Debit or EBT:
Y = Card Present
N = Card not Present
For Electronic Check:
C = Check Present, Consumer Present (POP)
P = Check Present, Consumer not (ARC)
R = Check not Present (PPD)
Added On: 04/08/15
SQL Column: CARD_SEQUENCE_NUMBER
Java Field: cardSequenceNumber
Status: Active
SQL Type: varchar(3)
Java Type: String
The Card Sequence Number is a number used to differentiate cards that have the same primary account number (PAN).
This field contains the Card Sequence Number in the range '000' to '099', right justified and left-padded with zeros. It is only used for transactions containing ICC System Data.
For transactions containing ICC Data, the Card Sequence Number is mandated when the card product includes the Card Sequence Number in the criteria for uniquely defining a card. In this case, this field must contain the Application PAN Sequence number (ICC tag 5F34), if present on the ICC. If ICC Tag 5F34 is not available (is not supplied by the card), this field must be omitted.
Added On: 10/17/12
SQL Column: CARD_TYPE
Java Field: cardType
Status: Active
SQL Type: varchar(2)
Java Type: String
The type of used card.
AX = American Express
DB = Debit Card
DC = Diners Club / Carte Blanche
DI = Discover
EB = Electronic Benefits Transfer (EBT)
EC = Electronic Check Service (ECS)
JB = JCB
VI = Visa
UP = Union Pay
MC = MasterCard
BB = Coca-Cola Blackboard
P1 = Private Label 1
P2 = Private Label 2
P3 = Private Label 3
Added On: 10/17/12
SQL Column: CARDHOLDER_ACTIVATED_TERMINAL
Java Field: cardholderActivatedTerminal
Status: Active
SQL Type: varchar(1)
Java Type: String
Visa
Space = Not Applicable
1 = Limited amount terminal
2 = Automated dispensing machine
3 = Self-service terminal
9 = Mobile Acceptance Solution
MasterCard
0 = Not a CAT transaction
1 = Automated dispensing machine
2 = Self-service terminal
3 = Limited amount terminal
4 = In-flight commerce
6 = Internet
All Others
Space = Not Applicable
Added On: 10/17/12
SQL Column: CARDHOLDER_ID_METHOD
Java Field: cardholderIdMethod
Status: Active
SQL Type: varchar(1)
Java Type: String
Space = Not Specified
1 = Signature
2 = PIN
3 = Unattended Terminal
4 = Mail / Telephone Order
Added On: 04/08/15
SQL Column: CARDHOLDER_VERIFICATION_METHOD_RESULTS
Java Field: cardholderVerificationMethodResults
Status: Active
SQL Type: varchar(6)
Java Type: String
This value is used to indicate the results of the last CVM preformed.
Added On: 04/08/15
SQL Column: CASHBACK_AMOUNT
Java Field: cashbackAmount
Status: Active
SQL Type: varchar(10)
Java Type: String
This field is used to indicate the cashback amount applied to the transaction. This amount should be included in the Transaction Amount field. The decimal is implied. ($1 is sent as 100 and 1¢ is sent as 1).
Added On: 02/16/16
SQL Column: CASHBACK_AMOUNT_EMV
Java Field: cashbackAmountEmv
Status: Active
SQL Type: varchar(12)
Java Type: String
Contains the amount of cash back given to the cardholder at the time of the EMV transaction. This amount cannot be higher than the transaction amount.
Added On: 06/14/16
SQL Column: CHARGE_TRANSACTION_FK
Java Field: chargeTransaction
Status: Active
SQL Type: bigint(20)
Java Type: Long
Reference to the entity that represents real-time financial transaction.
Added On: 04/08/15
SQL Column: CHIP_CONDITION_CODE
Java Field: chipConditionCode
Status: Active
SQL Type: varchar(1)
Java Type: String
This field indicates status of the chip code.
0 = Not Applicable
1 = Transaction was initiated from a magnetic stripe with a service code beginning with 2 or 6 and the last read at VSDC terminal was a successful chip read or was not a chip transaction.
2 = Transaction was initiated at a chip-capable terminal from a magnetic stripe that contains service code 2 or 6, and the previous transaction initiated by that terminal was an unsuccessful chip read.
Added On: 04/08/15
SQL Column: CRYPTOGRAM_INFORMATION_DATA
Java Field: cryptogramInformationData
Status: Active
SQL Type: varchar(2)
Java Type: String
This value indicates the type of cryptogram and the actions to be performed by the terminal.
Added On: 04/08/15
SQL Column: CRYPTOGRAM_TRANSACTION_TYPE
Java Field: cryptogramTransactionType
Status: Active
SQL Type: varchar(2)
Java Type: String
This field identifies the type of transaction cryptogram.
Added On: 10/17/12
SQL Column: CUSTOMER_CODE
Java Field: customerCode
Status: Active
SQL Type: varchar(25)
Java Type: String
This value is used to identify the customer number for purchasing card transactions.
Added On: 05/25/18
SQL Column: CUSTOMER_VAT_REGISTRATION_NUMBER
Java Field: customerVatRegistrationNumber
Status: Active
SQL Type: varchar(13)
Java Type: String
Added On: 10/17/12
SQL Column: CVV2_RESULT
Java Field: cvv2Result
Status: Active
SQL Type: varchar(1)
Java Type: String
The CVV2, CVC2, or CID Result Code.
Added On: 10/17/12
SQL Column: DEBIT_NETWORK_ID
Java Field: debitNetworkId
Status: Active
SQL Type: varchar(2)
Java Type: String
This value is used to indicate the Debit Network that the transaction was routed through for authorization.
Added On: 10/17/12
SQL Column: DEBIT_SETTLEMENT_DATE
Java Field: debitSettlementDate
Status: Active
SQL Type: varchar(4)
Java Type: String
This value is the debit switch settlement date in MMDD format.
Added On: 10/17/12
SQL Column: DEBIT_SURCHARGE_AMOUNT
Java Field: debitSurchargeAmount
Status: Active
SQL Type: varchar(8)
Java Type: String
Surcharge amount for the transaction in 9(6)v99 format.
Added On: 05/25/18
SQL Column: DESTINATION_COUNTRY_CODE
Java Field: destinationCountryCode
Status: Active
SQL Type: varchar(3)
Java Type: String
Added On: 05/25/18
SQL Column: DESTINATION_ZIP_CODE
Java Field: destinationZipCode
Status: Active
SQL Type: varchar(10)
Java Type: String
Added On: 05/25/18
SQL Column: DISCOUNT_AMOUNT
Java Field: discountAmount
Status: Active
SQL Type: varchar(12)
Java Type: String
Added On: 05/25/18
SQL Column: DUTY_AMOUNT
Java Field: dutyAmount
Status: Active
SQL Type: varchar(12)
Java Type: String
Added On: 05/25/18
SQL Column: ECI_SECURITY_LEVEL_INDICATOR
Java Field: eciSecurityLevelIndicator
Status: Active
SQL Type: varchar(3)
Java Type: String
Added On: 10/17/12
SQL Column: ECOMMERCE_INDICATOR
Java Field: ecommerceIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
Visa / MasterCard:
Space = Not Applicable
1 = Single transaction
2 = Recurring transaction
3 = Installment payment
4 = Unknown classification
5 = Secure EC with CH certificate
6 = Non secure EC with merchant certificate
7 = Non secure EC without merch certificate
8 = Non secure transaction
Electronic Check:
V = Verify
E = Edit Only (Parse + Edit)
All others:
Space = Not Applicable
Added On: 10/17/12
SQL Column: ELAVON4_RETAIL_FILE_BATCH_FK
Java Field: elavon4RetailFileBatch
Status: Active
SQL Type: bigint(20)
Java Type: Long
Added On: 10/17/12
SQL Column:
Java Field: expirationDate
Status: Active
SQL Type:
Java Type: String
This value is used to identify the date after which the card expires.
Added On: 10/17/12
SQL Column: ID
Java Field: id
Status: Active
SQL Type: bigint(20)
Java Type: Long
Attributes:
Unique, Required, CreateOnly, ReadOnly
Identifier of the object used for references; auto-incremented integer value.
Added On: 10/17/12
SQL Column: INSTALLMENT_COUNT
Java Field: installmentCount
Status: Active
SQL Type: varchar(2)
Java Type: String
MOTO installment count number.
Added On: 10/17/12
SQL Column: INSTALLMENT_SEQUENCE
Java Field: installmentSequence
Status: Active
SQL Type: varchar(2)
Java Type: String
MOTO installment sequence number.
Added On: 05/25/18
SQL Column: INVOICE_NUMBER
Java Field: invoiceNumber
Status: Active
SQL Type: varchar(25)
Java Type: String
Added On: 04/08/15
SQL Column: ISSUER_APPLICATION_DATA
Java Field: issuerApplicationData
Status: Active
SQL Type: varchar(64)
Java Type: String
This value is used to send proprietary application data to the issuer in an online transaction.
Added On: 10/17/12
SQL Column: MERCHANT_ACCOUNT_CODE
Java Field: merchantAccountCode
Status: Active
SQL Type: int(11)
Java Type: Integer
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: 05/25/18
SQL Column: MERCHANT_DBA_CITY
Java Field: merchantDbaCity
Status: Active
SQL Type: varchar(13)
Java Type: String
Added On: 04/24/13
SQL Column: MERCHANT_DBA_NAME
Java Field: merchantDbaName
Status: Active
SQL Type: varchar(25)
Java Type: String
This value of “Doing Business As” name for the merchant.
The use of the dynamic DBA (dDBA) field is restricted by Elavon and requires prior approval to participate in the program. Values that are sent in this field by merchants that are not approved for use of this field will be ignored by the host prior to authorization and the value currently “on file” with Elavon will be used.
Added On: 05/25/18
SQL Column: MERCHANT_VAT_REG
Java Field: merchantVatReg
Status: Active
SQL Type: varchar(20)
Java Type: String
Added On: 10/17/12
SQL Column: MSDI_INDICATOR
Java Field: msdiIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
The Market Specific Data Indicator value.
0 = Returned if the data was not presented in authorization
1 = Returned if the data passed the Hotel Edits (H)
2 = Returned if the data failed Edits (N)
3 = Healthcare / Auto-Substantiation (M)
4 = Transit / Auto-Substantiation (T)
5 = Returned if the data passed the Visa Aggregator edits (E)
6 = Returned if the data passed the Auto Rental edits (A)
7 = Returned if the data passed the Bill Payment edits (B)
8 = Returned if the data passed the MasterCard Payment Gateway edits (G)
9 = Business to Business Invoice Payments (J)
Added On: 05/25/18
SQL Column: NATIONAL_TAX
Java Field: nationalTax
Status: Active
SQL Type: varchar(12)
Java Type: String
Added On: 05/25/18
SQL Column: NATIONAL_TAX_INCLUDED
Java Field: nationalTaxIncluded
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 05/25/18
SQL Column: ORDER_DATE
Java Field: orderDate
Status: Active
SQL Type: varchar(6)
Java Type: String
Added On: 10/17/12
SQL Column: ORDER_NUMBER
Java Field: orderNumber
Status: Active
SQL Type: varchar(25)
Java Type: String
Added On: 10/17/12
SQL Column: ORIGINAL_AUTHORIZATION_AMOUNT
Java Field: originalAuthorizationAmount
Status: Active
SQL Type: varchar(10)
Java Type: String
Original amount authorized for this transaction in 9(8)v99 format, or the amount of cashback for debit card transaction.
Added On: 05/25/18
SQL Column: OTHER_TAX
Java Field: otherTax
Status: Active
SQL Type: varchar(12)
Java Type: String
Added On: 10/17/12
SQL Column: POS_CAPABILITY
Java Field: posCapability
Status: Active
SQL Type: varchar(1)
Java Type: String
Capability of the POS to read cards electronically.
Space = Not specified
0 = Unknown
1 = No terminal
2 = Magnetic stripe reader
3 = Bar code reader
4 = OCR reader
5 = ICC reader
8 = Proximity reader
9 = Key entry only, no electronic capability
M = Mobile POS (Discover Only)
Added On: 03/04/20
SQL Column: POS_CONDITION_CODE
Java Field: posConditionCode
Status: Active
SQL Type: varchar(2)
Java Type: String
Added On: 10/17/12
SQL Column: POS_ENTRY_MODE
Java Field: posEntryMode
Status: Active
SQL Type: varchar(2)
Java Type: String
This value is used to identify the account entry mode on the POS device originating the transaction.
Added On: 10/17/12
SQL Column: REFERENCE_NUMBER
Java Field: referenceNumber
Status: Active
SQL Type: varchar(11)
Java Type: String
This value is a reference number assigned by Elavon and returned in the authorization response message.
Added On: 10/17/12
SQL Column: RESPONSE_CODE
Java Field: responseCode
Status: Active
SQL Type: varchar(2)
Java Type: String
This value is a 2 character code indicating the authorization response status. An approval is always indicated with an ‘AA’ or ‘AP’ code, all other codes indicate a non-approval.
Added On: 06/02/16
SQL Column: RETAIL_TRANSACTION_CYCLE_FK
Java Field: retailTransactionCycle
Status: Active
SQL Type: bigint(20)
Java Type: Long
Reference to the entity that represents a group of real-time transactions which must be settled together.
Added On: 10/17/12
SQL Column: SALES_TAX_AMOUNT
Java Field: salesTaxAmount
Status: Active
SQL Type: varchar(8)
Java Type: String
This is the actual sales tax amount applied to this transaction. Consumer or Merchant tax exempt transactions can enter a single zero to properly reflect a tax exempt transaction.
Added On: 10/17/12
SQL Column: SALES_TAX_INCLUDED
Java Field: salesTaxIncluded
Status: Active
SQL Type: varchar(1)
Java Type: String
Indicates whether the sales tax is included into the total amount.
Visa
0 = Tax not Included in total purchase amount
1 = Tax Included in total purchase amount
2 = Transaction not subject to Tax
MasterCard
Y = Tax Included in total purchase amount
N = Transaction not subject to Tax
0, Space = Tax information unknown
Added On: 06/14/16
SQL Column:
Java Field: serviceCode
Status: Active
SQL Type:
Java Type: String
Added On: 10/17/12
SQL Column: SETTLEMENT_AMOUNT
Java Field: settlementAmount
Status: Active
SQL Type: varchar(10)
Java Type: String
Amount to be deposited in 9(8)v99 format.
Added On: 10/17/12
SQL Column: SHIP_DATE
Java Field: shipDate
Status: Active
SQL Type: varchar(8)
Java Type: String
The actual date when the product was shipped (YYYYMMDD).
Added On: 05/25/18
SQL Column: SHIP_FROM_ZIP_CODE
Java Field: shipFromZipCode
Status: Active
SQL Type: varchar(10)
Java Type: String
Added On: 05/25/18
SQL Column: SHIPPING_AMOUNT
Java Field: shippingAmount
Status: Active
SQL Type: varchar(12)
Java Type: String
Added On: 06/06/16
SQL Column: SPEND_QUALIFIER
Java Field: spendQualifier
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 03/04/20
SQL Column: STORED_CREDENTIAL_INDICATOR
Java Field: storedCredentialIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 05/25/18
SQL Column: SUMMARY_COMMODITY_CODE
Java Field: summaryCommodityCode
Status: Active
SQL Type: varchar(4)
Java Type: String
Added On: 04/08/15
SQL Column: TERMINAL_CAPABILITIES_PROFILE
Java Field: terminalCapabilitiesProfile
Status: Active
SQL Type: varchar(6)
Java Type: String
This value indicates the card data input, CVM, and security capabilities of the terminal.
Added On: 04/08/15
SQL Column: TERMINAL_COUNTRY_CODE
Java Field: terminalCountryCode
Status: Active
SQL Type: varchar(3)
Java Type: String
This value is used to identify the country code where the terminal is located.
Added On: 04/08/15
SQL Column: TERMINAL_TRANSMISSION_DATE
Java Field: terminalTransmissionDate
Status: Active
SQL Type: varchar(6)
Java Type: String
This value is used to identify the date for the settlement attempt.
Added On: 04/08/15
SQL Column: TERMINAL_TYPE
Java Field: terminalType
Status: Active
SQL Type: varchar(2)
Java Type: String
This value is used to indicate the environment of the terminal, its communication capability, and its operational control.
Added On: 04/08/15
SQL Column: TERMINAL_VERIFICATION_RESULTS
Java Field: terminalVerificationResults
Status: Active
SQL Type: varchar(10)
Java Type: String
This value indicates the status of the different functions as seen from the terminal.
Added On: 04/01/13
SQL Column: TOTAL_AUTHORIZED_AMOUNT
Java Field: totalAuthorizedAmount
Status: Active
SQL Type: varchar(10)
Java Type: String
Total amount authorized for this transaction in 9(8)v99 format.
Added On: 03/04/20
SQL Column: TRANSACTION_CHANNEL
Java Field: transactionChannel
Status: Active
SQL Type: varchar(2)
Java Type: String
Added On: 10/17/12
SQL Column: TRANSACTION_CODE
Java Field: transactionCode
Status: Active
SQL Type: varchar(1)
Java Type: String
This value is used to uniquely identify the type of transaction that is being submitted to Elavon. Refer to the specification of the provider for more information.
Added On: 02/04/13
SQL Column: UCAF_INDICATOR
Java Field: ucafIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
This value identifies the means in which the transaction was processed between the cardholder and the merchant for a SecureCode authentication transaction.
0 = UCAF data collection is not supported by the Merchant.
1 = UCAF data collection is supported by merchant but not populated.
2 = UCAF data collection is supported by merchant, and UCAF data must be present.
Added On: 04/08/15
SQL Column: UNPREDICTABLE_NUMBER
Java Field: unpredictableNumber
Status: Active
SQL Type: varchar(8)
Java Type: String
This value is used to provide variability and uniqueness to the generation of a cryptogram.
Added On: 05/25/18
SQL Column: VAT_AMOUNT_FREIGHT
Java Field: vatAmountFreight
Status: Active
SQL Type: varchar(12)
Java Type: String
Added On: 05/25/18
SQL Column: VAT_INVOICE_REFERENCE_NUMBER
Java Field: vatInvoiceReferenceNumber
Status: Active
SQL Type: varchar(15)
Java Type: String
Added On: 05/25/18
SQL Column: VAT_RATE_FREIGHT
Java Field: vatRateFreight
Status: Active
SQL Type: varchar(4)
Java Type: String
Added On: 10/17/12
SQL Column: VISA_ACI
Java Field: visaAci
Status: Active
SQL Type: varchar(1)
Java Type: String
Authorization Characteristic Indicator:
M = MasterCard
A = American Express
D = Discover
U = Union Pay
Added On: 10/17/12
SQL Column: VISA_TRANSACTION_ID
Java Field: visaTransactionId
Status: Active
SQL Type: varchar(15)
Java Type: String
The CPS Transaction ID that is returned on the original authorization response.
Added On: 10/17/12
SQL Column: VISA_VALIDATION_CODE
Java Field: visaValidationCode
Status: Active
SQL Type: varchar(4)
Java Type: String
The CPS Validation Code returned on the original authorization response.
Added On: 06/14/16
SQL Column: VOUCHER_CLEAR_NBR
Java Field: voucherClearNbr
Status: Active
SQL Type: varchar(15)
Java Type: String