TSYS Capture Retail Transaction UML

TSYS specific low-level representation of Retail Transaction produced by Forward Transformation Process within Settlement Process.

During Generation Process, TSYS specific interchange message is generated from this object for settlement. Consequently, all fields of the object are mapped into message segments/elements.

Contains a code specifying the method used to obtain the cardholder account number.

Contains the authorization code obtained from either authorization network or voice authorization center.

If the transaction is a credit or refund or other nonapproved transaction type, this field must be defaulted to spaces.
For Discover approved transactions on prepaid cards, the approval code will contain the available balance on the prepaid card.

Contains authorization source code used to provide information on the source or origin of the authorization code being settled.

If the transaction being settled was network authorized, this field must contain the value returned in the authorization response.
For the next value is used:

9 - Not Authorized (Includes Credits/Refunds).

Contains the transaction amount contained in the original authorization request message. Is not impacted by reversals.

If multiple authorizations and/or an authorization reversal were supplied, it must contain the authorized amount from the first authorization response. If the transaction was voice-center or device approved, this field must be defaulted to zeros.

Contains address verification result code.

If address verification service is being utilized, it should contain the value returned in the original authorization response message. If the transaction is a credit or was otherwise processed offline, it should be defaulted to zero.

Bank account or credit card number of the cardholder.

Contains a code specifying the method used to authenticate the identity of the cardholder for the transaction being settled.

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

Authorization message constituent fields.

Refer to the specification of the processor for more information.

Direct Debit group. Consists of the following fields:

1. Retrieval Reference Number - the 12-character numeric field contains the retrieval reference number returned in the original debit authorization response message and is utilized for transaction tracking purposes.

2. System Trace Audit Number - the 6-character numeric field contains the system trace audit number returned in the original debit authorization response message. Utilized for transaction tracking purposes.

3. Network Identification Code - contains the one-character network identification code returned in the original debit authorization response message. Identifies the network though which the transaction was authorized. Utilized for transaction tracking purposes.

4. Settlement Date (MMDD) - the 4-character numeric field contains the settlement date returned in the original debit authorization response message. The settlement date must be provided in MMDD format and is utilized for transaction tracking purposes.

Code that indicates chip condition of the card.

Direct Marketing group: installment or recurring payments. Consists of the following fields:

1. Multiple Clearing Sequence Number - used to indicate which payment number this particular payment represents in the total count of installment payments to be made. If the transaction is not an installment payment, the sequence number must be set to zero.

2. Multiple Clearing Sequence Count - direct marketing merchants should utilize this field when processing installment payments. In this case, this number identifies the total number of installment payments to be made in the series. If the transaction is not an installment payment, the count must be set to zero.

3. MOTO/e-Commerce Indicator - contains one-character transaction indicator identifying the type of transaction being settled.

Field that is used in secure e-commerce transactions such as Visa 3-D Secure, Amex SafeKey, or Discover ProtectBuy. For these Cardholder Authentication Verification Value (CAVV) transactions, this field contains the Transaction ID (XID) and the CAVV values. For Amex tokenization, the group contains Token Data Block B and Token Data Block A. Block A is required and Block B is included only if the token cryptogram is longer than 20 bytes.

Debit or EBT (Electronic Benefits Transfer) additional fields in authorization message.

Refer to the specification of the processor for more information.

American Express Corporate Purchasing Card group. Consists of the following fields:

1. Supplier Reference Number - contains a reference number that is used by AmEx to obtain supporting information on a charge from a merchant. The number can be any combination of characters and numerals defined by the merchant or authorized processor. However, it must be an index to the merchant’s record, so that charge information can be readily retrieved and promptly submitted within 10 calendar days (or within the period stipulated in the contractual agreement).

2. Cardholder Reference Number - defined by the card member and entered by the merchant at the point-of-sale. Must be character space-filled if not used. This information will be displayed within the statement/reporting process and may include accounting information specific to the client.
Required, if the merchant’s customer provides card member reference data. Therefore, at the time of certification, the merchant must demonstrate the ability to populate and transmit appropriate information in this field.

3. Shipped To ZIP Code - contains the ZIP code to which the commodity was shipped. If the “Ship-to ZIP” code is not available, provide the ZIP code of the merchant where the purchase took place.

4. Sales Tax - the entry in the authorization amount field must include this tax amount. For US dollars (USD), two decimal places are implied.

5. Charge Descriptor 1 - contains 40 characters of free text. Required field in which spaces are allowed.

