Field Definitions
| Field Name | Length Type | Description |
|---|---|---|
| HD.Network_Routing_Code | 2 numeric | Facilitates network routing for this transaction. Valid values:
|
| HD.Network_Status_Byte | 1 alpha | Facilitates network handling of the call for this transaction. Valid codes:
|
| HD.Application_ID | 8 alpha | Indicates the type of POS device that is originating the transaction. These values are case sensitive and must be capitalized. Each digit is described with corresponding valid values in the Application-ID table below. Example: HZ0000GC |
| HD.Terminal_ID | 22 numeric | Uniquely identifies the Merchant and their financial institution to Elavon. The Terminal ID consists of two parts and is assigned by Elavon for each POS device. Digits 1-6 (Bank Number) - This six digit fixed length value is assigned by Elavon. Digits 7-22 (Terminal Number or ID) - This sixteen digit fixed length value is assigned by Elavon. |
| HD.Device_Tag RD.Device_Tag | 6 alpha | Optional field that is used by the POS for routing the response back to the originating source (in the case of multi-trans / multi-lane systems). Valid Characters (a-z and 0-9) (restricted characters do not allow = or ^). |
| 01.POS_Entry_Capability 92.POS_Entry_Capability | 2 numeric | Identifies the account entry capabilities on the POS device originating the transaction. See POS_Entry_Capability table for valid codes. |
| 01.Account_Entry_Mode 60.Account_Entry_Mode 92.Account_Entry_Mode | 2 numeric | Identifies the method used to enter the Account Data for the transaction. See Account_Entry_Mode table for valid codes. |
| 01.Partial_Auth_Indicator | 1 numeric | Indicates if the POS is capable of performing partial authorizations. Valid values:
|
| 01.Account_Data 8D.Account_Data 92.Accunt_Data | alpha | Submits the cardholder account data to Elavon for processing. See the Account_Data table for valid formats. |
| 01.Transaction_Amount 05.Transaction_Amount 52.Transaction_Amount 84.Transaction_Amount 92.Transaction_Amount | 12 numeric | The actual amount of the transaction. The maximum transaction amounts supported are currently $9,999,999.99 for Visa and MasterCard, and $99,999.99 all other card associations. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. For Terminal-Based Settlement messages, this value will contain the total amount of the transaction in the Merchant’s currency, including any tips (for restaurant transactions). For Canadian Debit Authorization Response messages, this field is zero-filled and right-justified to 12 characters. |
| 01.Last_Record_Number 77.Last_Record_Number | 4 numeric | This value should contain the record number returned in the last response message to Elavon. Last Record Number processed by Elavon 0001 – 9999. In the Terminal-Based environment, the last record number should be 0000. After a manual settlement has successfully completed this value should be reset to 0000. |
| 01.Void_Record_Number | 4 numeric | This value should contain the record number of the transaction to void in the open batch. Numeric value between 0001 and 9999. |
| 01.PIN_Entry_Capability 92.PIN_Entry_Capability | 1 numeric | This value is used to indicate the capability of the terminal to capture a PIN. Valid values:
|
| 01.Terminal_Type 92.Terminal_Type | 2 numeric | This value is used to indicate the type of POS device used at the point of authorization. Valid values:
|
| 01.CAT_Indicator 92.CAT_Indicator | 2 numeric | Indicates the type of Cardholder Activated Terminal Indicator for this transaction. Valid values:
|
| 01.Token_Indicator 60.Token_Indicator 92.Token_Indicator | 1 numeric | Identifies if the data in the Account Data field contains an Elavon-defined token replacement value instead of the original account data. Valid values:
|
| 01.Association_Token_Indicator | 1 numeric | Identifies if the data in the Account Data field contains an Association-defined token replacement value instead of the original account data. Valid values:
|
| 01.Voucher_Indicator 92.Voucher_Indicator | 1 numeric | Identifies if the transaction is a Brazilian Voucher transaction. Valid values:
|
| 01.Stored_Credential_Indicator 92.Stored_Credential_Indicator | 1 alpha | Identifies when a cardholder’s credentials are being stored for the first time. It is also used to identify when a merchant is submitting an “unscheduled” recurring transaction using a consumer’s previously stored “credential on file”. Valid values:
|
| 01.mPOS_Acceptance_Device 92.mPOS_Acceptance_Device | 2 numeric | Indicates the type of mobile device used for an mPOS transaction. Valid values:
|
| 01.PAR_Value 02.PAR_Value 92.PAR_Value | 35 alpha | The payment account reference (PAR) is a non-financial reference that is assigned to a cardholder’s account and links all activity related to that underlying payment account. |
| 02.Response_Code 04.Response_Code 73.Response_Code 81.Response_Code | 2 alpha | 2-character code indicating the authorization response status. An approval is always indicated with an ‘AA’, ‘AP’ or ‘AC’ code, all other codes indicate a non-approval. Valid values:
|
| 02.Issuer_Response_Code 19.Issuer_Response_Code | 3 alpha | This value is the original Issuer response as returned during the authorization attempt. |
| 02.Authorization_Source 92.Authorization_Source | 1 alpha | Indicates the source for the authorization response. The values in this response message are subject to additions. For On-Line transactions, the codes are supplied by the Issuer and are returned by Elavon in the response message for all on line approvals. For Off-Line transactions, this is a one character field in the table below contains the Authorization Source code. Valid values:
|
| 02.Capture_Code | 1 numeric | Indicates to the POS which transactions should be captured in the local Shadow file. Valid values:
|
| 02.Approval_Code 19.Approval_Code 54.Approval_Code 55.Approval_Code 59.Approval_Code 65.Approval_Code 92.Approval_Code | 6 alpha | This field contains the approval code for the transaction. Note: If the Response Code on the authorization is not equal to “AA”, “AP” or “AC” the contents of this field are ignored. |
| 02.Authorization_Date 52.Authorization_Date 54.Authorization_Date 73.Authorization_Date 92.Authorization_Date | 6 numeric | The date which the transaction was authorized. For offline transactions, this value should be set to the date when the transaction occurs. Format is MMDDYY. |
| 02.Authorization_Time 52.Authorization_Time 54.Authorization_Time 73.Authorization_Time 92.Authorization_Time | 6 numeric | The time which the transaction was authorized. For offline transactions, this value should be set to the time when the transaction occurs. Format: HHMMSS. |
| 02.Batch_Number 88.Batch_Number 89.Batch_Number 8A.Batch_Number 90.Batch_Number | 3 numeric | Assigned by the Elavon host and will be returned in the authorization and batch response messages. For Terminal-Based authorization response messages, the batch number will be zero (0). |
| 02.Record_Number 78.Record_Number 91.Record_Number 92.Record_Number 9F.Record_Number | 4 numeric | Identifies the sequence number for the transaction. For Host-Based authorization responses, this value is returned by Elavon. For Terminal-Based processing this value will always be zero (0). For Settlement messages, this value identifies the record number for the transaction in the batch. |
| 02.Authorization_Response | 16 alpha | This field contains the 16 character response display message. Used by the POS device to display the authorization results. See Authorization_Response table for codes and definitions. |
| 02.Trace_Number 19.Trace_Number 59.Trace_Number | 6 numeric | Used as a message reference number identify the transaction request and is returned in all authorization response messages. It is sent to the host on reversal and void messages when applicable. |
| 02.Transaction_Reference_Nbr 19.Transaction_Reference_Nbr 59.Transaction_Reference_Nbr 96.Transaction_Reference_Nbr | 10 numeric | Returned in the authorization response message and is used on void and reversal transactions, when available. |
| 02.OAR_Data 04.OAR_Data | 60 alpha | This “retain and return” field is used by Elavon to return data elements in the original authorization response message for use on subsequent transactions, such as Incrementals, Voids or Reversals. |
| 02.Spend_Qualifier 92.Spend_Qualifier | 1 alpha | Returns the Spend qualifier indicator used to indicate if spend thresholds have been met for Ultra High net worth cardholders. Valid values:
|
| 02.Association_Name | 38 alpha | Returned in the authorization response messages and is used to indicate the association name for the transaction, for example: Visa, Visa Debit, Visa Electron, MasterCard, MasterCard Debit, EBT, etc. |
| 03.Merchant_Reference_Nbr | 11 numeric | Contains the merchant assigned reference number for this transaction. If this value is not present, then Elavon will generate this number for backend use. |
| 03.Dynamic_Auth_Type_Indicator | 1 alpha | Allows the Payment Facilitator to dynamically send the authorization type for the sub-merchant that is submitting the transaction. Valid values:
|
| 03.Dynamic_City | 13 alpha | Allows the merchant’s city location to be dynamically changed on each transaction submitted to the host for authorization. The use of the Dynamic City 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. |
| 03.Dynamic_Country_Code | 3 alpha | Allows the merchant’s country code (ISO 366-1) to be changed on each transaction submitted to the host for authorization. The use of the Dynamic Country Code 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. |
| 03.Dynamic_DBA_Name | 25 alpha | Allows the merchant to dynamically change the “Doing Business As” name on each transaction submitted to the host for authorization and settlement. 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. |
| 03.Dynamic_Email_Address | 70 alpha | Allows the merchant’s email address to be dynamically changed on each transaction submitted to the host for authorization and settlement. The use of the Dynamic Email Address 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. |
| 03.Dynamic_MCC | 4 numeric | Allows the merchant’s merchant Category Code (MCC) to be dynamically changed on each transaction submitted to the host for authorization. The use of the Dynamic MCC 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. |
| 03.Dynamic_Phone_Number | 20 numeric | Allows for the merchant’s phone number to be dynamically changed on each transaction submitted to the host for authorization and settlement. The use of the Dynamic Phone Number 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. |
| 03.Dynamic_Postal_Code | 9 alpha | Allows the merchant’s postal code to be dynamically changed on each transaction submitted to the host for authorization and settlement. The use of the Dynamic Postal Code 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. |
| 03.Dynamic_State | 2 alpha | Allows the merchant’s State to be dynamically changed on each transaction submitted to the host for authorization and settlement. The use of the Dynamic State 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. |
| 03.Dynamic_Street_Address | 30 alpha | Allows the merchant’s street address to be dynamically changed on each transaction submitted to the host for authorization and settlement. The use of the Dynamic Street Address 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. |
| 03.Dynamic_Sub-Merchant_ID | 15 numeric | Allows the sub-merchant ID to be dynamically changed on each transaction submitted to the host for authorization and settlement. The use of the Dynamic Sub-Merchant ID 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. |
| 03.Dynamic_Tax_ID | 14 alpha | Allows the sub-merchant’s tax ID to be dynamically changed on each transaction submitted to the host for authorization. The use of the Dynamic Tax ID 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. |
| 04.Transaction_Code | 3 alpha | Used to uniquely identify the type of transaction that is being submitted to Elavon. See the list of codes and descriptions. |
| 04.Original_Auth_Amount 92.Original_Auth_Amount | 12 numeric | This is the original amount that was submitted for authorization of the transaction. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 04.Cumulative_Auth_Amount | ||
| 05.State_Tax_Amount | 10 numeric | The state tax amount applied to this transaction. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 05.Municipal_Tax_Amount | 10 numeric | The municipal tax amount applied to this transaction. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 06.Lane_Number | 8 numeric | Allows a multi-lane retailer using interleaved processing to send up a unique value that will identify the lane where the transaction originated from. |
| 07.Format_Code | 3 alpha | A unique code that is used by the Merchant to denote the specific parsing rules for the merchant defined data that is contained in the Format Data field. Valid values:
|
| 07.Format_Data | 152 or 596 alpha | Sends Merchant-defined data for custom reporting. The Format Code field is used to denote different parsing structure for this field, if necessary. The POS logistics messages can be up to 596 characters in length, however all other messages must conform to a maximum of 152 characters in length. |
| 08.Mobile-Wallet_Type | 4 alpha | Indicates the type of mobile wallet used for the transaction. Valid values:
|
| 10.Postal_Zip_Code | 9 alpha | Indicates the cardholder’s Postal or Zip Code. 5 or 9 digits. |
| 10.Street_Address | 20 alpha | The cardholder’s street address. Example: “1234 Main Street” |
| 10.CVV2_Indicator | 1 numeric | Indicates the presence of the CVV2 data on the Visa card. For non-Visa Cards, the value of “Present” should be used when CVC2 or CID data is present, or “Bypassed” when not present. Valid values:
|
| 10.CVV2_Value | 4 alpha | Appears at the end of the printed PAN on the reserve side of the card and is used to verify a card’s presence in the mail order, telephone order (MO/TO) and card-not-present environments. (Left Justified, Trailing Spaces) |
| 11.Sales_Tax | 10 numeric | The actual sales tax amount applied to this transaction. Consumer or merchant initiated tax exempt transactions should be submitted by entering a single zero in this field. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 11.Customer_Code | 17 alpha | Identifies the customer number for purchasing card transactions. |
| 12.Invoice_Number | 25 alpha | Includes the POS’s local transaction invoice or order number. This is a required value for Mail Order and Ecommerce transactions. |
| 12.Shipping_Date | 8 numeric | The date that the consumer’s goods were shipped. This value is the “Transaction Date” for direct marketing and ecommerce transactions. Format: MMDDYYYY |
| 12.Multi-Clearing_Sequence_Nbr | 2 numeric | Includes the multi-clearing settlement sequence number for this transaction. Only use this value if you are settling multiple records from a single original authorization attempt. The sequence number for the initial multi-clearing transaction starts as “01” and is incremented for each subsequent clearing item sent. |
| 12.Multi-Clearing_Sequence_Count | 2 numeric | The total number of clearing records, if known, else Zero Fill. The final transaction should contain the final number of settlement detail records submitted for this transaction. |
| 12.Multi-Clearing_Partial_Reversal_Flag | 1 alpha | Indicates if a partial reversal is necessary for a Multi-Clearing transaction. This should only be used on the final transaction in the sequence and only if there is a remaining balance left from the original authorization amount. Valid values:
|
| 12.Multi-Clearing_Partial_Reversal_Amount | 12 numeric | Indicates the amount to be submitted for a partial reversal on the final Multi-Clearing transaction, if necessary. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 13.E-Commerce_Indicator | 1 alpha | Indicates the method used to capture the cardholder’s information for an eCommerce or internet transaction. Valid values:
|
| 13.DDD_Secure_Value | hex | Returned by the 3-D Secure authentication system for Visa (Verified by VISA), MasterCard (SecureCode), American Express (SafeKey) or Discover (ProtectBuy) programs. The Cardholder Authentication Verification Value (CAVV) is a cryptographic value that is generated by the Issuer’s Verified By VISA (ACS) server when a registered cardholder successfully passes the verification process. (40 Characters) The Universal Cardholder Authentication Field (UCAF) is a cryptographic value or “security token” for MasterCard cardholders who successfully pass the verification process. (up to 48 Characters) This field can be used for American Express to submit a SafeKey Cryptogram (40 characters) for 3DSecure processing or up to two SafeKey Cryptograms (40 or 80 characters). Used for an American Express Digital Wallet Transaction. This field can be used to submit the CAVV value for a Discover Protect Buy 3DSecure transaction or for an “In-App” purchase from a mobile device. (40 Characters) |
| 13.UCAF_Indicator | 1 numeric | Identifies the means in which the transaction was processed between the cardholder and the merchant for a SecureCode authentication transaction. Valid values:
|
| 13.Program_Protocol | 1 alpha | Indicates the type of 3D Secure protocol used. Valid values:
|
| 13.Directory_Server_Tran_ID | 36 alpha | Generated by the Directory Server during the authentication transaction and passed back to the merchant with the authentication results. Code: 01 - Directory Server Transaction ID |
| 14.Recurring_Payment_Type | 1 numeric | Identifies the type of recurring transaction that is being submitted for authorization. See the Recurring_Payment_Type table for further information. |
| 14.Installment_Number | 2 numeric | Indicates the current payment number for an installment transaction. For example, if the consumer is making payment 1 of 12, then this value should be set to “1”. |
| 14.Installment_Count | 2 numeric | Indicates the total number of payments for an installment transaction. For example, if the consumer is making payment 1 of 12, then this value should be set to “12”. |
| 14.Deferment_Count | 2 numeric | Number of Months to defer the first installment payment. |
| 15.DCC_Indicator | 1 alpha | Indicates that the POS device is Dynamic Currency Conversion (DCC) capable and the current transaction is eligible for conversion. Valid values:
|
| 15.DCC_Exponent 82.DCC_Exponent | 1 numeric | The number of exponent digits in the DCC Rate. Valid values are 0-9 |
| 15.DCC_Rate 82.DCC_Rate | 8 numeric | The DCC Exponent identifies where the decimal is positioned in this value starting from the right. For example, “12345678” with an exponent of “5” would be represented as a foreign exchange rate of “123.45678” |
| 15.Cardholder_Amount | cents | Amount of the transaction that the cardholder will be billed in the card issued currency. For Terminal-Based settlement messages, this value will contain the total amount of the transaction in the Cardholder’s currency, including any Tips (for restaurant transactions). |
| 15.Cardholder_Currency | 3 alpha | The Cardholder’s currency code as represented by the three (3) digit alpha Currency value. This is used on DCC transactions only. See the Currency Code Table for a complete list of currencies. |
| 15.Merchant_Currency 81.Merchant_Currency | 3 alpha | The three (3) digit alpha currency code value. This is used on DCC transactions only. |
| 15.DCC_Markup_Percentage 81.DCC_Markup_Percentage | 4 numeric | The markup percentage that has been included in the calculation of the DCC rate for this transaction. It is expressed with two implied decimals. For example, 3.25% is sent as 0325. |
| 15.DCC_Rate_Provider_Name 81.DCC_Rate_Provider_Name | 35 alpha | Returns the name of the entity that provided the currency exchange rate. |
| 16.ICC_Cryptogram 97.ICC_Cryptogram | 16 hex | Returned by the Chip (ICC) in response to a “Generate AC” command. EMV Tag 9F26 (Space Fill if not present from the chip). |
| 16.ICC_CID 97.ICC_CID | 2 hex | Indicates the type of cryptogram and the actions to be performed by the terminal. EMV Tag 9F27 (Space Fill if not present from the chip) |
| 16.ICC_Unpredictable_Number 97.ICC_Unpredictable_Number | 8 hex | Provides variability and uniqueness to the generation of a cryptogram. EMV Tag 9F37 (Space Fill if not present from the chip) |
| 16.ICC_ATC 86.ICC_ATC 97.ICC_ATC | 4 hex | An incrementing counter value that is managed by the application in the chip card. EMV Tag 9F36 (Space Fill if not present from the chip) |
| 16.ICC_TVR 97.ICC_TVR | 10 hex | Indicates the status of the different functions as seen from the terminal. EMV Tag 95 (Space Fill if not present from the chip) |
| 16.ICC_TT 97.ICC_TT | 2 numeric | Indicates the type of financial transaction, represented by the first two digits of the ISO 8583 processing code. EMV Tag 9C (Space Fill if not present from the chip) |
| 16.ICC_AIP 97.ICC_AIP | 4 hex | Indicates the capabilities of the card to support specific functions within the application. EMV Tag 82 (Space Fill if not present from the chip) |
| 16.ICC_TCP 97.ICC_TCP | 6 hex | Indicates the card data input, CVM, and security capabilities of the terminal. EMV Tag 9F33 (Space Fill if not present from the chip) |
| 16.ICC_CVMR 97.ICC_CVMR | 6 hex | Indicates the results of the last CVM performed. EMV Tag 9F34 (Space Fill if not present from the chip) |
| 16.ICC_TTD 97.ICC_TTD | 6 numeric | Indicates the local date that the transaction was authorized. Format: YYMMDD. EMV Tag 9A (Space Fill if not present from the chip). |
| 16.ICC_Transaction_Currency 97.ICC_Transaction_Currency | 3 numeric | Indicates the currency code of the transaction according to the ISO 4217 standard. EMV Tag 5F2A (Space Fill if not present from the chip) |
| 16.ICC_Authorized_Amount 97.ICC_Authorized_Amount | 12 numeric | Indicates the authorized amount of the transaction (excluding adjustments). EMV Tag 9F02 (Space Fill if not present from the chip) |
| 16.ICC_Other_Amount 97.ICC_Other_Amount | 12 numeric | Indicates a secondary “Cashback” amount associated with the transaction. EMV Tag 9F03 (Space Fill if not present from the chip) |
| 16.ICC_Terminal_Type 97.ICC_Terminal_Type | 2 numeric | Indicates the environment of the terminal, its communication capability, and its operational control. EMV Tag 9F35 (Space Fill if not present from the chip) |
| 16.ICC_CSN 86.ICC_CSN 97.ICC_CSN | 2 numeric | Differentiates chip cards using the same Primary Account Number (PAN). The Application PAN Sequence Number (CSN) – EMV Tag 5F34 (Space Fill if not present from the chip) |
| 16.ICC_AED 97.ICC_AED | 6 numeric | The Application Expiration Date. Format: YYMMDD. EMV Tag 5F24 (Space Fill if not present from the chip) |
| 16.ICC_IAD 97.ICC_IAD | 64 hex | The Issuer Application Data – EMV Tag 9F10 |
| 16.ICC_ARC 97.ICC_ARC | 2 alpha | The Authorization Response Code – EMV Tag 8A (Space Fill if not present from the chip) |
| 16.ICC_Form_Factor_Indicator 97.ICC_Form_Factor_Indicator | 8 hex | Indicators about the attributes of the card holder’s device and the technology used for communication between the cardholder’s device and the acquiring POS Device. EMV Tag 9F6E (Space Fill if not present from the chip) |
| 16.ICC_Customer_Exclusive_Data | 64 hex | Available for the Issuer’s discretionary use. The issuer is responsible for ensuring its use of the field complies with all applicable laws and its own privacy policy. EMV Tag 9F7C |
| 16.ICC_TCC 97.ICC_TCC | 3 numeric | Identifies the country code where the terminal is located. EMV Tag 9F1A (Space Fill if not present from the chip) |
| 16.ICC_Third_Party_Data | 64 hex | Contains indicators about the attributes of the card holder’s device and the technology used for communication between the cardholder’s device and the acquiring POS Device. EMV Tag 9F6E (Space Fill if not present from the chip) |
| 16.ICC_Dedicated_File_Name | 32 hex | Indicates the selected Application Identifier (AID) used in the transaction request. EMV Tag 84 |
| 16.ICC_CNE | 45 alpha | Indicates the extended cardholder’s Name for the transaction pulled from EMV Tag 9F0B. This value is only used for VAN transactions in the Brazilian region. EMV Tag 9F0B |
| 17.Healthcare_Amount | 12 numeric | This value is used to submit the total amount of All qualified medical expenses (Over the counter,Dental, Prescription and Clinical/Other amount) contained within this Auto-Substantiation purchase. The “Transit Amount” or “Vision Amount” is not included in this calculation. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. See the Healthcare_amount table below for use cases. |
| 17.Prescription_Amount | 12 numeric | Submits the amount of all prescription expenses contained within this purchase. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 17.Vision_Amount | 12 numeric | Submits the amount of all optical/vision expenses contained within this purchase. This amount is not included in the “Healthcare Amount” calculation for Auto-Substantiation transactions. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 17.Clinic-Other_Amount | 12 numeric | Submits the amount of all Clinical or other qualified medical expenses contained within this purchase. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 17.Dental_Amount | 12 numeric | Submits the amount of all Dental expenses contained within this purchase. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 17.Transit_Amount | 12 numeric | Submits the amount of all transportation-related expenses contained within this purchase. This amount is not included in the “Healthcare Amount” calculation for Auto-Substantiation transactions. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 18.Length_of_Stay 9B.Length_of_Stay | 2 numeric | The anticipated number of days for the room / folio or the number of days remaining in the stay for the folio (days remaining) for incremental transactions. |
| 18.PS2000_Data 19.PS2000_Data 20.PS2000_Data 80.PS2000_Data 93.PS2000_Data | 22 alpha | This data will be as received during the original authorization processing. This is a “retain and return” value for terminal- based settlement messages. See PS2000 section for structure of data field. |
| 18.Program_Indicator 20.Program_Indicator 9A.Program_Indicator 9B.Program_Indicator | 1 numeric | This value is used to identify the Lodging and Auto Rental transaction type. Valid values:
|
| 19.Original_Account_Entry_Mode | 2 numeric | Identifies the method used to enter the Account Data for the original transaction. Valid values:
|
| 19.Card_ID 92.Card_ID | 1 alpha | Indicates the method used to obtain / verify the cardholder’s identity. Valid values:
|
| 20.Length_of_Rental 9A.Length_of_Rental | 2 numeric | The anticipated number of days for the auto rental or the number of days remaining in the stay for the folio (days remaining) for incremental transactions. |
| 21.Departure_Date | 6 numeric | The date that the consumer’s stay ends. Format: YYMMDD |
| 21.Completion_Date | 6 numeric | The date that the consumer’s travel will be completed. Format: YYMMDD |
| 22.ICC_ISR 97.ICC_ISR | 84 hex | Identifies the results of the terminal script processing. EMV Tag 9F5B |
| 40.Customer_Phone_Number 60.Customer_Phone_Number | 10 numeric | The consumer’s phone number including the area code. (no Dashes or Spaces) |
| 40.Drivers_License_Number | 19 alpha | Contains the check presenter’s driver’s license number followed by an equal sign (=) and the two digit state code. Refer to the state code table. |
| 50.Account_Type 83.Account_Type 84.Account_Type | 1 numeric | Facilitates transaction routing on Elavon. Valid values:
|
| 50.Surcharge_Amount 93.Surcharge_Amount 94.Surcharge_Amount 95.Surcharge_Amount | 8 numeric | Indicates the amount of the surcharge 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. |
| 50.Cashback_Amount 93.Cashback_Amount 94.Cashback_Amount 95.Cashback_Amount | 8 numeric | Indicates 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. |
| 50.Debit-EBT_Network_ID 83.Debit-EBT_Network_ID 84.Debit-EBT_Network_ID 94.Debit-EBT_Network_ID 95.Debit-EBT_Network_ID | 2 alpha | Indicates the Debit Network that the transaction was routed through for authorization. It may also be used on the Debit Purchase and PINless Purchase transaction to indicate the preferred Debit Network routing ID for authorization. Valid values:
|
| 51.Key_Pointer 56.Key_Pointer 83.Key_Pointer | 1 alpha | Indicates which encryption methodology was used for US Debit transactions (POS to Elavon) and which key to use for the next transaction (Elavon to POS). Valid values:
|
| 51.PIN_Block 56.PIN_Block | 16 hex | The encrypted Personal Identification Number entered by Debit / EBT Cardholder as identification for Transaction. The encrypted PIN Block is returned from the PIN Pad Device. |
| 51.KSN 56.KSN | 20 hex | Key Serial Number. The value returned by the PIN Pad device, which was used to encrypt the cardholder’s Personal Identification Number (PIN) using the Derived Unique Key Per Transaction (DUKPT) method. It is a 10 byte composite field that is transmitted as 20 alphanumeric characters. The 10 bytes before they are expanded to the ASCII character representation are comprised as follows:
|
| 52.Reference_Number 54.Reference_Number 83.Reference_Number 84.Reference_Number 85.Reference_Number | 8 numeric | A reference number assigned by Elavon and returned in the authorization response message. |
| 54.Retrieval_Reference_Number 84.Retrieval_Reference_Number | 12 alpha | The retrieval reference number returned from the Canadian Debit gateway during an authorization attempt. This value is also used in a Canadian Debit Void transaction. |
| 55.Voucher_Clear_Nbr 94.Voucher_Clear_Nbr | 15 numeric | The Voucher Clear Number from the Merchant’s EBT Food Stamp sales slip. |
| 56.System_Trace_Audit_Nbr 84.System_Trace_Audit_Nbr | 6 numeric | Used by the POS in the Canadian Debit authorization request message to uniquely identify the transaction to the host. This value is used in the MAC Calculation. For Canadian Debit Reversal transactions this value contains the original System Trace Audit Number from the transaction that is being reversed. |
| 56.Processing_Code 84.Processing_Code | 6 numeric | This value is submitted on all Canadian Debit transactions to indicate the transaction type. Refer to the Processing_Code table below for which processing codes are used by message type (Transaction Code). |
| 56.MAC_KEY_Pointer | 1 alpha | Indicates which encryption methodology was used for the Canadian Debit MAC Value. Valid code: T - Triple-DES DUKPT |
| 56.MAC_Value 84.MAC_Value | 8 hex | The Message Authentication Code (MAC) is used to verify that a Canadian Debit message transferred over a telecommunications network has not been altered. The MAC Value is optional on a Canadian Debit Reversal and must be space-filled if not utilized. See the Mac_Value table for additional information. |
| 56.MAC_KSN | 20 hex | Key Serial Number. This value is returned by the encrypting device and is used to generate the Message Authentication Code (MAC) using the Derived Unique Key Per Transaction (DUKPT) method. It is a 10-byte composite field that is transmitted as 20 alphanumeric characters. The 10 bytes before they are expanded to the ASCII character representation are comprised as follows:
|
| 60.Loyalty_Account_Data | 160 or 76 alpha | This value is used to submit the gift card or loyalty card data. Track 2 data or manually-entered Card Data (Account Number=MMYY) or Encrypted account information. |
| 60.Enrollment | 2 numeric | This value is used to identify the enrollment status for the current loyalty transaction.
|
| 60.Issue_Points | 1 alpha | Identifies whether points need to be accrued for the current loyalty transaction. Valid values:
|
| 60.Promo_Code 62.Promo_Code 66.Promo_Code | 10 alpha | The promo code of the reward that is being offered or redeemed. |
| 60.Encryption_Type E1.Encryption_Type | 1 alpha | Indicates the type of encryption that is used to secure the sensitive data. Valid values:
|
| 60.Encryption_Key_Material E1.Encryption_Key_Material | 512 alpha | Submits additional key material used in the encryption of sensitive data for the transaction. |
| 61.Account_Status | 1 alpha | Identifies the cardholder’s account status in the loyalty inquiry response transaction. Valid values:
|
| 61.Loyalty_Prompt | 1 alpha | Identifies if the application should prompt the cardholder to link their account data for the loyalty program. Valid values:
|
| 61.Tender_Amount | 12 numeric | Identifies the transaction amount less the discount for the current offer, if available. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 61.Access_Code | 6 alpha | Identifies the randomly generated access code that is tied to the primary customer for the account created as part of the loyalty program. |
| 61.Loyalty_Program | 22 alpha | Merchant’s loyalty program description printed on the consumer’s receipt. |
| 61.Token_Value 8E.Token_Value | 19 numeric | Returned in the authorization response message when the terminal ID is set up for the tokenization service. It is the token replacement value for the Account Data field used in the original request message. |
| 62.Promo_Code_Name | 22 alpha | Provides the name or “headline” for the promotional code that is offered to the consumer. |
| 62.Promo_Code_Description | 44 alpha | The description for the promotional code that is being offered to the consumer. |
| 62.Promo_Code_Issue_Points | 1 alpha | Identifies if a promotional issuance is necessary when the consumer elects to accept the specified promotional code. Valid values:
|
| 63.Pre-Auth_Reference_Number 68.Pre-Auth_Reference_Number | 12 numeric | A Gift Card value used to identify the original pre-authorization request. This value is required to submit the post-authorization completion transaction message. |
| 65.Gift-Loyalty_Transaction_Code 68.Gift-Loyalty_Transaction_Code | 12 alpha | A unique value assigned by the POS to identify the gift card transaction. Required for both Gift Card and Loyalty reversal transactions. |
| 65.Points | 12 numeric | The amount of points to remove from the account. |
| 66.Units | 6 numeric | The number of units for the transaction represented in whole numbers. |
| 67.SKU_Number | 30 alpha | The SKU number for the selected item. |
| 67.Price | 12 numeric | The cost of an item in a Loyalty card transaction. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 67.Quantity | 6 numeric | The count of items in whole numbers in the SKU line item detail. Assume 1 if left blank. |
| 68.Points_Added | 12 numeric | The amount of points added to an account. |
| 68.Points_Canceled | 12 numeric | The amount of points canceled from the account. |
| 68.Member_Name | 50 alpha | The Member name associated with the gift or loyalty card transaction, if available. |
| 68.Receipt_Message | 40 alpha | A custom message printed on Gift / Loyalty card transactions. |
| 70.Tender_Type | 1 numeric | Identifies the payment method used to activate or reload a gift card. Valid values:
|
| 70.Security_Code | 6 numeric | The Gift Card/Loyalty Security Code (PIN) value. If a Security Code (PIN) value has been assigned to the account, it is required to be included in the authorization request to the gift card/loyalty provider. |
| 72.Cardholder_ID | 9 numeric | The applicant’s social security number (SSN). |
| 72.House_Number | 9 numeric | Used on Bridgestone/Firestone Instant Credit message to identify the applicant’s street address. Numeric values only. |
| 72.Zip_Code | 5 numeric | Used on Bridgestone/Firestone Instant Credit message to identify the ZIP code of the applicant. |
| 72.Date_of_Birth | 8 numeric | Used on Bridgestone/Firestone Instant Credit message to identify the birth date of the applicant. Format: MMDDYYYY |
| 72.Annual_Income_Amount | 10 numeric | Indicates the applicant’s annual gross income from all sources for the Bridgestone/Firestone instant credit application request. Submitted in whole dollars. Example: $10,000 is sent as 10000 |
| 72.Application_Type | 2 alpha | Indicates the application type used to submit the Bridgestone/Firestone instant credit application request. Valid values:
|
| 72.Resident_Status | 1 numeric | Indicates the applicant’s current resident Status. Valid values:
|
| 72.Rent-Mortgage_Amount | 5 numeric | Indicates the applicant’s current monthly rent or mortgage amount expressed in a whole dollar amount. If the Resident Status is “Own” then send as “0” (zero). ($1,000 is sent as 1000) |
| 73.Return_Message | 16 alpha | The response message that is returned on a CFNA Bridgestone/Firestone credit application request. Valid codes and response messages:
|
| 73.Account_Number | 9 alpha | The applicant’s CFNA Bridgestone / Firestone account number returned from the instant credit application request. |
| 73.Credit_Limit | 5 numeric | The total credit limit returned from a CFNA Bridgestone / Firestone credit application request. The decimal is not implied and values are rounded up to whole numbers. ($1 is sent as 1) |
| 73.First_Name | 14 alpha | The applicant’s first name on the Bridgestone/Firestone instant credit application request. |
| 73.Last_Name | 20 alpha | The applicant’s last name on the Bridgestone/Firestone instant credit application request. |
| 78.Additional_Key_Available | 1 numeric | Returned in the EMV Key exchange response message to identify if another EMV Key is available to be retrieved from the host. Valid values:
|
| 78.Data_Type | 2 numeric | Identifies the type of EMV Key that is being sent. Default value is 01 - CA Public Key |
| 78.RID | 10 alpha | Identifies the specific application system in on the POS Device. |
| 78.PKI | 2 hex | Public Key Index. Identifies the Public Key in conjunction with the RID. CA Public Key Index |
| 78.Hash_ID | 2 alpha | Identifies the hash algorithm used to produce the hash results in the digital signature scheme. Default value is 01 - Hash algorithm |
| 78.Digital_Signature_ID | 2 alpha | Identifies the digital signature algorithm to be used with the public key. Default value is 01 - Digital Signature (default) |
| 78.Public_Key | 496 hex | The value of the modulus part of the Certification Authority Public Key. |
| 78.Exponent | 6 alpha | The exponent part of the public key for an EMV Key exchange. |
| 78.Check_Sum | 40 hex | A check value that is calculated on the concatenation of all parts of the public key. |
| 78.CA_Public_Key_Length | 2 hex | One of the elements of the public key used to confirm the size of the public key in the cryptography process. |
| 78.CA_Public_Key_Exp_Date | 6 numeric | CA Public Key Expiration Date. Format: YYMMDD |
| 78.EMV_Key_Date 86.EMV_Key_Date | 8 numeric | Identifies the date of the last change to the EMV Key table at the host. If this date is greater than the date of the last key update in the POS application, then the POS needs to perform an EMV Key Exchange message to obtain the latest EMV Keys for the terminal. Format: MMDDYYYY |
| 80.Amex_Capture_Code | 1 numeric | The American Express Capture Code field is returned during a credit card authorization response. It determines the capture option allowed for the American Express Card in the Split Dial environment, where the POS is accessing Amex directly for Authorization processing of Amex Cards. Valid values:
|
| 80.AVS_Response 93.AVS_Response | 1 alpha | 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. See below for valid values. |
| 80.CVV2_Response 93.CVV2_Response | 1 alpha | This value contains the Card verification response code returned in Authorization Response. It is also a required value for a terminal-based settlement message, if returned in the authorization response. Valid values:
|
| 80.MSDI 83.MSDI 93.MSDI 94.MSDI | 1 alpha | The Market Specific Data Indicator value. See the MSDI table for valid values. |
| 80.ECI_Security_Level_Indicator 93.ECI_Security_Level_Indicator | 3 alpha | Indicates the security level and cardholder authentication for MasterCard transactions. This value should be retained and returned unaltered in Terminal-Based settlement messages.
|
| 81.Time_Stamp | 12 numeric | Indicates the date and time until which the Foreign Exchange Rates are valid. Format: YYYYMMDDHHMM |
| 82.Currency_Code | 3 alpha | The three (3) digit alpha currency code value. See the Currency Code Table for a complete currency list. |
| 83.Debit-EBT_Settlement_Date 84.Debit-EBT_Settlement_Date 94.Debit-EBT_Settlement_Date 95.Debit-EBT_Settlement_Date | 4 numeric | Debit Settlement Date. Format: MMDD |
| 83.Debit_Interchange_Indicator 94.Debit_Interchange_Indicator | 1 alpha | Indicates that a special interchange rate was used in the processing of this transaction. Valid values:
|
| 84.PIN_Working_Key | 16 or 32 hex | Deprecated. This value is the data-encrypting key for Canadian Debit transactions which is used to encrypt PINs for transmission from the terminal to the host computer. This field is no longer used. |
| 84.Debit_Response_Code | 2 alpha | This value is returned by the debit gateway for a Canadian debit authorization attempt. If a value of “TO” is returned in this field indicating a transaction time out, then a debit reversal message will need to be generated from the POS device. See table below for valid values. |
| 85.Response_Source_Indicator 96.Response_Source_Indicator | 1 alpha | Indicates if the check was authorized by a participating member bank or a third party check processor. Valid values:
|
| 85.Parsed_Transit_Routing_Nbr 96.Parsed_Transit_Routing_Nbr | 9 numeric | The parsed checking Transit / Routing number as returned in the authorization response message. |
| 85.Parsed_Account_Nbr | 16 numeric | The parsed checking account number as returned in the authorization response message. |
| 85.Parsed_Check_Nbr 96.Parsed_Check_Nbr | 8 numeric | The parsed checking serial number as returned in the authorization response message. |
| 85.Transaction_ID 96.Transaction_ID | 15 numeric | The transaction ID value returned in the Electronic Check authorization response message. |
| 85.Free_Form_Data | 76 alpha | This value is used on non-approved check transitions and is intended to identify the contact information on the issuer/processor that declined the transaction. This information must be printed on the receipt. Each line of data in this string is delimited by the “/” character. The “\” character should be replaced with a space. Please refer to the Electronic Check primer for receipt requirements. |
| 85.Service_Fee | 21 alpha | Identifies the applicable NSF fees for the Merchant’s state on approved check transactions and must be printed on the check presenter’s receipt. Please refer to the Electronic Check primer for receipt requirements. Example: “GA = $20 or 5%” |
| 86.ICC_ARPC | 32 hex | Contains data sent to the chip card for online issuer authentication. EMV Tag 91 |
| 86.ICC_Issuer_Script | 256 hex | Returns the Issuer specified script contained in EMV Tags 71 or 72 back to the POS in the authorization response message.
|
| 86.Device_Type 97.Device_Type | 2 alpha | Identifies the device type used for this transaction. This value is derived from the Third Party Data Tag 9F6E field and is returned in the authorization response message. See table for valid values. |
| 87.Authorized_Amount | 12 numeric | Identifies 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. |
| 87.Account_Balance_1 | 12 numeric | For Credit and Debit cards: this value indicates the remaining balance for a pre-paid account. For EBT transactions: this value indicates the remaining Food Stamp balance. For Gift Card transactions: this value indicates the remaining Gift Card balance on the account. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. See the Account_Balance table for field information. |
| 87.Account_Balance_2 | 12 numeric | For Credit and Debit cards: this value indicates the remaining Gift Card Balance on the account. For EBT transactions: this value indicates the remaining Cash Benefit balance. For Gift Card transactions: this value indicates the remaining Loyalty points on the account. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. See the Account_Balance table for field information. |
| 87.Account_Balance_3 | 12 numeric | For Credit and Debit cards: this value indicates the remaining Loyalty points on the account. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. See the Account_Balance table for field information. |
| 88.Redemption_Amount | 12 numeric | Identifies the total amount of all Gift Card Redemption transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 88.Redemption_Count | 8 numeric | The total number of Gift Card Redemption transactions in the batch. |
| 88.Activation_Amount | 12 numeric | Identifies the total amount of all Gift Card Activation transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 88.Activation_Count | 8 numeric | Identifies the total number of all Gift Card Activation transactions in the batch. |
| 88.Card_Refund_Amount | 12 numeric | Identifies the total amount of all Gift Card “Card Refund” transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 88.Card_Refund_Count | 8 numeric | Identifies the total number of all Gift Card “Card Refund” transactions in the batch. |
| 88.Reload_Amount | 12 numeric | Identifies the total amount of all Gift Card Reload transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 88.Reload_Count | 8 numeric | Identifies the total number of all Gift Card Reload transactions in the batch. |
| 88.Credit_Amount | 12 numeric | Identifies the total amount of all Gift Card Credit transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 88.Credit_Count | 8 numeric | Identifies the total number of all Gift Card Credit transactions in the batch. |
| 88.Points_Transfer_Amount(to) 8A.Points_Transfer_Amount(to) | 12 numeric | Identifies the total amount of all Loyalty Transfer (to) transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 88.Points_Transfer_Count(to) 8A.Points_Transfer_Count(to) | 8 numeric | Identifies the total number of all Loyalty Transfer (to) transactions in the batch. |
| 88.Points_Transfer_Amount(from) 8A.Points_Transfer_Amount(from) | 12 numeric | Identifies the total number of all Loyalty Transfer (from) transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 88.Points_Transfer_Count(from) 8A.Points_Transfer_Count(from) | 8 numeric | Identifies the total number of all Loyalty Transfer (from) transactions in the batch. |
| 89.Response_Message | 16 alpha | This field contains a response code indicating the status of the batch settlement. This response message is used by the POS Device to aid in diagnosing the batch capture status and/or problems and must be displayed and/or printed. The amount fields are positive if unsigned and negative if preceded by a “-” sign. See the table for codes and descriptions. |
| 89.Net_Amount_Sign | 1 alpha | Identifies the net dollar amount of all transactions in the batch. Valid values:
|
| 89.Net_Amount 90.Net_Amount | 12 numeric | Identifies the net dollar amount of all transactions in the batch. Calculates as: Net Amount = ((Credit Sales + Forces) – Credit Returns) + (Debit and EBT Purchases– Debit and EBT Returns) + (ECS Purchases) The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. Negative amounts are expressed with a minus sign: -$1 is sent as -100. |
| 89.Net_Count | 8 numeric | Identifies the total number of transactions in the batch. Net Count = (Credit Sales + Forces + Returns) + (Debit Purchases + Debit Returns) + (EBT Purchases + EBT Returns) + (ECS Purchases) |
| 89.Credit_Sale_Amount | 12 numeric | Submits the total amount of all Credit Card Sale and Force transactions. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 89.Credit_Sale_Count | 8 numeric | Submits the total count of all Credit Card Sale and Force transactions. |
| 89.Credit_Return_Amount | 12 numeric | Submits the total amount of all Credit Card Return transactions. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 89.Credit_Return_Count | 8 numeric | Submits the total count of all Credit Card Return transactions. |
| 89.Debit-EBT_Purchase_Amount | 12 numeric | Submits the total amount of all Debit Card and EBT Purchase transactions. This includes Voucher Clear Purchase transactions. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 89.Debit-EBT_Purchase_Count | 8 numeric | Submits the total count of all Debit Card and EBT Purchase transactions. This includes Voucher Clear Purchase transactions. |
| 89.Debit-EBT_Return_Amount | 12 numeric | Submits the total amount of all Debit Card and EBT Return transactions. This includes Voucher Clear Return transactions. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 89.Debit-EBT_Return_Count | 8 numeric | Submits the total count of all Debit Card and EBT Return transactions. This includes Voucher Clear Return transactions. |
| 89.ECS_Purchase_Amount | 12 numeric | Submits the total amount of all Electronic Check Purchase transactions. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 89.ECS_Purchase_Count | 8 numeric | Submits the total count of all Electronic Check Purchase transactions. |
| 89.Void_Amount | 12 numeric | Submits the total amount of all voided transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 89.Void_Count | 8 numeric | Submits the total count of all voided transactions in the batch. |
| 8A.Loyalty_Add_Points_Amount | 12 numeric | Identifies the total amount of all Loyalty Add Point transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8A.Loyalty_Add_Points_Count | 8 numeric | Identifies the total number of all Loyalty Add Point transactions in the batch. |
| 8A.Loyalty_Redemption_Amount | 12 numeric | Identifies the total amount of all Loyalty Redemption transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8A.Loyalty_Redemption_Count | 8 numeric | Identifies the total number of all Loyalty Redemption transactions in the batch. |
| 8A.Loyalty_Return_Amount | 12 numeric | Identifies the total amount of all Loyalty Return transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8A.Loyalty_Return_Count | 8 numeric | Identifies the total number of all Loyalty Return transactions in the batch. |
| 8B.Total_Installments | 2 numeric | Total number of Installment payments for the transaction. |
| 8B.Installment_Amount | 12 numeric | The amount of the installment payment including interest, if applicable. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8B.Total_Installment_Amount | 12 numeric | The total amount of the Installment transaction payments including interest, if applicable. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8B.Total_Effective_Cost | 7 numeric | This value is the total annual rate (CET) for the Installment transaction. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8B.Monthly_Interest | 5 numeric | Contains the monthly interest amount for the installment payment. Two Implied decimals. |
| 8B.Interest_Rate | 7 numeric | Identifies the Interest rate used for the installment transaction. Two Implied decimals. |
| 8B.Tax_Amount | 7 numeric | The tax amount of the Installment transaction. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8B.Insurance_Amount | 7 numeric | Identifies the insurance amount for the transaction, if applicable. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8B.Additional_Amount | 7 numeric | Identifies that additional amount for a Brazilian Installment transaction. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8B.Register_Amount | 7 numeric | Used in Brazilian Installment transactions. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 8B.Installment_Date | 6 numeric | The date of the first installment payment. Format: DDMMYY |
| 8C.IVU_Loto_Prefix | 2 alpha | The unique IVU Loto processor identifier assigned for Elavon. |
| 8C.Draw_Date | 6 numeric | The Loto Draw Date. Format: MMDDYY |
| 8C.Draw_Number | 3 numeric | The Loto Draw Number. |
| 8C.IVU_Loto_Number | 10 alpha | IVU Loto Number. |
| 8F.Token_Account_Status | 1 alpha | Identifies the value as a regulated or non-regulated token. Valid values:
|
| 8F.Token_Assurance_Level | 2 alpha | Returns a value that indicates the confidence level of the token to PAN mapping (Space Fill, if not present). |
| 8F.Token_Requestor_ID | 11 alpha | Returns the token requestor ID. |
| 8F.PAN_Last_Four_Digits | 4 numeric | Returns the last four (4) digits of the actual card account number when a token was presented for authorization. |
| B1.ROC_Text_Data | 39 alpha | Used to submit additional data on the transaction; unique merchant-assigned data for this transaction. |
| 90.Record_Count 98.Record_Count | 8 numeric | contains the batch record count generated by the POS Device. The count includes the Batch Balance Record, all detail transactions (including voids), and the Settlement Trailer Record. |
| 90.Net_Tip_Amount | 12 numeric | Indicates the total amount of TIPs included in the batch. This field is used during settlement for the reconcilement of out of balance conditions between Elavon and the POS Shadow file. In retail this field will always be zero. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 91.Tip_Amount | 6 numeric | The TIP amount applied to the transaction. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 92.Account_Source | 1 numeric | Facilitates transaction routing to Elavon. Valid codes are:
|
| 92.Capture_Tran_Code | 1 numeric | Indicates the type of transaction that is being submitted for settlement. Valid codes are:
|
| 92.Service_Code | 3 numeric | The service code of the card. (Space Fill, if not present) |
| 92.Number_of_Incrementals | 2 numeric | Identifies the number of incremental authorizations that have been submitted with this transaction. Valid values are 00 - 90. 00 is default value. |
| 93.Total_Auth_Amount 9A.Total_Auth_Amount 9B.Total_Auth_Amount | 12 numeric | The total amount for authorizations for this transaction, including all incremental authorizations. This value should be in Cardholder Currency for DCC transactions else in Merchant Currency. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 98.Transmission_Date | 4 numeric | The date of the settlement attempt. Format: MMDD |
| 98.Net_Deposit | 12 numeric | Identifies the net deposit amount of all transactions in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. Negative amount are expressed with a minus sign (-$1 is sent as -100) Calculates as: Net Amount = ((Credit Sales + Forces) – Credit Returns) + (Debit and EBT Purchases – Debit and EBT Returns) + (ECS Purchases) |
| 98.Hash_Total | 16 numeric | This value contains a batch-hashing total that is generated by the POS device. The total is created by adding together the transaction amount for all detail transactions. The Credit and Return transaction amounts are treated as positive and are added to the total not subtracted from it. For Host-based Restaurant processing, the hash total is calculated by adding together all tips in the batch. The decimal is implied: $1 is sent as 100 and 1¢ is sent as 1. |
| 99.Merchant_ID | 16 numeric | The Merchant ID assigned by Elavon. |
| 9A.Rental_Check_Out_Date | 8 numeric | The date the customer first drove away with the rental vehicle. Format: MMDDYYYY |
| 9A.Rental_Return_Date | 8 numeric | The date the customer returned the rental vehicle. Format: MMDDYYYY. This value is the “Transaction Date”. |
| 9A.Auto_Rental_Number | 25 alpha | The auto rental number as entered by the property. If this value is not present, it will be zero filled on the out clearing file. |
| 9A.Extra_Charges 9B.Extra_Charges | 6 numeric | The charges that were incurred after the rental or check out has taken place. The values listed in the table below can appear in any order, not to exceed the maximum length and no duplicate entries on transaction. See table for valid Lodging and Auto Rental codes. |
| 9A.Renter_Name | 20 alpha | The name of the customer who rented the vehicle. (Used for MasterCard transactions) |
| 9A.Rental_Return_City | 18 alpha | The name of the city where the vehicle was returned. (Used for MasterCard transactions) |
| 9A.Rental_Return_State-Country | 3 alpha | The name of the State or Country where the vehicle was returned. (Used for MasterCard transactions) |
| 9A.Rental_Return_Location_ID | 10 alpha | The location ID of where the vehicle was returned. (Used for MasterCard transactions) |
| 9B.Check_In_Date | 8 numeric | The check in date. Format: MMDDYYYY |
| 9B.Check_Out_Date | 8 numeric | The check out date. This is the “Transaction Date” for lodging transactions. Format: MMDDYYYY |
| 9B.Room_Number | 10 numeric | The Folio or Room number as entered by the property. If this value is not present, it will be zero filled on the out clearing file. |
| 9C.Risk_Data | 5 alpha | This value is returned by the risk provider and is used to assess the potential risk on a transaction. This can be used to assist in the decision to continue with the transaction. See the Risk_Data table for provider information. |
| 9C.Risk_Data_Provider | 2 alpha | Identifies the provider of the risk information returned in the response. The risk data will be sent in the Risk Data Field. Valid values:
|
| 9F.Status | 1 alpha | This value is used to identify the status of the current settlement transaction. If the transaction passes all criteria it will be accepted. If not, the reason for the error will be returned in the Transaction Results field. Valid codes:
|
| 9F.Results | 16 alpha | This field may contain an error response message for a settlement detail packet that is sent to the host. This field is blank when the Settlement detail transaction does not have an error in processing. |
| B2.Download_Start_Date | 6 numeric | This field is returned in the authorization response message to identify the Date that the terminal download is being requested. This is only returned in the Brazilian region. Format: MMDDYY |
| B2.Download_Start_Time | 6 numeric | This field is returned in the authorization response message to identify the time that the terminal download is being requested. This is only returned in the Brazilian region. Format: HHMMSS |
| B2.Download_Type | 1 alpha | This field is returned in the authorization response message to identify the type of terminal download that is being requested. This is only returned in the Brazilian region. Valid codes:
|
| B3.VAN_Partner_Data | 39 alpha | Unique VAN Partner Data for receipt printing. |
| D1.Device_Serial_Number | 20 alpha | Device Serial Number of the encrypting device. |
Account_Balance_1
| Field Name | Credit Card | Debit Card | EBT | Check | Gift Card |
|---|---|---|---|---|---|
| Account Balance 1 | Pre-Paid | Pre-Paid | Food Stamp | n/a | Gift Card |
| Account Balance 2 | Gift Card | Gift Card | Cash Benefit | n/a | Loyalty |
| Account Balance 3 | Loyalty | Loyalty | n/a | n/a | n/a |
Account_Data
Track 1 (max length =76) or Track 2 (max length =37) data as read from a Magnetic Stripe Reader (MSR) or proximity with the start and end sentinels removed from the track. Track data is only used on original authorization requests.
Manually entered card data (Account Number=MMYY).
Manually entered card data (Account Number). Expiration Date is optional for Debit and EBT.
The unformatted MICR data exactly as read from the MICR line of the check, including spaces, except that the MICR symbols will be replaced as follows: (“raw TOAD” format):
- The Transit symbol
must be replaced by the letter (T) in either upper or lower case.
- The On-us symbol
must be replaced by the letter (O) in either upper or lower case.
- The Amount symbol
must be replaced by the letter (A) in either upper or lower case.
- The Dash symbol
must be replaced by the letter (D) in either upper or lower case.
- The manually entered Check Data in the following format (spaces and dashes removed):
For POP, ARC, or BOC transactions (exception processing): “T” + (Transit\Routing) + “T” + Checking Account Number + “O” + Check Number
Example: T987654321T1234567890123456O12345For WEB, TEL, PPD, CCD transactions: “T” + (Transit\Routing) + “T” + Checking Account Number + “O
Example: T987654321T1234567890123456O
The parsed Checking Account Number as returned in the authorization response message. This format is used for Terminal-Based settlements only (Account Number).
Token data (Token Data=MMYY)
Token data (Token Data). Expiration Date is optional for Debit and EBT
Encrypted account information.
- Encrypted Track 1 or Track 2 Data with Start and End sentinels removed.
- Encrypted Pan and Expiration Date in “Account Number=MMYY” format.
Account_Entry_Mode
| Code | Description |
|---|---|
| 01 | Key Entered – Card Not Present (01) |
| 02 | Key Entered – Card Present (71) |
| 12 | Key Entered – Credential on File |
| 03 | Swiped (90) |
| 04 | Proximity (91) |
| 05 | EMV (ICC) with CVV or iCVV (05) |
| 06 | EMV (ICC) proximity read (07) |
| 07 | EMV (ICC) with no CVV or iCVV (95) |
| 08 | EMV (ICC) – Mag stripe Read when the chip failed to read |
| 09 | EMV (ICC) – Digital Secure Remote Payment (09) |
| 10 | Scanned MICR (84) |
| 11 | Keyed MICR |
Amount Rounding
All cardholder amounts are rounded to the number of decimals indicated by the precision value in the currency rate table. Amounts are rounded up when a five (5) or greater is present after the precision value and are rounded down when a four (4) or less is present.
For example, an Australian dollar amount of $12.345111 would round to $12.35 since the precision indicator for Australian Dollar is two (2). A Japanese Yen amount of ¥1234.56789 would round to ¥1235 since the precision indicator for the Japanese Yen is set to a value of zero (0).
Sample Rate Conversions
| USD* | Foreign Rate | Rounded Value |
|---|---|---|
| $10.00 USD | 112.27188 (JPY Rate) = ¥ 1122.7188 | ¥ 1123 |
| $10.00 USD | 0.55074 (GBP Rate) = £ 5.5074 | £ 5.51 |
| $10.00 USD | 0.80363 (EUR Rate) = € 8.0363 | € 8.04 |
| $10.00 USD | 1.2616 (CAD Rate) = $ 12.616 | $ 12.62 |
| $10.00 USD | 1.35045 (AUD Rate) = $ 13.5045 | $ 13.50 |
info_outline
note
The amount values are only rounded to the next significant digit after the precision indicator. In another example containing an Australian dollar amount of $12.3445 would round to $12.34 since the value after the Precision Indicator for the above rate is four (4).
Application_ID
| Digit | Description |
|---|---|
| 1 | Processing Type H = Host Based T = Terminal Based |
| 2 | Device Type Z = 3rd Party Vendor Solution |
| 3-6 | Vendor ID Number, as assigned by Elavon |
| 7 | Market Segment G = General R = Retail, Restaurant M = Mail Order / Telephone Order I = (MOTO) Internet (e-Commerce) L = Lodging A = Auto Rental |
| 8 | Communication Module Space = Dial A = NOVA API L = NOVA Link SSL C = SSL Gateway W = Wireless X = (CDMA) Custom TCP/IP |
Authorization_Response
| Message | Code | Definition |
|---|---|---|
| APPROVAL | AA | Approved |
| APPROVAL | AP | Approved Partial |
| APPROVAL | AC | Approved (without Cashback) |
| SERV NOT ALLOWED | ND | Invalid request |
| REQ EXCEEDS BAL | ND | Request exceeds balance |
| NOT ON FILE | ND | Cardholder not found |
| EXPIRED CARD | ND | Expired Card |
| INCORRECT PIN | ND | Invalid PIN |
| PICK UP CARD | NC | Pick up card |
| INVALID CARD | ND | Invalid Card |
| DECLINED | ND | Do Not Honor |
| CALL AUTH CENTER | NR | Refer to Issuer |
| DECLINED-HELP 9999 | ND | System Error |
| CALL REF.; 999999 | NR | Refer to Issuer |
| AMOUNT ERROR | ND | Tran Amount Error |
| INVALID TERM ID | ND | Invalid Terminal ID |
| INVLD TERM ID 1 | ND | Invalid Merchant Number |
| INVLD TERM ID 2 | ND | Invalid SE Number |
| REC NOT FOUND | NF | Record not on Elavon Network |
| INVLD VOID DATA | ND | Invalid Data |
| TOKEN ERROR | ND | Invalid Token |
| ERR PLS CALL | ND | Call for Assistance |
| APPL TYPE ERROR | ND | Call for Assistance |
| DECLINE CVV2 | N7 | Do Not Honor due to CVV2 mismatch \ failure MUST SETTLE MMDD ND Must settle, open batch is over 7 days old |
info_outline
note
Batch will be Auto Settled after 10 days.
Gift Cards
| Message | Code | Definition |
|---|---|---|
| APPROVAL | AA | Approved |
| DECLINED-HELP 9999 | 01 | Host Busy |
| INVALID CARD | 02 | Invalid Card |
| INVALID TERM ID | 03 | Invalid Terminal ID |
| AMOUNT ERROR | 04 | Tran Amount Error |
| ALREADY ACTIVE | 05 | Card already active |
| REQ. EXCEEDS BAL. | 06 | Request exceeds balance |
| MAX REACHED | 07 | Cannot load the amount specified NON RELOADABLE 08 The card cannot be reloaded |
| CARD ALREADY ACTIVE | 12 | The EGC card is already activated DECLINED-HELP 9999 99 General System Error |
| SERV NOT ALLOWED | ND | Invalid request |
| INVLD TERM ID 1 | ND | Invalid Merchant Number SEQ ERR PLS CALL ND Call for Assistance |
| APPL TYPE ERROR | ND | Call for Assistance |
Private Label
| Message | Code | Definition |
|---|---|---|
| AP xxxxxx $9999 | AA | CFNA Private Label Approval |
| DECLINED | ND | Sale is Not Approved |
| CALL 18007629000 | NR | Call CFNA Credit Department for more information |
AVS_Response
| Code | Description |
|---|---|
| A | Address (Street) matches, Zip does not |
| B | Street address match, Postal code in wrong format (international issuer) |
| C | Street address and postal code in wrong format |
| D | Street address and postal code match (international issuer) |
| E | AVS error |
| F | Address does compare and five-digit ZIP code does compare (UK only) |
| G | Card issued by a non-US issuer that does not participate in the AVS System |
| I | Address information not verified by international issuer |
| M | Street Address and Postal code match (international issuer) |
| N | No Match on Address (Street) or Zip |
| P | Postal codes match, Street address not verified due to incompatible formats |
| R | Retry, System unavailable or Timed out |
| S | Service not supported by issuer |
| U | Address information is unavailable (domestic issuer) |
| W | 9 digit Zip matches, Address (Street) does not |
| X | Exact AVS Match |
| Y | Address (Street) and 5 digit Zip match |
| Z | 5 digit Zip matches, Address (Street) does not |
Credit_Authorization_Amount
This field is used to identify the cumulative authorization amount that has been requested for the transaction.
| Length | Type | Description |
|---|---|---|
| 12 | Numeric | The decimal is implied. ($1 is sent as 100 and 1¢ is sent as 1) |
Debit_Response_Code
This value is returned by the debit gateway for a Canadian debit authorization attempt. If a value of “TO” is returned in this field indicating a transaction time out, then a debit reversal message will need to be generated from the POS device.
All response codes have a field length of 2 and a type of Alphanumeric.
| Debit Code | Elavon Code | Description | External Terminal | External PIN Pad | Internal PIN Pad |
|---|---|---|---|---|---|
| 00 | AA | Approved | Approval authno | Approved | Approval authno |
| 05 | ND | Do not honor | Do not honour | Declined | Do not honour |
| 06 | ND | Edit error | Error | Declined | Error |
| 12 | ND | Invalid processing code | Invalid transaction | Declined | Invalid transaction |
| 13 | ND | Invalid amount | Invalid amount | Declined | Invalid amount |
| 14 | ND | Edit Error in PAN | Declined | Invalid card number | Invalid card number |
| 19 | ND | RFI error – re-enter transaction | Re-enter transaction | Re-enter transaction | Re-enter transaction |
| 40 | ND | Requested function not supported | Invalid transaction | Declined | Invalid transaction |
| 51 | ND | Non-sufficient funds | Declined | Not sufficient funds | Not sufficient funds |
| 52 | ND | No chequing account | Declined | No chequing account | No chequing account |
| 53 | ND | No savings account | Declined | No savings account | No savings account |
| 54 | ND | Expired card | Expired card | Expired card | Expired card |
| 55 | ND | Incorrect PIN | Declined | Incorrect PIN | Incorrect PIN |
| 56 | ND | No card record | No card record | No card record | No card record |
| 57 | ND | Tran not permitted to cardholder | Unauthorize txn | Declined | Unauthorize txn |
| 58 | ND | Tran not permitted to terminal | Invalid transaction | Declined | Invalid transaction |
| 61 | ND | Exceeds withdrawal amount limit | Declined | Exceeds amount limit | Exceeds amount limit |
| 62 | ND | Restricted card | Declined | Restricted card | Restricted card |
| 63 | ND | Security violation –MAC value is incorrect | Security violation | Declined | Security violation |
| 65 | ND | Exceeds withdrawal frequency limit | Declined | Exceeds freq limit | Exceeds freq limit |
| 68 | ND | Response received too late (Time- Out) | Response timeout | Declined | Response timeout |
| 75 | ND | Number of PIN tries exceeded | Declined | PIN tries exceeded | PIN tries exceeded |
| 77 | ND | Invalid capture date | No ntwrk shr agrment | Declined | No ntwrk shr agrment |
| 81 | ND | Invalid PIN block | Declined | Incorrect PIN | Incorrect PIN |
| 82 | ND | PIN length error | Declined | Incorrect PIN | Incorrect PIN |
| 85 | ND | No keys available for Use | Suspected malfunc | Declined | Suspected malfunc |
| 86 | ND | Message encryption key synchronization error | Suspected malfunc | Declined | Suspected malfunc |
| 87 | ND | PIN key synchronization error | Pin key sync error | Declined | Pin key sync error |
| 88 | ND | Mac key synchronization error | MAC key sync error | Declined | MAC key sync error |
| 89 | ND | Transaction requires Contact Interface | Pls Insert Card | Trn Not Complete | Pls Insert Card |
| 91 | ND | Issuer Inc or switch is inoperative | Iss or switch inop | Declined | Iss or switch inop |
| 92 | ND | Financial institution or intermediate network facility cannot be found for routing | Cannot contact bank | Declined | Cannot contact bank |
| 94 | ND | Duplicate transmission | Dupl transmission | Dupl transmission | Dupl transmission |
| 96 | ND | System malfunction | System malfunction | Declined | System malfunction |
| Q0 | ND | Edit error in capture date | No ntwrk shr agrment | Declined | No ntwrk shr agrment |
| Q9 | ND | Response not listed above has been received | Suspected malfunc | Declined | Suspected malfunc |
| TO | ND | Host time-out | Host time-out | Trn not complete | Host time-out |
| TQ | ND | Sequence error | Seq err pls call | Trn not complete | Seq err pls call |
| TX | ND | Service not allowed | Service not allowed | Trn not complete | Service not allowed |
| TE | ND | Expired card | Expired card | Trn not complete | Expired card |
| TC | ND | Invalid card | Invalid card | Trn not complete | Invalid card |
| TA | ND | Amount error | Amount error | Trn not complete | Amount error |
| TI | ND | Invalid terminal ID | Invalid term ID | Trn not complete | Invalid term ID |
| TM | ND | Invalid merchant # | Invalid term ID 1 | Trn not complete | Invalid term ID 1 |
| TS | ND | Invalid SE # | Invalid term ID 2 | Trn not complete | Invalid term ID 2 |
| TR | ND | Record not found on Elavon | Record not found | Trn not complete | Record not found |
| TV | ND | Invalid data | Invld void data | Trn not complete | Invld void data |
| TN | ND | Call for assistance | Appl type error | Trn not complete | Appl type error |
| TP | ND | Please retry | Please retry | Trn not complete | Please retry |
| TB | ND | Transaction error | Invalid data5276 | Trn not complete | Invalid data5276 |
| TZ | ND | Unknown error | System error | Trn not complete | System error |
Device_Type
| Len | Type | Code | Description |
|---|---|---|---|
| 2 | Alpha | spaces | Not Applicable (default value) |
| 01 | Mobile Network Operator (MNO) controlled removable secure element (SIM or UICC) personalized for use with a mobile phone or smartphone | ||
| 07 | Mobile phone or smartphone with a fixed (non-removable) secure element controlled by the MNO, for example, code division multiple access (CDMA) | ||
| 08 | Removable secure element not controlled by the MNO, for example, memory card personalized for used with a mobile phone or smartphone | ||
| 09 | Mobile phone or smartphone with a fixed (non-removable) secure element not controlled by the MNO | ||
| 10 | MNO controlled removable secure element (SIM or UICC) personalized for use with a tablet or e-book | ||
| 11 | Tablet or e-book with a fixed (non-removable) secure element controlled by the MNO | ||
| 12 | Removable secure element not controlled by the MNO, for example, memory card personalized for use with a tablet or e-book | ||
| 13 | Tablet or e-book with fixed (non-removable) secure element not controlled by the MNO | ||
| 14 - 99 | Reserved for Future Use |
Extra_Charges
| Code | Lodging Description | Auto Rental Description |
|---|---|---|
| 1 | Restaurant Charge | Gasoline |
| 2 | Gift Shop Charge | Extra Mileage |
| 3 | Mini-Bar Charge | Late Return |
| 4 | Telephone Charge | One Way Service Fee |
| 5 | Laundry Charge | Parking or Moving Violation |
| 6 | Other/Miscellaneous Charge |
Healthcare_Amount
| Auto Substantiation Fields | Usage 1 | Usage 2 | Usage 3 | Usage 4 | Usage 5 |
|---|---|---|---|---|---|
| Over The Counter Amount | + $40.00 | + $40.00 | – | – | – |
| Prescription Amount (4U) | – | + $10.00 | + $10.00 | – | – |
| Clinic/Other Amount (4W) | – | + $10.00 | + $10.00 | – | – |
| Dental Amount (4X) | – | + $10.00 | + $10.00 | – | – |
| * Vision Amount (4V) | – | $10.00 | $10.00 | $10.00 | – |
| * Transit Amount (4T) | – | – | – | – | $10.00 |
| Healthcare Amount (4S) | = $40.00 | = $70.00 | = $30.00 | $0.00 | – |
*Amounts (4V & 4T) are not included in the total Healthcare Amount field (4S)
- Use 1 = $40 OTC Amount Only
- Use 2 = $40 OTC Amount + $10 Prescription + $10 Clinic + $10 Dental = $70 Healthcare Amt, plus $10 Vision
- Use 3 = $10 Prescription + $10 Clinic + $10 Dental = $30 Healthcare Amount, plus $10 Vision
- Use 4 = $10 Vision Amount Only (not included in Healthcare Amount, must be sent as $0)
- Use 5 = $10 Transit Amount Only (not included in Healthcare Amount)
MAC_Key
This is the key that is used during the Message Authentication Code process (MAC’ing) in the terminal to generate the MAC Value for each debit request.
| Len | Type | Description |
|---|---|---|
| 16 32 | hex | This is the key used to generate the MAC value for each transaction. This value will be either a 16 character or a 32 character length value. |
MAC_Value
| Fields | Len | Description |
|---|---|---|
| Processing Code | 6 | The processing code from the transaction. |
| Transaction Amount | 12 | The transaction amount that is used to calculate the MAC value should be a right justified, zero filled twelve (12) character numeric value. |
| System Trace Audit Number | 6 | The System Trace Audit Number from the transaction, if available. |
| Card Account Number (PAN) | 1-19 | Card Account Number (Numeric Value Only). |
| Retrieval Reference Number | 12 | The Retrieval Reference Number, if available. |
| Debit Response Code | 2 | The Debit Response Code, if available. |
info_outline
note
The following editing rules will apply:
- A single space is inserted following each implicitly delimited field.
- Lower case characters are translated to upper case.
- Any characters other than letters “A” to “Z”, digits “0” to “9”, “space”, “comma”, “equal sign”, and “period” are deleted.
- The Card Account Number (PAN) field is a numeric-only value.
- No spaces or dashes are allowed in the Card Account Number (PAN) field. Any characters other than digits “0” to “9” are deleted.
- All leading spaces are deleted.
- All trailing spaces are deleted.
The MAC value uses variable fields depending upon the message type being submitted. The following table describes the values that are used in the MAC calculation by message type.
| Fields | Purchase | Return | Void | Reversal | Response |
|---|---|---|---|---|---|
| Processing Code | Yes | Yes | Yes | Yes | No |
| Transaction Amount | Yes | Yes | Yes | Yes | Yes |
| System Trace Audit Number | Yes | Yes | Yes | Yes | Yes |
| Card Account Number (PAN) | Yes | Yes | Yes | No | No |
| Retrieval Reference Number | No | No | Yes | No | Yes |
| Debit Response Code | No | No | No | No | Yes |
MSDI
| Len | Type | Code | Description |
|---|---|---|---|
| 1 | Alpha | 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) | ||
| A | Debit Purchase without PIN Block (S) |
POS_Entry_Capability
| Code | Description |
|---|---|
| 01 | Manual Entry Only (01,02,12) |
| 02 | Magnetically Swipe Capability (01, 02, 12, 03) |
| 03 | Proximity Read Capability (w/Magstripe) (01, 02, 12, 03, 04, 06) |
| 13 | Proximity Read Capability Only (wo/Magstripe) (04, 06) |
| 04 | EMV Chip Capability (ICC) – Contact Only(w/Magstripe) (01, 02, 12, 03, 05, 07, 08) |
| 05 | EMV Chip Capability (ICC) – Duel Interface(w/Magstripe) (01, 02, 12, 03, 04, 05, 06, 07, 08, 09) |
| 15 | EMV Chip Capability (ICC) – Dual Interface(wo/Magstripe) (05, 06, 07, 08) |
| 10 | MICR Read (10, 11) |
Processing_Code
| Len | Type | Description | Tran Code: | 200 | 201 | 298 | 299 |
|---|---|---|---|---|---|---|---|
| 6 | Numeric | 000000 = Debit Purchase from the Default Account (Flash Only) | Yes | Yes | |||
| 001000 = Debit Purchase from Savings | Yes | Yes | |||||
| 002000 = Debit Purchase from Checking | Yes | Yes | |||||
| 091000 = Debit Purchase with cashback from Savings | Yes | Yes | |||||
| 092000 = Debit Purchase with cashback from Checking | Yes | Yes | |||||
| 200000 = Debit Return from the Default Account (Flash Only) | Yes | Yes | |||||
| 200010 = Debit Return from Savings | Yes | Yes | |||||
| 200020 = Debit Return from Checking | Yes | Yes | |||||
| 220000 = Void of a Debit Purchase from the Default Account (Flash Only) | Yes | ||||||
| 220010 = Void of a Debit Purchase from Savings | Yes | ||||||
| 220020 = Void of a Debit Purchase from Checking | Yes | ||||||
| 020000 = Void of a Debit Return from the Default Account (Flash Only) | Yes | ||||||
| 021000 = Void of a Debit Return from Savings | Yes | ||||||
| 022000 = Void of a Debit Return from Checking | Yes |
PS2000_Data
The structure of the PS2000 data field is as follows:
| Card Brand | Pos. 1 | Pos. 2 - 16 | Pos. 17 - 20 | Pos. 21 - 22 |
|---|---|---|---|---|
| Visa | ACI | Transaction ID | Validation Code | ALP |
| MasterCard | “M” | Banknet Reference Nbr | Banknet Date | TIC |
| Discover | “D” | NRID | Transaction Data Condition Code (LF – space filled) | Spaces |
| AMEX | “A” | Transaction ID | Spaces | Spaces |
| Union Pay | “U” | 2-7 = STAN 8-16 = Pos. 1-9 of Date/Time | 17 = Pos. 10 of Date/Time 18-20 = Julian Date | Spaces |
Recurring_Payment_Type
| Code | Description | USA | PRI | CAN | BRA | MEX |
|---|---|---|---|---|---|---|
| 1 | Recurring Transaction | Yes | Yes | Yes | Yes | Yes |
| 2 | Installment Transaction | Yes | Yes | No | No | No |
| 3 | Acquirer Installment Transaction (without Interest) | No | No | No | Yes | No |
| 4 | Issuer Installment Transaction (with Interest) | No | No | No | Yes | Yes |
| 5 | Issuer Installment Transaction (without Interest) | No | No | No | No | Yes |
| 6 | Issuer Installment Transaction (without Promotion) | No | No | No | No | Yes |
| 7 | Buy Now, Pay Later (Deferred payment in full) | No | No | No | No | Yes |
| 8 | Carne Bill Payment (Brazil) | No | No | No | Yes | No |
A Recurring Transaction is a transaction in which a cardholder allows a merchant to charge their card for recurring goods or services for a mutually agreed-upon payment amount (variable or set) and for a specified length of time. The merchant must obtain written permission to bill a cardholder on a recurring basis. Subsequent permission must be obtained when the agreement is renewed.
Recurring transactions have a defined billing cycle and are in effect as long as the contract between the merchant and the cardholder is in good standing. Recurring payments include charges for Utilities, membership fees, subscriptions, insurance premiums, tuition, etc.
An Installment Transaction is when a cardholder allows a merchant to charge their card for a single purchase of goods or services on a pre-determined payment schedule. The merchant must obtain permission to bill the cardholder in an arrangement in which a single purchase of goods/service is divided into two or more payments. Subsequent permission must be obtained when the agreement is modified.
Installment transactions have a defined transaction amount, billing cycle, and a total number of payments, which equal the full amount for the original agreed upon purchase. Installment payments include charges for loan payments, car purchase, furniture stores, etc.
A Carne Bill Payment Transaction is a Brazilian transaction in which a cardholder enters into an agreement and signs a contract with the Merchant to make regular monthly payments using a domestic Brazilian Debit Card for a current purchase. The cardholder then agrees to return to the store each month and present a domestic Brazilian Debit Card to make a payment according to the terms of the contract.
Response_Message
The first two characters (GB or RB) of the response message are used to indicate a successful or failed settlement attempt.
| Len | Type | Response Code | Response Description |
|---|---|---|---|
| 16 | Alpha | GB | Good Batch |
| RB | Rejected Batch | ||
| GBOK BBBMMDDHHMM | GBOK = Good batch, settlement received OK BBB = Batch Number 001 through 999 MMDD = Month and day of Settlement HHMM = Time of Settlement in hours and minutes | ||
| RBOUT OF BALANCE | Item and Dollar totals do not match the settlement trailer record totals. | ||
| RB INV ACCT 9999 | Record number 9999 is invalid. | ||
| RB INV CARD 9999 | Card type not allowed for settlement for the Merchant ID for record 9999. | ||
| RB INV DATA 9999 | Data Invalid for record 9999, please retry. | ||
| RB INVLD AMT9999 | Invalid transaction amount for record 9999. | ||
| RB PLEASE RETRY | System failure, please re-attempt. | ||
| RB UNREC CAR9999 | Card type not recognized for record 9999. | ||
| RB UPLOAD TIPS | An out of balance condition was detected that uploading of tip data will correct. | ||
| INVALID TERM ID | Terminal ID not on file at Elavon. | ||
| INVALID MER ID | Merchant number not found on the Elavon system. | ||
| NO PRIOR BATCH | No prior batch exists for inquiry. | ||
| NO TRANSACTIONS | There are no transactions in the requested batch. | ||
| BATCH 999 PURGED | Batch number specified was deleted per end user request. | ||
| BATCH NOT PURGED | Request was denied - Invalid Merchant ID. | ||
| SERV NOT ALLOWED | Merchant not set up for settlement processing on Elavon. |
Risk_Data
The format may vary by provider.
| Provider | Field Name | Len | Type | Description |
|---|---|---|---|---|
| VI (Visa) | Risk Assessment Data | 2 | Numeric | A value from 00 to 99. This value indicates the degree of risk associated with the transaction. A higher number indicates higher risk. |
| VI (Visa) | Risk Condition Code | 2 | Numeric | This optional field indicates the potential for fraud to occur on the card account over the next 30 days. A higher number indicates higher risk. |
| MC (MasterCard) | Merchant Fraud Score | 3 | Alpha | A value from 001 to 998. Where 001 indicates the least likely fraudulent transaction and 998 indicates the most likely fraudulent transaction. |
| MC (MasterCard) | Merchant Score | 2 | Alpha | This field indicates the key factors that influenced Reason Code fraud score. |
Transaction_Code
| Code | Description | Request ID |
|---|---|---|
| 000 | Credit Card Sale | Credit Card.Sale |
| 001 | Credit Card Authorization Only | Credit Card.Auth Only |
| 002 | Credit Card Account Verification Only | Credit Card.Account Verification Only |
| 004 | Credit Card Pre-Paid Balance Inquiry | Credit Card.Pre-Paid Balance Inquiry |
| 005 | Credit Card Return | Credit Card.Return |
| 006 | Credit Card Force | Credit Card.Force |
| 008 | Credit Card Visa Account Funding | Credit Card.Visa Account Funding |
| 009 | Credit Card MasterCard Payment Transaction | Credit Card.MasterCard Payment |
| 010 | Credit Card Lodging Check In | Credit Card.Lodging Check In |
| 011 | Credit Card Incremental | Credit Card.Incremental |
| 012 | Auto Rental | Credit Card.Auto Rental |
| 098 | Credit Card Void | Credit Card.Void |
| 099 | Credit Card Reversal | Credit Card.Reversal |
| 100 | Debit Card Purchase | Debit.Purchase |
| 101 | Debit Card PIN Less Purchase | Debit.PINless Purchase |
| 102 | Debit Card Return | Debit.Return |
| 103 | Debit Card Balance Inquiry | Debit.Balance Inquiry |
| 120 | EBT Food Stamp Purchase | EBT.Food Stamp Purchase |
| 121 | EBT Food Stamp Voucher Clear Purchase | EBT.Food Stamp Voucher Clear Purchase |
| 122 | EBT Food Stamp Return | EBT.Food Stamp Return |
| 123 | EBT Food Stamp Voucher Clear Return | EBT.Food Stamp Voucher Clear Return |
| 124 | EBT Food Stamp Balance Inquiry | EBT.Food Stamp Balance Inquiry |
| 140 | EBT Cash Benefit Purchase | EBT.Cash Benefit Purchase |
| 141 | EBT Cash Benefit Balance Inquiry | EBT.Cash Benefit Balance Inquiry |
| 197 | Debit / EBT Echo | Debit.Echo or EBT.Echo |
| 198 | Debit / EBT Void | Debit.Void or EBT.Void |
| 199 | Debit / EBT Reversal | Debit.Reversal or EBT.Reversal |
| 200 | Debit Card Purchase (Canadian) | Canadian Debit.Purchase |
| 201 | Debit Card Return (Canadian) | Canadian Debit.Return |
| 298 | Debit Void (Canadian) | Canadian Debit.Void |
| 299 | Debit Reversal (Canadian) | Canadian Debit.Reversal |
| 300 | ECS Purchase w/Conversion | ECS.Purchase with Conversion |
| 301 | ECS Purchase w/Verification | ECS.Purchase with Verification |
| 302 | ECS Purchase w/Guarantee | ECS.Purchase with Guarantee |
| 397 | ECS Echo | ECS.Echo |
| 398 | ECS Void | ECS.Void |
| 399 | ECS Reversal | ECS.Reversal |
| 400 | Gift Card Activation | Gift Card.Activation |
| 401 | Gift Card Sale / Redemption | Gift Card.Redemption |
| 402 | Gift Card Credit / Return | Gift Card.Credit |
| 403 | Gift Card Replenishment / Reload | Gift Card.Reload |
| 404 | Gift Card Balance Inquiry | Gift Card.Balance Inquiry |
| 405 | Gift Card “Card Refund” | Gift Card.Refund |
| 407 | Pre-Authorization | Gift Card.Pre-Auth |
| 408 | Post Authorization | Gift Card.Post-Auth |
| 420 | Add Loyalty Points | Gift Card.Add Loyalty Points |
| 421 | Redeem Loyalty Points | Gift Card.Redeem Loyalty Points |
| 422 | Loyalty Enrollment | Gift Card.Loyalty Enrollment |
| 423 | Loyalty Balance Inquiry | Gift Card.Loyalty Balance Inquiry |
| 424 | Loyalty Return | Gift Card.Loyalty Return |
| 425 | Loyalty Lead Inquiry | Gift Card.Loyalty Lead Inquiry |
| 426 | Loyalty Member Inquiry | Gift Card.Loyalty Member Inquiry |
| 493 | Loyalty Current Batch Inquiry | Gift Card.Loyalty Current Batch Balance |
| 494 | Loyalty Last Settled Batch Inquiry | Gift Card.Loyalty Previous Batch Balance |
| 495 | Gift Card Batch Close Out | Gift Card.Batch Close Out |
| 496 | Gift Card Current Batch Inquiry | Gift Card.Current Batch Balance |
| 497 | Gift Card Last Settled Batch Inquiry | Gift Card.Previous Batch Balance |
| 498 | Gift Card / Loyalty Void | Gift Card.Void |
| 499 | Gift Card / Loyalty Reversal | Gift Card.Reversal |
| 800 | DCC Rate Request | Misc.DCC Rate Update |
| 801 | BSFS Credit Application | Misc.Bridgestone Instant Credit |
| 803 | Key Exchange (EMV) | Misc.EMV Key Exchange |
| 804 | Cash or Cash-equivalent Purchase Transaction | Misc.IVU Loto Cash Purchase |
| 805 | Cash or Cash-equivalent Refund Transaction | Misc.IVU Loto Cash Refund |
| 806 | Cash or Cash-equivalent Void Transaction | Misc.IVU Loto Cash Void |
| 807 | Cash or Cash-equivalent Reversal Transaction | Misc.IVU Loto Cash Reversal |
| 808 | POS Logistics Message | Misc.POS Logistics |
| 810 | Get Token Request | Misc.Get Token |
| 811 | Transaction Eligibility | Misc.Transaction Eligibility |
| 900 | Balance Header (HB only) | Batch.Balance |
| 910 | Tip Header (HB Restaurant Header) | Batch.TIP Header |
| 911 | Tip Detail (HB Restaurant Tips) | Batch.TIP Detail |
| 919 | Tip Trailer Record (HB Restaurant Footer) | Batch.TIP Trailer |
| 920 | Detail Header (TB Settlement Header) | Batch.Detail Header |
| 921 | Detail Record (TB Detail) | Batch.Detail |
| 929 | Detail Trailer Record (TB Settlement Footer) | Batch.Detail Trailer |
| 997 | Last Settled Inquiry | Batch.Previous Balance |
| 998 | Current Batch Inquiry (Host-Based only) | Batch.Current Balance |
| 999 | Delete/Purge Batch (Host-Based only) | Batch.Purge |