eSocket.POS Developer Guide

TerminalId

M

A

TransactionId

M

A

Type

M

A

MessageType

O

C

ForceOnline

O

-

Reversal

C

T

Must be set to true for a reversal. The default (if this property is not set) is false .

Reversal Type

O

C

Defaults to ADVICE (offline).

DateTime

O

A

LocalDate

O

A

LocalTime

O

A

ExtendedTransactionType

C

H

AmountTransactionFee

O

H

CardVerificationResult

O

H

BusinessDate

O

H

RetrievalRefNr

O

C

This property can be used to identify the sequence of transactions to which this transaction is chained. This is useful in the case where the sequence identifier is common between the transactions or has a format which is not compatible with Transaction Id 's n6 format.

ReceivingInstIdCode

O

C

PosOperatorId

O

-

CardNumber

CG

G

If eSocket.POS does not read the card, either the Track2 or the CardNumber and ExpiryDate properties must be set. If eSocket.POS is configured to mask sensitive data, it will send the first 6 digits and the last 4 digits of this field in the clear and will mask the middle remainder of the field. For a message type of "CONFIRM": if the PAN component is configured to encrypt the PAN, this field will not be set if eSocket.POS is restarted. For advice responses to the POS if eSocket.POS is configured with point-to-point encryption, this field will not be set in the response.

ExpiryDate

CG

A

If eSocket.POS does not read the card, either the Track2 or the CardNumber and ExpiryDate properties must be set. For advice responses to the POS if eSocket.POS is configured with point-to-point encryption, this field will not be set in the response.

ExtendedAuthorizationNumber

C

C

Should be sent in a referral when an authorization number is provided, for instance, after calling an authorization center. Will be present in a response if set by the authorizer of the transaction and the value is longer than the standard field (AuthorizationNumber) and up to 8 characters in length.

LongAuthorizationNumber

C

C

Should be sent in a referral when an authorization number is provided, for instance after calling an authorization center. Will be present in a response if set by the authorizer of the transaction and the value is longer than the standard field (AuthorizationNumber) and ExtendedAuthorizationNumber, and up to 50 characters in length.

StartDate

O

G

Will be returned if the EffectiveDate component has been configured in the response pipeline in eSocket.POS and the card configuration indicates that either effective (start) date validation is required or that an effective date is available. Note that returning the effective date is a UK requirement.

CardSequenceNumber

O

T

Cvv2

O

-

Track1

O

TCG

If the card is configured to mask sensitive data, this field will not be set in the response. If the Message Type is "CONFIRM" and eSocket.POS has been restarted, this field will not be set in the response, even if it is configured not to mask this field.

Track2

CG

TCG

If eSocket.POS does not read the card, either the Track2 or the CardNumber and ExpiryDate properties must be set. If eSocket.POS is configured to mask sensitive data, it will send the first 6 digits and the last 4 digits of the PAN in Track2 in the clear and will mask the middle remainder of the PAN as well as the service restriction code and discretionary data in the response. If the Message Type is "CONFIRM" and eSocket.POS has been restarted, this field will not be set in the response, even if it is configured not to mask this field.

Track3

O

CG

In general not returned, unless eSocket.POS declines the transaction. If eSocket.POS is configured to mask sensitive data, this field will not be set in the response.

PanEntryMode

O

A

If not set, this value will be set based on the presence or absence of Track2 .

PosCondition

O

A

If not set, the default value of '00' - Normal Presentment will be assumed.

TransactionAmount

G

A

Required unless eSocket.POS inserts the amount. On a transaction with an accepted DCC offer, this will be in the source/local currency.

CashbackAmount

CG

T

Required for a transaction involving cashback, unless the Cashback component has been configured to insert the cashback amount.

GratuityAmount

OG

H

Required for a transaction involving gratuity, unless the Gratuity component has been configured.

CurrencyCode

O

A

Mandatory for some configurations where the PAN component is placed before the Amount component; the CurrencyCode might be required to allow a fallback transaction. On a transaction with an accepted DCC offer, this will be the source/local currency code.

ExtendedPaymentPeriod

CG

T

Required for a transaction involving an extended payment period, unless the Extended Payment component will insert the extended payment period.

Account

G

A

Required if eSocket.POS is not configured with an Account component. Optional otherwise.

PinData

O

-

Required if PIN entry and encryption is performed by the POS.

PinKeySequenceNr

C

-

Required if PinData is present.

FinalAmount

O

T

CardholderInformation

-

H

PrivateData

O

G

ResponseCode

O

A

ActionCode

-

A

MessageReasonCode

O

A

AuthorizationNumber

C

C

Should be sent in a referral when an authorization number is provided, for instance after calling an authorization center. Will be present in a response if set by the authorizer of the transaction.

AuthorizingAgent

-

C

Will be present if the authorizer of the transaction was not the card issuer.

AuthorizationProfile

-

T

AuthorizationToken

C

C

Should be sent when a token-based authentication is used by the upstream entity.

CardholderAddress

O

T

Will be ignored unless PostalCode property is also set.

PostalCode

O

T

AddressVerificationResult

-

H

CtlsPinBypass

O

C

Should be sent when the PIN was bypassed for the contactless transaction.

ServiceRestrictionCode

-

CG

Will be returned if Track 2 Data is available. will not be set in the response if eSocket.POS is configured to mask sensitive data.

CardProductName

-

G

Will be returned if this card product is configured in eSocket.POS.

CardholderName

-

G

Will be returned if set up by a response pipeline component in eSocket.POS.

MerchantId

-

G

Will be returned if set up by a response pipeline component in eSocket.POS.

ReferralTelephone

-

C

Will be provided in a referral authorization response if a referral telephone number is available for this card.

