API Reference

Following are the Elavon Gateway message fields for all input requests and most output responses from Elavon Gateway.

We strongly recommend that your application retain all fields noted as 'Store' until completion and settlement of the transaction. Other fields can be stored at the discretion of the integrator.

Field	Name	Length Type	Description
			General Data
0001	Transaction Type	2 numeric	Required in all requests. Determines what action Gateway products will perform with the data in the API input file. Store.
0002	Transaction Amount	4-13 cents	Total amount of the transaction including tax, gratuity, etc. Store. Valid range is 0.00 - 9999999999.99 ($9,999,999,999.99 Max)
0003	Account Number	31-128 alphanumeric	Contains either the manually entered account number, unformatted track swipe/chip read, encrypted track swipe or an account token value. If track read, the data should be unaltered, except for encrypting intact track. This means include the start and stop sentinels, but no LRC characters. Store. It is against card association regulations to store Track data. The Unique ID is returned in Field 3. The POS application will store this Unique ID and pass this value on all successive transactions until the transaction has been successfully settled. The token will be prefaced with "ID:" (Example: ID:1234567890123456).
0004	Expiration Date	4 date	Format: MMYY. Represents the expiration date of the card. Store - must be encrypted. Note: Include the expiration date ONLY if the card was manually entered.
0006	Authorization Code	6-10 alphanumeric	Code returned from the card issuer or authorizing institution indicating an approved authorization request. Only supply an authorization code if a valid authorization code is obtained in a voice authorization. Store.
0007	Reference Number	1-8 numeric	Transaction-unique number (1- 99999999) supplied by the POS to identify the transaction within a batch/processing period. This number should be unique within a settlement batch. Store. Note: Elavon does not recommend padding this field with leading zeros.
0009	Host Batch Number	1-8 numeric	Incrementing number that identifies the batch number. A batch number may not be available under some processor specifications.
0011	Simplify Integration Field	80 alphanumeric	Simplify - Field contains various pieces of transaction data including switch timeout value, message type, transaction sequence number, etc. See Simplify Developer Guide for more information.
0012	Force Flag	1 numeric	Used with Host Capture Processors who provide duplicate checking. This will basically override the host checking enabling a valid "duplicate" transaction into the batch. Not supported by all hosts. Definition of a duplicate is defined by the host. If the force flag is present with a value of 1, the transaction will not be sent to the processor. Applies to Authorization Only (Tran Type 01) and Sale (Tran Type 02) transactions.
0017	Cash Back (PIN Debit)	4-6 cents	The amount of any cash advance included in the purchase amount (field 0002). Valid range is 0.00 - 999.99 ($999.99 Max)
0020	Debit Surcharge Amount (PIN Debit)	4-5 cents	Any additional amount included in the total amount (field 0002) added as a debit processing charge (ATM fees, for example). Valid range is 0.00 - 99.99 ($99.99 Max).
0025	Business Date	6 date	Used to control business date in Gateway. Store. Format - MMDDYY
			Compliance Data
