FirstData Omaha Auth Retail Transaction UML
Added On: 06/17/13
Module: UniCharge
Type: Entity
Status: Active
Java Class: FirstDataOmahaAuthRetailTransaction
FirstData Omaha specific low-level representation of Retail Transaction produced by
Forward Transformation Process within
Authorization Process.
During
Generation Process, FirstData Omaha 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/17/13
SQL Column:
Java Field: accountNumber
Status: Active
SQL Type:
Java Type: String
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: 06/17/13
SQL Column: ACTION_CODE
Java Field: actionCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Code indicating a Host response.
Added On: 06/17/13
SQL Column: ADDITIONAL_RESPONSE_INDICATOR
Java Field: additionalResponseIndicator
Status: Active
SQL Type: varchar(4)
Java Type: String
Variable Length, 4 position Field. Positions 2 – 4 Reserved for Future Use. Position 1 Only – used in conjunction with Terminal ID Field. It will only be present in Credit Sale, Credit Auth only transactions for Retail industry.
Added On: 06/17/13
SQL Column: APPROVED_AMOUNT
Java Field: approvedAmount
Status: Active
SQL Type: varchar(16)
Java Type: String
The amount approved if received Partial Sale / Auth, Action Code 3. Must support the PARTIAL AUTHORIZATION INDICATOR within transaction message Industry Specific Formats. If Partial Auth not accepted, this Amount must be the TOTAL AMOUNT of the void transaction to cancel the partially approved transaction.
Added On: 06/17/13
SQL Column: AUAR
Java Field: auar
Status: Active
SQL Type: varchar(17)
Java Type: String
If the AUAR value is not available do not send this field with a default value.
Added On: 06/17/13
SQL Column: AUTH_CHAR_INDICATOR_REQUEST
Java Field: authCharIndicatorRequest
Status: Active
SQL Type: varchar(1)
Java Type: String
Code identifying the type of transaction approval.
Added On: 02/25/15
SQL Column: AUTH_CHAR_INDICATOR_RESPONSE
Java Field: authCharIndicatorResponse
Status: Active
SQL Type: varchar(1)
Java Type: String
Code identifying the type of transaction approval.
Added On: 06/17/13
SQL Column: AUTHORIZATION_CODE
Java Field: authorizationCode
Status: Active
SQL Type: varchar(6)
Java Type: String
Numeric or alphanumeric code assigned to a transaction as verification that a transaction has been approved.
Added On: 06/17/13
SQL Column: AVS_ADDRESS
Java Field: avsAddress
Status: Active
SQL Type: varchar(5)
Java Type: String
Principal cardholder‘s address entered for address verification.
Added On: 06/17/13
SQL Column: AVS_RESPONSE_CODE
Java Field: avsResponseCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Code indicating whether address verification was performed and the results.
Added On: 06/17/13
SQL Column: AVS_ZIP_CODE
Java Field: avsZipCode
Status: Active
SQL Type: varchar(9)
Java Type: String
ZIP (or postal) code of principal cardholder‘s address entered for address verification.
Added On: 06/17/13
SQL Column: BALANCE_SIGN
Java Field: balanceSign
Status: Active
SQL Type: varchar(1)
Java Type: String
If Positive balance position will contain a space Character If Balance is negative, field will contain a ―-―character.
Added On: 06/17/13
SQL Column: BATCH_NUMBER
Java Field: batchNumber
Status: Active
SQL Type: varchar(1)
Java Type: String
Number identifying the batch; assigned by the POS device.
Added On: 06/17/13
SQL Column: CARD_TYPE_INDICATOR
Java Field: cardTypeIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
Character indicating the type of card.
Added On: 06/17/13
SQL Column: CARD_VERIFICATION_PRESENCE_INDICATOR
Java Field: cardVerificationPresenceIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
Character that indicates whether the CVV2/CVC2/CID value is included with message packet.
Added On: 06/17/13
SQL Column: CARD_VERIFICATION_RESPONSE_CODE
Java Field: cardVerificationResponseCode
Status: Active
SQL Type: varchar(1)
Java Type: String
The result from performing a CVC2/CVV2/CID check.
Added On: 06/17/13
SQL Column:
Java Field: cardVerificationValue
Status: Active
SQL Type:
Java Type: String
Actual CVV2/CVC2/CID value on card.
Added On: 06/17/13
SQL Column: CARDHOLDER_SET_CERTIFICATE_SERIAL_NUMBER
Java Field: cardholderSetCertificateSerialNumber
Status: Active
SQL Type: varchar(32)
Java Type: String
Cardholder Secure Electronic Transaction Certificate Serial number.
Added On: 06/17/13
SQL Column: CASH_BACK_AMOUNT
Java Field: cashBackAmount
Status: Active
SQL Type: varchar(6)
Java Type: String
Dollar-and-cent amount ($$$.¢¢) of a debit/EBT cash back amount.
Added On: 05/29/14
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: 06/17/13
SQL Column: CUSTOMER_CODE
Java Field: customerCode
Status: Active
SQL Type: varchar(17)
Java Type: String
Added On: 06/17/13
SQL Column: DEBIT_CARD_TYPE_NUMBER
Java Field: debitCardTypeNumber
Status: Active
SQL Type: varchar(3)
Java Type: String
The number of the debit network through which the debit card was processed.
Added On: 06/17/13
SQL Column: DEBIT_NETWORK_NAME
Java Field: debitNetworkName
Status: Active
SQL Type: varchar(20)
Java Type: String
The name of the network through which the debit card was processed.
Added On: 06/17/13
SQL Column: DEVICE_ID
Java Field: deviceId
Status: Active
SQL Type: varchar(4)
Java Type: String
Merchant-assigned code identifying the device at the merchant‘s location.
Added On: 06/17/13
SQL Column: EBT_CURRENT_BALANCE
Java Field: ebtCurrentBalance
Status: Active
SQL Type: varchar(14)
Java Type: String
Current balance of EBT account will match the information in the RESPONSE TEXT field.
Added On: 06/17/13
SQL Column: EBT_REMAINING_BALANCE
Java Field: ebtRemainingBalance
Status: Active
SQL Type: varchar(14)
Java Type: String
The amount of funds available to cardholder on EBT account.
Added On: 06/17/13
SQL Column: EBT_RESPONSE_CODE
Java Field: ebtResponseCode
Status: Active
SQL Type: varchar(2)
Java Type: String
Code sent by Network that processed the transaction.
Added On: 06/17/13
SQL Column: EBT_VOUCHER_NUMBER
Java Field: ebtVoucherNumber
Status: Active
SQL Type: varchar(15)
Java Type: String
Number from EBT Voucher Form.
Added On: 12/08/14
SQL Column: EMV_DATA_REQUEST
Java Field: emvDataRequest
Status: Active
SQL Type: varchar(364)
Java Type: String
EMV data-in received from client's card.
Added On: 12/08/14
SQL Column: EMV_DATA_RESPONSE
Java Field: emvDataResponse
Status: Active
SQL Type: varchar(361)
Java Type: String
EMV data output received from processor in transaction response.
Added On: 06/17/13
SQL Column:
Java Field: expirationDate
Status: Active
SQL Type:
Java Type: String
Date (MMYY), on which the cardholder plastic expires.
Added On: 06/17/13
SQL Column: FORMAT_CODE
Java Field: formatCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Code indicating the type of format for the message to the Host.
Added On: 06/17/13
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: 06/17/13
SQL Column: INVOICE_NUMBER
Java Field: invoiceNumber
Status: Active
SQL Type: varchar(8)
Java Type: String
Added On: 06/17/13
SQL Column: ITEM_NUMBER
Java Field: itemNumber
Status: Active
SQL Type: varchar(3)
Java Type: String
Number of the transaction in the batch; assigned by the POS.
Added On: 09/25/15
SQL Column: ITEM_NUMBER_RESPONSE
Java Field: itemNumberResponse
Status: Active
SQL Type: varchar(3)
Java Type: String
Added On: 12/08/14
SQL Column: MC_TRACE_ID
Java Field: mcTraceId
Status: Active
SQL Type: varchar(15)
Java Type: String
Must be included in subsequent/follow-ups transactions such as incremental authorization. First 9 digits of the Trace ID contain the BankNet Reference Number that was received from MasterCard for original authorization; next 4 digits contain the Settlement Date in the MMDD format. The 4 digit Settlement Date is followed by two spaces.
Added On: 06/17/13
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: 06/17/13
SQL Column: MERCHANT_NUMBER
Java Field: merchantNumber
Status: Active
SQL Type: varchar(19)
Java Type: String
Number assigned by merchant‘s financial institution.
Added On: 06/17/13
SQL Column: MERCHANT_SET_CERTIFICATE_SERIAL_NUMBER
Java Field: merchantSetCertificateSerialNumber
Status: Active
SQL Type: varchar(32)
Java Type: String
Merchant Secure Electronic Transaction Certificate Serial number.
Added On: 06/17/13
SQL Column: ORDER_NUMBER
Java Field: orderNumber
Status: Active
SQL Type: varchar(25)
Java Type: String
Merchant-defined number identifying the purchase or service.
Added On: 06/17/13
SQL Column: PARTIAL_AUTHORIZATION_INDICATOR
Java Field: partialAuthorizationIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
Value will be blank for Online Void.
Added On: 06/17/13
SQL Column: PHONE_MAIL_ORDER_FLAG
Java Field: phoneMailOrderFlag
Status: Active
SQL Type: varchar(1)
Java Type: String
Code identifying whether the transaction is mail order, phone order or electronic commerce.
Added On: 06/17/13
SQL Column:
Java Field: pinBlock
Status: Active
SQL Type:
Java Type: String
Hexadecimal encrypted code.
Added On: 06/17/13
SQL Column: POS_DATA_CODES
Java Field: posDataCodes
Status: Active
SQL Type: varchar(3)
Java Type: String
POS Codes for American Express Ticket Only (Tran Code 3) transaction. Contact American Express to determine how these values are generated and used for American Express.
Added On: 06/17/13
SQL Column: PROTOCOL_TYPE
Java Field: protocolType
Status: Active
SQL Type: varchar(1)
Java Type: String
Character identifying which protocol rule the transaction follows; required field.
Added On: 06/17/13
SQL Column: REMAINING_BALANCE
Java Field: remainingBalance
Status: Active
SQL Type: varchar(16)
Java Type: String
Right justified w/leading spaces when a Balance returned by issuer.
Balance is returned by Issuer when Partial Auth Indicator is set to 1 in the online sale request. When Balance not returned by Issuer, The field will contain the constant value ―UNAVAILABLE‖ Left justified trailing spaces.
Added On: 06/17/13
SQL Column: REQUESTED_AMOUNT
Java Field: requestedAmount
Status: Active
SQL Type: varchar(16)
Java Type: String
The Amount entered at POS to be authorized by Host.
Added On: 06/17/13
SQL Column: RESPONSE_CODE
Java Field: responseCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Value defining how the System responded to the transaction.
Added On: 06/17/13
SQL Column: RESPONSE_TEXT
Java Field: responseText
Status: Active
SQL Type: varchar(16)
Java Type: String
Message from the Host which appears on the POS device.
Added On: 06/17/13
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: 06/17/13
SQL Column: REVISION_NUMBER
Java Field: revisionNumber
Status: Active
SQL Type: varchar(1)
Java Type: String
Number identifying the number of revisions to a monetary transaction.
Added On: 12/08/14
SQL Column: ROUTING_CODE
Java Field: routingCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Code that have values ‘D’ (Debit) or ‘C’ (Credit) to indicate where the transaction was routed.
Added On: 06/17/13
SQL Column: SHIP_TO_POSTAL_CODE
Java Field: shipToPostalCode
Status: Active
SQL Type: varchar(6)
Java Type: String
This is a mandatory field for supporting Amex Level 2 Transactions.
Added On: 12/08/14
SQL Column: SIGNATURE_CODE
Java Field: signatureCode
Status: Active
SQL Type: varchar(1)
Java Type: String
If present, the field may contain a “Y”. The device should follow signature protocols if not present. The value of "Y" indicates a recommendation to a signature request on the receipt. However, requesting a signature may ultimately be a POS Solution decision.
Added On: 06/17/13
SQL Column:
Java Field: smidId
Status: Active
SQL Type:
Java Type: String
Security Management Information Data. For Debit reversal of partially approved amount, SMID ID should be filled with ‗F‘s; for example: FFFFFFFFFFFFFFFFFFFF for 20 digits SMID ID.
Added On: 06/17/13
SQL Column: SURCHARGE
Java Field: surcharge
Status: Active
SQL Type: varchar(6)
Java Type: String
Dollar-and-cent amount ($$$.¢¢) of the charge that the cardholder paid the merchant for the ability to perform the transaction.
Added On: 06/17/13
SQL Column: TAX_AMOUNT
Java Field: taxAmount
Status: Active
SQL Type: varchar(6)
Java Type: String
Dollar-and-cent amount ($$$$$.¢¢) of tax for the purchase.
Added On: 12/08/14
SQL Column: TERMINAL_CAPABILITY
Java Field: terminalCapability
Status: Active
SQL Type: varchar(4)
Java Type: String
Merchant POS Terminal Capability Code. 4-position character field that represents a 2-position hex bit map. Each position can
represent 4 capabilities with bit 8, 4, 2 and 1, represented in character format.
Added On: 06/14/16
SQL Column: TERMINAL_CARD_CAPTURE_CAPABILITY
Java Field: terminalCardCaptureCapability
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 06/14/16
SQL Column: TERMINAL_CATEGORY_CODE
Java Field: terminalCategoryCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 06/17/13
SQL Column: TERMINAL_ID
Java Field: terminalId
Status: Active
SQL Type: varchar(9)
Java Type: String
Code identifying the balancing features available to the POS from the Host.
Added On: 06/14/16
SQL Column: TERMINAL_PIN_CAPABILITY
Java Field: terminalPinCapability
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 06/17/13
SQL Column: TIP_AMOUNT
Java Field: tipAmount
Status: Active
SQL Type: varchar(6)
Java Type: String
Dollar-and-cent amount ($$$.¢¢) of the tip given at the restaurant for the purchase.
Added On: 06/17/13
SQL Column: TOTAL_AMOUNT
Java Field: totalAmount
Status: Active
SQL Type: varchar(8)
Java Type: String
Total dollar-and-cent amount ($$$$$.¢¢) of the purchase.
Added On: 06/17/13
SQL Column: TOTAL_AUTHORIZED_AMOUNT
Java Field: totalAuthorizedAmount
Status: Active
SQL Type: varchar(8)
Java Type: String
Dollar-and-cent amount ($$$$$.¢¢) of the purchase.
Added On: 06/17/13
SQL Column: TPP
Java Field: tpp
Status: Active
SQL Type: varchar(6)
Java Type: String
If a First Data assigned TPP value is not available do not send this field with a default value.
Added On: 06/17/13
SQL Column:
Java Field: trackData
Status: Active
SQL Type:
Java Type: String
Magnetic stripe on the back of a plastic that contains various encoded proprietary information.
Added On: 06/17/13
SQL Column: TRANS_STAIN
Java Field: transStain
Status: Active
SQL Type: varchar(56)
Java Type: String
A value used to define a merchant‘s security settings for SET.
Added On: 06/17/13
SQL Column: TRANSACTION_CODE
Java Field: transactionCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Code identifying how the System will respond to the transaction request.
Added On: 06/17/13
SQL Column: TRANSACTION_IDENTIFIER
Java Field: transactionIdentifier
Status: Active
SQL Type: varchar(15)
Java Type: String
Code generated by the card associations on the authorization; known as TID for Visa and BankNet Reference Number for MasterCard.
Added On: 06/17/13
SQL Column: TRANSACTION_TYPE
Java Field: transactionType
Status: Active
SQL Type: varchar(1)
Java Type: String
Code identifying how the System will respond to the transaction request.
Added On: 06/17/13
SQL Column: WRITE_CONTROL_CHARACTER
Java Field: writeControlCharacter
Status: Active
SQL Type: varchar(1)
Java Type: String
Character identifying the account number entry method and Host response protocol (single or multiple mode).
Added On: 06/17/13
SQL Column: XID
Java Field: xid
Status: Active
SQL Type: varchar(40)
Java Type: String
A unique transaction identifier assigned to a SET Transaction.