SignatureData

O

G

May be provided in the response if set up by a pipeline component.

SignatureFormat

O

G

May be provided in the response if set up by a pipeline component.

SignatureRequired

-

G

May be provided in the response if set up by a pipeline component.

RPS

-

G

Will be present if the RPS component is configured and transaction is Rapid Payment Service.

FallbackType

-

G

Will be present if the FallbackIndicator component is configured. Or if it was received in the request.

FallbackReason

-

G

Will be present if provided by the FallbackIndicator component. Or if it was received in the xml request.

EmvAmount

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag. EMV Tag ID: 9F02 NOTE: In the request, EmvAmount and EmvAmountAuthorized are the same.

EmvAmountOther

O

C

Will be provided in the response if available when an EMV card was used, and a cashback amount was requested. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F03

EmvAmountAuthorized

O

C

Will be provided in the response if available when an EMV card was used, and a cashback amount was requested. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F02. NOTE: In the response, if this field does not exist, it will be set to EmvAmount.

EmvApplicationIdentifier

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 4F

EmvApplicationInterchangeProfile

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 82

EmvApplicationLabel

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 50

EmvApplicationPreferredName

O

C

EmvApplicationPreferredNameRaw

-

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F12

EmvApplicationPreferredNameInternational

-

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag. This field will only be provided if the Java Virtual Machine (JVM) in which eSocket.POS is running supports conversion from ISO/IEC 8859 using the code page specified by the EmvIssuerCodeTableIndexEmvIssuerCodeTableIndex. EMV Tag ID: 9F12

EmvApplicationTransactionCounter

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F36

EmvApplicationUsageControl

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F07

EmvApplicationVersionNumber

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F08

EmvAuthorizationResponseCode

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 8A

EMVCardSequenceNumber

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 5F34

EmvCryptogram

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F26

EmvCryptogramInformationData

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F27

EmvCvmList

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 8E

EmvCvmResults

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F34

EmvInterfaceDeviceSerialNumber

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F1E

EmvIssuerActionCodeDefault

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F0D

EmvIssuerActionCodeDenial

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F0E

EmvIssuerActionCodeOnline

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F0F

EmvIssuerApplicationData

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F10

EmvIssuerCodeTableIndex

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F11

EmvIssuerScriptResults

O

C

Will be provided in the response if available when an EMV card was used.

EmvTerminalActionCodeDefault

-

C

Will be provided in the response if available when an EMV card was used.

EmvTerminalActionCodeDenial

-

C

Will be provided in the response if available when an EMV card was used.

EmvTerminalActionCodeOnline

-

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag

EmvTerminalApplicationVersionNumber

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F09

EmvTerminalCapabilities

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F33

EmvTerminalCountryCode

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F1A

EmvTerminalTransactionQualifiers

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F66

EmvTerminalType

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F35

EmvTerminalVerificationResult

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 95

EmvTransactionCategoryCode

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F53

EmvTransactionCurrencyCode

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 5F2A

EmvTransactionDate

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9A

EmvTransactionSequenceCounter

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F41

EmvTransactionStatusInformation

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9B

EmvTransactionType

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9C

EmvUnpredictableNumber

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F37

EmvFormFactorIndicator

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F6E

EmvCustomerExclusiveData

O

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F7C

EmvAdditionalTerminalCapabilities

-

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F40

EmvTransactionTime

-

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 9F21

EmvApplicationPriorityIndicator

-

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 87

EmvIssuerCountryCode

-

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 5F28

EmvApplicationExpiryDate

-

C

Will be provided in the response if available when an EMV card was used. Or if it was received in the Esp:Transaction request or as part of the TlvIccDataExtended structured data tag EMV Tag ID: 5F24

EmvIssuerAuthenticationData

-

C

Will be provided in the response if it was returned by the upstream entity after online issuer authentication. EMV Tag ID: 91

EmvIssuerScriptTemplate1

-

C

Will be provided in the response if it was returned by the upstream entity after online issuer authentication. EMV Tag ID: 71

EmvIssuerScriptTemplate2

-

C

Will be provided in the response if it was returned by the upstream entity after online issuer authentication. EMV Tag ID: 72

StructuredData

O

HG

- Name

M

A

- Value

M

A

- Flags

O

G

- - DoNotPersist

O

G

PosStructuredData

O

HG

- Name

M

A

- Value

M

A

PurchasingCardData

O

G

Can be set to send level 2 and 3 details for a transaction involving a purchasing card. Within this element, all attributes are optional.

NOTE: At this time only the PurchasingCardData.InvoiceNumber field is returned in the response.

Balance

-

H

- AccountType

-

H

- AmountType

-

H

- CurrencyCode

-

H

- Sign

-

H

- Amount

-

H

- SequenceNumber

-

H

- DateTime

O

H

- TerminalId

-

H

- TransactionType

-

H

- To Account type

-

H

- Account Id 1

-

H

- Account Id 2

-

H

- AuthorizationId

-

H

- Surcharge

-

H

- PreviousBalance

O

C

PassThruPanReference

O

-

Aimed at P2PE scenarios where the device/PED implements a P2PE scheme supported by ACI, yet eSocket.POS does not drive the device/PED (e.g. fuel forecourts).

- Scheme

M

-

This subfield is only mandatory if the PanReference field is present.

- Ksn

O

-

- Data

O

-

- SensitiveDataBlock

O

-

- WhitelistFileName

O

-

- MaxReliableBinLength

O

-

- TlvMapping

O

-

ChainedTransactionId

O

C

Will be provided in the response if the chained transaction information could be retrieved.

Rank

M

-

Indicates which set of logical devices will be used.

SignatureStandAloneDynamicText