0030	Online Indicator	1 numeric	Code returned by Gateway indicating the transaction was processed online, this value must be returned with any subsequent adjustments or capture requests. 0 = Offline, 1 = Online
0031	Commercial Card Type	1 alphanumeric	A single character returned from VISA that indicates the type of commercial card that was used on a transaction. Valid values are: B= Business R= Corporate S= Purchasing F=Fleet space= not a commercial card
0032	Authorization Date	6 date	Date the original authorization transaction took place. Main transactions that use this field are incrementals, reversals, and prior auths. Format: MMDDYY
0033	Authorization Time	6 time	Time the original authorization transaction took place. Main transactions that use this field are incrementals, reversals, and prior auths. Format: HHMMSS
0034	Authorization Characteristics Indicator	1 alphanumeric	Code that is used to track participation status of this transaction in interchange rate programs. From original authorization.
0035	Validation Code	1-4 alphanumeric	Computed value assigned by the card association (Visa, MasterCard, etc) and used to verify data integrity between authorization and settlement. From original authorization.
0036	Transaction Identifier	1-15 alphanumeric	Unique tracking number assigned by the credit card issuing bank. From original authorization.
0037	Authorizer	1 alphanumeric	Code which identifies the authorizing agency. From original authorization.
0038	Reason Code	1-2 alphanumeric	Code assigned by some third party processors to track why a transaction was rated as it was. From original authorization.
0039	TPP Data Entry Code	1-4 alphanumeric	Code assigned by some third party processors identifying how the data was entered. From original authorization.
0040	Issuer Card Verification Indicator	1 alphanumeric	Usually contains the indicator returned by issuing bank to indicate the result of the CVV2 (Visa), CVC2 ( MasterCard) or CID (Amex) verification. Store.
0041	Track Quality Indicator	1 alphanumeric	Returned by issuing bank to indicate the quality of track data received by the host. From original authorization.
0042	Issuing Bank Code	1-6 alphanumeric	Code assigned by the credit card issuing bank to the transaction.
0043	System Trace Audit Number (STAN)	6-25 numeric	The "STAN" is a unique number normally supplied by the merchant. This is the POS to TPP tracing number. If STAN is not supplied by the POS, SofTrans may generate one on the merchant's behalf. It is used by the processor to track a transaction through its system. It is often the "key" field used by the processor to lookup a previous transaction when a Reversal is requested. Many Gift Card and Debit processors require the STAN to be printed on the receipt. Store.
0047	POS Data Code	15-29 alphanumeric	Tableized Field delimited with ";" semi-colon between each POS DataCode value. Required for EMV implementations. See this page for values. Format: ;;;;;;;;;;;;;;* (default value)
0049	Card Product Result Code	3 alphanumeric	Code returned by issuer indicating the type of card product being authorized. This field must be retained from the auth response and passed back in the settlement record. From original authorization.
0050	CVV2/CVC2/CID Information	3-10 alphanumeric	The CVV2 indicator is found on the back of the card. It is usually a 3 numeric value. Normally used in conjunction with AVS transactions to verify the cardholder and the card. The maximum length and datatype have been modified to support encrypted values generated as part of P2PE on manually entered pans in a Safe-T-Suite PIN pad. Note: 10 digit A/N will be permitted on an inbound request only for manually entered E2EE transactions.
0052	Transponder/Proximity Indicator	1 numeric	Indicator stating that a transponder or proximity device was used to originate the transaction. Valid values: 0=no transponder 1=transponder initiated transaction 2=Proximity using VSDC rules 3=Proximity using MagStripe rules 5=Terminal Transponder equipped, transaction swiped or key entered
0054	POS Entry Mode	2 numeric	Required for EMV. See this page for valid values. From original authorization.
0060	Unique Device ID	1-8 numeric	Required. Identifies the source lane or terminal through which a transaction is processed, so that a compromised device or fraudulent transaction can be easily identified. Some third-party processors only support a maximum of four digits being passed in this field, so the last four numbers must be unique to each register within a location. This field should be presented in all transaction types supported by a POS/PMS application. Store.
			Commercial Card Fields
0070	Customer Code	1-25 alphanumeric	Merchant-assigned code identifying this customer (Customer Id or general ledger account number, for example). Visa supports up to 17 characters, MasterCard supports up to 25.
0071	Tax 1 Indicator	1 alphanumeric	Must be populated with the appropriate code to qualify the contents in the Tax Amount field. From original authorization. Valid codes for Level II: 0=no tax included 1=tax included 2=tax exempt Additional indicators for Level III: A=Labor Taxable, Material Exempt B=Material Taxable, Labor Exempt C=Not Taxable F= Exempt (Goods/ Service Tax) G= Exempt (Provincial Sales Tax) L=Exempt Local Service R=Recurring Exempt U=Usage Exempt
0072	Tax Amount 1	4-7 cents	Sales tax. Contains the total of all tax amounts for the purchase. Valid range is 0.00 - 9999.99 ($9,999.99 Max).
0073	Tax 2 Indicator	1 alphanumeric	Use a valid value from Tax 1 Indicator list of options.
0074	Tax Amount 2	4-7 cents	Contains the amount of additional taxes. Normally associated with the Local Sales Tax. For MC Corporate lodging, this field will be used for room tax. The only valid range is: 0.00 - 9999.99 ($9,999.99 Max).
			Internal Fields (Global Variables)
0109	Terminal ID	1-8 alphanumeric	References a terminal defined in merchant configuration that lets the Gateway product know which processor to dial, what phone # to use, and which merchant information to access. This value may NOT contain embedded spaces. Store.
0110	Cashier ID	1-8 alphanumeric	Can contain any code or name up to 8 uppercase characters to identify the person running the POS.
0115	Transaction Qualifier	3 numeric	Determines type of account used (optional field for credit transaction). Store. Valid values: 010=Credit 020=Check Verification 030=Debit 050=Stored Value 051=Loyalty
0117	Stored Value Function	1 numeric	Indicates stored value transaction function. 1=Activate, 2=Issue, 3=Reload, 4=Return, 5=Redeem, 6=Redeem w/Cashback, 7=Prior-auth, 8=Virtual Card Issue, 9=Partial Lock
			Compliance Data
