Elavon4 Auth Retail Transaction UML

Elavon4 specific low-level representation of Retail Transaction produced by Forward Transformation Process within Authorization Process.
During Generation Process, Elavon4 specific interchange message is generated from this object for authorization. Consequently, all fields of the object are mapped into message segments/elements.

Field used for account balance amount.

For Credit and Debit cards, if present this value indicates the remaining balance for a pre-paid account. For EBT transactions, if present this value indicates the remaining Food Stamp balance. For Gift Card transactions, if present this value indicates the remaining Gift Card balance on the account. Refer to the specification of the provider for more information.

For Credit and Debit cards, if present this value indicates the remaining Gift Card Balance on the account.
For EBT transactions, if present this value indicates the remaining Cash Benefit balance.
For Gift Card transactions, if present this value indicates the remaining Loyalty points on the account.

The value is used to submit the cardholder account data to Elavon for processing. Refer to the specification of the provider for more information.

This value is used to identify the method used to enter the Account Data for the transaction. Refer to the specification of the provider for more information.

This value is used to facilitate transaction routing on Elavon.

0 = Default or primary account on file (In Canada this is only used for Flash Transactions)
1 = Checking
2 = Savings
3 = Food Stamp
4 = Cash Benefits

This is the American Express Capture Code field and 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.

0 = Do not process
1 = Allow authorizations but do not capture in Settlement file
2 = Allow authorizations and capture in settlement file for processing

This field is used to indicate the type of POS device that is originating the transaction. These values are case sensitive and must be capitalized. Sample: HZ0000GC.

This field contains the Approval Code for an approved transaction.

Note: If the Response Code on the auth. is not equal to "AA" or “AP” the contents of this field are ignored.

Name of the assigned association.

This value is the date which the transaction was authorized. For offline transactions, this value should be set to the date when the transaction occurs.

This field contains the 16 character response display message. This field is used by the POS device to display the authorization results.

This value is used to indicate 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:

9 = No Authorization Source Code. This is used for non-authorized transactions, such as Credit Card Returns
E = Off-Line Approval. This is used when the approval code is manually entered, such as on a Referral or Force Transaction
6 = Off-Line approval, POS generated the approval.

This value is the time which the transaction was authorized. For offline transactions, this value should be set to the time when the transaction occurs.

This value is used to identify the total authorized amount for the authorization request. If the Partial authorization flag is enabled, this amount may be less than the requested amount.

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. Refer to the specification of the provider for more information.

This field is used to indicate to the POS which transactions should be captured in the local Shadow file.

0 = Do not Capture – Authorization Only
1 = Capture Transaction in Shadow File (EDC)
2 = Capture Transaction in Shadow File (EDC). This value is used for Debit Returns to indicate that the Debit Purchase is in the current batch.

This field is used to indicate the cashback amount applied to the transaction. This amount should be included in the Transaction Amount field.

This value is used to indicate the type of Cardholder Activated Terminal Indicator for this transaction.

00 = Not a CAT Transaction
01 = Limited Amount Terminal
02 = Automated Dispensing Machine
03 = Self-Service Terminal (AFD)
04 = In-Flight Commerce
05 = Internet
06 = Transponder
07 = Remote Indicator

Reference to the entity that represents real-time financial transaction.

This value is used to submit the amount of all Clinical or other qualified medical expenses contained within this purchase.

This value is used to identify the customer number for purchasing card transactions.

This value is used to indicate 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.

0 = Bypassed
1 = Present
2 = Illegible
9 = Not Present

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.

M = Match
N = No match
P = Not Processed
S = Issuer indicates that CVV2 data should be present on the card, but the merchant has indicated that the CVV2 data is not present on the card (Visa Only)
U = Issuer not certified or registered to process card verification.

This value is a three to four digit value that appears at the end of the printed PAN on the reserve side of the card. This value is used to verify a card’s authenticity for the purpose of preventing fraud in the mail order, telephone order (MO/TO) and card-not-present environments.

This value is used to indicate 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. Refer to the specification of the provider for more information.

This value is the debit switch settlement date in MMDD format.

This value is used to submit the amount of all Dental expenses contained within this purchase.

Code of the device type.

Vestion of the corresponding documentation.

Dynamic city of the merchant.