O

C

Standalone dynamic text that will be displayed on the screens that host the check box prompts.

SignatureImagePassedInResponse

O

C

Indicates whether or not the image should be included in the transaction response.

SignatureImageFormat

O

C

The format of the image to be returned in the response, if requested in the SignatureImagePassedInResponse field.

SignatureScrollableText

O

C

This field will be used to populate the scrollable text area on the free text screens.

SignatureImageSequence

O

C

The sequence number to associate with the image. If more than one image is associated with a single transaction, this value will differentiate between them. Only to be set for a signature capture transaction.

SignatureOriginalFormat

O

C

The format of the image in the user interface request. Only to be set for a signature capture transaction.

SignatureImageCategory

O

C

The category of the image. Only to be set for a signature capture transaction.

SignatureImageEncrypted

O

C

Indicates whether the image in the user interface message request is encrypted. Only to be set for a signature capture transaction.

SignatureCheckbox1Text

O

C

Dynamic text label associated with the first check box on forms.

SignatureCheckbox2Text

O

C

Dynamic text label associated with the second check box on forms.

SignatureCheckbox3Text

O

C

Dynamic text label associated with the third check box on forms.

SignatureCheckbox1State

O

C

The state of the first check box after user input.

SignatureCheckbox2State

O

C

The state of the second check box after user input.

SignatureCheckbox3State

O

C

The state of the third check box after user input.

SignatureButtonValue

O

C

Indicates the button input collected from the user.

SignaturePromptName

O

C

The name of the prompt. Only to be set for a signature capture transaction.

EbtResponseText

O

C

The full response text as sent by the EBT provider.

EbtBeginningFoodStampAccountBalance

O

C

The beginning food stamp account balance.

EbtEndingFoodStampAccountBalance

O

C

The ending food stamp account balance.

EbtAvailableFoodStampAccountBalance

O

C

The available food stamp account balance.

EbtBeginningCashBenefitsAccountBalance

O

C

The beginning cash benefits account balance.

EbtEndingCashBenefitsAccountBalance

O

C

The ending cash benefits account balance.

EbtAvailableCashBenefitsAccountBalance

O

C

The available cash benefits account balance.

EbtCaseNumber

O

C

EBT case number.

EbtVoucherNumber

O

C

EBT voucher number.

RtsTotalHealthcareAmount

C

C

The total amount for the healthcare transaction . If extended transaction type is set to "7111 - Healthcare Benefit", then this field should be set.

RtsPrescriptionAmount

O

-

The amount for the prescription component of the healthcare transaction.

RtsOpticalAmount

O

-

The amount for the optical component of the healthcare transaction.

RtsDentalAmount

O

-

The amount for the dental component of the healthcare transaction.

RtsClinicAmount

O

-

The amount for the clinic component of the healthcare transaction.

LdFolioNr

O

T

Lodging (e.g. hotel, motel) transactions: The lodging facility’s internal invoice or billing identification reference number.

LdFacilityPhoneNr

O

T

Lodging (e.g. hotel, motel) transactions: The local phone number of the lodging facility at which the cardholder stayed.

LdDateArrival

O

T

Lodging (e.g. hotel, motel) transactions: The date on which the cardholder checked in at the lodging facility.

LdDateDeparture

O

T

Lodging (e.g. hotel, motel) transactions: The date on which the cardholder checked out of the lodging facility.

LdAmountRoomRate

O

T

Lodging (e.g. hotel, motel) transactions: The daily room charges, exclusive of taxes and fees.

LdAmountRoomTax

O

T

Lodging (e.g. hotel, motel) transactions: The daily room tax amount.

LdAmountPhoneCharges

O

T

Lodging (e.g. hotel, motel) transactions: The total amount of phone calls charged to the room.

LdAmountRestaurantAndRoomService

O

T

Lodging (e.g. hotel, motel) transactions: The total amount of restaurant and/or room service food charged to the room.

LdAmountBarAndMinibar

O

T

Lodging (e.g. hotel, motel) transactions: The total amount of bar and in-room "mini-bar" items charged to the room.

LdAmountLaundryAndDryCleaning

O

T

Lodging (e.g. hotel, motel) transactions: The total amount of laundry and drycleaning items charged to the room.

LdAmountGiftShop

O

T

Lodging (e.g. hotel, motel) transactions: The total amount of gift shop and specialty shop items charged to the room.

LdAmountOtherServices

O

T

Lodging (e.g. hotel, motel) transactions: The total amount of miscellaneous items/services charged to the room, not specified elsewhere.

LdAmountOtherServicesIndicator

O

T

Lodging (e.g. hotel, motel) transactions: Indicates the type of charges provided in LdAmountOtherServices.

LdAmountBillingAdjustment

O

T

Lodging (e.g. hotel, motel) transactions: The amount of any additional charges incurred after the cardholder’s departure.

LdProgramCode

O

T

Lodging (e.g. hotel, motel) transactions: A code allocated by the acquirer that identifies special circumstances.

LdCustomerServicePhoneNr

O

T

Lodging (e.g. hotel, motel) transactions: The customer service number that the cardholder may call to resolve questions or disputes.

LdNumberInParty

O

T

Lodging (e.g. hotel, motel) transactions: The number of guests.

LdNameOfGuest

O

T

Lodging (e.g. hotel, motel) transactions: The name of the guest.

PosDataCode

O

A

AvailableOfflineSpendingAmount

-

C

The Visa Available Offline Spending Amount value, if available on the card.

OfflineAccumulatorBalance

-

C

Represents the amount of offline spending available on the card.

APM

O

-

The Alternative Payment Method.

PaymentBrand

O

-

The Payment Brand.

QRCodeData