0125	Retrieval Reference Number	1-15 alphanumeric	Assigned for chargeback retrieval purposes. Should be printed on receipt. Store.
0126	Track Indicator	1 numeric	Indicator showing how card was presented on original authorization: 00 = Manual 01 = Track 1 02 = Track 2 This value can optionally be stored in the POS application to provide to the user how the original transaction was presented - manual, or swiped (Track 1 or 2). Note: Checks that are MICR read may have a value 1 to indicate that it is not manually entered.
0127	Non-standard Rate Qualify Data	1 alphanumeric	Any additional, non-standard data that must be tracked to qualify for rate programs.
0128	Original Authorization Amount	4-13 cents	Original authorization-only dollar amount associated with this transaction. If not supplied, the value defaults to the authorization amount (field 0002). Valid range is 0.00 - 9999999999.99 ($9,999,999,999.99 Max).
0129	Compliance Data	1 alphanumeric	CPS data. From original authorization.
0130	Total Authorized Amount	4-13 cents	Total amount authorized up to this point in the lifecycle of this transaction. If not supplied, the value defaults to the authorization amount (field 0002). If the transaction is a prior- auth(07) this field should contain the dollar amount to be settled. Valid range is 0.00 - 9999999999.99 ($9,999,999,999.99 Max).
0131	Total Incremental Authorizations	2 numeric	This is the total number of incremental auths that were sent within a batch settlement.
0132	Authorization Reversal Sent	1 numeric	This field is used for prior auth (07) transactions to indicate whether an authorization reversal associated with this sale was transmitted. 0 – Partial Reversal Not Sent 1 – Partial Reversal Approved
			Dynamic Currency Conversion Fields
0140	Merchant Currency	3 alpha	Merchant Transaction Currency Code
0142	Cardholder Currency	3 alpha	Cardholder ISO Currency Code
0143	Cardholder Currency Code	3 numeric	ISO numeric currency code of the cardholder. From original authorization.
0144	Converted Currency Amount	1-14 cents	Cardholder Transaction amount
0150	DCC Rate	1-10 numeric	Foreign Currency Exchange Rate
0151	DCC Indicator	1 numeric	DCC Eligible terminal indicator. Valid values include: 0 = Not DCC Capable 1 = DCC Capable and cardholder has opted-in 2 = DCC BIN match, but no corresponding rate for that currency 3 = DCC capable, but cardholder has opted-out
0159	DCC Exponent	1 numeric	Number of exponent digits in the DCC Rate
0164	DCC File ID	21 numeric	In the case where Simplify or the payment application performs the DCC Inquiry on behalf of the POS/PMS, they will need to populate the value from field 7007 in the transaction type 46 response into field 0164 in the authorization response to the PMS/POS. PMS/POS store this value for receipt printing and research of previous rates
0165	DCC Markup Percentage	4 numeric	DCC Rate markup with the 2 implied decimals (3.25% is 0325)
0166	DCC Rate Provider Name	1-35 alphanumeric	Indicates the name of the currency rate provider
0169	Merchant PMS/POS DCC Capability	1 numeric	0 = Merchant’s PMS/POS is not DCC Capable 1 = Merchant’s PMS/POS is DCC Capable and enabled 2 = Merchant’s PMS/POS is DCC Capable and not enabled 3 = Merchant’s PMS/POS is DCC Capable and enabled, Merchant does not want to perform DCC on this transaction
			eCommerce fields
0190	eCommerce Indicator (EC)	1 alphanumeric	This value must be presented in any e-commerce transaction. For returns, the value must be the same as the value of the original sale. Valid values are: 5 = 3-D Secure Compliant 6 = Non-Authenticated 3-D Secure 7 = Channel Encrypted
0191	Electronic Goods Indicator	1 alphanumeric	Valid values: D = Digital Goods P = Physical Goods
0192	Program Protocol*	1 numeric	Used to indicate the type of 3- D secure protocol used. Valid values: Blank - Not a 3D secure transaction 1 - 3D secure transaction, version 1.0 2 - 3D secure transaction, version 2.0
0193	Direct Server Transaction ID*	1-36 alphanumeric	Required version for 3-D secure version 2.0 (API Field 0192 = 2) This data is generated by the directory server during the authentication transaction and passed back to the merchant with the authentication results. Allowed Values: Variable
0194	CAVV/UCAF/Tran Stain*	1-40 alphanumeric	Used for a 3-D, SPA, or SET transaction. This field contains a unique value calculated by applying a secure algorithm to the XID.
0195	XID*	1-40 alphanumeric	Used in a 3-D, SPA, or SET transaction. This field contains a value assigned as a unique transaction identifier. It allows an alternate form of identifying the transaction without divulging the credit card account number in the response to the verification process.
0196	CAVV Response*	1 numeric	Used in a 3-D transaction: Blank = CAVV not validated 0 = CAVV not validated due to erroneous data submitted 1 = CAVV failed 2 = CAVV passed 3 = CAVV validation could not be performed (issuer attempt incomplete) 4 = CAVV validation could not be performed (issuer system error)
			Restaurant Fields
