TSYS Auth Retail Transaction UML

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

Contains code identifying the source of the customer data entered in field:

• D - Full magnetic stripe read and transmit, Track two
• H - Full magnetic stripe read and transmit, Track one
• T - Manually keyed, Track two capable
• X - Manually keyed, Track one capable
• @ - Manually keyed, terminal has no card reading capability

Contains a six-character numeric Visa assigned Bank Identification Number (BIN) issued by the merchant's member bank or processor. The Acquirer BIN identifies the member bank that signed the merchant using the POS application.

Contains an agent number assigned by the signing member or processor. The number identifies an institution which signs merchants as an agent of a member. The member uses this number to identify the agent within TSYS Acquiring Solutions’ system.

Contains a merchant chain identification number assigned by the signing member or processor. The member uses this number to identify the merchant chain within the TSYS Acquiring Solutions’ system.

Contains fixed approval code returned in the original authorization response record.

This is the authorization code for the completed AFD transaction, or the transaction to be either partially or completely reversed. For a debit non-confirm purchase or ATM authorization transactions, the approval code will be space filled.

Amount actually used.
The merchant must tender the difference between the requested amount and the approved amount.

Contains a response or display text message. This message can be used by the terminal to display the authorization result. The display text must not be used to determine the nature of a response message.

Contains code indicating the source of the authorization code. The received code must be stored and resubmitted in the data capture settlement record.

Contains the Address Verification Result Code. An Address Verification Result Code can provide additional information concerning the authentication of a particular transaction for which cardholder Address Verification was requested. An Address Verification result code of “0” is returned in the response message when no address verification has been requested. The value returned should be stored and submitted as part of the data capture settlement record.

Amount of available balance on the card.

Contains a batch sequence number generated by the terminal. The number wraps from 999 to 001. This number is also transmitted as the data capture batch number. Batch numbers should not be repeated within five days.

The following sub-fields are required when performing an ATM or Debit Non-Confirm Authorization request, or when performing an Authorization Reversal request, a Debit Reversal/Cancel request, or a AFD Completion Advice message. For all other transaction types, this field should be submitted without data.

Approval Code:
Contains approval code returned in the original authorization response record. This is the authorization code for the completed AFD transaction, or the transaction to be either partially or completely reversed. For a debit non-confirm purchase or ATM authorization transactions, the approval code will be space filled.

Local Transaction Date:
Contains value reflecting the local transaction date returned in the original authorization response record for the AFD sale or the transaction to be canceled or reversed. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction date.

Local Transaction Time:
Contains the local transaction time of the original authorization request for the AFD sale or the transaction to be either partially or fully reversed. The Local Transaction Time must be submitted in HHMMSS format. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction time.

Retrieval Reference Number:
In AFD Completion Advice messages and reversal transactions, this field must contain Retrieval Reference Number returned in the original authorization response. For debit non-confirm purchase or ATM authorization transactions, this field contains two parts. The first four characters are a yddd date (Julian date) format. The last eight characters are a numeric transaction identification number.

The following sub-fields are required when requesting any of the following Authorization Transaction Codes: A3, A4, B1, B2, B3, B4, C1, C3, C4 and 5C. This field does not contain data for any other transaction types.

System Trace Audit Number:
Must contain the System Trace Audit Number returned in the confirmation data field of the debit authorization response record for the transaction to be canceled or reversed. For a debit non-confirm purchase transaction, this number uniquely.

Network Identification Code:
When returned in a debit authorization response message, this value designates the debit network through which the request was processed. When performing an Authorization Reversal, this field must contain the one-character Network Identification Code returned in the confirmation data field of the authorization response record for the item to be canceled or reversed. For a debit non-confirm or ATM authorization transactions, the network identification code field will be space-filled.

The following sub-fields are required for direct debit transactions. For all other transactions, the following sub-fields should be configured as parameters within the POS system but need not necessarily contain data.

The format of this 40-byte field is:

“NNNNNNNNNNNNNNNNNNNNNNNNNLLLLLLLLLLLLLSS”
where
NNNN... 1-25 A/N Merchant Name
LL.....LL 26-38 A/N Merchant City
SS 39-40 A/N Merchant State

For Direct Marketing merchants and preferred customer/passenger transport transactions, this field should contain a customer service phone number in XXX-XXXXXXX format.

Contains code created by Visa during the authorization process.

Conditional in the response record. It will only be returned if the values are non-zero.

Type of the card used for transaction processing.

Contains a code that specifies the method used to verify the identity the cardholder. The values can be used in conjunction with AVS and Recurring and Installment Requested ACI Indicators.

• K - Personal Identification Number 32-character DUK/PT
• M - Card Present: Unable to read Mag stripe, sending Address Verification Data
• N - Card Not Present: Includes e-Commerce and Full Address Verification Data
• Z - Cardholder Signature - Terminal has a PIN Pad
• @ - Cardholder Signature - No PIN pad available

The identification data of the cardholder.

Indicates whether the authentication value submitted by the merchant can be validated by Visa or the issuer.

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

Contains the code used to further identify the merchant location (ZIP Code).

If the Commercial Card Request Indicator (this field is utilized to request that TSYS Acquiring Solutions systems return a value in the authorization response message identifying whether the card type being presented was a Commercial Card. This field is currently defaulted to 010, and is supported for Visa and MasterCard transactions only) was supplied in the authorization request, the host responds with one of the following response indicators identifying the card being processed.

When a response indicator has been received indicating that the approved card is a Business, Corporate, or Purchasing Card, the POS device should prompt for addendum data elements as needed for settlement.

This is a variable length field containing the customer account or check acceptance ID data in one of three formats. The cardholder account information can be read from one of two magnetic stripes on the card or it can contain data which has been entered manually.

Balance of the EBT card associated with the customer.

Contains identifiers for account types.

Contains identifiers for account types.

Contains any additional amounts related to the authorization request or response.

Contains currency code identifying the currency for the returned additional amount.

Indicates whether the amount is a debit or credit.

Contains identifiers for account types.

Contains identifiers for account types.

Contains any additional amounts related to the authorization request or response.

Contains currency code identifying the currency for the returned additional amount.

Indicates whether the amount is a debit or credit.

Indicates that the transaction contains no addendum data.

Identifier of the payment facilitator.

Commercial Card Requesi Indicator.

Consists of:

• Group III Version Number
• Commercial Card Request Indicator
• Group Separator

Group III Version Number:
Version number whenever an optional addendum Group III is appended to an authorization request message. Required to properly identify the addendum data group being provided.

Commercial Card Request Indicator:
Utilized to request that TSYS Acquiring Solutions systems return a value in the authorization response message identifying whether the card type being represented was commercial card. Supported for Visa and MasterCard transactions only.

Group Separator:
TSYS Acquiring Solutions utilizes a group separator to designate the presence of multiple addendum data groups in authorization request and response messages and defined as Hex ID.

Card Verification Code 2.

Consists of the following fields:
Request message:

• Group III Version Number
• Verification Code
• Group Separator

Response message:

• Group III Version Number
• Verification Code Result Code
• Group Separator

Group III Version Number:
Version number whenever an optional addendum Group III is appended to an authorization request message. Required to properly identify the addendum data group being provided.

Verification Code:
Used in assigning a value that assists in authenticating the physical presence of a Visa, MasterCard, Discover, PayPal or American Express credit card.

Verification Code Result Code:
Contains the host returned CVV2/CVC2/CID result code.

Group Separator:
TSYS Acquiring Solutions utilizes a group separator to designate the presence of multiple addendum data groups in authorization request and response messages and defined as Hex ID.

Chip Condition Code.

Provides information about magnetic stripe read transactions using chip capable cards at chip capable POS devices.
This information must be sent when the Account Data Source Code value is equal to "Z" (for more information refer to the specification of the provider).