O

-

The QR code data in QR code transactions (e.g. a URL, identification number or transactional data string). This field takes precedence over the BarcodeData field in request messages.

QRCodeHostRef

O

-

An additional transaction reference received from the host system in QR code transaction response messages.

QRCodeImage

O

-

The QR code image encoded in Base64.

QRCodeTranId

O

-

The QR code transaction ID received from the host system. This field should be set in refund requests for consumer-presented QR code transactions, if required. It should also be sent in merchant-presented QR code transaction status requests.

QRCodeType

O

-

The QR code type in the QR code transactions.

BarcodeData

O

-

The barcode data. e.g. 0123456789. This field will be ignored in request messages if the QRCodeData field is set.

Quantity

O

-

Can be set to indicate the quantity of items purchased in consumer-presented QR code transaction requests.

TransactionName

O

-

Can be set to indicate the name of the Transaction in consumer-presented QR code transaction requests.

StoreId

O

-

Can be set to indicate the store ID in consumer-presented QR code transaction requests.

Memo

O

-

Can be set to indicate the memo in consumer-presented QR code transaction requests.

DccStatusCode

-

C

The dynamic currency conversion (DCC) status code.

DccProviderRoutingId

-

C

An identifier for the external entity that provided the currency conversion information which represents a DCC offer.

DccRate

-

C

The exchange rate used when performing currency conversion from the amount in the source currency to the amount in the target currency.

DccSrcCurrCode

-

C

Numeric code of the currency being converted from.

DccSrcCurrAlphaCode

-

C

Alphabetic code of the currency being converted from.

DccSrcCurrMinorUnits

-

C

The number of digits following the decimal separator.

DccTgtCurrCode

-

C

Numeric code of the currency being converted to.

DccTgtCurrAlphaCode

-

C

Alphabetic code of the currency being converted to.

DccTgtCurrMinorUnits

-

C

The number of digits following the decimal separator.

DccProvider

-

C

The currency conversion service provider.

DccRateSrc

-

C

The source of conversion data.

DccTimestamp

-

C

Time the conversion was performed in Coordinated Universal Time (UTC).

DccMargRate

-

C

Numeric value representing the foreign exchange markup rate as a fraction.

DccCommRate

-

C

Numeric value representing the foreign exchange commission rate as a fraction.

DccDccDiffOverECB

-

C

Numeric value representing the foreign exchange markup, it compares the DCC exchange rate to the European Central Bank rate as a fraction.

DccSrcAmt

-

C

Amount of the transaction in the currency being converted from.

DccTgtAmt

-

C

Amount of the transaction in the currency being converted to.

DccExpTimestamp

-

C

The offer expiration date and time in Coordinated Universal Time (UTC).

DccRcptTxt1

-

C

Additional disclaimer information required for printing on receipts.

DccRcptTxt2

-

C

Additional disclaimer information required for printing on receipts.

DccAcqId

-

C

The dynamic currency conversion specific acquirer identifier.

DccCardAcceptorId

-

C

The dynamic currency conversion specific card acceptor identifier.

DccTermId

-

C

The dynamic currency conversion specific terminal identifier.

NetworkLabel

-

H

The Credit or Debit network that processed the transaction.

PayeeNameAndAddress

O

H

Payee name and address contains identification and billing information for a payee.

AdditionalPayeeInformation

O

H

Contains additional payee name and address details.

AccountData

O

H

Contains account details needed for a credit application.

DisplayData

O

H

The status response from ADS based on the processor specification.

PrintData

O

H

The status response that contains information about the account.

MerchantOpcSelection

G

T

Indicates whether the merchant or cardholder OPC selection mode should be applied.

FinalAuthIndicator

O

T

Indicates whether the amount requested is a pre-authorization, normal authorization, or the final amount.

EspCardInfo

G

G

Contains additional card details, as configured in eSocket.POS.

FleetData

G

-

Can be set to send details for a transaction involving a fleet card. Within this element, all attributes are optional.

FleetDataRsp

-

H

Set in response to send details to the pump from the acquirer for a transaction involving a fleet card. Within this element, all attributes are optional.

PosGeographicDataLatitude

O

H

An optional PosGeographicDataLatitude field can be attached to a transaction.

PosGeographicDataLongitude

O

H

An optional PosGeographicDataLongitude field can be attached to a transaction.

TerminalAddress

O

H

An optional TerminalAddress field can be attached to a transaction.

DoNotDisplay

O

-

Set to disable the welcome and transaction outcome displays on a device.

RecurringPaymentIndicator

O

H

Specifies the recurring payment indicator.

StoredCredentialIndicator

O

H

Specifies the stored credential indicator.

RecurringPaymentDetail

O

H

Contains the details of the recurring payment.

TerminalId

M

A

TransactionId

M

A

Type

M

A

DateTime

O

A

LocalDate

O

A

LocalTime

O

A

ExtendedTransactionType

O

H

For an account inquiry for a credit admin status application transaction received from the POS, set this property to '7007'. For a customer linked account inquiry for a credit account lookup transaction received from the POS, set this property to '7001'.

AmountTransactionFee

O

H

AuthorizationNumber

C

C

Should be sent in a referral when an authorization number is provided, for instance after calling an authorization center. Will be present in a response if set by the authorizer of the transaction.

AuthorizationToken

C

C

Should be sent when a token-based authentication is used by the upstream entity.

CardholderAddress

O

T

Will be ignored unless PostalCode property is also set.

CtlsPinBypass

O

C

Should be sent when the PIN was bypassed for the contactless transaction.

PostalCode

O

T

CardVerificationResult

O

H

BusinessDate

O

H

RetrievalRefNr

O

C

ReceivingInstIdCode