0200	Charge description	1 numeric	REQUIRED. Details the items purchased. Valid values: 1 = FOOD 2 = FOOD/BEV 3 = BEVERAGE Default to 1 if not provided. Ex.: 0200,2
0201	Tip 1 amount	4-7 cents	OPTIONAL. Tip for primary server (may not be known at time of authorization). Ex.: 0201,2.75
0202	Tip 2 amount	4-7 cents	OPTIONAL. Tip for secondary server. Ex.: 0202,1.50
0203	Employee ID of primary server	1-8 numeric	OPTIONAL. Unique number which identifies the primary server. Ex.: 0203,23
0204	Employee ID of secondary server	1-8 numeric	OPTIONAL. Unique number which identifies the primary server. Ex.: 0204,501
0205	Check number (ROC)	1-6 numeric	OPTIONAL. Ticket number for the transaction. May be the same as Field 7. Ex.: 0205,123456
0207	Food amount	4-7 cents	OPTIONAL. Dollar amount of the total ticket price for food charges. Valid range is 0.00 - 9,999.99 max. Ex.: 0207,153.78
0208	Beverage amount	4-7 cents	OPTIONAL. Dollar amount of the total ticket price for beverage charges. Valid range is 0.00 - 9,999.99 max. Ex.: 0208,25.00
0209	Table number	1-3 numeric	OPTIONAL. Identifies the customer’s table number. Ex.: 0209,47
0210	Description of Tip #1	1-8 alphanumeric	OPTIONAL. Description of first tip amount. This field should contain ‘TIP’ even if no Tip 1 is included. Ex.: 0210,TIP
0213	Food description	1-24 alphanumeric	OPTIONAL. Description of food charges. Valid values: “FOOD” for food charges only. “BEVERAGE” for drink charges only. “FOOD/BEV” for food and drink charges. Default to FOOD/BEV if not provided. Ex.: 0213,FOOD/BEV
0214	Beverage description	1-8 alphanumeric	OPTIONAL. Description of beverage charges. Valid values are “BEVERAGE” or “DRINKS" Ex.: 0214,BEVERAGE
0215	Description of Tip #2	1-8 alphanumeric	OPTIONAL. Description of a second tip amount. This field should contain ‘TIP’ even if no Tip 2 is included. Ex.: 0215,TIP
0216	Number of guests	2 numeric	OPTIONAL. Number of guests on the ticket. Ex.: 0216,02
			Lodging Fields
0300	Charge Description	1 numeric	Valid values: 0=Health Spa 1 = Lodging 2 = Food/Beverage 3 = Gift Shop 4 = Beauty Salon 5 = Convention Fees 6 = Tennis/Pro Shop 7 = Golf/Pro Shop 9 = unassigned 8 = unassigned Defaults to 1.
0301	Folio Number	1-8 numeric	Folio number where the transaction was charged. Ex.: 0301,123456
0302	Room Rate	1-8 cents	Per-day charge for the room. The only valid range is 0.00 - 99999.99 ($99,999.99 max) Ex.: 0302,50.00
0303	Arrival Date	6 date	Date when the customer checks in to the property. Format is MMDDYY. Ex.: 0303,061025
0304	Departure Date	6 date	Actual or anticipated guest departure date. Typically, this field coincides with the transaction date (or the date the transaction was settled). If the transaction is a partial payment, occurring prior to the departure, the departure date should be set to the current date, not the actual departure date. Format: MMDDYY Ex.: 0304,061525
0305	Program Code	1 numeric	Valid values: 1 = Lodging 2 = Assured Reservation (no show) 3 = Advanced Deposit 4 = Delayed Charge 5 = Express Service 6 = Assured Reservation Defaults to 1.
0307	Duration of Stay	2 numeric	The number of days for the charge. Minimum one day. Ex.: 0307,5
0308	Ticket Number/ROC	8 numeric	Record of Charge (ROC) or reference number assigned to the charge. Ex.: 0308,12345678
0309	Employee Number	1-6 numeric	Identifies the person who checked the guest out. Ex.: 0309,22
0310	Room Number	1-4 alphanumeric	Identifies the room number for primary charges. Ex.: 0310,211
0311	Extra Charges Amount	1-14 cents	Dollar amount for any extra charges incurred by the guest. Ex.: 0311,125.00
0312	Extra Charges Reason Codes	6 numeric	This field should only contain a value if the Extra Charges Amount (API field 0311) contains a valid amount. Enter multiple reasons back to back. Reason(s) codes: 2 = Restaurant 5 = Telephone 3 = Gift Shop 6 = Other 4 = Minibar 7 = Laundry Ex.: 0312,23 (for Restaurant and Gift Shop charges)
0313	Guest Name	26 alphanumeric	Name of the guest. If Track I is present and this field is blank, the name encoded in Track I will be used. Ex.: 0313,Claire Bell
			Retail Fields