• 0 - Service code does not begin with two or six or fill far subsequent positions that are present;
• 1 - Service code begins with two or six; last CCPS read at the chip capable terminal;
• 2 - Service code begins with two or six; last transaction at the chip capable terminal was unsuccessful chip read.

Group III Electronic Benefits Transfer.

Consists of:
Request message format:

• Group III Version Number
• FCS ID
• Field Separator
• Electronic Voucher Serial Number
• Field Separator
• Voucher Approval Code
• Group Separator

Response message format:

• Group III Version Number
• Available Balance
• Group Separator

Group III Version Number:
Message Reason Code. Includes Group III Version Number, Message Reason Code, Group Separator. Group III Version Number. Version number whenever an optional addendum Group III is appended to an authorization request message. Required to properly identify the addendum data group being provided.

FCS ID:
Contains Food and Consumer Identifier, that identifies the merchant as being certified and approved to accept Food Stamps.

Field Separator:
TSYS Acquiring Solutions utilizes a field separator to define the presence of a variable length field. It is defined as a Hex 1C.

Electronic Voucher Serial Number:
Provided by the Electronic Benefits Transfer (EBT) voice authorization system because of as POS System or EBT Network unavailable condition.

Voucher Approval Code:
Voice Authorization Approval Code sent in the request message for EBT/Electronic Voucher transactions returned in the response message is to be stored and submitted in the settlement data capture record.

Group Separator:
TSYS Acquiring Solutions utilizes a group separator to designate the presence of multiple addendum data groups in authorization request and response messages and defined as Hex ID.

Available Balance:
Returned in the response message for EBT/Food Stamps transactions. Optionally returned for EBT/Cash Benefit transactions.

MOTO / e-Commerce Indicator.

Transaction indicator identifying the type of transaction being authorized.

3-D secure e-Commerce Verification Service.

Request/Response Message - Secure e-Commerce Transaction (Visa) or Token Cryptogram (AmEx).
Refer to the specification of the processor for more information.

Field that contains MasterCard universal cardholder authentication value.

Developer information that includes TSYS Acquiring Solutions assigned Developer ID and Version ID, Gateway ID (optional) and must be sent on all formats of transactions.

Additional Amounts.

Can support on the request either no additional amounts or four field separated additional amounts.

• If the transaction does not require additional amount in the request but requires it in the response, the POS device should send only the Group III Version NUmber (022).
• If the transaction requires additional amounts - the POS device should send Group III Version Number (022) plus the field separated additional amounts. The POS device should send the field separators for all four additional amounts even if some of them are not used.

All five subfields for an amount must be present for the amount to be valid.

Product Participation Group.

Contains a group of single character flags. It indicates the merchant's level of participation in partial authorization transactions. Refer to the specification of the processor for more information.

POS Data Group.

The POS Data group is a fixed string of 12 characters S1 to S12 that indicate the condition of the POS device at the time of transaction (for more information refer to the specification of the provider).
The information in the POS Data group takes precedence over the values in the Account Data Source Code (ADSC) and the Cardholder Identification Code (CID) fields. Information in the POS Data group should accurately indicate the condition of the POS device at the time of transaction.

Even though the POS Data group has the precedence over the ADSC and CID fields, they still need to be populated to match the condition of the transaction as closely as possible.

Card Product Code.

Contains card brand token issued by the Token Service Provider. The token is a surrogate value for a PAN that is consistent with ISO8583 message requirements and is a 13- or 19-digit numeric value that passes basic validation rules of an account number, including LUHN check.

Realtime substantination group.

Identifies if the merchant verified the purchased items against an Inventory Information Approval System (IIAS).
Refer to the specification of the processor for more information.

Method used for cardholder verification.

Network ID.

Contains a code that specifies the network to be used for transmission message and determines the program rules that apply to the transaction.

Integrated Chip Card (ICC) EMV TLF Format.

All data must be expressed as hexidecimal characters A-F and 0-9.

Consists of:

• Group III Version Number
• TLV Data
• Field Separator
• Group Separator

Group III Version Number:
Version number whenever an optional addendum Group III is appended to an authorization request message. Required to properly identify the addendum data group being provided.