O

C

PosOperatorId

O

-

CardNumber

CG

TG

If eSocket.POS does not read the card, either the Track2 or the CardNumber and ExpiryDate properties must be set. In a check verification or check guarantee transaction, the card number should be set to 19 zeros if no check/cheque card is to be used. If eSocket.POS is configured to mask sensitive data, eSocket.POS will send the first 6 digits and the last 4 digits of this field in the clear and will mask the middle remainder of the field.

ExpiryDate

CG

T

If eSocket.POS does not read the card, either the Track2 or the CardNumber and ExpiryDate properties must be set.

ExtendedAuthorizationNumber

C

C

Should be sent in a referral when an authorization number is provided, for instance after calling an authorization center. Will be present in a response if set by the authorizer of the transaction and the value is longer than the standard field (AuthorizationNumber) and up to 8 characters in length.

CardSequenceNumber

O

T

Cvv2

O

-

OriginalMessageType

O

-

Used for transaction inquiries to provide the MessageType of the original transaction that should be retrieved.

OriginalTransactionType

O

-

Used for transaction inquiries to provide the Type of the original transaction that should be retrieved.

EspTransaction

O

C

Will be returned in the response of a transaction inquiry with the transaction data if the transaction is found

Track1

O

CG

Will be returned if this inquiry type was CARD_READ and the data for this track is available. If the card is configured to mask sensitive data, this field won’t be set in the response.

Track2

CG

TG

If eSocket.POS does not read the card, either the Track2 or the CardNumber and ExpiryDate properties must be set. If eSocket.POS is configured to mask sensitive data, it will send the first 6 digits and the last 4 digits of the PAN in track2 in the clear and will mask the middle remainder of the PAN as well as the service restriction code and discretionary data in the response.

Track3

O

CG

Will be returned if this inquiry type was CARD_READ and the data for this track is available. If eSocket.POS is configured to mask sensitive data, this field won’t be set in the response.

PanEntryMode

O

A

May be set if the CardNumber is set. Should not be set otherwise. If not set, this value will be set by the PAN component based on the presence or absence of Track2 .

PosCondition

O

A

If not set, the default value of '00' - Normal Presentment will be assumed.

CurrencyCode

O

T

CardholderInformation

-

H

PrivateData

O

G

ResponseCode

O

A

ActionCode

-

A

MessageReasonCode

-

A

Account

O

A

Must be set if eSocket.POS is not configured with an Account component. Optional otherwise.

PinData

O

-

Required if PIN entry and encryption is performed by the POS

PinKeySequenceNr

C

-

Required if PIN data is present

TransactionAmount

C

T

May be required in check verification or check guarantee requests.

ServiceRestrictionCode

-

C

Will be returned if Track 2 Data is available.

CardProductName

-

G

Will be returned if this card product was configured in eSocket.POS.

CardholderName

-

G

Will be returned if set up by a response pipeline component in eSocket.POS.

MerchantId

-

G

Will be returned if set up by a response pipeline component in eSocket.POS.

ChequeNumber

O

G

This property is deprecated. Rather use an EspCheck object for a check verification or check guarantee transaction.

ChequeAccountNumber

O

G

This property is deprecated. Rather use an EspCheck object for a check verification or check guarantee transaction.

ChequeInstitutionCode

O

G

This property is deprecated. Rather use an EspCheck object for a check verification or check guarantee transaction.

Balance

-

C

Will be present in the response to a Balance Inquiry, an Available Funds Inquiry or else a Mini-statement Inquiry.

- AccountType

-

C

Will be present in the response to a Balance or Available Funds Inquiry. May be present in a Mini-statement Inquiry.

- AmountType

-

C

Will be present in the response to a Balance or Available Funds Inquiry.

- CurrencyCode

-

C

Will be present in the response to a Balance or Available Funds Inquiry. May be present in a Mini-statement Inquiry.

- Sign

-

C

Will be present in the response to a Balance or Available Funds Inquiry.

- Amount

-

C

Will be present in the response to a Balance or Available Funds Inquiry. May be present in a Mini-statement Inquiry.

- SequenceNumber

-

H

May be present in a Mini-statement Inquiry.

- DateTime

O

H

May be present in a Mini-statement Inquiry. Also used to filter transactions for a transaction inquiry

- TerminalId

-

H

May be present in a Mini-statement Inquiry.

- TransactionType

-

H

May be present in a Mini-statement Inquiry.

- To Account type

-

H

May be present in a Mini-statement Inquiry.

Account Id 1

-

H

May be present in a Mini-statement Inquiry.

- Account Id 2

-

H

May be present in a Mini-statement Inquiry.

- AuthorizationId

-

H

May be present in a Mini-statement Inquiry.

- Surcharge

-

H

May be present in a Mini-statement Inquiry.

PurchasingCardData

O

G

May be set in order to send level 2 and 3 details for a transaction involving a purchasing card. Within this element, all attributes are optional. Note: At this time only the PurchasingCardData.InvoiceNumber field is returned in the response.

StructuredData

O

HG

- Name

M

A

- Value

M

A

- Flags

O

G

- -DoNotPersist

O

G

PosStructuredData

O

HG

- Name

M

A

- Value

M

A

PassThruPanReference

O

-

Aimed at P2PE scenarios where the device/PED implements a P2PE scheme supported by ACI, yet eSocket.POS does not drive the device/PED (e.g. fuel forecourts).

- Scheme

M

-

This subfield is only mandatory if the PanReference field is present.

- Ksn

O

-

- Data

O

-

- SensitiveDataBlock

O

-

- WhitelistFileName

O

-

- MaxReliableBinLength

O

-

- TlvMapping

O

-

PassThruVolatileP2peData