Dynamic country code of the merchant.

This value 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.

Dynamic phone number of the merchant.

Dynamic ZIP (or postal) code of the merchant.

Dynamic state code of the merchant.

Dynamic street address of the merchant.

Dynamic sub-merchant identification number of the merchant.

This indicates the method used to capture the cardholder’s information for an eCommerce or Internet transaction.

1 = Secure Electronic Commerce Transaction that includes the 3-D Secure Authentication value. (5)
2 = Non-Authenticated Security Transaction from a 3-D Secure capable merchant, and merchant attempted to authorize using 3-D Secure. Transaction Does Not Include 3-D Secure authentication value. (6)
3 = Non-Authenticated Security Transaction w/o Merchant Certificate i.e., Channel Encrypted (7)
4 = Non-Authenticated Security Transaction at a SET Capable merchant (9)
5 = Non-Secure Transaction (no encryption used) (8)

Date when the EMV key was generated.

This character is used by the POS to uniquely identify the transaction to the gift card host. This value is required for both Gift Card and Loyalty reversal transactions.

A unique value assigned by the POS to identify the gift card transaction.

This value is used to submit the total amount of All qualified medical expenses (Over the counter, Dental, Prescription, Vision, and Clinical/Other amount) contained within this Auto-Substantiation purchase. The “Transit Amount” is not included in this calculation.

This value is used to identify the date after which the application expires (The Application Expiration Date).

This value is used to indicate the capabilities of the card to support specific functions within the application (The Application Interchange Profile).

This value is generated by the authorization authority for an approved transaction.

This value contains data sent to the chip card for online issuer authentication.

This is an incrementing counter value that is managed by the application in the chip card (The Application Transaction Counter).

This is an incrementing counter response value that is managed by the application in the chip card.

This value is used to indicate the authorized amount of the transaction (excluding adjustments).

This value indicates the type of cryptogram and the actions to be performed by the terminal (The Cryptogram Information Data).

This cryptogram value is returned by the Chip (ICC) in response to a “Generate AC” command.

This value is used to differentiate chip cards using the same Primary Account Number (PAN).

This response value is used to differentiate chip cards using the same Primary Account Number (PAN).

This field is 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.

This value is used to indicate the results of the last CVM preformed. The Cardholder Verification Method Results (CVM) – EMV Tag 9F34.

ICC (International Chamber of Commerce) dedicated name of a file.

This field 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.

This value is used to send proprietary application data to the issuer in an online transaction.

This value is used to identify the results of the terminal script processing.

This value is used to return the Issuer specified script contained in EMV Tags 71 or 72 back to the POS in the authorization response message. Refer to the specidication of the provider for more information.

This value is used to indicate a secondary “Cashback” amount associated with the transaction.

This value is used to identify the country code where the terminal is located.

This value indicates the card data input, CVM, and security capabilities of the terminal.

This value is used to indicate the environment of the terminal, its communication capability, and its operational control.

Data assigned to ICC third party company.

This value is used to indicate the currency code of the transaction according to the ISO 4217 standard.

This value indicates the type of financial transaction, represented by the first two digits of the ISO 8583 processing code.

This value is used to indicate the local data that the transaction was authorized (The Transaction Date).

This value indicates the status of the different functions as seen from the terminal.

This value is used to provide variability and uniqueness to the generation of a cryptogram.

Identifier of the object used for references; auto-incremented integer value.

This value is used to indicate 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”.

This value is used to indicate 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”.

This value is used to include the POS’s local transaction invoice or order number. This is a required value for Mail Order and Ecommerce transactions.

This value is the original Issuer response as returned during the authorization attempt.

This value is used to indicate which encryption methodology was used for US Debit transactions (POS to Elavon) and which key to use for the next transaction (Elavon to POS).

D = Single-DES DUKPT
T = Triple-DES DUKPT
P = PIN Less Debit Purchase

This is 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.

This field is used to allow a multi-lane retailer using interleaved processing to send up a unique value that will identify the lane where the transaction originated from.

Key assigned to the merchant account code.

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 space filled if not utilized.

The Member name associated with the gift or loyalty card transaction, if available.

Code of Merchant Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.

This value contains the merchant assigned reference number for this transaction. If this value is not present, then Elavon will generate this number for backend use.

