FirstData Nashville Auth Retail Transaction UML
Added On: 11/05/12
Module: UniCharge
Type: Entity
Status: Active
Java Class: FirstDataNashvilleAuthRetailTransaction
FirstData Nashville specific low-level representation of Retail Transaction produced by
Forward Transformation Process within
Authorization Process.
During
Generation Process, FirstData Nashville specific interchange message is generated from this object for authorization. Consequently, all fields of the object are mapped into message segments/elements.
Added On: 11/05/12
SQL Column: ACI
Java Field: aci
Status: Active
SQL Type: varchar(1)
Java Type: String
Authorization Characteristics Indicator.
This field indicates the result of the Visa's evaluation of the authorization characteristics of a custom payment service transaction.
Added On: 11/06/12
SQL Column:
Java Field: applicationId
Status: Active
SQL Type:
Java Type: String
Identification number of the used application.
Added On: 11/05/12
SQL Column: APPROVED_AMOUNT
Java Field: approvedAmount
Status: Active
SQL Type: varchar(12)
Java Type: String
Returned with an amount less than the requested amount.
Added On: 11/05/12
SQL Column: AUTHORIZATION_CODE
Java Field: authorizationCode
Status: Active
SQL Type: varchar(6)
Java Type: String
Alphanumeric value assigned by the bank to a merchant sale or cash advance that has received specific approval. The code is used as proof that the transaction has been properly approved.
Added On: 11/05/12
SQL Column: AVS_RESPONSE_CODE
Java Field: avsResponseCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Address Verification Response.
One character code indicating the response of the Address Verification process.
Added On: 11/05/12
SQL Column: BANK_NET_DATE
Java Field: bankNetDate
Status: Active
SQL Type: varchar(4)
Java Type: String
Space-fill in the 0100 original authorization request message. The value received in the 0110 original authorization response, must be submitted in the 0100 incremental request & 0400 reversal message and capture only transaction request message. The Issuer will respond with the 4-byte BankNET Date (MMDD).
Added On: 11/05/12
SQL Column: BANK_NET_REFERENCE
Java Field: bankNetReference
Status: Active
SQL Type: varchar(9)
Java Type: String
Space-fill in the 0100 original authorization request message. The value received in the 0110 original authorization response, must be submitted in the 0100 incremental request & 0400 reversal message and capture only transaction request message. The Issuer will respond with the 9-byte BankNET Reference.
Added On: 06/17/15
SQL Column: BIT31
Java Field: bit31
Status: Active
SQL Type: varchar(1)
Java Type: String
Acquirer Reference Data.
Contains values to be used by the "Acquirer" (First Data) to determine how to process the transaction. Currently only the first byte in the field is being used. The remaining positions are reserved for future use and should not be sent.
Note: This should only be used for host capture merchants. If this field is present for other merchants, the transaction could be rejected.
Added On: 12/13/16
SQL Column: BIT70
Java Field: bit70
Status: Active
SQL Type: varchar(3)
Java Type: String
Network management information code that indicates the function of a particular 0800 Test Message.
Added On: 11/05/12
SQL Column: BIT11
Java Field: bit11
Status: Active
SQL Type: varchar(6)
Java Type: String
A system-generated number is provided by the merchant and it uniquely identifies a transaction. It is ―echoed‖ back to the merchant in the host response messages.
Note: System Trace Number cannot be repeated for another Terminal ID of the same merchant for the same day.
Added On: 11/05/12
SQL Column: BIT12
Java Field: bit12
Status: Active
SQL Type: varchar(12)
Java Type: String
This is the time stamp of the transaction, and as a Regulation E requirement it should be printed on the Debit Receipt given to a customer. It does not change on subsequent transactions (i.e., on debit reversals).
Added On: 03/31/15
SQL Column:
Java Field: bit126
Status: Active
SQL Type:
Java Type: String
Added On: 11/05/12
SQL Column: BIT13
Java Field: bit13
Status: Active
SQL Type: varchar(4)
Java Type: String
For POS terminals sending credit card transactions, this code identifies the month and day a transaction is sent. It must be POS terminal time and match the printed receipt.
This is the date stamp of the transaction and, as a REG-E requirement; it should be printed on the Debit/EBT Receipt given to a customer. It does not change on subsequent transactions (i.e., debit reversal).
Added On: 03/31/15
SQL Column:
Java Field: bit14
Status: Active
SQL Type:
Java Type: String
Card Expiration Date.
Conditional — Mandatory for manual entry of Account number (Credit, Debit and EBT); Mandatory for Debit Reversals, and Void; optional for card-swiped transactions (YYMM).
This field expresses the expiration date (YYMM) for the card. It is included in both Track 1 and Track 2 data. The terminal must not store the track information, so the PAN is sent on all advice messages (i.e., adjust, off-line, etc.).
- Transactions associated with an expired card must be settled within four days, or the batch will be rejected.
- For Discover (JCB (US Domestic only), and Diners) recurring and Installment transactions the transaction must include a valid expiration date for the card being used in the recurring agreement with the merchant.
- For Debit and EBT Transactions, the requirement is only as to presence. If present it may contain expired dates or '0000' without issues.
Added On: 11/05/12
SQL Column: BIT18
Java Field: bit18
Status: Active
SQL Type: varchar(4)
Java Type: String
A code that identifies the type of business or services conducted by the service establishment.
Added On: 03/31/15
SQL Column:
Java Field: bit2
Status: Active
SQL Type:
Java Type: String
Primary Account Number.
Conditional — Mandatory for:
- Credit card authorizations, authorization and capture, and capture only for all transactions, both manual/swiped entry modes used during original authorization.
- EBT Voucher Clear Transactions and Debit PIN-less Transactions.
- Debit Reversal and Void.
Not included for check transactions message.
In the 0200 Financial Transaction messages for EBT Card, this field is mandatory if the Track 2 Data cannot be read.
Identifies the card member‘s account number. Unlike most numeric fields, the Primary Account Number is left-justified. In this case, the rightmost byte is padded with a ½ byte binary zero (e.g., a three-position field, X ‘03 12 30‘).
Added On: 11/05/12
SQL Column: BIT22
Java Field: bit22
Status: Active
SQL Type: varchar(12)
Java Type: String
This field specifies how the Primary Account Number was entered into the terminal. The code is comprised of the POS Entry Mode Value and the PIN Capability Value
Added On: 03/30/15
SQL Column: BIT23
Java Field: bit23
Status: Active
SQL Type: varchar(23)
Java Type: String
Card Sequence Number.
The Card Sequence Number is a number used to differentiate cards that have the same primary account number (PAN). Field 023 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, Field 023 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), Field 023 must be omitted.
Added On: 11/05/12
SQL Column: BIT24
Java Field: bit24
Status: Active
SQL Type: varchar(3)
Java Type: String
This field identifies the acquiring host. This code will be returned on the host response.
Added On: 11/05/12
SQL Column: BIT25
Java Field: bit25
Status: Active
SQL Type: varchar(2)
Java Type: String
This field describes the conditions at the POS location for a particular transaction.
Added On: 11/05/12
SQL Column: BIT3
Java Field: bit3
Status: Active
SQL Type: varchar(6)
Java Type: String
A required code is used in conjunction with the message type to define the type of transaction that is by the terminal to the host.
Added On: 03/31/15
SQL Column:
Java Field: bit35
Status: Active
SQL Type:
Java Type: String
Track 2 Data.
Contains the information encoded from a valid Track 2 magnetic stripe read. It includes information such as the Primary Account Number and Expiration Date. Entire Track Data must be forwarded intact (excludes Start Sentinel, End Sentinel and Longitudinal Redundancy Check).
1. On Debit Card transactions, this field is mandatory (with the exception of Debit Card PIN-Less transactions). Debit Card PIN-Less transactions are manually entered transactions.
2. On EBT transactions (Cash Benefit and Food Stamps), this field should be sent if available (If not available, manual entry is allowed).
3. On EBT Voucher Clear transactions, this field is not available.
4. On Debit and EBT Card transactions, Bit 45 (Track 1) should be off.
5. On a 0400 EBT reversal message, this field must match the original 0200 EBT request.
6. On a Credit Card 0400 reversal message, Track Data must not be included as Card Associations forbid the storage of track data.
7. On a 0400 (Debit) reversal message, this field must not be present.
Added On: 11/05/12
SQL Column: BIT37
Java Field: bit37
Status: Active
SQL Type: varchar(12)
Java Type: String
Authorization only — For Credit and debit transactions (excluding Canadian Debit) the retrieval reference number can be any value based on the merchant‘s choosing (e.g. sequential tracking of transactions, fixed value etc.). The value submitted in the request message is then echoed back in response.
Authorization with capture — For Credit and debit transactions (excluding Canadian Debit), this is a unique 12-byte reference number assigned to a transaction by the merchant and returned in the response message.
Capture Only – For Credit card transactions the retrieval reference number must be the same value that was submitted in the original authorization request.
Canadian Debit — The POS terminal at the merchant‘s location generates the retrieval reference number and includes it in the transaction request. The host echoes the value back in the response. The terminal must ensure that the number is unique.
Reversals — In a 0400 (Debit/Credit) reversal request message, the retrieval reference number does not have to match the original 0100 (Credit) and 0200 (Debit) request. This is applicable to all transaction type (Credit, Debit inclusive of Canadian Debit).
Added On: 11/20/12
SQL Column: BIT38
Java Field: bit38
Status: Active
SQL Type: varchar(6)
Java Type: String
The Authorization ID Response is the approval code assigned by the association, issuing bank, or Debit/EBT network.
Added On: 05/08/14
SQL Column: BIT39
Java Field: bit39
Status: Active
SQL Type: varchar(2)
Java Type: String
The host response to a message to indicate the status of the transaction. The value returned in the authorization response is submitted in the capture only transaction request.
Added On: 11/05/12
SQL Column: BIT4
Java Field: bit4
Status: Active
SQL Type: varchar(12)
Java Type: String
This field specifies the transaction amount, in the acquirer‘s currency.
Added On: 11/05/12
SQL Column: BIT41
Java Field: bit41
Status: Active
SQL Type: varchar(8)
Java Type: String
This field contains a code that identifies a merchant terminal.
Added On: 11/05/12
SQL Column: BIT42
Java Field: bit42
Status: Active
SQL Type: varchar(15)
Java Type: String
This field contains a code assigned to a merchant location.
Added On: 07/31/15
SQL Column: BIT43
Java Field: bit43
Status: Active
SQL Type: varchar(107)
Java Type: String
Alternative Merchant Name/Location.
This field contains a number of sub-fields identifying the merchant‘s name, location and service entitlement number.
Note: Must be in upper-case letters.
The purpose of this field is to override information that is stored for the merchant on First Data‘s Merchant Master. Merchant name, City and State must be completely entered; otherwise the legal name in First Data‘s Merchant Master will be used. It is recommended for American Express and Debit transactions that the Street Address also be provided.
Added On: 09/14/15
SQL Column: BIT44
Java Field: bit44
Status: Active
SQL Type: varchar(1)
Java Type: String
Additional Response Data. Contains the response to an Address Verification Only (AVS) request.
Conditional — If Bit 48 is used in the request message (0100, 0200), this field is returned in the response message (0110, 0210). For Host Capture merchants, if the transaction is a Capture only transaction (Bit 31 value of 2) and address verification was processed on the original authorization, the Address Verification Response Code must be presented in the 0100 message.
Added On: 03/31/15
SQL Column:
Java Field: bit45
Status: Active
SQL Type:
Java Type: String
Additional Response Data.
Conditional — If Bit 48 is used in the request message (0100, 0200), this field is returned in the response message (0110, 0210). For Host Capture merchants, if the transaction is a Capture only transaction (Bit 31 value of 2) and address verification was processed on the original authorization, the Address Verification Response Code must be presented in the 0100 message.
Contains the response to an Address Verification Only (AVS) request.
Added On: 11/05/12
SQL Column: BIT48
Java Field: bit48
Status: Active
SQL Type: varchar(31)
Java Type: String
First Data uses field 48 to communicate elements not included in the ISO 8583 specification.
Added On: 07/30/15
SQL Column: BIT49
Java Field: bit49
Status: Active
SQL Type: varchar(4)
Java Type: String
Transaction Currency Code.
Can be used to specify the currency type associated with a transaction (e.g., 840=U.S. Dollar).
Note : Conditional — Mandatory for "multi-currency" merchants, but optional for merchants who use U.S. currency only.
Added On: 03/31/15
SQL Column:
Java Field: bit52
Status: Active
SQL Type:
Java Type: String
Encrypted PIN Data.
Conditional — Mandatory for Debit Card transactions (with exception of Debit Card PIN-Less transactions).
Mandatory for EBT Cash Benefit transactions and mandatory for all EBT Food Stamp transactions (except for EBT Voucher Clear transactions).
Personal Identification Number (PIN) data as received from the PIN pad. The terminal is not itself a secure device, so it doesn‘t process the PIN data. The terminal simply passes the encrypted PIN data (cryptogram) as received from the PIN pad. On a 0400 message send eight bytes of Hex '0‘s for domestic DUKPT processing. The same format applies to Master Key processing.
For transactions where the PIN is verified offline (e.g. Interac chip) or not required (debit contactless transactions under the no PIN required‟ floor limit), a value of all F‟s (FFFFFFFFFFFFFFFF‟) should be populated in this field.
All new applications supporting Debit and EBT are required to use Derived Unique Key Per Transactions (DUKPT) key management between the point-of-sale and the first link where the PIN block is decrypted and re-encrypted at a Host Security Module. This means that in most situations Leased Line merchants will be required to use DUKPT key management, since the PIN block will be passed from the pointof-sale to the corporate host to the First Data host, where the First Data Host Security Module decrypts it. For DUKPT, Field 63 (Table 33) is required in addition to Field 52. Refer to page 4-82 for details concerning this table.
For any corporation that has its own Host Security Module, Debit/EBT transactions are required to use DUKPT key management between the point-of-sale and the corporate host to which the Host Security Module is attached. These transactions can then be transmitted to the First Data host during Master/Session Key management.
Added On: 03/31/15
SQL Column:
Java Field: bit53
Status: Active
SQL Type:
Java Type: String
Data associated with Merchant Advice Code table received from the processor.
Added On: 11/19/12
SQL Column: BIT54
Java Field: bit54
Status: Active
SQL Type: varchar(12)
Java Type: String
This field contains amounts associated with the transaction. For Debit card (with exception of Debit Card PIN-Less transactions) and EBT Cash benefit transactions, this field represents the ―Cash Back‖ amount. On a 0400 (Debit/EBT) reversal message, this field must match the original 0200 (Debit/EBT) request.
Added On: 03/31/15
SQL Column:
Java Field: bit55
Status: Active
SQL Type:
Java Type: String
ICC Data.
ICC Data is a series of ―Tag/Length/Value combination for ICC card processing. The length of the field is the length of all data that follows the length (total length of field 55 minus 3). All information that follows the 3 digit BCD length of Field 55 should be considered binary data.
Added On: 08/26/15
SQL Column:
Java Field: bit55Response
Status: Active
SQL Type:
Java Type: String
ICC Data is a series of ―Tag/Length/Value‖ combination for ICC card processing. The length of the field is the length of all data that follows the length (total length of field 55 minus 3). All information that follows the 3 digit BCD length of Field 55 should be considered binary data.
Refer to the specification of the provider for more information.
Added On: 11/05/12
SQL Column: BIT59
Java Field: bit59
Status: Active
SQL Type: varchar(9)
Java Type: String
The merchant's postal/ZIP code must be left-justify and filled if less than 9 bytes.
Added On: 11/05/12
SQL Column: BIT60
Java Field: bit60
Status: Active
SQL Type: varchar(2)
Java Type: String
This field is comprised of the POS Type (first four bits) and the POS Capability (last four bits) data elements. The POS Type describes the general category of terminal used for the transaction. POS Capability describes the data entry methods available at the POS location.
Added On: 03/31/15
SQL Column:
Java Field: bit61
Status: Active
SQL Type:
Java Type: String
Added On: 03/31/15
SQL Column:
Java Field: bit63
Status: Active
SQL Type:
Java Type: String
First Data Private Use Data Element.
First Data uses Field 63 to communicate elements not included in the ISO 8583 specification.
New merchants/VARS are required to use Bitmap Position 63. Existing merchants are advised to switch from Bitmap Position 62 to 63 as well, since Bit 63 provides access to additional tables supporting required/optional services.
Added On: 11/05/12
SQL Column: BIT7
Java Field: bit7
Status: Active
SQL Type: varchar(10)
Java Type: String
This code identifies the month, day, hour, minute, and second a transaction is sent (MMDDhhmmss). This must be represented in GMT or Universal time.
Added On: 01/25/16
SQL Column: CANADIAN_NETWORK_RESPONSE_CODE
Java Field: canadianNetworkResponseCode
Status: Active
SQL Type: varchar(2)
Java Type: String
Response code generated by Interac network system.
Added On: 11/05/12
SQL Column: CARD_LEVEL_RESPONSE_CODE
Java Field: cardLevelResponseCode
Status: Active
SQL Type: varchar(2)
Java Type: String
The Card Level Response Code field is required to be included in the Settlement records for Visa sale transactions that were electronically authorized. The Visa Compliance Table is sent in on the request message as a trigger to receive the Visa Compliance table in the response message.
Added On: 03/04/13
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: 11/05/12
SQL Column: CLIENT_REF
Java Field: clientRef
Status: Active
SQL Type: varchar(14)
Java Type: String
Added On: 06/18/15
SQL Column: CUSTOMER_REFERENCE_IDENTIFIER
Java Field: customerReferenceIdentifier
Status: Active
SQL Type: varchar(17)
Java Type: String
For Visa the Customer Code/Customer Reference Identifier — Used by the customer to identify the purchase (e.g., the invoice number).
For Visa this field must be 12 digits.
For MasterCard and American Express the code that facilitates merchant/corporation communication and record keeping.
For MasterCard this field must be 17 digits.
For MasterCard Electronic Payment Transactions this value should represent the Invoice Number.
Note: Refer to Conditional Requirement Matrix for further detail.
Added On: 11/05/12
SQL Column: CVC_ERROR_CODE
Java Field: cvcErrorCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Space-fill in authorization request message.
CVC Incorrect Indicator. An indicator, provided by the Issuer in the authorization response, to identify the presence of an invalid card verification code (CVC). If there is an error, the Issuer will respond with the 1-byte CVC Error Code (Y).
Added On: 11/05/12
SQL Column: CVV2_RESULT_CODE
Java Field: cvv2ResultCode
Status: Active
SQL Type: varchar(1)
Java Type: String
The result code of CVV2 verification.
Added On: 11/06/12
SQL Column:
Java Field: datawireId
Status: Active
SQL Type:
Java Type: String
Identification code of the datawire.
Added On: 12/02/12
SQL Column: DEBIT_NETWORK_ID
Java Field: debitNetworkId
Status: Active
SQL Type: varchar(6)
Java Type: String
Applicable to Authorization only, and Authorization and Capture
Added On: 06/18/15
SQL Column: DESTINATION_POSTAL_CODE
Java Field: destinationPostalCode
Status: Active
SQL Type: varchar(10)
Java Type: String
Optional for Visa and MasterCard. Mandatory for American Express.
The postal or ZIP code of the "ship to" location. This is equal to the Ship from Postal/ZIP Code when the customer takes possession of the items at the merchant location.
Added On: 12/02/12
SQL Column: DS_ADDRESS_VERIFICATION_RESULT
Java Field: dsAddressVerificationResult
Status: Active
SQL Type: varchar(1)
Java Type: String
Result of the mailing address verification.
Added On: 12/02/12
SQL Column: DS_NRID
Java Field: dsNrid
Status: Active
SQL Type: varchar(15)
Java Type: String
Network ID.
Must match authorization response value.
Added On: 12/24/14
SQL Column: DS_PROCESSING_CODE
Java Field: dsProcessingCode
Status: Active
SQL Type: varchar(6)
Java Type: String
A required code is used in conjunction with the message type to define the type of transaction that is by the terminal to the host.
Added On: 12/02/12
SQL Column: DS_STAN
Java Field: dsStan
Status: Active
SQL Type: varchar(6)
Java Type: String
System trace audit number (STAN).
Added On: 12/02/12
SQL Column: DS_TRACK_DATA_CONDITION_CODE
Java Field: dsTrackDataConditionCode
Status: Active
SQL Type: varchar(2)
Java Type: String
Card Track Data Submitted at the Time of Auth.
Added On: 11/05/12
SQL Column: HOST_RESPONSE_TEXT
Java Field: hostResponseText
Status: Active
SQL Type: varchar(16)
Java Type: String
Text displayed on the terminal corresponds to the response code
Added On: 11/05/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: 11/24/12
SQL Column: IS_PRIVATE_DATA_FIELD_RESPONSE_PRESENT
Java Field: isPrivateDataFieldResponsePresent
Status: Active
SQL Type: tinyint(1)
Java Type: Boolean
Attributes:
Default:false
Indicates whether the private data field response is present in the request.
Added On: 06/14/16
SQL Column:
Java Field: macValue
Status: Active
SQL Type:
Java Type: String
MAC value assigned to the transaction by a processor.
Added On: 12/02/12
SQL Column: MC
Java Field: mc
Status: Active
SQL Type: varchar(12)
Java Type: String
Data associated with MasterCard processing received from the processor.
Added On: 11/05/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: 04/25/17
SQL Column: MERCHANT_ADVICE_CODE
Java Field: merchantAdviceCode
Status: Active
SQL Type: varchar(3)
Java Type: String
A code associated with the reason a recurring payment transaction has been declined.
Added On: 06/18/15
SQL Column: MERCHANT_TAX_ID
Java Field: merchantTaxId
Status: Active
SQL Type: varchar(15)
Java Type: String
Mandatory for MasterCard. Not applicable for Visa or American Express. The merchant‘s federal tax identification number.
Added On: 01/18/16
SQL Column:
Java Field: messageAuthenticationWorkingKey
Status: Active
SQL Type:
Java Type: String
Relevant key used for messages authentication.
Added On: 01/18/16
SQL Column:
Java Field: messageEncryptionWorkingKey
Status: Active
SQL Type:
Java Type: String
Relevant key used for encryption of the message.
Added On: 11/05/12
SQL Column: MESSAGE_TYPE
Java Field: messageType
Status: Active
SQL Type: varchar(4)
Java Type: String
A code that defines the message type.
Added On: 11/05/12
SQL Column: MSDI
Java Field: msdi
Status: Active
SQL Type: varchar(1)
Java Type: String
The value submitted for reversal and capture only request must mirror the value that was submitted in the 0100 initial authorization request.
Added On: 07/12/17
SQL Column: NETWORK_LABEL
Java Field: networkLabel
Status: Active
SQL Type: varchar(10)
Java Type: String
Label that shows the network where the transaction was routed for authorization (e.g. ‘NYCE’, ‘PULSE’,’ STAR’, ‘Visa’, ‘MasterCard’ etc.)
Added On: 01/18/16
SQL Column:
Java Field: pinEncryptionWorkingKey
Status: Active
SQL Type:
Java Type: String
Relevant key used for PIN encryption.
Added On: 11/05/12
SQL Column: POS_DATA
Java Field: posData
Status: Active
SQL Type: varchar(13)
Java Type: String
Space-fill in authorization request message.
Only if the American Express Indicator on the authorization request message (0100) is an ―X‖, Amex CAPN POS Data field will be returned in the response (0110), otherwise zero-filled.
Added On: 11/05/12
SQL Column: POS_ENTRY_MODE_CHANGE
Java Field: posEntryModeChange
Status: Active
SQL Type: varchar(3)
Java Type: String
Space-fill in authorization request message. If the entry mode has changed, the Issuer will respond with the 1-byte POS Entry Mode Change (Y).
Added On: 12/29/15
SQL Column: PROVIDER_ID
Java Field: providerId
Status: Active
SQL Type: varchar(3)
Java Type: String
Identification number of the provider.
Added On: 06/18/15
SQL Column: PURCHASE_IDENTIFIER
Java Field: purchaseIdentifier
Status: Active
SQL Type: varchar(25)
Java Type: String
For Visa the information in the field used by the merchant to identify the purchase (e.g., SKU number).
For MasterCard the code that the cardholder supplied to the merchant.
For American Express the customer reference number.
Added On: 11/05/12
SQL Column: RESPONSE_CODE
Java Field: responseCode
Status: Active
SQL Type: varchar(2)
Java Type: String
Indicates the status of the transaction. For details, refer to Bitmap 39 — Response Code on page 4-19.
Added On: 03/04/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: 11/06/12
SQL Column:
Java Field: serviceId
Status: Active
SQL Type:
Java Type: String
Digital number that represents the specific code of the product/service.
Added On: 12/13/16
SQL Column: SP_TAG08
Java Field: spTag08
Status: Active
SQL Type: varchar(1)
Java Type: String
Indicates whether security key update mechanism is activated.
Added On: 12/13/16
SQL Column: SP_TAG12
Java Field: spTag12
Status: Active
SQL Type: varchar(2)
Java Type: String
Identificator of the CA key.
Added On: 08/28/15
SQL Column: SP_TAG01
Java Field: spTag01
Status: Active
SQL Type: varchar(6)
Java Type: String
TransArmor Security Packet (SP) tags.
01 -Security Level.
Added On: 08/28/15
SQL Column: SP_TAG02
Java Field: spTag02
Status: Active
SQL Type: varchar(6)
Java Type: String
TransArmor Security Packet (SP) tags.
02 - Encryption Type.
Added On: 08/28/15
SQL Column: SP_TAG03
Java Field: spTag03
Status: Active
SQL Type: varchar(7)
Java Type: String
TransArmor Security Packet (SP) tags.
03 - Encryption Target.
Added On: 08/28/15
SQL Column: SP_TAG04
Java Field: spTag04
Status: Active
SQL Type: varchar(16)
Java Type: String
TransArmor Security Packet (SP) tags.
04 - Key ID.
Added On: 06/14/16
SQL Column:
Java Field: spTag05
Status: Active
SQL Type:
Java Type: String
If the transaction includes encrypted data, this field contains encrypted card number, track data, etc.
Added On: 08/28/15
SQL Column: SP_TAG06
Java Field: spTag06
Status: Active
SQL Type: varchar(9)
Java Type: String
TransArmor Security Packet (SP) tags.
06 - Token Type.
Added On: 08/28/15
SQL Column: SP_TAG07
Java Field: spTag07
Status: Active
SQL Type: varchar(24)
Java Type: String
TransArmor Security Packet (SP) tags.
07 - Token.
Added On: 08/28/15
SQL Column: SP_TAG10
Java Field: spTag10
Status: Active
SQL Type: varchar(8)
Java Type: String
TransArmor Security Packet (SP) tags.
10 - Provider ID.
Added On: 08/28/15
SQL Column: SP_TAG11
Java Field: spTag11
Status: Active
SQL Type: varchar(9)
Java Type: String
TransArmor Security Packet (SP) tags.
11 - ExpDate.
Nothing is to be sent from the merchant. These fields are passed in the response.
Added On: 10/05/17
SQL Column: SPEND_QUALIFIED_INDICATOR
Java Field: spendQualifiedIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 03/26/14
SQL Column: SUB_REQUEST_CL
Java Field: subRequestCl
Status: Active
SQL Type: varchar(1)
Java Type: String
Enumeration of possible sub requests available in the system.
Added On: 06/08/18
SQL Column: TABLE36_ORDER_NUMBER
Java Field: table36_order_number
Status: Active
SQL Type: varchar(15)
Java Type: String
Added On: 09/14/15
SQL Column: TABLE_DS_RESP
Java Field: tableDsResp
Status: Active
SQL Type: varchar(97)
Java Type: String
Table DS – Discover (JCB (US Domestic only), and Diners) Compliance – Fixed Portion.
Refer to the specification of the provider for more information.
Added On: 04/06/15
SQL Column: TABLE_EV
Java Field: tableEv
Status: Active
SQL Type: varchar(30)
Java Type: String
Additional Compliance Data.
For 0100 and 0200 authorization request processing, the fixed header portion of the ICC Table is sent in on the request message from the POS Device as a trigger that the device can receive the "EV" table in the 0110 or 0210 response message if applicable.
Refer to the specification of the provider for more information.
Added On: 09/14/15
SQL Column: TABLE_MC_RESP
Java Field: tableMcResp
Status: Active
SQL Type: varchar(56)
Java Type: String
Table MC - MasterCard Qualification Data.
Refer to the specification of the provider for more information.
Added On: 01/04/16
SQL Column: TABLE_TK_PN
Java Field: tableTkPn
Status: Active
SQL Type: varchar(4)
Java Type: String
Last 4 Digits of actual Account number.
Last 4 digits of actual account number will be returned back in auth response when it’s available from association, merchant can use it for receipt-printing purpose instead of using payment token number.
Added On: 01/04/16
SQL Column: TABLE_TK_TA
Java Field: tableTkTa
Status: Active
SQL Type: varchar(40)
Java Type: String
AMEX token cryptogram data.
Required tag for AMEX token in-app transaction. (AMEX Digital Wallet) Hex-Binary representation of 20 bytes binary data.
Added On: 01/04/16
SQL Column: TABLE_TK_TB
Java Field: tableTkTb
Status: Active
SQL Type: varchar(40)
Java Type: String
AMEX token cryptogram data.
Required tag for AMEX token in-app transaction. (AMEX Digital Wallet) Hex-Binary representation of 20 bytes binary data.
Added On: 01/04/16
SQL Column: TABLE_TK_TI
Java Field: tableTkTi
Status: Active
SQL Type: varchar(2)
Java Type: String
Token Assurance Level.
Token Assurance Level will be returned back to merchants in auth response when it’s available from association.
This tag should be included in capture message, if available from auth response.
Added On: 09/14/15
SQL Column: TABLE_VI_RESP
Java Field: tableViResp
Status: Active
SQL Type: varchar(20)
Java Type: String
Table VI - Visa Compliance Field Identifier Table.
Refer to the specification of the provider for more information.
Added On: 09/14/15
SQL Column: TABLE14_RESP
Java Field: table14Resp
Status: Active
SQL Type: varchar(106)
Java Type: String
CPS/2000 Additional credit card Data.
Refer to the specification of the provider for more information.
Added On: 06/05/14
SQL Column: TABLE60_ADDITIONAL_POS_INFO
Java Field: table60AdditionalPosInfo
Status: Active
SQL Type: varchar(2)
Java Type: String
MOTO/Bill Payment/Electronic-Commerce additional POS information.
Added On: 12/11/12
SQL Column: TABLE68_ACCOUNT_TYPE1
Java Field: table68AccountType1
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information.
Type of account used.
- 00 - Not specified
- 30 - Credit Card Account — used for cash disbursement.
Added On: 12/11/12
SQL Column: TABLE68_ACCOUNT_TYPE2
Java Field: table68AccountType2
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information.
Type of account used.
- 00 - Not specified
- 30 - Credit Card Account — used for cash disbursement.
Added On: 12/11/12
SQL Column: TABLE68_ACCOUNT_TYPE3
Java Field: table68AccountType3
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information.
Type of account used.
- 00 - Not specified
- 30 - Credit Card Account — used for cash disbursement.
Added On: 12/11/12
SQL Column: TABLE68_ACCOUNT_TYPE4
Java Field: table68AccountType4
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information.
Type of account used.
- 00 - Not specified
- 30 - Credit Card Account — used for cash disbursement.
Added On: 12/11/12
SQL Column: TABLE68_ACCOUNT_TYPE5
Java Field: table68AccountType5
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information.
Type of account used.
- 00 - Not specified
- 30 - Credit Card Account — used for cash disbursement.
Added On: 12/11/12
SQL Column: TABLE68_ACCOUNT_TYPE6
Java Field: table68AccountType6
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information.
Type of account used.
- 00 - Not specified
- 30 - Credit Card Account — used for cash disbursement.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT_TYPE1
Java Field: table68AmountType1
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information
Type of specified amount.
- 4S - Healthcare (Visa/MC only) - Qualified medical expenses (i.e. over-thecounter qualified medical items);
- 4T - Transit (Visa only) - Transit fare media such as commuter and parking passes, and mass transit vouchers and tickets;
- 40 - Cash Disbursement (Discover (JCB (US Domestic only), and Diners) Only) - Amount of Cash Back being requested;
- 4U - RX (Visa/MC only) - Sub-Total of Prescription RX;
- 4V - Vision (Visa only) - Sub-Total of Vision/Optical;
- 4W - Clinical (Visa only) - Sub-Total of Clinical;
- 4X - Dental (Visa only) - Sub-Total of Dental;
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT_TYPE2
Java Field: table68AmountType2
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information
Type of specified amount.
- 4S - Healthcare (Visa/MC only) - Qualified medical expenses (i.e. over-thecounter qualified medical items);
- 4T - Transit (Visa only) - Transit fare media such as commuter and parking passes, and mass transit vouchers and tickets;
- 40 - Cash Disbursement (Discover (JCB (US Domestic only), and Diners) Only) - Amount of Cash Back being requested;
- 4U - RX (Visa/MC only) - Sub-Total of Prescription RX;
- 4V - Vision (Visa only) - Sub-Total of Vision/Optical;
- 4W - Clinical (Visa only) - Sub-Total of Clinical;
- 4X - Dental (Visa only) - Sub-Total of Dental.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT_TYPE3
Java Field: table68AmountType3
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information
Type of specified amount.
- 4S - Healthcare (Visa/MC only) - Qualified medical expenses (i.e. over-thecounter qualified medical items);
- 4T - Transit (Visa only) - Transit fare media such as commuter and parking passes, and mass transit vouchers and tickets;
- 40 - Cash Disbursement (Discover (JCB (US Domestic only), and Diners) Only) - Amount of Cash Back being requested;
- 4U - RX (Visa/MC only) - Sub-Total of Prescription RX;
- 4V - Vision (Visa only) - Sub-Total of Vision/Optical;
- 4W - Clinical (Visa only) - Sub-Total of Clinical;
- 4X - Dental (Visa only) - Sub-Total of Dental.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT_TYPE4
Java Field: table68AmountType4
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information
Type of specified amount.
- 4S - Healthcare (Visa/MC only) - Qualified medical expenses (i.e. over-thecounter qualified medical items);
- 4T - Transit (Visa only) - Transit fare media such as commuter and parking passes, and mass transit vouchers and tickets;
- 40 - Cash Disbursement (Discover (JCB (US Domestic only), and Diners) Only) - Amount of Cash Back being requested;
- 4U - RX (Visa/MC only) - Sub-Total of Prescription RX;
- 4V - Vision (Visa only) - Sub-Total of Vision/Optical;
- 4W - Clinical (Visa only) - Sub-Total of Clinical;
- 4X - Dental (Visa only) - Sub-Total of Dental.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT_TYPE5
Java Field: table68AmountType5
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information
Type of specified amount.
- 4S - Healthcare (Visa/MC only) - Qualified medical expenses (i.e. over-thecounter qualified medical items);
- 4T - Transit (Visa only) - Transit fare media such as commuter and parking passes, and mass transit vouchers and tickets;
- 40 - Cash Disbursement (Discover (JCB (US Domestic only), and Diners) Only) - Amount of Cash Back being requested;
- 4U - RX (Visa/MC only) - Sub-Total of Prescription RX;
- 4V - Vision (Visa only) - Sub-Total of Vision/Optical;
- 4W - Clinical (Visa only) - Sub-Total of Clinical;
- 4X - Dental (Visa only) - Sub-Total of Dental.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT_TYPE6
Java Field: table68AmountType6
Status: Active
SQL Type: varchar(2)
Java Type: String
Additional Account/Amount Information
Type of specified amount.
- 4S - Healthcare (Visa/MC only) - Qualified medical expenses (i.e. over-thecounter qualified medical items);
- 4T - Transit (Visa only) - Transit fare media such as commuter and parking passes, and mass transit vouchers and tickets;
- 40 - Cash Disbursement (Discover (JCB (US Domestic only), and Diners) Only) - Amount of Cash Back being requested;
- 4U - RX (Visa/MC only) - Sub-Total of Prescription RX;
- 4V - Vision (Visa only) - Sub-Total of Vision/Optical;
- 4W - Clinical (Visa only) - Sub-Total of Clinical;
- 4X - Dental (Visa only) - Sub-Total of Dental.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT1
Java Field: table68Amount1
Status: Active
SQL Type: varchar(12)
Java Type: String
Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT2
Java Field: table68Amount2
Status: Active
SQL Type: varchar(12)
Java Type: String
Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT3
Java Field: table68Amount3
Status: Active
SQL Type: varchar(12)
Java Type: String
Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT4
Java Field: table68Amount4
Status: Active
SQL Type: varchar(12)
Java Type: String
Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT5
Java Field: table68Amount5
Status: Active
SQL Type: varchar(12)
Java Type: String
Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount.
Added On: 12/11/12
SQL Column: TABLE68_AMOUNT6
Java Field: table68Amount6
Status: Active
SQL Type: varchar(12)
Java Type: String
Additional Account/Amount Information.
12 digits, with implied decimal relative to the currency code. In Auto-Substantiation transactions, this value reflects the qualified amount of the total purchase. For Discover (JCB (US Domestic only), and Diners) credit card cash disbursement transactions, this value reflects the cash portion of the total purchase amount.
Added On: 12/11/12
SQL Column: TABLE68_CURRENCY_CODE1
Java Field: table68CurrencyCode1
Status: Active
SQL Type: varchar(3)
Java Type: String
Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field.
Added On: 12/11/12
SQL Column: TABLE68_CURRENCY_CODE2
Java Field: table68CurrencyCode2
Status: Active
SQL Type: varchar(3)
Java Type: String
Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field.
Added On: 12/11/12
SQL Column: TABLE68_CURRENCY_CODE3
Java Field: table68CurrencyCode3
Status: Active
SQL Type: varchar(3)
Java Type: String
Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field.
Added On: 12/11/12
SQL Column: TABLE68_CURRENCY_CODE4
Java Field: table68CurrencyCode4
Status: Active
SQL Type: varchar(3)
Java Type: String
Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field.
Added On: 12/11/12
SQL Column: TABLE68_CURRENCY_CODE5
Java Field: table68CurrencyCode5
Status: Active
SQL Type: varchar(3)
Java Type: String
Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field.
Added On: 12/11/12
SQL Column: TABLE68_CURRENCY_CODE6
Java Field: table68CurrencyCode6
Status: Active
SQL Type: varchar(3)
Java Type: String
Additional Account/Amount Information.
The 3-digit code defines the currency used in the amount field.
Added On: 12/11/12
SQL Column: TABLE68_SIGN_AMOUNT1
Java Field: table68SignAmount1
Status: Active
SQL Type: varchar(1)
Java Type: String
Additional Account/Amount Information.
- C - Positive Amount
- D - Negative Amount
Added On: 12/11/12
SQL Column: TABLE68_SIGN_AMOUNT2
Java Field: table68SignAmount2
Status: Active
SQL Type: varchar(1)
Java Type: String
Additional Account/Amount Information.
- C - Positive Amount
- D - Negative Amount
Added On: 12/11/12
SQL Column: TABLE68_SIGN_AMOUNT3
Java Field: table68SignAmount3
Status: Active
SQL Type: varchar(1)
Java Type: String
Additional Account/Amount Information.
- C - Positive Amount
- D - Negative Amount
Added On: 12/11/12
SQL Column: TABLE68_SIGN_AMOUNT4
Java Field: table68SignAmount4
Status: Active
SQL Type: varchar(1)
Java Type: String
Additional Account/Amount Information.
- C - Positive Amount
- D - Negative Amount
Added On: 12/11/12
SQL Column: TABLE68_SIGN_AMOUNT5
Java Field: table68SignAmount5
Status: Active
SQL Type: varchar(1)
Java Type: String
Additional Account/Amount Information.
- C - Positive Amount
- D - Negative Amount
Added On: 12/11/12
SQL Column: TABLE68_SIGN_AMOUNT6
Java Field: table68SignAmount6
Status: Active
SQL Type: varchar(1)
Java Type: String
Additional Account/Amount Information.
- C - Positive Amount
- D - Negative Amount
Added On: 06/18/15
SQL Column: TAX_AMOUNT
Java Field: taxAmount
Status: Active
SQL Type: varchar(12)
Java Type: String
For Visa the amount of state or provincial tax included in the transaction amount. The tax amount must be within 0.1 % and 22% of the transaction amount. Two (2) decimal places are implied and size can be 12 bytes.
For MasterCard the total amount of sales tax or VAT on the total purchase must be between 0.1% and 30 % of the total transaction amount; zeroes indicate that the card acceptor is capable of transmitting the tax amount and the tax amount is zero. Right justified and zero filled. Two (2) decimal places are implied and size can be 9 bytes maximum.
For American Express the amount of tax calculated or entered for the transaction. Two (2) decimal places are implied and size can be 12 bytes.
Note: Refer to Conditional Requirement Matrix for further detail.
Added On: 06/18/15
SQL Column: TAX_INDICATOR
Java Field: taxIndicator
Status: Active
SQL Type: varchar(1)
Java Type: String
Mandatory for Visa and MasterCard.
Visa
- 0 - No tax information provided.
- 1 - Local tax amount is provided.
- 2 - Item is tax exempt or non taxable (The Local Tax Amount [above] must be zero).
MasterCard
An indicator used to reflect sales tax capture and reporting:
- Y - Sales tax included in total purchase amount
- N - Merchant has ability to provide tax amount, but goods/services were not taxable
- Space - Sales tax not provided
Added On: 12/29/15
SQL Column: TOKEN_CODE
Java Field: tokenCode
Status: Active
SQL Type: varchar(19)
Java Type: String
Token code used for the transaction.
Added On: 01/04/16
SQL Column: TOKEN_REQUESTOR_ID
Java Field: tokenRequestorId
Status: Active
SQL Type: varchar(11)
Java Type: String
For payment token transactions, merchant should send in token requestor id when it’s available. It’s a required field for MasterCard card-on-file token transactions.
Token Requestor ID will also be returned/ echoed back to merchant in payment token response message when it’s available from association.
This tag should be included in capture message, if available from auth response.
Added On: 11/05/12
SQL Column: TRAN_ID
Java Field: tranId
Status: Active
SQL Type: varchar(15)
Java Type: String
Terminal will send X‘20‘ (spaces) in initial authorization message.
Transaction Identifier back in the authorization response.
Added On: 11/05/12
SQL Column: TRANSACTION_EDIT_ERROR_CODE
Java Field: transactionEditErrorCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Space-fill in authorization request message. If there is an error, the Issuer will respond with the 1-byte Transaction Edit Error Code.
Added On: 11/01/18
SQL Column: UCAF_COLLECTOR_DATA
Java Field: ucafCollectorData
Status: Active
SQL Type: varchar(3)
Java Type: String
Added On: 11/01/18
SQL Column: UCAF_DOWNGRADE_REASON_CODE
Java Field: ucafDowngradeReasonCode
Status: Active
SQL Type: varchar(1)
Java Type: String
Added On: 11/06/12
SQL Column:
Java Field: urls
Status: Active
SQL Type:
Java Type: String
URL adresses. For example, E-commerce URL address.
Added On: 11/05/12
SQL Column: VALIDATION_CODE
Java Field: validationCode
Status: Active
SQL Type: varchar(4)
Java Type: String
Space-filled for initial authorization message. The Issuer response will be sent for incremental authorizations and reversals.
Added On: 12/02/12
SQL Column: VPAS_RESPONSE_VALUE
Java Field: vpasResponseValue
Status: Active
SQL Type: varchar(1)
Java Type: String
VPAS (Visa Payer Authentication Service) response value.