Property Glossary

Each event payload type can contain different properties. The table below defines properties that could appear in payloads.

Property Glossary

Property NameMeaning
aa (MessageTypeIndicator)The four-digit message type identifier from the original request message. Applicable only to debit card events.
ab (OutputMessageTypeIndicator)The four-digit message type identifier from the response message. Applicable only to debit card events.
ac (OutputResponseCode)The two-digit status code from the response message. Applicable only to debit card events.
ad (SystemTraceAuditNumber)The System Trace Audit Number (Field #11 from the ISO-8583 specification) as defined by the network provider. Useful when interfacing with the network provider's support tools or staff. Applicable only to debit card events.
af (AcquirerInstitutionCountryCode)3 digit numeric code for the country where the acquiring institution is located. Applicable only to debit card events.
al (RetrievalReferenceNumber)The Retrieval Reference Number (Field #37 from the ISO-8583 specification) as defined by the network provider. Useful when interfacing with the network provider's support tools or staff. Applicable only to debit card events.
am (ResponseCode)The two-digit status code from the original request message. Applicable only to debit card events.
aq (AdditionalAmounts_Gratuity)The amount of gratuity provided when the transaction occurred. This field is zero-padded on the left side, and two decimals will be assumed. e.g.: 000000000000832 represents an amount of $8.32.Applicable only to debit card events.
bf (Advice_ReasonCode)The identifying reason for an advice and/or reversal.
bg (AcquirerNetworkIdCode)The network from which DPS acquired the transaction. Applicable only to debit card events.
bh (FallbackIndicator)The fallback indicator (Field #63.4, Position 5 from the ISO-8583 specification). Indicates whether the transaction was processed as magnetic stripe even though the card and terminal are EMV capable. Applicable only to debit card events.
bi (SpecialTransactionIndicator)The special transaction indicator (Field #63.7, Position 1 from the ISO-8583 specification).
- A: Payment Account Status Inquiry (ASI) Transaction
- B: Token account verification
- C: Cloud based payment/HCE
- D: Device Binding
- T: Tokenized Message
- V: Verified by Visa enrollment authorization request
- blank: No special transaction considerations

Applicable only to debit card events.
bj (ISAIndicator)Visa International Service Assessment (ISA) Indicator (Field #63.7, Position 2 from the ISO-8583 specification), used to indicate whether a transaction is single or multi-currency.
- C: Single Currency ISA (0.8%)
- S: Multi-Currency ISA (1.0%)
- R: ISA assessed and rebated
- blank: Transaction does not qualify for fee assessment.

Applicable only to debit card events.
bk (PartialAuthIndicator)Transaction eligibility for Partial Authorization Indicator (Field #63.7, Position 3 from the ISO-8583 specification).
- Y: Acquirer supports a partial authorization for transaction
- blank: Acquirer does not support a partial authorization for transaction.

Applicable only to debit card events.
amountThe amount of the transaction that caused this event.
approvedAmountThe amount of the mobile check deposit that was approved by the bank. Applicable only to mobile check deposit events.
approvedDateThe date the mobile check deposit was approved by the bank. Applicable only to mobile check deposit events.
availableDateThe date the funds associated with the transaction were applied to the availableAmount and therefore made available for withdrawal.
authorizationTransactionIdThe transactionId of the authorization that this transaction completed.
cardHolderPresenceTypeCodeThe presence of the card holder at the time the transaction was originated. Possible values:
- INSTALL: Cardholder not present, installment payment
- MAILTEL: Cardholder not present, mail or telephone order
- MOBILE: Mobile
- NOTPRESENT: Cardholder not present, unspecified
- PRESENT: Cardholder present
- RECUR: Cardholder not present, recurring payment
- TRANSFER: Money Transfer
- UNKNOWN: Unknown
- WEB: Web
cardIdThe card associated with the transaction. Applicable only to debit card events.
cardPresenceTypeCodeThe presence of the physical card at the time the transaction was originated. Possible values:
- NOTPRESENT: Card not present
- PRESENT: Card present
- PREAUTH: Pre-authorized purchase
cashbackAmountThe amount of cash the end user received during a debit card withdrawal at a non-ATM device. Applicable only to debit card events.
cashDepositAmountThe amount of cash deposited by the transaction. Applicable only to debit card events.
checkDepositAmountThe amount of the check deposited by the transaction. Applicable only to debit card events.
checkAmountThe amount of the mobile check deposit that was submitted. Applicable only to mobile check deposit events.
commentA notation applied by Helix employees internally containing any special extra information about the transaction. Very rare.
cp (Advice_OriginatorCode)(Field #60.2 - Advice Reason Codes, Position 1, from the ISO-8583 specification)
0: Not an advice. Position 2 (Advice_ReasonCode)must also be 0.
1:Advice originated by card acceptor
2: Advice originated by acquirer
3: Advice originated by stand-in agent
cq (Card Control Tag)Tag of the card control that was evaluated against this authorization. Via IsoMessage.CardControlId.
cr (Card Control Rule Tag)Tag of the rule that matched this authorization. Via IsoMessage.CardControlRuleId.
customerIdThe unique identifier for the customer in Helix that caused this event.
createdDateThe date the transaction was first created in Helix.
cs (Card Control Rule Source)Source of the rule that matched this authorization.
"Customer" or "Program" or NULL
ct (Card Control Result)Result of executing the matched card control rule.
0: Declined
1: Allowed
cu (In Auth Helix Result)Helix's result for In Auth processing
customField1A caller-specified, freeform value assigned to this particular transaction.
cv (In Auth Program Result)Program's result for In Auth processing
cw (Program Response Duration in Ms)Helix's timing for program's In Auth processing time
cx (Tap To Phone Indicator)Indicator to identify transactions initiated via a contactless acceptance solution referred to as Tap to Phone that allows current-generation connected devices, such as smartphones and tablets to accept contactless card-present payments.
cy (Card Lock Status)Indicator to identify a card lock state.
cz (Card Lock Reason Type Code)The reason the lock was applied to the card.
da (Card Lock Type Code)The type of lock applied to the card.
db (Visa Transaction ID)The Visa DPS Original Transaction Identifier
dc (Transaction Local Date)The local month and day the transaction takes place at the card acceptor location
dd (Transaction Local Time)The time the transaction takes place as expressed in the local time of the card acceptor location
denialReasonText describing why a transaction was denied from taking place. Applicable only to debit card events.
descriptionA caller-specified description of the transaction that caused this event. Will be automatically filled with relevant data if transaction resulted from ACH or debit card activity.
feeCodeThe programmatic value for the type of fee this transaction represents. Possible values:
- RGD: Regulation D Fee
- RTN: Return Item Fee
- NSF: Insufficient Funds Fee
feeDescriptionA human-readable description of the feeCode.
friendlyDescriptionA human-readable, automatically generated description of the transaction that caused the event. Driven by the typeCode of the transaction.
fromAccountIdThe unique identifier for the customer account that was debited.
fromAccountAmountTotal balance of the customer account that was debited, after the debit was applied, including funds that have holds placed on them. Represents all settled transactions to date.
fromAccountNumberMaskedMasked version of the Account number of the customer account that was debited. e.g. ********1234
fromAvailableAmountBalance available for immediate withdrawal from the customer account that was debited after the debit was applied.
fromCategoryThe caller-specified category to which the customer account that was debited belongs.
fromCreatedDateDate the customer account was created.
fromCustomField1A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField2A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField3A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField4A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField5A caller-specified, freeform value assigned to the customer account that was debited.
fromLegalName1The first legal name used to identify the customer account that was debited.
fromLegalName2The second legal name used to identify the customer account that was debited.
fromNameA caller-specified, user-friendly name for the customer account that was debited.
fromPendingAmountBalance of pending deposit transactions on the customer account that was debited, after the debit was applied.
fromPrimaryCustomerIdDenotes the customer considered the primary owner for the account that was debited.
fromSubCategoryThe caller-specified subcategory to which the customer account that was debited belongs.
fromTagA caller-specified, unique identifier for the customer account that was debited.
fromTargetAmountThe amount the customer wants the fromAvailableAmount to reach on the account that was debited.
fromTargetDateThe date the customer would like the fromTargetAmount to be reached on the account that was debited.
fromTargetMetDateThe first date the availableAmount reached or exceeded the fromTargetAmount on the account that was debited.
institutionNameThe name of the institution from which the transaction originated. Rarely contains data.
masterIdThe unique identifier created by Helix used to group related transactions together that caused this event.
merchantCityThe city of the merchant at which the transaction originated. Applicable only to debit card events.
merchantCountryCodeThe two-character country abbreviation of the merchant at which the transaction originated. Applicable only to debit card events.
merchantGroupTypeCodeA grouping of multiple Merchant Category Codes into fewer, more useful sets. Applicable only to debit card events. See Merchant Group Codes for more information.
merchantIdThe identification code of the merchant that accepted the card information. Applicable only to debit card events.
merchantLocationThe location of the merchant at which the transaction originated. Applicable only to debit card events.
merchantStateCodeThe two-character state abbreviation of the merchant at which the transaction originated. Applicable only to debit card events.
merchantZipCodeThe postal code of the merchant at which the transaction originated. Applicable only to debit card events.
modifiedByIdThe customerId or the Admin userId that last modified the transaction.
networkProviderTypeIdThe id of card's network provider.
- 1: Shazam
- 2: VisaDps

Applicable only to debit card events.
panEntryModeTypeCodeThe method by which the card number was input to the merchant's device. Possible values:
- KEY: Manually (key) entered
- MAG: Magnetic stripe read
- MAN: Manual, no terminal
- UNK: Unknown
payloadTypeIdThe "type" of payload in the data node. Represents a predefined set of properties that could potentially appear in the data node. (Properties with null values for a particular instance of the payload will be excluded.)
pinEntryModeTypeCodeThe method by which the card holder was validated at the merchant's device. Possible values:
- N/A: Not Applicable
- PIN: Network Provider-verified PIN
- PWD: Password authentication
pinValidationCodeIndicates successful PIN validation. Applicable only to debit card events.
purchaseAmountThe amount of the purchase for the transaction. Applicable only to debit card events.
receiptIdThe unique identifier of a mobile check deposit record. Applicable only to mobile check deposit events.
rejectDateThe date the mobile check deposit was rejected by the bank. Applicable only to mobile check deposit events.
rejectReasonThe reason the mobile check deposit was rejected by the bank. Applicable only to mobile check deposit events.
requestTypeCodeThe method of request from the debit rails. Possible values:
- REQ: Request; Helix approved or denied the message.
- ADV: Advice; The network provider approved or denied the message and notified Helix afterwards.
responseCodeVisa DPS response code to Risk Factor message. Possible values:
- 24: Visa cannot accept msg
- 25: Wrong PAN
- 27: Invalid Data
- 28: File currently open and in use
- 29: Update failed
returnCodeThe ACH-specified return code applied to the transaction.
settledDateThe date the funds associated with the transaction were applied to the accountAmount for the corresponding account. Note: This does not imply the funds are available for withdrawal yet.
submissionDateThe date the mobile check deposit was originally submitted by the customer. Applicable only to mobile check deposit events.
subTypeA human-readable description of the subcatgorization of the type. For debit card transactions, this is the description of the Merchant Category Code value represented in the subTypeCode. See Merchant Category Codes
subTypeCodeA programmatic subcategorization of the typeCode. For debit card transactions, this is the exact Merchant Category Code value received from the network provider. See Merchant Category Codes for more information.
surchargeAmountThe amount of surcharge applied to the tranasaction amount. For instance, if the amount property contains 202.50 and the surchargeAmount contains 2.50,' the user actually received 200.00.` Applicable only to debit card events.
tagA caller-specified unique value to represent the transaction that caused this event.
terminalIdThe identification code of the device at the merchant that accepted the card information. Applicable only to debit card events.
terminalPremisesTypeCodeLocation of the merchant's device in relation to the merchant's location. Possible values:
- ECOMM: Electronic Commerce
- OFFPREM: Off premise
- ONPREM: On premise
terminalUnattendedTypeCodePossible values:
- ATTENDED: Terminal was attended
- NOTERM: No terminal
- UNATTENDED: Terminal was unattended
toAccountAmountTotal balance of the customer account that was credited, after the credit was applied, including funds that have holds placed on them. Represents all settled transactions to date.
toAccountIdThe unique identifier for the customer account that was credited.
toAccountNumberMaskedMasked version of the Account number of the customer account that was credited. e.g., ********1234
toAvailableAmountBalance available for immediate withdrawal from the customer account that was credited after the credit was applied.
toCategoryThe caller-specified category to which the customer account that was credited belongs.
toCreatedDateDate the customer account was created.
toCustomField1A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField2A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField3A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField4A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField5A caller-specified, freeform value assigned to the customer account that was credited.
toLegalName1The first legal name used to identify the customer account that was credited.
toLegalName2The second legal name used to identify the customer account that was credited.
toNameA caller-specified, user-friendly name for the customer account that was credited.
toPendingAmountBalance of pending deposit transactions on the customer account that was credited, after the credit was applied.
toPrimaryCustomerIdDenotes the customer considered the primary owner for the account that was credited.
toSubCategoryThe caller-specified subcategory to which the customer account that was credited belongs.
toTagA caller-specified, unique identifier for the customer account that was credited.
toTargetAmountThe amount the customer wants the toAvailableAmount to reach on the account that was credited.
toTargetDateThe date the customer would like the toTargetAmount to be reached on the account that was credited.
toTargetMetDateThe first date the availableAmount reached or exceeded the targetAmount on the account that was credited.
transactionIdThe unique identifier created by Helix for the particular transaction that caused this event.
typeA human-readable representation of the type of transaction that caused this event.
typeCodeProgrammatic value for the type of transaction that caused this event. See the typeCode property on the transaction object for possible values.
versionThe version of the payload in the data node.
visaRiskFactorRequestIdThe Set card risk factors requestID provided in the 200 response. The visaRiskFactorRequestId Property is in the Visa DPS Risk Factor Events and is the TextInfo property (starting position 3549) in the Card Event Notification File.
voidedDateThe date the transaction was voided in Helix.