EMV API Fields

This chapter provides you with the additional Elavon Gateway API field requirements for EMV. The API fields for all industries are provided in the Elavon Gateway Message Getting Started Guide. This template serves as a supplement to the basic (core) API fields by providing you with the fields required for EMV.

Warning: Elavon strongly recommends that your application retain until completion, and / or settlement of the transaction, those fields noted with a under the Store column. Any other fields can be stored at the discretion of the integrator.

| Types | | |——-|-| | N | Numeric | | A / N | Alphanumeric | | C | Dollar / cents amount, including decimal point (ex. 1.00). Dollar amounts less than $1.00 must be prefixed with a leading zero. |

The actual fields returned in the Output Response are dependent on the TPP interface module being used. If the interface requires the data, and the processor returns the information, the field information is returned in a format dictated by the processor.

In, Out, and Store Descriptions

In

The actual Elavon Gateway API fields sent in the Input Request are dependent on the TPP interface module being used, the POS and the Payment application. If the interface requires the data, and the data is supplied to Fusebox, it is sent in the format required by the processor.

Out

The actual fields returned in the Output Response are dependent on the TPP Interface module being used. If the interface requires the data, and the processor returns the information, it is returned in the format required by the processor and returned to the POS using the Elavon Gateway API.

Store

We strongly recommend that your application retain until completion, and / or settlement of the transaction, those fields noted with a check mark under the Store column. Any other fields can be stored at the discretion of the integrator. Some EMV fields never reach Fusebox as they are generated in the 2nd Generate AC occurring between the EMV Kernel and the ICC chip after the response has left Fusebox. Those fields should be stored by the POS system.

Gateway EMV API Fields

EMV binary data must be translated to ASCII in order to be accepted by the Fusebox switch. The field sizes have been adjusted accordingly.

API Field # Field Name Size Type Option / Description In Out Store
0002 Transaction Amount 1-14 C Authorized Amount. EMV Tag 9F02
0013 Transaction Date 6 N Terminal Transaction Date. EMV Tag 9A
0017 Cash Back 1-14 C Cashback / Other Amount - Optional

EMV Tag 9F03
0023 Account Type 2 N Type of account used. 00=Checking (default) 01 = Savings 02 = Other, 03 = Credit

EMV Tag 5F57
0052 Transponder / Proximity Indicator 1 N Indicator stating that a transponder or proximity device was used to originate the transaction. Valid values:

0 = no transponder

1 = transponder initiated transaction

2 = Proximity using VSDC rules

3 = Proximity using magstripe rules

4 = Chip / Smart Card

5 = Transponder equipped using magstripe or key entry
0054 POS Entry Mode 2 N ISO POS Entry Mode values:

00-Unknown

01 – Manual / Key Entry

04 – OCR code read

05 – Integrated circuit card read - CVV data reliable (smart card)

07 – Contactless M/Chip or Visa Smart Card read

10 - Scanned MICR/check

79 – Chip Card capable – chip and magstripe read failed, fall back to manual

80 – Chip Card capable - unaltered track data read (used for EMV fall back to swipe)

82 – Contactless Mobile Commerce device

90 – Magnetic Stripe-CVV/CVC certified, unaltered Track Data (1 or 2) included in Authorization Request. Required to participate in PS/2000 or CPS/2000

91 – Contactless chip magnetic stripe read

95 – Integrated circuit card read - CVV data unreliable

85 – Internet (not an ISO value)
0055 PIN Capabilities 1 N PIN Capabilities Flag of POS Entry Mode.

ISO specs, values:

0 – Unknown

1 – Can accept PIN

2 – Cannot accept PIN (Valid Value for Transponders)

8 – PIN Pad is down

9 - PIN verified by terminal device
0057 ICC Chip Condition Code 1 N Required to support Fallback identification for EMV enabled POS. Provides information about magnetic-stripe read or manually-entered transactions for ICC enabled cards at EMV-capable terminals.