TLV Data:
Composed solely of hexidecimal characters (0-9, A-F or a-f). Each pair of characters represents one byte of information. The string of characters represents a series of TLV data that represents the information passed between the card and the terminal.

Field Separator:
TSYS Acquiring Solutions utilizes a field separator to define the presence of a variable length field. It is defined as a Hex 1C.

Group Separator:
TSYS Acquiring Solutions utilizes a group separator to designate the presence of multiple addendum data groups in authorization request and response messages and defined as Hex ID.

The following list of EMV tags are mandatory and must be sent on any transaction that contains G3v055. If either or both of these tags are missing, tha transaction will be rejected:

• DF79 - Kernel Version Number - The version number of the kernel used to process the chip data in the transaction.
• DF78 - Device Serial Number - The manufacturer's unique serial number of the device that interacts with the chip card.

Integrated Chip Card (ICC) EMV TLF Format.

All data must be expressed as hexidecimal characters A-F and 0-9.
Consists of:

• Group III Version Number
• TLV Data (Typically includes one or more issuer scripts (tag 71 or 72) and issuer authentication data (tag 91))
• Field Separator
• Group Separator

Group III Version Number:
Version number whenever an optional addendum Group III is appended to an authorization request message. Required to properly identify the addendum data group being provided.

TLV Data:
Composed solely of hexidecimal characters (0-9, A-F or a-f). Each pair of characters represents one byte of information. The string of characters represents a series of TLV data that represents the information passed between the card and the terminal.

Field Separator:
TSYS Acquiring Solutions utilizes a field separator to define the presence of a variable length field. It is defined as a Hex 1C.

Group Separator:
TSYS Acquiring Solutions utilizes a group separator to designate the presence of multiple addendum data groups in authorization request and response messages and defined as Hex ID.

Message Reason Code.

Includes:

• Group III Version Number
• Message Reason Code
• Group Separator

Group III Version Number.
Version number whenever an optional addendum Group III is appended to an authorization request message. Required to properly identify the addendum data group being provided.

Message Reason Code:
Required in all chip 0400 chip card reversal messages and all 0420 reversal messages. It is not used in responses. If no MRC is required then this field and its group III version must be immited. Required in AFD advice messages.

Group Separator:
TSYS Acquiring Solutions utilizes a group separator to designate the presence of multiple addendum data groups in authorization request and response messages and defined as Hex ID.

Spend Qualified Indicator.
Should be sent on all Visa transactions.

Consists of the following fields:
Request message format:

• Group III Version Number
• Group Separator

Response message format:

• Group III Version Number
• Spend Qualified Indicator
• Field Separator
• Group Separator

Group III Version Number:
Version number whenever an optional addendum Group III is appended to an authorization request message. Required to properly identify the addendum data group being provided.

Group Separator:
TSYS Acquiring Solutions utilizes a group separator to designate the presence of multiple addendum data groups in authorization request and response messages and defined as Hex ID.

Spend Qualified Indicator:
Optionally sent by Visa in an authorization response message. The merchant's intercharge rate may be determined by the value of Spend Qualified Indicator. Valid values are shown delow:

• B - Base spend assessment threshold has been met.
• N - Spend qualification threshold has not been met.
• Q - Spend qualification threshold has been met.

Field Separator:
TSYS Acquiring Solutions utilizes a field separator to define the presence of a variable length field. It is defined as a Hex 1C.

Card Brand Tokenization.

NOTE: This group is for Card Brand Tokenization only. To use TSYS tokenization, please, refer to G3v053.

This group may be sent on Visa, MasterCard or Discover token purchase transactions. This is recommended if the merchant uses or pays for card brand tokenization. Can be included if the merchant expects to see any response fields.

Identifier of the MasterCard authorization request result.

Identifier of the lane.

Contains a unique host message identifier assigned by the authorizing system and returned in debit card response messages. Reserved for future use and will most likely contain spaces. This value must be recorded and submitted in the debit confirmation record.

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