U.S. Only Non-T&E Commercial Card Level II (Visa and MasterCard) group. Consists of the following fields:

1. Optional Amount Identifier - contains one-character identifying the characteristics of the amount appearing below. Contains such values:

• 0 - Not Used
• 1 - Local Sales Tax Amount

2. Optional Amount - 12-character numeric field contains the amount. If the value in field optional amount identifier is set to “0,” it should be defaulted to zeros.
Any non-zero sales tax must have a minimum value of 0.1% and a maximum value of 22% of the sale amount. For Discover transactions with an amount exceeding 999999 will be rejected.

3. Purchase Order No. / Customer Ref. ID - contains a 16, 17 or 25-character purchase order number supplied by the Visa or MasterCard purchasing card cardholder. If the field is not used, it should be defaulted to spaces. Optional for Visa or MasterCard purchasing card.

Map Extension group.

The record type is a 5-character field utilized to define the characteristics of a settlement record being submitted for processing on the TSYS acquiring solutions system. The first byte of the record type field designates the general classification of the settlement record. See the list below for record types information:

H - Header Record
P - Parameter Record
D - Detail Record
A - American Express Line Item Detail Record
T - Trailer Record
R - Trailer Response Record
L - Commercial Card Line Item Detail Record
F - Fleet Line Item Detail Record
E - Encrypted Transmission Block Record

1. Group map (optional data group designation):

The remaining four bytes of the record type are used to denote the presence of one or many optional (addendum) data groupings appended to required “base” group of fields.

An optional data group is composed of a set of logically associated fields, utilized primarily for fulfillment of a specific industry or program requirement. The TSYS Acquiring Solutions system performs a bit level examination of the remaining four bytes of the record type to determine the presence of data groupings. Bit settings denote either the presence or absence of the specified data group. Moving right to left, the sequence position number of each bit corresponds directly to the number of the desired optional group.

Refer to the specification of the processor for more information.

Product Participation group.

The product participation group contains a group of single character flags (see processor specification for more information). Indicates the merchant's level of participation in partial authorization transactions.

POS Data Group.