O

-

Aimed at P2PE scenarios where the device/PED implements a P2PE scheme supported by ACI, yet eSocket.POS does not drive the device/PED (e.g. fuel forecourts).

- Scheme

M

-

This subfield is only mandatory if the PassThruVolatileP2peData field is present.

- Ksn

O

-

- Data

O

-

- SensitiveDataBlock

O

-

- WhitelistFileName

O

-

- MaxReliableBinLength

O

-

- TlvMapping

O

-

ChainedTransactionId

O

C

Will be provided in the response if the chained transaction information could be retrieved.

EmvAmount

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F02

EmvAmountOther

-

C

Will be provided in the response if available when an EMV card was used and a cashback amount was requested.

EMV Tag ID: 9F03

EmvApplicationIdentifier

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 4F

EmvApplicationInterchangeProfile

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 82

EmvApplicationLabel

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 50

EmvApplicationPreferredName

-

C

Will be provided in the response if available when an EMV card was used. This field will only be supplied in the xml interface if all characters can be represented as ASCII. Note: This field has been deprecated - please use either EmvApplicationPreferredNameRaw or EmvApplicationPreferredNameInternational.

EMV Tag ID: 9F12

EmvApplicationPreferredNameRaw

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F12

EmvApplicationPreferredNameInternational

-

C

Will be provided in the response if available when an EMV card was used. This field will only be provided if the Java Virtual Machine (JVM) in which eSocket.POS is running supports conversion from ISO/IEC 8859 using the code page specified by the EmvIssuerCodeTableIndex.

EMV Tag ID: 9F12

EmvApplicationTransactionCounter

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F36

EmvApplicationUsageControl

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F07

EmvApplicationVersionNumber

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F26

EmvAuthorizationResponseCode

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F27

EmvCryptogram

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 8E

EmvCryptogramInformationData

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F34

EmvCvmList

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F1E

EmvCvmResults

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F0D

EmvInterfaceDeviceSerialNumber

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F0E

EmvIssuerActionCodeDefault

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F0F

EmvIssuerActionCodeDenial

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F10

EmvIssuerActionCodeOnline

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F11

EmvIssuerApplicationData

-

C

Will be provided in the response if available when an EMV card was used.

EmvIssuerCodeTableIndex

-

C

Will be provided in the response if available when an EMV card was used.

EmvIssuerScriptResults

-

C

Will be provided in the response if available when an EMV card was used.

EmvTerminalActionCodeDefault

-

C

Will be provided in the response if available when an EMV card was used.

EmvTerminalActionCodeDenial

-

C

Will be provided in the response if available when an EMV card was used.

EmvTerminalActionCodeOnline

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9F09

EmvTerminalApplicationVersionNumber

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9F33

EmvTerminalCapabilities

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F1A

EmvTerminalCountryCode

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 9F35

EmvTerminalType

-

C

Will be provided in the response if available when an EMV card was used.

EMV Tag ID: 95

EmvTerminalVerificationResult

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9F53

EmvTransactionCategoryCode

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 5F2A

EmvTransactionCurrencyCode

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9A

EmvTransactionDate

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9F41

EmvTransactionSequenceCounter

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9B

EmvTransactionStatusInformation

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9C

EmvTransactionType

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9F37

EmvUnpredictableNumber

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9F6E

EmvFormFactorIndicator

O

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9F7C

EmvCustomerExclusiveData

O

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9F40

EmvAdditionalTerminalCapabilities

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 9F21

EmvTransactionTime

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 87

EmvApplicationPriorityIndicator

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 5F28

EmvIssuerCountryCode

-

C

Will be provided in the response if available when an EMV card was used. EMV Tag ID: 5F24

EmvApplicationExpiryDate

-

C

Will be provided in the response if available when an EMV card was used.

EbtResponseText

O

C

The full response text as sent by the EBT provider.

EbtBeginningFoodStampAccountBalance

O

C

The beginning food stamp account balance.

EbtEndingFoodStampAccountBalance

O

C

The ending food stamp account balance.

EbtAvailableFoodStampAccountBalance

O

C

The available food stamp account balance.

EbtBeginningCashBenefitsAccountBalance

O

C

The beginning Cash Benefits account balance.

EbtEndingCashBenefitsAccountBalance

O

C

The ending Cash Benefits account balance.

EbtAvailableCashBenefitsAccountBalance

O

C

The available Cash Benefits account balance.

EbtCaseNumber

O

C

EBT Case Number.

EbtVoucherNumber

O

C

EBT Voucher Number.

PosDataCode

O

A

AvailableOfflineSpendingAmount

-

C

The Visa Available Offline Spending Amount value, if available on the card.

OfflineAccumulatorBalance

-

C

Represents the amount of offline spending available on the Card.

PayeeNameAndAddress

O

H

The payee name and address object contains identification and billing information for the payee.

AdditionalPayeeInformation

O

H

Contains additional payee name and address details.

AccountData

O

H

Contains account details needed for a credit application.

DisplayData

O

H

The status response from ADS based on the processor specification.

PrintData

O

H

The status response containing information about the account.

EspCardInfo

G

G

Contains additional card details, as configured in eSocket.POS.

TerminalStatus

G

G

Contains information regarding the status of eSocket.POS that serves the terminal.

TerminalId

M

A

TransactionId

M

A

Type

M

A

DateTime

O

A

LocalDate

O

A

LocalTime

O

A

ExtendedTransactionType

O

H

AmountTransactionFee

O

H

AuthorizationNumber

C

C

Should be sent in a referral when an authorization number is provided, for instance after calling an authorization center. Will be present in a response if set by the authorizer of the transaction.

ExpiryDate

O

T