0400	Product Code	2-4 numeric	An international numeric code describing the type of purchase. A list of valid codes should be provided to the merchant by the acquiring bank or processor. Used in European countries.
0401	Invoice Number/ROC	1-10 numeric	Contains the invoice number or record of charge (ROC). Ex.: 0401,123456
0406	Item 1 Text	40 max alphanumeric	REQUIRED. Description of purchased item. This field is required along with API Field 0412. Ex.: 0406,BRUSH
0407	Item 2 Text	40 max alphanumeric	Description of purchased item. Required if there is an Item Code 2 (API Field 0413). Ex.: 0407,SOAP
0408	Item 3 Text	40 max alphanumeric	Description of purchased item. Required if there is an Item Code 3 (API Field 0414). Ex.: 0408,SHAMPOO
0409	Item 4 Text	40 max alphanumeric	Description of purchased item. Required if there is an Item Code 4 (API Field 0415). Ex.: 0409,TOOTHPASTE
0410	Item 5 Text	40 max alphanumeric	Description of purchased item. Required if there is an Item Code 5 (API Field 0416). Ex.: 0410,TOOTHBRSH
0411	Retail Terms	4 numeric	Identifies special terms or payment options. Ex.: 0411,1234
0412	Item Code/Details 1	4‐35 alphanumeric	Item code describing type of product purchased. SubField 1 - Item Code describing type of product purchased [max size 16, numeric] SubField 2 - Item Quantity [max size 3, numeric] SubField 3 - Item Amount [max size 13] Format: NNNN;NNN;NNNNNNNNNN.NN Examples: 0412,23;1;13.42 (This example includes all subfields, item code, quantity, amt) 0412,;2;2.35 (This example is quantity + amt only) 0412,453 (This example is item code only. This is an example of Legacy use).
0413	Item Code/Details 2	4‐35 alphanumeric	Item Code describing type of product purchased. Required if there is an Item 2 text.  Refer to description for field 0412.
0414	Item Code/Details 3	4‐35 alphanumeric	Item Code describing type of product purchased. Required if there is an Item 3 text. Refer to description for field 0412.
0415	Item Code/Details 4	4‐35 alphanumeric	Item Code describing type of product purchased. Required if there is an Item 4 text. Refer to description for field 0412.
0416	Item Code/Details 5	4‐35 alphanumeric	Item Code describing type of product purchased. Required if there is an Item 5 text. Refer to description for Field 0412.
0432	Freight Amount	4-7 cents	Amount of applicable freight charges included in the final amount (field 0002). Valid range is 0.00 - 9999.99 ($9,999.99 Max).
0433	Discount Amount	4-7 cents	Amount of any discount applied to this transaction. Valid range is 0.00 - 9999.99 ($9,999.99 Max).
0434	Duty Handling Amount	4-7 cents	Amount of any duty or handling fees included in the final amount (field 0002). Valid range is 0.00 - 9999.99 ($9,999.99 Max).
			Private Label
0608	Product Amount 1	1-14 cents	CONDITIONAL. Dollar amount of product item #1 Valid values are 0.00 – 9999.99.
0615	Promotion Code	2-8 alphanumeric	CONDITIONAL. Represents any promotion associated with the purchase. Values are issuer-specific (see valid options below). Should be table driven.
0632	Account Balance	4-13 cents	The dollar amount in the account. Valid range is 0.00 - 9999999999.99 ($9,999,999,999.99 Max).
			Partial/Prepaid Support Fields
0647	Partial Authorization Acceptance	1 numeric	Account Balance information will be returned where available. Store. 0 = POS cannot support partial authorization responses 1 = POS can support partial authorization responses Ex.: 0647,1
0651	Authorization Reversal Data	256 alphanumeric	Some TPPs are requiring special data to be retained from the original request and return with Partial (tran type 76) or Full (tran type 61) Reversals or on Settlements. Ex. FDMS Requires FID K3. This can be used for auxiliary retrieval reference number when field 125 is too short (ex. Global East)
			Address Verification System (AVS) Fields
0700	Billing ZIP Code	5-9 alphanumeric	OPTIONAL. Card holder's zip code. Used for keyed or manual transactions only. Entered at the PIN pad if using encryption, Simplify, or EMV. Ex.: 0700,30076
0701	Billing Street Address	1-20 alphanumeric	Street number and name of cardholder's billing address (format is all capital letters). Used for keyed or manual transactions only. OPTIONAL for Visa and MasterCard. REQUIRED for American Express and Discover. Ex.: 221B BAKER STREET
			Direct Marketing Fields