0 – ICC enabled card chip read

1 – ICC enabled card first magnetic stripe Fallback

2 – ICC enabled card subsequent magnetic stripe Fallback

3 – ICC enabled card manually entered Fallback.
0140 Terminal Currency Tri-graph 3 A ISO alpha currency code of the terminal running at the merchant location
0141 Terminal Currency Code 3 N ISO numeric currency code of the terminal running at the merchant location. Code defining the common currency used by the terminal in case the Transaction Currency Code is different from the Application Currency Code. EMV Tag 9F3C
0163 Cardholder Language Preference 2 A/N Alpha characters according to ISO 639 representing language indicated by cardholder or card data for transaction. EMV Tag 5F2D
0201 TIP 1-14 C Tip / Other Amount - Optional. EMV Tag 9F03
1300 Application Cryptogram 16 A/N Cryptogram returned by the ICC in response to the “Generate AC’ command. Used by the issuer to verify the request came from the card. EMV Tag 9F26
1301 Issuer Authentication Data 32 A/N Data sent to the ICC for online issuer authentication, used by the ICC to verify the response came from the issuer. EMV Tag 91
1302 Application Expiration Date 6 N Date after which application expires. Format YYMMDD. EMV Tag 5F24
1303 Cardholder Verification Method (CVM) Results 1-6 A/N Indicates the results of the last CVM performed. EMV Tag 9F34
1304 Device (IFD) Serial Number 8 A/N Unique and permanent serial number assigned to the IFD by the manufacturer.