The Market Specific Data Indicator value.

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)

Approval code associated with the original transaction.

Record that contains specified data assigned by a processor.

Response code associated with the original transaction.

Trace number of the merchant from which the payment is applied.

Secondary identifier of the transaction which can be used to cross-reference records between UniPay and integrated systems.

This value is used to indicate if the POS is capable of performing partial authorizations.

0 = Indicates that the POS is not capable of Partial Authorizations.
1 = Indicates that the POS is capable of Partial Authorizations.
2 = Indicates that the POS is capable of Partial Authorizations and is a Visa Aggregator.

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.

This value is used to indicate the capability of the terminal to capture a PIN.

0 = Unknown
1 = Can accept and pass an online PIN
2 = Cannot accept and pass an online PIN
8 = PIN Pad is not functional

Key assigned to the current PIN of the cardholder.

This value is used to indicate the number of points added to an account an account.

This value is used to indicate the number of points to cancel from an account.

This value is used to identify the account entry capabilities on the POS device originating the transaction. Refer to the specification of the provider for more information.

This value is used to indicate the cardholder’s Postal or ZIP Code.

This is a Gift Card value used to identify the original pre-authorization request. This value is required to submit the post-authorization completion transaction message.

This value is used to submit the amount of all prescription expenses contained within this purchase.

Processing code of the transaction.

This data will be as received during the original authorization processing. It will not be present for off line transactions. This is a “retain and return” value for terminal-based settlement messages. Refer to the specification of the provider for more information.

This field contains a custom message as retuned from the Gift Card host to be printed on the cardholder’s receipt.

This field is used to identify the type of recurring transaction that is being submitted for authorization.

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 a transaction in which a cardholder allows a merchant permission 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.

This value is a reference number assigned by Elavon and returned in the authorization response message.

Type of request.

This value is a 2 character code indicating the authorization response status. An approval is always indicated with an ‘AA’ or ‘AP’ code, all other codes indicate a non-approval.

AA = Approved Transaction (Authorizations and Reversals)
AP = Approved Transaction for a Partial Amount
NC = Decline (Pick Up Card)
ND = Decline (Hard or Soft)
NF = Decline (Record Not Found)
NR = Decline (Referral Message)
N7 = Decline (For CVV2 Only)
NL = Decline (Loyalty/Gift Error)
00-99 = Decline (Additional Gift Card Declined)

Reference to the entity that represents a group of real-time transactions which must be settled together.

Retrieval reference number of the merchant.

This is the actual sales tax amount applied to this transaction. Consumer or Merchant tax exempt transactions can enter a single zero to properly reflect a tax exempt transaction.

The value is the date that the consumer’s goods were shipped. This value is the “Transaction Date” for direct marketing and ecommerce transactions.

Shipping Date in MMDDYYYY format.

This value is used to identify the cardholder’s street address.

This field is used to indicate the amount of the surcharge applied to the transaction. This amount should be included in the Transaction Amount field.

System trace audit number.

The value is used to identify the payment method use to activate or reload a gift card.

0 = Cash
1 = Credit Card
2 = Debit Card
3 = Check
9 = Unknown

The terminal identification number is used to uniquely identify the Merchant and their financial institution to Elavon. The Terminal ID consists of two parts and is assigned by Elavon for each POS device.

This value is used to indicate the environment of the terminal, its communication capability, and its operational control.

Value of the 3-D secure verification of the transaction.

This value is 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.

This is 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 others card associations.

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.

This value is used to uniquely identify the type of transaction that is being submitted to Elavon. Refer to the specification of the provider for more information.

The Transaction Reference Number is returned in the authorization response message and is used on void and reversal transactions, when available. This number is assigned by Elavon.

This value identifies the means in which the transaction was processed between the cardholder and the merchant for a SecureCode authentication transaction.

0 = UCAF data collection is not supported by the Merchant
1 = UCAF data collection is supported by merchant but not populated
2 = UCAF data collection is supported by merchant, and UCAF data must be present

This value is used to submit the amount of all optical/vision expenses contained within this purchase.

The Voucher Number from an EBT sales slip, used for Voucher Clear Food Stamp transactions.
The 15 digit Voucher Clear Number from the Merchant’s EBT Food Stamp sales slip.