0711	Shipping Date	6 date	Date the merchandise was shipped to the customer. Format: MMDDYY
0712	Charge Description	1 numeric	Identifies the type of direct marketing charge. Valid values are: 1 = Single transaction mail/telephone order 2 = Recurring mail order transaction 3 = Mail order installment payment 4 = Unknown mail order transaction or IVR/VRU PINless Debit 9 = Call center PINless debit
0713	Clearing Sequence Count	2 numeric	Contains the total number of payments or installments to be made on this account.
0714	Clearing Sequence Number	2 numeric	Contains the sequence number of the payment or installment associated with the charge. The value should be between 1 and the clearing sequence count (API field 0713).
0715	Order Number	10 alphanumeric	Contains the purchase order or invoice number associated with this charge. May be the same as contents of reference number (API field 0007).
0716	Ship to ZIP	5-9 alphanumeric	Ship code where the merchandise is to be delivered.
0717	Item 1 Text	40 alphanumeric	Description of charges. This field is required along with API field 0720.
0718	Item 2 Text	40 alphanumeric	Description of charges. Required if there is an Item Code 2 (API field 0721).
0719	Item 3 Text	40 alphanumeric	Description of charges. Required if there is an Item Code 3 (API field 0722).
0720	Item Code 1	4-23 numeric	SubField 1: Item code describing type of product purchased (max size 4, type N) SubField 2: Item quantity (max size 3, type N) SubField 3: Item amount (max size 14, type C) Format: NNNN;NNN;NNNNNNNNNNN.NN Valid Examples: 720,23;1;13.42 (This example includes all subfields, item code, quantity, amt.) 720,2;2.35 (This example is quantity + amt only.) 720,453 (This example is item code only. This is an example of legacy use.)
0721	Item Code 2	4-23 numeric	Item code describing type of product purchased. Required if there is an Item 2 Text. Refer to description for field 720.
0722	Item Code 3	4-23 numeric	Item code describing type of product purchased. Required if there is an Item 3 Text. Refer to description for field 720.
0723	Recurring Payments status	1 alphanumeric	Flag indicating status of recurring payment (Card on File transaction) Valid values are: F - First Payment S - Subsequent scheduled recurring payment (i.e., regular payment) U - Unscheduled recurring payment/purchase
0724	Ship to Address Line 1	35 alphanumeric	If different than the billing street address.
0725	Ship to Address Line 2	35 alphanumeric	If different than the billing street address and an additional line is necessary.
0726	Ship to City	20 alphanumeric	If different than the billing city.
0727	Ship to State	2 alphanumeric	If different than the billing state.
0732			error_outline note e-Commerce field migrated to 191.
0733	Item 4 Text	40 alphanumeric	Description of charges. Required if there is an Item Code 4 (API field 0735).
0734	Item 5 Text	40 alphanumeric	Description of charges. Required if there is an Item Code 5 (API field 0736).
0735	Item Code 4	4-23 numeric	Item code describing type of product purchased. Required if there is an Item 4 Text. Refer to description for field 0720.
0736	Item Code 5	4-23 numeric	Item code describing type of product purchased. Required if there is an Item 5 Text. Refer to description for field 720
0738	Recurring compliance data	1-50 alphanumeric	Contains compliance data that merchants should retain and then return unaltered in the next recurring/card on file transaction.
			Check Authorization Fields
0900	Account Number/MICR	1-40 alphanumeric	MICR information to be sent to processor. May be manual account number (up to 15 characters) or swiped data that includes the all the information from the bottom of the check. Output is masked in the response.
0901	Driver’s License	1-127 alphanumeric	Optional. Driver’s license information. May be manually entered or swiped.
0902	Check Number	10 numeric	Sequential check number of check presented.
0903	State ID	2 alpha	State code where driver’s license was issued.
0904	State Code	2 numeric	Optional. State code where check or driver’s license was issued.
0905	Date of Birth	6 date	Optional. Customer's date of birth. Format: MMDDYY.
0906	Check Type	3 numeric	Type of check presented. Valid values: 000 = personal check (default) 001 = personal savings 003 = corporate 004 = payroll 005 = government
0907	MICR Entry Mode	1 numeric	Indicates how MICR Field 900 was entered. Valid values: 0 = manual 1 = MICR reader
0908	Driver License Entry Mode	1 numeric	Optional. Indicates how Field 901 was entered. Valid values: 0 = manual 1 = swiped Confirm Federal, State and local regulations regarding the use of a Driver’s License.
0910	Zip Code	9 alphanumeric	Optional. Zip Code from address on the check.
0911	Phone Number	10 numeric	Optional. Phone number of primary account holder listed on check.
0912	ABA Number	9 numeric	Optional. ABA (transit) number from the bottom of the check. Required for manually entered account numbers.
0913	Alternate Identification Indicator	1 numeric	Optional. Identifies the type of alternate identification presented. Valid values: 0 = Other 1 = SSN 2 = Courtesy Card 3 = Military ID 4 = Debit Card 5 = Credit Card 6 = Address Confirm Federal, State and local regulations regarding the use of alternate identification.
0914	Alternate Identification	80 alphanumeric	Optional. This field contains the appropriate data relating to the type of identification noted in field 913. Should be masked in the response.
0916	Check Status	1 alphanumeric	Valid options: 0=Verification Only 1=Accept Check Conversion 2=Decline Check Conversion 4=Validation 5=Guarantee
0917	ACH Reference Number	1-25 alphanumeric	Host Reference for approved ACH transactions.
0918	Returned Check Note	1-100 alphanumeric	Accommodates additional state specific return check fee information.
0919	Returned Check Fee (Check)	4-6 cents	The fee charged to the check writer when a check is returned unpaid. Valid range is 0.00 - 999.99 ($999.99 Max).
0920	ACH Format Code	3 numeric	Required for ACH ECS transactions. Valid Values: 001 = ECS Data - Format B
0921	ACH ECS Product Code	3 alphanumeric	Required for ACH. Indicates the ECS Product method used for the ACH transaction. Valid values: WEB = Web Initiated-Entry TEL = Telephone Initiated-Entry CCD = Corporate Cash Disbursement PPD = Pre-Arranged Payment and Deposit.
1000	Card Type	2 alphanumeric	Two-character card abbreviation defined in Elavon Gateway applications. Store. Use CK for electronic check conversion.
1001	Card Name	1-26 alphanumeric	Full text card name defined in the Elavon Gateway applications. May be printed on receipts (either 1000 or 1001 must be printed on receipts). May be associated to the Unique ID to allow the POS application to know what type of payment is associated with the transaction. Store. Use CHECK for electronic check conversion.
1002	Cardholder Name	1-30 alphanumeric	Cardholder name parsed from Track 1, if provided in input API. May be printed on receipts. This may be different than the Guest or Customer.
			Response Fields
