Heartland Portico Auth Retail Transaction UML

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

Type of Alias action requested
Valid values are as follows: DELETE, ADD, CREATE.

Alternate identifier used to reference a stored value account.

Indicates whether partial authorization is supported. Default is 'N'.

Valid values = 'Y' or 'N'.

Contains total amount of additional amounts.

If supplied from the Issuer on a partial authorization, the authorized amount (lass than the original or requested amount).

If authorized, authorization code returned by the Issuer.

Maximum characters = 8

If supplied from the Issuer, the available balance on the associated card.

Required Address verification result code.

Maximum length = 1

Description of AVS result code.

If authorized, the new balance on the gift card.

Balance Inquiry Type:

CASH = Cash Benefits
FOODSTAMP = Food Stamp

Cardholder address that can be used for address verification.

Cardholder city.

Maximum length = 20.

Cardholder email address.
Maximum length = 40.

Cardholder first name.

Maximum length = 26.

Cardholder last name.

Maximum length = 26.

Cardholder phone number.

Maximum length = 10.

Purchase order number assigned by the cardholder.

Maximum length = 17.

Cardholder state.

Maximum length = 20.

Cardholder zip code that can be used for address verification.

Maximum length = 9.

The number of the credit card or bank account.

Indicates whether a card reader was present when card data was manually entered.

Valid values = Y or N.

Card brand name.

Cash back amount information, the portion of the settlement amount that represents cash back given to the cardholder.

Reference to the entity that represents transaction of type Sale.

If the commercial card was specified in the request, the commercial card response indicator returned by the Issuer.

Commercial card request.

Valid values = Y or N.

Identifies the currency of the transaction amount.

Result code if CW was requested.

Maximum length = 1

Description of CVV result code.

Card verification code on the card.

Maximum length = 6.

Indicates why the CVV2 value was not provided. Valid values include: ILLEGIBLE and NOTPRESENT.

Note:This field is NOT used for EBT transactions.

Developer Identifier, field length is exactly 6 characters.

NOTE: Even though this field is optional in the schema, it is now required for all new certifications.

Device identifier, assigned by Heartland Payment Systems during registration.

Invoice number for direct marketing.

Maximum length = 25.

Ship day for direct marketing.

Ship month for direct marketing.

Identifies this transaction as eCommerce or mail order/telephone order.

Valid values = ECOM or MOTO

Serial Number provides by EBT voice authorization System.

The EMV request.

The response received from EMV.

The card expiration date. The format is MM.

The card expiration date. The format is YY.

Voucher Expiration date.

The format is MMYY.

First Amount object.

The first amount must have an AmtType of "4S."

The first amount type is '4S'.

Fourth Amount object.

Type of forth amount object: date and time.

Response code returned by the POS Gateway.

Response message returned by the POS Gateway.

Transaction identifier assigned by POS Gateway.

If present, revises (replaces) the gratuity amount information of the original auth. If not present, does not affect the gratuity amount information, if any, of the original auth. This element is for informational purposes only and does not affect the authorized amount.

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

Invoice number for direct marketing.

Maximum length = 25

License identifier, assigned by Heartland Payment Systems Administrator during registration.

Indicates the type of advanced lodging deposit.

Valid values: ASSURED_RESERVATION, CARD_ DEPOSIT, PURCHASE, OTHER.

Indicates the check in date.

Indicates the check out date.

Indicates the duration of stay.

Indicates whether the extra charge is included in the bill.

Indicates whether the extra charge is included in the bill.

Indicates whether the extra charge is included in the bill.

Indicates whether the extra charge is included in the bill.

Indicates whether the extra charge is included in the bill.

Indicates whether the extra charge is included in the bill.

Used to identify lodging transaction by the lodging system/software.

Indicates whether the extra charge is included in the bill.

Indicates the daily room rate amount.

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.

New credit card number.

New track data read from the card by the card reader.

Contains rewards messages to be displayed on a receipt, mobile app, or web page to inform an account holder about special rewards or promotions available on the account.

Authorization code obtained from the Issuer outside of the POS Gateway.

Maximum characters = 8

Indicates whether this is a one time payment (Y) or a recurring payment.

Valid values = Y or N.

Password for user.

PIN Block.

If authorized, the new balance on the stored value account in points.

Customer Primary Account Number.

Indicates whether a card reader was present when card data was manually entered.

Valid values = Y or N.

Indicates if a Merchant used an Inventory Approval System to verify items purchased qualify for healthcare auto-substantiation. Default is 'N'.

Valid values = Y or N.

Reference number returned by the Issuer.

Maximum characters = 12

If authorized, the new balance that was on the card before it was deactivated and should be refunded to the cardholder.

Contains an identifier to aid in determining the type of client's request.

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

Identifies rewards (dollars or points) added to the account as a result of a transaction.

Authorization response code returned by the Issuer.

The transaction response date and time in the merchant's time zone that is stored on the POS Gateway. This is expected to be used for printing date and time on receipts.

Authorization response text returned by the Issuer.

Second Amount object.

Type of second ammount.

Site identifier, assigned by Heartland Payment Systems during registration.

Site trace, specified by client and echoed in the response for validation.

If insufficient funds on gift card to complete sale, the portion of the total sale that was not funded by the gift card and thus is still due from the cardholder.

If insufficient funds on gift card to complete sale, the split tender portion of the total sale that was subtracted from the gift card balance.

Tax amount.

Tax type indicator that qualifies the CPC tax amount.

Third Amount object.

Type of third amount.

Track data read from the card by the card reader.

Used to indicate how the associated track data was obtained. The valid values for Method are Swipe or Proximity.

Example of the XML follows:

<TrackData method="swipe">
...full data from MSR here...
</TrackData>

User name, assigned by Heartland Payment Systems Administrator during registration.

POS Version Number.

NOTE: Even though this field is optional in the schema, it is now required for all new certifications.

Provided by EBT Voice Authorization System.