Property Glossary
Each event payload type contains various aliases and properties. The tables below define these aliases and properties that could appear in payloads.
Alias Glossary
Property Glossary
| Property Name | Meaning |
|---|---|
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 considerationsApplicable 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. |
amount | The amount of the transaction that caused this event. |
approvedAmount | The amount of the mobile check deposit that was approved by the bank. Applicable only to mobile check deposit events. |
approvedDate | The date the mobile check deposit was approved by the bank. Applicable only to mobile check deposit events. |
availableDate | The date the funds associated with the transaction were applied to the availableAmount and therefore made available for withdrawal. |
authorizationTransactionId | The transactionId of the authorization that this transaction completed. |
cardHolderPresenceTypeCode | The presence of the card holder at the time the transaction was originated. Valid values include: - 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 |
cardId | The card associated with the transaction. Applicable only to debit card events. |
cardPresenceTypeCode | The presence of the physical card at the time the transaction was originated. Valid values include - NOTPRESENT: Card not present- PRESENT: Card present- PREAUTH: Pre-authorized purchase |
cashbackAmount | The amount of cash the end user received during a debit card withdrawal at a non-ATM device. Applicable only to debit card events. |
cashDepositAmount | The amount of cash deposited by the transaction. Applicable only to debit card events. |
checkDepositAmount | The amount of the check deposited by the transaction. Applicable only to debit card events. |
checkAmount | The amount of the mobile check deposit that was submitted. Applicable only to mobile check deposit events. |
clientId | The unique ID of the client with which the line item is associated. |
comment | A notation applied by Helix employees internally containing any special extra information about the transaction. Very rare. |
contextId | GUID correlation identifier for tracking |
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 acceptor2: Advice originated by acquirer3: 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. |
customerId | The unique identifier for the customer in Helix that caused this event. |
createdDate | The 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: Declined1: Allowed |
cu (In Auth Helix Result) | Helix's result for In Auth processing |
customerId | |
customerTag | |
customField | A property for holding client-defined data. There is no business logic in Helix for a custom field |
customField1 | A 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. |
dateOfLastCustomerContact | The date of the most recent interaction with the customer. |
db (Visa Transaction ID) | The Visa DPS Original Transaction Identifier |
de (PrivatelyDefinedData_RiskData_MasterCardFraudScore) | A value that indicates the degree of risk associated with the transaction. Higher values are more likely to be fraudulent. 000 = Actual score (where XXX unable to return score and ZZZ Fraud server is unavailable. |
denialReason | Text describing why a transaction was denied from taking place. Applicable only to debit card events. |
depositRiskFactorId | Identification of the risk factor. |
description | A 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. |
df (PrivatelyDefinedData_RiskData_MasterCardRiskCondition1) | Fraud condition indicator |
dg (PrivatelyDefinedData_RiskData_MasterCardRiskCondition2) | Additional Fraud condition indicator |
dh (PrivatelyDefinedData_RiskData_MasterCardFraudScoreReason) | Fraud condition score reason |
di(In Auth Reason Code) | Program's reason code for an In Auth processing result |
dj (cardholderCustomerID) | Identifies the business customer performing card transactions on a business account with multiple cardholders |
dk (RSM Rule Id) | Risk Services Manager (RSM) rule id that was applied which resulted in a debit card transaction decline. |
feeCode | The programmatic value for the type of fee this transaction represents. Valid values include: - RGD: Regulation D Fee- RTN: Return Item Fee- NSF: Insufficient Funds Fee |
feeDescription | A human-readable description of the feeCode. |
friendlyDescription | A human-readable, automatically generated description of the transaction that caused the event. Driven by the typeCode of the transaction. |
fromAccountId | The unique identifier for the customer account that was debited. |
fromAccountAmount | Total 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. |
fromAccountNumberMasked | Masked version of the Account number of the customer account that was debited. e.g. ********1234 |
fromAvailableAmount | Balance available for immediate withdrawal from the customer account that was debited after the debit was applied. |
fromCategory | The caller-specified category to which the customer account that was debited belongs. |
fromCreatedDate | Date the customer account was created. |
fromCustomField1 | A caller-specified, freeform value assigned to the customer account that was debited. |
fromCustomField2 | A caller-specified, freeform value assigned to the customer account that was debited. |
fromCustomField3 | A caller-specified, freeform value assigned to the customer account that was debited. |
fromCustomField4 | A caller-specified, freeform value assigned to the customer account that was debited. |
fromCustomField5 | A caller-specified, freeform value assigned to the customer account that was debited. |
fromLegalName1 | The first legal name used to identify the customer account that was debited. |
fromLegalName2 | The second legal name used to identify the customer account that was debited. |
fromName | A caller-specified, user-friendly name for the customer account that was debited. |
fromPendingAmount | Balance of pending deposit transactions on the customer account that was debited, after the debit was applied. |
fromPrimaryCustomerId | Denotes the customer considered the primary owner for the account that was debited. |
fromSubCategory | The caller-specified subcategory to which the customer account that was debited belongs. |
fromTag | A caller-specified, unique identifier for the customer account that was debited. |
fromTargetAmount | The amount the customer wants the fromAvailableAmount to reach on the account that was debited. |
fromTargetDate | The date the customer would like the fromTargetAmount to be reached on the account that was debited. |
fromTargetMetDate | The first date the availableAmount reached or exceeded the fromTargetAmount on the account that was debited. |
impactedCustomerId | The unique identifier for the customer in Helix impacted by this event. |
impactedUserId | |
institutionName | The name of the institution from which the transaction originated. Rarely contains data. |
isCredit | |
lastCustomerContactType | Indicates the last mode of communication used to contact the customer. Valid values include: |
masterId | The unique identifier created by Helix used to group related transactions together that caused this event. |
merchantCity | The city of the merchant at which the transaction originated. Applicable only to debit card events. |
merchantCountryCode | The two-character country abbreviation of the merchant at which the transaction originated. Applicable only to debit card events. |
merchantGroupTypeCode | A grouping of multiple Merchant Category Codes into fewer, more useful sets. Applicable only to debit card events. See Merchant Group Codes for more information. |
merchantId | The identification code of the merchant that accepted the card information. Applicable only to debit card events. |
merchantLocation | The location of the merchant at which the transaction originated. Applicable only to debit card events. |
merchantStateCode | The two-character state abbreviation of the merchant at which the transaction originated. Applicable only to debit card events. |
merchantZipCode | The postal code of the merchant at which the transaction originated. Applicable only to debit card events. |
modifiedById | The customerId or the Admin userId that last modified the transaction. |
networkProviderTypeId | The id of card's network provider. - 1: Shazam- 2: VisaDpsApplicable only to debit card events. |
panEntryModeTypeCode | The method by which the card number was input to the merchant's device. Valid values include: - KEY: Manually (key) entered- MAG: Magnetic stripe read- MAN: Manual, no terminal- UNK: Unknown |
PANSourceType | Conditionally sent by the acquirer. Valid values include: - 01: Key Entered- 02: On File- 03: Mobile Banking App- 04: PAN Source- 05: Chip dip- 06: Contactless tap |
payloadTypeId | The "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.) |
pinEntryModeTypeCode | The method by which the card holder was validated at the merchant's device. Valid values include - N/A: Not Applicable- PIN: Network Provider-verified PIN- PWD: Password authentication |
pinValidationCode | Indicates successful PIN validation. Applicable only to debit card events. |
programId | |
purchaseAmount | The amount of the purchase for the transaction. Applicable only to debit card events. |
receiptId | The unique identifier of a mobile check deposit record. Applicable only to mobile check deposit events. |
rejectDate | The date the mobile check deposit was rejected by the bank. Applicable only to mobile check deposit events. |
rejectReason | The reason the mobile check deposit was rejected by the bank. Applicable only to mobile check deposit events. |
requestTypeCode | The method of request from the debit rails. Valid values include: - REQ: Request; Helix approved or denied the message.- ADV: Advice; The network provider approved or denied the message and notified Helix afterwards. |
responseCode | Visa DPS response code to Risk Factor message. Valid values include: - 24: Visa cannot accept msg- 25: Wrong PAN- 27: Invalid Data- 28: File currently open and in use- 29: Update failed |
returnCode | The ACH-specified return code applied to the transaction. |
settledDate | The 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. |
submissionDate | The date the mobile check deposit was originally submitted by the customer. Applicable only to mobile check deposit events. |
subType | A 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 |
subTypeCode | A 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. |
surchargeAmount | The 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. |
tag | A caller-specified unique value to represent the transaction that caused this event. |
terminalId | The identification code of the device at the merchant that accepted the card information. Applicable only to debit card events. |
terminalPremisesTypeCode | Location of the merchant's device in relation to the merchant's location. Valid values include: - ECOMM: Electronic Commerce- OFFPREM: Off premise- ONPREM: On premise |
terminalUnattendedTypeCode | Valid values include: - ATTENDED: Terminal was attended- NOTERM: No terminal- UNATTENDED: Terminal was unattended |
toAccountAmount | Total 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. |
toAccountId | The unique identifier for the customer account that was credited. |
toAccountNumberMasked | Masked version of the Account number of the customer account that was credited. e.g., ********1234 |
toAvailableAmount | Balance available for immediate withdrawal from the customer account that was credited after the credit was applied. |
toCategory | The caller-specified category to which the customer account that was credited belongs. |
toCreatedDate | Date the customer account was created. |
toCustomField1 | A caller-specified, freeform value assigned to the customer account that was credited. |
toCustomField2 | A caller-specified, freeform value assigned to the customer account that was credited. |
toCustomField3 | A caller-specified, freeform value assigned to the customer account that was credited. |
toCustomField4 | A caller-specified, freeform value assigned to the customer account that was credited. |
toCustomField5 | A caller-specified, freeform value assigned to the customer account that was credited. |
toLegalName1 | The first legal name used to identify the customer account that was credited. |
toLegalName2 | The second legal name used to identify the customer account that was credited. |
toName | A caller-specified, user-friendly name for the customer account that was credited. |
toPendingAmount | Balance of pending deposit transactions on the customer account that was credited, after the credit was applied. |
toPrimaryCustomerId | Denotes the customer considered the primary owner for the account that was credited. |
toSubCategory | The caller-specified subcategory to which the customer account that was credited belongs. |
toTag | A caller-specified, unique identifier for the customer account that was credited. |
toTargetAmount | The amount the customer wants the toAvailableAmount to reach on the account that was credited. |
toTargetDate | The date the customer would like the toTargetAmount to be reached on the account that was credited. |
toTargetMetDate | The first date the availableAmount reached or exceeded the targetAmount on the account that was credited. |
transactionId | The unique identifier created by Helix for the particular transaction that caused this event. |
transactionStatus | |
transactionTag | |
type | A human-readable representation of the type of transaction that caused this event. |
typeCode | Programmatic value for the type of transaction that caused this event. See the typeCode property on the transaction object for possible values. |
version | The version of the payload in the data node. |
visaRiskFactorRequestId | The 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. |
voidedDate | The date the transaction was voided in Helix. |
Updated 29 days ago