1003	Gateway Response Code	1-4 numeric	Code generated by the Elavon Gateway applications as part of the Final Four to indicate the success of the transaction. Governs internal error messages and displays in Field 1010 or host messages displayed in Field 1004. Store.
1004	Host Response Message	1-80 alphanumeric	Host response message verbatim or evaluated. May contain an Elavon Gateway application error message or a message from a partner application or TPP.
1005	Merchant Number	1-30 alphanumeric	Merchant number from the Elavon Gateway applications configuration information. Must be printed on receipt.
1006	Terminal Number	1-30 alphanumeric	Host response message verbatim or evaluated. May contain an Elavon Gateway application error message or a message from a partner application or TPP.
1008	Masked account number	ID alphanumeric	Used if tokens are part of the project scope. Store. 'ID:' returns a masked credit card number. Ex.: 1008,ID:
1009	Host Response Code	1-10 alphanumeric	Host response code indicating condition of the transaction (both authorization and settlement). May contain an Elavon Gateway application error code or a code from a partner application or TPP.
1010	Gateway Response Message	1-80 alphanumeric	Elavon Gateway application text response message corresponding to error code returned in Field 1003.
1011	Host Reference Number	1-16 alphanumeric	Elavon Gateway batch number associated with transactions in a Elavon Gateway batch. If returned in the output response, it must be printed on the receipt. Store.
1012	Gateway Batch Number	1-8 numeric	Elavon Gateway batch number associated with transactions in an Elavon Gateway batch. Returned with inquiry (14) settlement (13) Transaction. May be stored with transactions in the POS application post settlement. Store.
1013	Local Batch Net Amount	1-20 cents	Net Amount of transactions captured in the Gateway batch file. This field will contain a leading "-" sign if net amount is negative.(NOTE larger field size).
1014	Local Batch Transaction Count	1-9 numeric	Total count of transactions captured in the Elavon Gateway batch. Returned with Inquiry (14) and Settlement (13) Transactions.
			AVS Fields cont'd
1015	AVS Result Code	1 alphanumeric	Code (AVS External Codes) returned by the issuing bank to indicate the level of success of the address verification portion of an authorization. This field holds the value specific to the TPP and should be used for receipts.
1016	Host Batch Net Amount	1-20 cents	For Host capture processors capable of returning this information. Net Amount of transactions captured in the Host batch file. This field will contain a leading "-" sign if net amount is negative. (NOTE larger field size).
1017	Host Batch Tran Count	1-9 numeric	For host capture TPP capable of retuning this information. Total count of transactions captured in the host batch.
1018	Funded Batch Amount	1-20 cents	Returned in settlement response. Total amount of all sub-batches successfully closed in this settlement attempt.
1019	Funded Batch Count	1-9 numeric	Total count of all transaction in the Elavon Gateway application batch sent to the TPP. This count will always match the local batch count.
1020	AVS Response Field	1 alphanumeric	Code (AVS Internal Codes) returned by gateway switch as a uniform response code. These are Elavon Gateway normalized values: A - Address match, ZIP mismatch N - No match R - System unavailable S - AVS not supported Y - Address and ZIP match Z - ZIP match, address mismatch
			User-Defined Fields