Used to identify the industry type of the merchant submitting the authorization request.

• R - Retail
• D - Direct Marketing

Contains value reflecting the local transaction date (in MMDDYY format) returned in the original authorization response record for the AFD sale or the transaction to be canceled or reversed. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction date.

Contains the local transaction time of the original authorization request for the AFD sale or the transaction to be either partially or fully reversed. The local transaction time must be submitted in HHMMSS format. For a debit non-confirm purchase or ATM authorization transactions, this field will contain the local transaction time.

Used to indicate which industry data is being submitted.

When this sub-field is supplied in an incremental transaction, it should use the same value that was requested in the original authorization transaction.

The following sub-fields contain market specific data for hotel and auto rental transactions. The market specific data sub-fields need not be supplied for incremental authorization or authorization reversal transactions.

The format of this field is: “PIDD.”

• P - Prestigious Indicator (This indicator is used by participants in Visa’s Prestigious Lodging Program)
• I - Market Specific Data Identifier (The market specific data identifier is used to indicate which industry data is being submitted)
• DD - Stay or Rental Duration (When the market specific data is supplied in an incremental transaction, this sub-field represents the number of additional days for the hotel stay or auto rental)

• P - Non-participating properties should put a “space”
• I - Bill Payment Transaction
• DD - For Bill Payment this sub-field should be set to “00.”

Identifies the merchant to a direct debit switch.

This field must be supplied for all direct debit request transactions except for the Interlink Debit Cancel (Transaction Code 95). This number is provided by the signing member or processor.

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.

Contains a number assigned by the signing member or processor to identify a merchant industry classification.

This value is similar to the Standard Industry Code (SIC).

Contains a unique number, assigned by the signing merchant’s bank or processor. Used to identify the merchant within the TSYS Acquiring Solutions system.

Identifies the merchant settling agent. Provided by the signing member or processor.

Contains a code that specifies the network to be used for transmission of the message and determines the program rules that apply to the transaction.

Data associated with the transaction.

Identifies the message format with the TSYS Acquiring Solutions system.

• D - Credit Card Authorization request messages (Groups I and III)
• T - Debit/Electronic Benefits Transfer - EBT request messages (Groups I, II, and III)

Contains the Requested Authorization Characteristics Indicator (ACI) used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs. If a merchant chooses not to participate in CPS, the Requested ACI value should default to an “N.”
Y - Device is CPS capable
R - Recurring Payment. No AVS required
N - Device is not CPS capable

Contains code identifying the type of authorization or function being requested.

In conditions where an authorization request has been submitted to the host but no response was ever received, the transaction code should be converted to its corresponding “Repeat” value and resubmitted for authorization.

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

Contains value reflecting the transaction Retrieval Reference Number returned by the authorizing system.

The POS system should record the retrieval reference number received in the original authorization response. The Retrieval Reference Number from the original response is required when submitting AFD Completion Advice messages and when submitting incremental authorizations, or authorization reversal requests that must be settled for direct debit transactions.

Contains the Returned Authorization Characteristics Indicator (ACI).
Provides information concerning the transactions’ CPS qualification status. It is not recommended that the POS system attempt to interpret the meaning of this value. Instead, the POS system should extract whatever value is returned in this field and submit it in the data capture settlement record. The POS system should not interpret any relationship between this field and the presence of data in either the Transaction Identifier or Validation Code fields.

When performing either an Incremental Authorization or Authorization Reversal request, this field must contain the Transaction Identifier returned in the original authorization response record. For all other transaction types, this field should be submitted without data.

Contains identifiers for account types.

Contains identifiers for account types.

Contains any additional amounts related to the authorization request or response.

Contains currency code identifying the currency for the returned additional amount.

Indicates whether the amount is a debit or credit.

Secondary amount associated with the transaction representing a cashback amount.