The POS Data group is a fixed string of 12 characters S1 to S12 that indicates the condition of the POS device at the time of transaction (see processor specification for more information).
The information in the POS Data group takes precedence over the values in the Account Data Source (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 precedence over the ADSC and CID fields, the ADSC and CID fields still need to be populated to match the condition of the transaction as closely as possible.

Direct Marketing group. Consists of the following fields:

1. Total Authorized Amount - the 12-character numeric field contains the total authorized amount of the transaction.
For transaction authorized online, this field contains the sum of the original authorization amount and all subsequent incremental authorization amounts, less any authorization reversal amount. If incremental authorization and authorization reversal transaction are not supported, this field will be identical to the settlement amount. For transactions processed offline, this field must be defaulted to zeros.
If incremental authorizations or authorization reversals are supported and have successfully been performed on the transaction being settled, this field should equal the settlement amount.

2. Purchase Identifier Format Code - contains a one-character code identifying if and what type of purchase identifier is associated with the transaction.
Contains such value:
1 - Direct Marketing - Order Number

3. Purchase Identifier - contains 25-character purchase order number identifier assigned by the merchant. If utilized, the field should contain a value other than zeros or spaces.

Market Specific Data Indicator group. Consists of the field Market Specific Data Indicator.
Contains one-character industry identifier. Will be defaulted to <SPACE> for any other industry types.

Used value:
B - Bill Payment

Data that contains information about currency conversion.

Card-Level Results.

Contains a two-character code created by Visa during the authorization process.
Conditional field in the response record. It will only be returned if the values are non zero.

Refer to the specification of the processor for more information.

Promotion Code.

The Discover network may establish promotional relationships with merchants. Indicates the promotion to be used by the merchant for rewarding the cardholder at the point of service. The value sent in the authorization request will be echoed back in the authorization response.

Identifier of the transaction type.

Visa Miscellaneous Fields group. Consists of the following fields:

1. Version Number - 3-character numeric field contains the version number for specific groups.

2. Card-level Results - contains a two-character code created by Visa during the authorization process.
If the transaction being settled was authorized online, this field must contain the value returned in the authorization response. If the transaction is a credit or was otherwise processed offline, this field should be defaulted to two spaces.

AmEx CAPN Corporate Purchasing Solution Extension group. Consists of the following fields:

1. Requester Name - contains the name of the requester, if the card member is not the person that ordered or purchased the product or service.

2. Total Tax Amount - numeric field, contains the total tax amount assessed at the point-of-sale, for all line items. This entry is the total of all taxes applicable to this transaction and it should not be used to report individual line item details for taxes.

3. Tax Type Code - for tax amounts that can be categorized as one tax type, this field contains the tax type code that corresponds to the entry in the preceding total tax amount field.
Valid entries include the following:
056 = Sales Tax

For now this field is set to null.

Indicator of the Visa ISA charge transaction.

Detail Extension group. Consists of the following fields:

1. Group Length - contains the total length of the group.

2. Group Fields - contains the data for the detail extension optional data group:
- TAG - space-filled alphanumeric identifier that indicates what the field name is;
- SIZE - numeric identifier that indicates how many positions the VALUE will occupy;
- VALUE - the actual value being passed in the tag/size/value group.

Used values:
OAI - Optional Amount Identifier
OA - Optional Amount
PON - Purchase Order Number

Hotel group. Consists of the following fields:

1. Total Authorization Amount - contains the total authorization amount of the transaction being settled. Refer to the specification of the processor for more information.

2. Purchase Identifier Format Code - contains one-character code identifying if and what type of purchase identifier is associated with the transaction being settled.

3. Purchase Identifier - contains 25-characted identifier assigned by the merchant. If this field is utilized, it should contain a value of other than zeros or spaces. Refer to the specification of the processor for more information.

4. Market Specific Data - contains one-character industry identifier.

5. No Show Indicator - contains one-character identifier used to indicate whether the cardholder is being billed for a hotel room or rental vehicle that was reserved but not actually rented. For use with non AmEx cards only.

• 0 - Non Applicable
• 1 - No Show

6. Extra Charges - contains 6-character numeric value used to identify any additional ancillary charges that are booked to the cardholder's card after the transaction was completed. Refer to the specification of the processor for more information.

7. Rental Date (YYMMDD) - contains 6-character numeric date reflecting when the cardholder checked into hotel. Refer to the specification of the processor for more information.

Card Verification Value (CVV2/CVC2).

The 6-character field is used in assigning a value that assists in authenticating the physical presence of a Visa, MasterCard, Discover, or American Express credit card (see processor specification for more information).

Card verification is not contained in the magnetic stripe information nor does it appear on sales receipts; it is an additional three to four-character value, printed on the front or back of Visa, MasterCard, Discover, and American Express cards. Used to support the following card verification programs.

• Visa - Card Verification Value 2 (CVV2)
• MasterCard - Card Validation Code 2 (CVC2)
• American Express - Cardholder Identification Code (CID)
• Discover - Cardholder Identification Code (CID)

If verification code is sent as part of an encrypted transaction (record format = 'W'), positions 1 and 2 still need to be present even though the verification code is sent in a different field.

Contains the clearing cryptogram used to validate transaction processing in the event of a dispute. The crytogram is returned by the ICC to the terminal in response of the GENERATE AC command.

Carried in VSDC transactions, provides a series of indicators that reflect the specific functions supported by the chip card account. For example, it indicates whether cardholder verification is supported.

Contains the count of the transactions performed within the application.

Increments by 1 each time a transaction is initiated.
Multiple authorization requests for the same transaction will have the same ATC. For example, when online PIN fails and the next authorization represents a different PIN tried for the same transaction, the ATC will be the same.
For reversals and advices, the ATC is the value from the original message. Incrementing the ATC is managed by the ICC.

Contains the number assigned to a specific card when two or more cards are associated with a single account number.

Сontains the transaction amount used by the chip when calculating the last cryptogram.

Indicates the type of cryptogram and the actions to be performed by the terminal.

Indicates the results of the last Cardholder Verification Method (CVM) performed.

Contains indicators related to the attributes of the cardholder's device and the technology used for the communication between the cardholder's and the acquiring device.

Contains issuer application data depending upon the type of chip card and card brand. This is proprietary application data for transmission to the issuer in an online transaction.

Data sent by the issuer to the chip card for the chip card to validate the authenticity of the issuer (during online issuer authentication).

Identifies the update command that the issuer sends in the authorization response to the card during online processing. With the command, the card updates its parameters and records the success or failure of the update in the Issuer Script Results field.

Indicates the card input data, the Cardholder Verification Method (CVM), and the security capabilities that are supported by the terminal.

Contains the currency code of the transaction.

Contains the local date at the terminal on which the transaction was authorized. Must be in YYMMDD format.

Series of indicators from the terminal perspective.

The terminal records results of offline and online processing by setting a series of indicators in this field. These indicators are available to members in the online message and clearing transaction.

Indicates the type of financial transaction used by the card to calculate the cryptogram.

Contains the number used in the generation of the cryptogram for chip (VSDC) transactions. It provides variability and uniqueness to the cryptogram.

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

Contains a local transaction date associated with the transaction being settled. The date supplied must be in MMDD format and reflect the following industry information. For credits, the date should be the same date as the capture transaction.

1. For retail or general category merchants, this field must contain the authorization transaction date.
2. For direct marketing category merchants, this field must contain the shipping date.
3. For hotel category merchants, this field must contain the checkout date.
4. For auto-rental category merchants, this field must contain the rental return date.

Contains a local transaction time associated with the authorization code being settled.

If the transaction was authorized online, it must contain the value returned in the original authorization response message. If the transaction was processed offline, it must contain a POS device generated time.

Appears in HHMMSS format.

Number of nights that are paid within the transaction.

Room rate that is paid within the transaction.

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.

Utilized to define the characteristics of a settlement record being submitted for processing on the TSYS Acquiring Solutions system. The first byte of the record type field designates the general classification of the settlement record.

Used to denote the presence of one or many optional (addendum) data groupings appended to required “base” group of fields.

Optional Data group is composed of a set of logically associated fields, utilized primarily for fulfillment of a specific industry or program requirement. The TSYS acquiring solutions system performs a bit level examination of the remaining four bytes of the record type to determine the presence of data groupings. Bit settings denote either the presence or absence of the specified data group. Moving right to left, the sequence position number of each bit.
Corresponds directly to the number of the desired optional group.

Contains requested Authorization Characteristics Indicator (ACI). The indicator provides additional information as to the capabilities of the POS device.
If the transaction being settled was authorized online, it must contain the value used in that authorization request.
If the transaction is a credit or was otherwise processed offline, it should be defaulted to a “Y” with the exception of checks which default to an “N”.

Contains response code associated with the authorization code being settled.
If the transaction being settled was authorized online, this field must contain the value returned in that authorization response. If the transaction is a credit/refund or offline/voice approval, this field must be defaulted to spaces.

Contains returned Authorization Characteristics Indicator (ACI). This indicator provides information on conditions or characteristics of the authorization code.

If the transaction being settled was authorized online, it must contain the value returned in that authorization response. If the transaction is a credit or was otherwise processed offline, it should be defaulted to a <SPACE>.

If the data requirements are met, but 3-D secure validation fails, VIP returns an ACI value of P. The clearing transaction can request the existing CPS/Hotel and Car Rental Card Not Present rate.

Contains the final settlement amount of the transaction.
The field entry must be right-justified and zero-filled and is represented in absolute value. Must always be greater than zero.

Contains transaction code used to identify the transaction type being settled.

Contains a transaction identifier associated with the transaction being settled.

If the transaction was authorized online, it must contain the value (if returned) from the original authorization response message. If the transaction identifier received in the original authorization response message is less than 15-character numeric, - it must be left-justified and space-filled to 15 bytes. If a value was not returned in the authorization response or the transaction was processed offline, this field must be defaulted to zeros.

Contains transaction sequence number generated by the POS device for tracking purposes. It must contain the value populated during the original authorization request.

Contains at least one non-zero value populated during authorization.

Contains a two-character numeric code providing additional data on the characteristics of the transaction being settled.

The first position is utilized to indicate whether a partial authorization reversal is associated with the transaction being settled.
The second position indicates whether a host acknowledgment (ACK) was received to a POS device generated debit confirmation message. If authorization reversal or direct debit transaction are not being supported, this field must be defaulted to “00.”

Position 1:
REVERSAL TRANSMITTED
0 - No Authorization Reversal Transmitted
1 - An Authorization Reversal Was Transmitted

Position 2:
PROTOCOL COMPLETION STATUS
0 - Host Acknowledgment <ACK> Received
1 - Host Acknowledgment NOT Received

Reference to the entity taht represents TSYS retail items information.

Contains transaction identifier associated with the transaction being settled.

If the transaction was authorized online, it must contain the value (if returned) from the original authorization response message. If the value was not returned in the authorization response or the transaction was processed offline, it must be defaulted to spaces.