1101	User Defined Field 1	1-34 alphanumeric	Optional. These fields are used for important POS application data that is not defined in the Elavon Gateway message and can be searched in the Elavon Gateway applications. Store.
1102	User Defined Field 2	1-34 alphanumeric	Optional. These fields are used for important POS application data that is not defined in the Elavon Gateway message and can be searched in the Elavon Gateway applications. Store.
1103	User Defined Field 3	1-34 alphanumeric	Optional. These fields are used for important POS application data that is not defined in the Elavon Gateway message and can be searched in the Elavon Gateway applications. Store.
1104	User Defined Field 4	1-34 alphanumeric	Optional. These fields are used for important POS application data that is not defined in the Elavon Gateway message and can be searched in the Elavon Gateway applications. Store.
1105	User Field 5	1-25 alphanumeric	User defined field. Store. If previous integrations used API Field 11 migrate data to this API field.
1200	Issuer Network Information	29 alphanumeric	Card Issue Reference data returned from TPP, required for settlement pertaining to network information.
			EMV Specification Fields (not necessarily restricted to EMV usage)
1378	EMV Approved Receipt Field List	1-256 alphanumeric special	OPTIONAL. EMV-specific delimited field that contains the API fields required by the merchant’s TPP to be printed. Ex.: 1378,1300	TC: ;1307	TVR: ;
1379	EMV Declined Receipt Field List	1-256 alphanumeric special	OPTIONAL. EMV-specific delimited field which contains the API fields required by the merchant’s TPP to be printed. Ex.: 1379,1300	TC: ;1307	TVR: ;
1380	POS Entry Indicator	1-20 alphanumeric	OPTIONAL. TPP-specific POS entry mode text for receipts based on the value in field 0054 and TPP rules. Fusebox TPP Interface layer sets this response field.
			Host Capture Response Fields (varied support, returned in response for Fields 14 and 13)
2003	Visa Total Amount	1-20 cents	Net total Visa card sale transaction amount. (Sales - Void Sales).
2005	MasterCard Total Amount	1-20 cents	Net total MasterCard card sale transaction amount. (Sales - Void Sales).
2007	Other Credit Card Total Amount	1-20 cents	Net total non-Visa, non-MasterCard sale transaction amount. (Sales - Void Sales).
2009	Total Credit Sales Amount	1-20 cents	Net total credit card sale transaction amount. (Sales - Void Sales).
2011	Total Debit Card Sales Amount	1-20 cents	Net total debit card sale transaction amount. (Sales - Void Sales).
2013	Total Credit Card Void Amount	1-20 cents	Net total credit card void amount.
2015	Total Debit Card Void Amount	1-20 cents	Net total debit card void amount.
2017	Total Credit Card Return Amount	1-20 cents	Net total credit card return amount.
2019	Total Debit Card Return Amount	1-20 cents	Net total debit card return amount.
2027	Gift Card Amount	1-20 cents	Identifies the total amount of all Gift Card Credit transactions in the batch.
			Point to Point Encryption (P2PE)
5002	Device Serial Number	1-20 alphanumeric	Serial numbers of devices are required by terminal products to transmit data to the TPP on auth requests or as identifiers for P2PE products. Store.
5004	Encryption Provider ID	2 alphanumeric	Requires a site ID be boarded with P2PE in Fusebox. When a site ID is boarded for P2PE, all transactions sent to that terminal must be encrypted or tokens. Fusebox-only valid values are: S1=Verifone Classic Key V1=Verifone Derived Key G1=Voltage type TEP 1 G2=Voltage type TEP 2 G3=Voltage type TEP 3
7007	Transaction Link Identifier	21 numeric	Fusebox only: A value assigned to each transaction (not each lifecycle) to uniquely identify the transaction in the Sybase database. Not required to store, but useful in troubleshooting.
			Elavon Internal Fields
8002	Location name	1-16 alphanumeric	OPTIONAL. The unique location name. Ex.: 8002,ATL26
8006	Chain code	1-6 alphanumeric	OPTIONAL. Used for key management in Gateway environments. The code is assigned during the boarding/conversion process. Ex.: 8006,TST123

Transaction Amount

The Elavon Gateway Message for Fusebox has the capability to support transaction amounts up to 13 characters (##########.##).

Batch Count and Amount

The Elavon Gateway Message for Fusebox returns batch counts and totals in some situations. The increased maximum batch counts and amounts are controlled on the Fusebox settlement back end. When currency amounts are increased, responses may return with a batch total of up to 20 characters (#################.##).

Decimals and Currency Fields

Requests: Currency fields are expected to be passed in the Gateway Message with a fully qualified decimal. For example, one hundred dollars should always appear as 100.00.

Some global currencies are whole unit and have different decimal masks. Every currency field is used as decimalized with a 0.00 format.

Response: All currency fields returned must have the decimal implied if not returned. For example, if a response is 100000, the POS should imply a decimal and read as 1000.00.

Site, PAN, and Reference Fields

The following fields are added if Site, PAN and Reference fields are in the active transaction database and not present in the current transaction.

The natural maximum transaction limit is #####.##, unless pre-approved to a specific TPP. Fields affected are marked with an asterisk (*).

• previous Receipt Example
• next POS Data Code