RetrievalRefNr

O

C

AuthorizationToken

C

C

Should be sent when a token-based authentication is used by the upstream entity.

ReceivingInstIdCode

O

C

NetworkId

-

A

ProductId

M

A

Required if the merchandise type is REQUEST or PROCURE.

ProductType

O

C

UserId

CG

H

For merchandise requests requiring the user to be identified, either the UserId or the Track2 property must be set, or these must be obtained by eSocket.POS.

Track2

CG

-

For merchandise requests requiring the user to be identified, either the UserId or the Track2 property must be set, or these must be obtained by eSocket.POS.

TransactionAmount

O

G

TenderAmount

O

-

TenderType

O

-

TenderSerialNumber

O

-

CardholderInformation

-

H

PrivateData

O

G

ResponseCode

-

A

ActionCode

-

A

MessageReasonCode

O

A

TranSequenceNumber

O

H

May be set in a request if the Type is CONFIRM or REVERSE. In this case it should match the value in the original REQUEST or PROCURE response.

HostResponseCode

-

H

ResponseMsg

-

H

ItemPin

-

H

ItemSerialNumber

-

H

ItemExpiryDate

-

H

ItemAmount

-

H

ItemTaxAmount

-

H

NetworkName

-

H

ProductName

-

H

ItemMessage

-

H

DescriptiveValue

-

H

IssuerName

-

H

IssuerId

-

H

IssuerRegistrationNr

-

H

IssuerTelephoneNr

-

H

ConsumerAddress

-

H

ConsumerId

-

H

ConsumerName

-

H

ItemBalance

-

H

- ProductCode

-

H

- ProductName

-

H

- ExpiryDate

-

H

- Quantity

-

H

- QuantityDescription

-

H

Token

-

H

- TokenDescription

-

H

- TokenValue

-

H

StructuredData

O

HG

- Name

M

A

- Value

M

A

- Flags

O

G

- -DoNotPersist

O

G

PosStructuredData

O

HG

- Name

M

A

- Value

M

A

ChainedTransactionId

O

C

Will be provided in the response if the chained transaction information could be retrieved.

TerminalId

M

A

TransactionId

M

A

Type

M

A

MessageType

O

C

Can be set to indicate AUTHADV, TRANREQ or CONFIRM message type in requests. Value in response is set based on the request value.

Reversal

C

T

Must be set to true for a reversal. The default (if this property is not set) is false .

DateTime

O

A

Reversal Type

O

C

Defaults to ADVICE (offline).

DateTime

O

A

LocalDate

O

A

LocalTime

O

A

ExtendedTransactionType

O

H

AmountTransactionFee

O

H

AuthorizationNumber

C

C

Should be sent in a referral when an authorization number is provided, for instance after calling an authorization center. Will be present in a response if set by the authorizer of the transaction.

AuthorizationToken

C

C

Should be sent when a token-based authentication is used by the upstream entity.

AuthorizationProfile

-

A

BusinessDate

O

H

RetrievalRefNr

O

C

PosOperatorId

O

-

CardNumber

C

TC

Should be set if a check ID card is used. Will be present in the response if this property was present in the request or eSocket.POS populated the value while processing the request. If eSocket.POS is configured to mask sensitive data, it will send the first 6 digits and the last 4 digits of the CardNumber

ExpiryDate

C

TC

Should be set if a check ID card is used. Will be present in the response if this property was present in the request or eSocket.POS populated the value while processing the request.

CardSequenceNumber

O

TCG

May be set if the CardNumber or Track2 is set. Should not be set otherwise.

Track2

C

TCG

Must be set if CardNumber and ExpiryDate are not set and a check ID card is used. Optional otherwise. Will be present in the response if this property was present in the request or eSocket.POS populated the value while processing the request. If eSocket.POS is configured to mask sensitive data, it will send the first 6 digits and the last 4 digits of the PAN in track2 in the clear and will mask the middle remainder of the PAN as well as the service restriction code and discretionary data in the response.

PanEntryMode

O

A

May be set if the CardNumber is set. Should not be set otherwise. If not set, this value will be set by the PAN component based on the presence or absence of track 2 data .

CurrencyCode

O

T

PrivateData

O

G

ResponseCode

O

A

ActionCode

-

A

MessageReasonCode

O

A

TransactionAmount

M

A

ServiceRestrictionCode

-

C

Will be returned if Track 2 Data is available.

MerchantId

-

G

Will be returned if set up by a response pipeline component in eSocket.POS.

CheckType

O

CheckIdCard

O

H

Should be set to true if this is a Check ID Card transaction. Default is false .

IdCrossChecked

O

H

Should be set to true if the ID was validated against a second ID. Default is false .

SupervisorId

O

H

CheckNr

O

H

TransitNr

O

H

AccountNr

O

H

UnformattedMICR

O

H

DriversLicenseNr

C

H

Must be set if a driver’s license is used as the form of identification.

DriversLicenseStateCode

O

H

GenericIdNr

C

H

Must be set if a generic ID is used as the form of identification.

GenericIdType

O

H

StructuredData

O

HG

- Name

M

A

- Value

M

A

- Flags

O

G

- -DoNotPersist

O

G

PosStructuredData

O

HG

- Name

M

A

- Value

M

A

PurchasingCardData

O

-

May be set in order to send level 2 and 3 details for a transaction involving a purchasing card. Within this element, all attributes are optional.

ChainedTransactionId

O

C

Will be provided in the response if the chained transaction information could be retrieved.

MICRKeyedOrScanned

O

H

DriversLicenseDateOfBirth

O

H

DriversLicenseKeyedOrScanned

O

H

DriversLicenseExpirationDate

O

H

MICRLineFormatCode

O