This is a variable length field from zero to 12-character numeric in length. This field contains a secondary transaction amount related to the transaction type and industry indicated. The transaction amount is to be presented with an implied decimal point. For example, $.01 could be represented as 1, 01, or 001. The allowable number of significant digits, as well as the positioning of any implied decimal point, are dictated by the Currency Code designated. In the United States, the allowable number of significant characters is seven with an implied decimal point.
In industries where cash back is permitted on purchase transactions, this field could contain a cash back amount.
For Authorization Reversal transactions, this field must contain the final settlement amount for a partial reversal, and is not used for a full reversal.

Contains the transaction settlement date returned by the TSYS Acquiring Solutions authorization system and is submitted in MMDD format.

Contains a listing of direct debit and EBT networks that a POS device can access. Provided by the signing member or processor. The values must correspond to one of the Visa assigned direct debit network types. This data is part of the TSYS Acquiring Solutions direct debit data.

Optionally sent by Visa in an autorization response message. The merchant's intercharge rate may be determined by spend qualified indicator. See the specification of the processor for more information.

Contains a number assigned by the signing member, processor, or merchant to identify a specific merchant store within the TSYS Acquiring Solutions’ system.

Must contain System Trace Audit Number returned in the confirmation data field of the debit authorization response record for the transaction to be canceled or reversed. For a debit non-confirm purchase transaction, this number uniquely identifies a cardholder transaction. The trace number remains unchanged for all messages throughout the life cycle of the transaction.

Contains a number assigned by the signing member, processor, or merchant to identify a unique terminal within a merchant location.

Because the terminal number submitted in the authorization request is echoed back to the terminal in the authorization response, this field can additionally be used in controller-based environments to assist in the matching and routing of authorization request and response messages at the point of concentration.

Contains identifiers for account types.

Contains identifiers for account types.

Contains any additional amounts related to the authorization request or response.

Contains currency code identifying the currency for the returned additional amount.

Indicates whether the amount is a debit or credit.

Contains a code used to calculate the local time within the TSYS Acquiring Solutions authorization system.

The differential is calculated by the signing member or processor, providing the standard local time zone differential from Greenwich Mean Time (GMT). The first character numeric specifies the direction of the differential and offset increment as well as whether daylight savings is observed, and the last two-character numeric specify the magnitude of the differential.
For now, such values is used - 705, 706, 707, 708

Contains the transaction amount to be authorized. The transaction amount is to be presented with implied decimal point.

For all Authorization Reversal transactions, this field contains the Total Authorization Amount (the total of all previous authorizations performed for a particular transaction or associated with a single Transaction ID).

Contains a code identifying the type of authorization or function being requested.

In conditions where an authorization request has been submitted to the host but no response was ever received, the transaction code should be converted to its corresponding “Repeat” value and resubmitted for authorization.

• 54 - Standard Authorization Request
• 56 - Used primarily in Direct Marketing, Mail, and Telephone Order Environments
• 59 - Used to reverse a completed credit authorization prior to batch settlement
• 93 - Standard Debit Authorization Request
• 94 - Direct Debit: Purchase Return
• 5A - Same as code '59', except the reversal is being submitted after batch settlement occurred
• 5B - Bill Payment Transaction (Credit Card)
• 9C - Debit transactions without a PIN
• A3 - Automatic Reversal: Direct Debit Purchase
• A4 - Automatic Reversal: Direct Debit Purchase Return

Contains a transaction identifier (Visa, American Express or Discover) or Reference Number (MasterCard). The POS device does not attempt to interpret the meaning of any data appearing in this field. Data returned in this field is recorded and submitted as part of the data capture settlement format.

Contains a terminal-generated transaction sequence number to be submitted in all authorization request messages.

This number is echoed back to the terminal for purposes of assisting in the matching of authorization request and response messages.
This value must be in the range of 0001 - 9999 and is incremented on each authorization request message. This number is automatically incremented from 9999 to 0001.

Discover Usage:
Used to indicate the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions.

Non-Discover Usage:
Can contain specific information generated by the card issuer. The POS device should not attempt to interpret the meaning of any data appearing in this field. Data returned in this field is recorded and submitted as part of the data capture settlement format.

Contains the host returned CVV2/CVC2/CID result code.