EMV Tag 9F1E
1305 Issuer Application Data 1-64 A/N Contains proprietary application data for transmission to the issuer in an online transaction. EMV Tag 9F10
1306 Terminal Capabilities 6 A/N Indicates the card data input, CVM and security capabilities of the terminal. EMV Tag 9F33
1307 Terminal Verification Result (TVR) 10 A/N A set of indicators from the terminal application risk analysis and cardholder verification. EMV Tag 95
1308 Pre-AC Generate Issuer Scripts 1-256 A/N Contains proprietary issuer data for transmission to the ICC before the second GENERATE AC command. EMV Tag 71
1309 Issuer Script Results 1-84 A/N Indicates the result of the terminal script processing. EMV Tag 9F5B
1310 Issuer Script Identifier 8 A/N Identification of the Issuer Script. EMV Tag 9F18
1311 Application Currency Code 3 N Indicates the country of the ICC chip issuer. EMV Tag 9F42
1312 Terminal Country Code 3 N Indicates the country of the terminal. EMV Tag 9F1A
1313 Application PAN Sequence Number 2 N Identifies and differentiates cards with the same PAN. EMV Tag 5F34
1314 Dedicated File Name 10-32 A/N Identifies the name of the DF as described in ISO/IEC 7816-4. EMV Tag 84
1315 ICC Application Version Number 4 A/N Version number assigned by the payment system for the application. EMV Tag 9F08
1316 EMV Device ID 8 A/N Designates the unique location of a terminal at a merchant (aka Terminal Identification). EMV Tag 9F1C
1317 Terminal Application Version Number 4 A/N Version number assigned by the payment system for the application. EMV Tag 9F09
1318 Transaction Sequence Counter 1-8 N Counter maintained by the terminal application that is incremented by one for each transaction. EMV Tag 9F41
1319 Application Interchange Profile 4 A/N Indicates the capabilities of the card to support specific functions in the application. EMV Tag 82
1320 Application Transaction Counter (ATC) 4 A/N Counter maintained by the application in the ICC (incrementing the ATC is managed by the ICC). EMV Tag 9F36
1321 Cryptogram Information Data 2 A/N Indicates the type of cryptogram and the actions to be performed by the terminal. EMV Tag 9F27
1322 Terminal Type 2 A/N Indicates the environment of the terminal, its communications capability, and its operational control. EMV Tag 9F35
1323 Unpredictable Number 8 A/N Value to provide variability and uniqueness to the generation of a cryptogram. EMV Tag 9F37
1325 ICC Application Identifier 6-32 A/N ICC AID - Identifies the application as described in ISO/IEC 7816-5. EMV Tag 4F
1326 ICC Application Preferred Name 1-16 A/N Preferred mnemonic associated with the AID. EMV Tag 9F12
1327 Application Label 1-16 A/N Mnemonic associated with the AID according to ISO/IEC 7816-5. EMV Tag 50
1328 Terminal Application Identifier 6-32 A/N Terminal AID - Identifies the application as described in ISO/IEC 7816-5. RID is first 10 bytes of AID data. Terminal AID - Identifies the application as described in ISO/IEC 7816-5. RID is first 10 bytes of AID data. EMV Tag 9F06
1329 Default Issuer Action Code 10 A/N Specifies the issuer’s conditions that cause a transaction to be rejected if it might have been approved online, but the terminal is unable to process the transaction online. EMV Tag 9F0D
1330 Denial Issuer Action Code 10 A/N Specifies the issuer’s conditions that cause the denial of a transaction without attempt to go online. EMV Tag 9F0E
1331 Online Issuer Action Code 10 A/N Specifies the issuer’s conditions that cause a transaction to go online. EMV Tag 9F0F
1332 Application Usage Control 4 A/N Indicates issuer’s specified restrictions on the geographic usage and services allowed for the application. EMV Tag 9F07
1333 Last Host EMV Key Download 8 N Indicates the date of the latest EMV Key Update in MMDDYYYY format. If this date changes in the response messages, it indicates a new download may be required.
1334 Transaction Status Information 4 A/N Indicates the functions performed in a transaction. EMV Tag 9B
1338 Smart Card Scheme 2 A/N Smart Card Scheme. EMV Tag DF04
1339 EMV Response Code 1-2 A/N EMV Response Code. EMV Tag 8A
1340 Extra EMV ISO TLV Data 1-685 A/N Any extra EMV Tag data, without an Elavon Gateway API Field identified, put in this field in TLV format.
1343 Post-AC Generate Issuer Scripts 1-265 A/N Contains proprietary issuer data for transmission to the ICC after the second GENERATE AC command. EMV Tag 72
1345 ICC Form Factor Indicator 8 A/N Form Factor Indicator. EMV Tag 9F6E
1346 ICC Customer Data 1-64 A/N Customer Exclusive Data. EMV Tag 9F7C
1357 Transaction Currency Code 3 A/N Indicates the currency code of the transaction according to ISO 4217. Indicates the currency code of the transaction according to ISO 4217. EMV Tag 5F2A
1358 Cryptogram Tran Type 2 A/N EMV Transaction Type. EMV Tag 9C
1359 EMV CVM Verification Indicator 1 A/N Field to indicate to the POS the cardholder verification methods. Valid values are:

0 - Failed CVM

1 - Signature required

2 - PIN verified

3 - PIN verified and signature required
1361 Issuer Country Code 3 A/N Issuer Country Code. EMV Tag 5F56
1378 EMV Approved Receipt Field List 1-256 A/N A delimited field containing the Elavon Gateway API fields required by the merchant’s TPP to be printed to meet the additional EMV receipt requirements.
1379 EMV Declined Receipt Field List 1-256 A/N A delimited field containing the Elavon Gateway API fields required by the merchant’s TPP to be printed to meet the additional EMV receipt requirements.
1380 POS Entry Indicator 1-20 A/N TPP specific POS Entry Mode text for receipts based on the value in Field 0054 and the TPP rules.
Depending on the payment type, card type, transaction type, the Third Party Processor being interfaced with, and other factors, not all of these tags may be available on every transaction. The recommended best practice is for the EMV Payment Application to retrieve all of the EMV tag data available from the EMV Kernel and place the values into the appropriate API field. If an EMV tag is present with no existing API field identified, the data should be entered into API Field 1340 in TLV format.