H

CustomerName

O

H

CustomerFirstName

O

H

CustomerLastName

O

H

CustomerMiddleInitial

O

H

CustomerInitials

O

H

CustomerPhoneNumber

O

H

CustomerAddress

O

H

CustomerCity

O

H

CustomerState

O

H

CustomerZip

O

H

CheckIssuedDate

O

H

TruncationTransactionID

O

H

MICRSequenceNr

O

H

TruncationIndicator

O

H

ServiceCharge

O

H

DenialNr

O

H

SettlementCode

O

H

ProprietaryResponseInfo

O

H

TerminalId

M

A

TransactionId

M

A

SettlementCurrencyCode

O

C

PrivateData

O

G

DateTime

O

A

LocalDate

O

A

LocalTime

O

A

PosStructuredData

O

HG

- Name

M

A

- Value

M

A

ResponseCode

-

A

ActionCode

-

A

MessageReasonCode

-

A

9670 - ' Batch Totals Not Available ', if there was any condition that the totals was not retrieved from Postilion Realtime

NumberOfCredits

O

C

NumberOfCreditsReversal

O

C

NumberOfDebits

O

C

NumberOfDebitsReversal

O

C

NumberOfInquiries

O

C

NumberOfAuthorizations

O

C

AuthorizationToken

C

C

Should be sent when a token-based authentication is used by the upstream entity.

CreditsAmount

O

C

CreditsReversalAmount

O

C

DebitsAmount

O

C

DebitsReversalAmount

O

C

NetSettlementAmount

O

C

Amount

M

A

Sign

M

A

StructuredData

O

HG

- Name

M

A

- Value

M

A

- Flags

O

G

- -DoNotPersist

O

G

TerminalId

M

A

TransactionId

M

A

DateTime

O

A

LocalDate

O

A

LocalTime

O

A

ResponseCode

-

A

ActionCode

-

A

MessageReasonCode

-

A

PrivateData

O

G

SecurityInfo

O

H

NetworkMngInfoCode

M

H

ReceivingInstIdCode

G

A

Required if the message will be sent to Transaction Manager, unless this is populated by a pipeline component.

MerchantId

-

G

Will be returned if set up by a response pipeline component in eSocket.POS.

StructuredData

O

HG

- Name

M

A

- Value

M

A

- Flags

O

G

- -DoNotPersist

O

G

PosStructuredData

O

HG

- Name

M

A

- Value

M

A

EAuthorizationToken

C

C

Should be sent when a token-based authentication is used by the upstream entity.

EspPosData

O

H

Contains data passed from the Point-of-Service (POS) system.

- PosTerminalId

M

A

- PosSequenceNumber

M

A

- PosOperatorId

M

A

TerminalId

M

A

Action

M

A

ActionCode

-

A

MessageReasonCode

-

A

Register

O

-

One or more register elements

- Type

M

-

- EventId

M

-

TerminalId

M

-

EventId

M

-

EventData

O

-

TerminalId

M

A

EventId

M

A

EventData

O

-

ResponseData

-

A

TerminalId

-

C

Will be set if available in the request that resulted in the error.

TransactionId

-

C

Will be set if available in the request that resulted in the error.

ActionCode

-

A

1 / DECLINE

ResponseCode

-

A

30 - Format error

MessageReasonCode

-

A

9791 - Administrative response

Description

-

C

Will be set if available in the Java exception.

0

Success

1

Failure

2

Timeout

3

Cancelled

-1

Unknown

1

EAN13

2

EAN8

3

UPCA

4

UPCE

5

EAN13_2

6

EAN8_2

7

UPCA_2

8

UPCE_2

9

EAN13_5

10

EAN8_5

11

UPCA_5

12

UPCE_5

13

Code 39

14

RFU

15

Interleaved 2 of 5

16

Standard 2 of 5

17

Matrix 2 of 5

18

RFU

19

CodaBar

20

AmesCode

21

MSI

22

Pleassey

23

Code 128

24

Code 16k

25

Code 93

26

Code 11

27

Telepen

28

Code 49

29

Code 39_ItalianCPI

30

Codablock A

31

Codablock F

32

Codablock 256

33

PDF417

34

GSI_128

35

ISBT128

36

MicroPDF

37

GSI_DataBarOmni

38

GSI_DataBarLimited

39

GSI_DataBarExpanded

40

DataMatrix

41

QRCode

95

GSI DataBar Omni-Dir Composite (CC-A)

44

GSI DataBar

45

GS1 DataBar Expanded Composite (CC-A)

46

GS1 Composite/GS1-128 Composite (CC-A)

47

EAN-13 Composite (CC-A)

48

EAN-8 Composite (CC-A)

49

UPC-A Composite (CC-A)

50

UPC-E Composite (CC-A)

51

GS1 DataBar Omni-Dir Composite (CC-B)

52

GS1 DataBar Limited Composite (CC-B)

53

GS1 DataBar Expanded Composite (CC-B)

54

GS1 Composite/GS1-128 Composite (CC-B)

55

EAN-13 Composite (CC-B)

56

EAN-8 Composite (CC-B)

57

UPC-A Composite (CC-B)

58

UPC-E Composite (CC-B)

59

GS1 Composite/GS1-128 Composite (CC-C)

60

ISBN

61

Postnet

62

Planet

63

BPO

64

Canada Post

65

Australian Post

66

Japan Post

67

Dutch Post

68

China Post

69

Korean Post

70

TLC39

71

Trioptic

72

ISMN

73

ISSN

74

Aztec

75

Sweden Post

76

Infomail

77

Multicode

78

Incomplete Multicode

90

MaxiCode

91

NEC 2 of 5

92

Postal format

93

Pharma code