Property Glossary
Defines aliases and properties that can appear in realtime event payloads.
Alias And Property Glossary
| Property Name | Meaning | |
|---|---|---|
aa | MessageTypeIndicator Identifies the kind of original card-network request message. Possible values:
| |
ab | OutputMessageTypeIndicator Identifies the response/output message type sent back through the network. Possible values:
| |
ac | OutputResponseCode Response/status code sent back in the output/response message. Possible values:
| |
ad | SystemTraceAuditNumber Network trace number used to locate the transaction with the network provider. Possible values:
| |
ae | MerchantCategoryCode Merchant category code describing the merchant type. Possible values:
| |
af | AcquirerInstitutionCountryCode Three-digit numeric ISO country code for the acquiring institution. This maps to ISO 8583 Field 19 and should be validated against Country and Currency Codes. Possible values:
| |
ag | PointOfServicePanEntryMode How the card number/PAN was entered at the point of sale. Possible values:
| |
ah | PointOfServicePinEntryMode How PIN entry was handled at the point of sale. Possible values:
| |
ai | TransactionFeeAmount Fee amount associated with the transaction in transaction currency. Possible values:
| |
aj | SettlementFeeAmount Fee amount used for network settlement. Possible values:
| |
ak | Track2Data_ServiceCode Service code read from track 2 card data. Possible values:
| |
al | RetrievalReferenceNumber Network retrieval reference number used to locate/support the transaction. Possible values:
| |
am | ResponseCode Response/status code received from the original request message. Possible values:
| |
an | CardAcceptorCountryCode Two-character alpha ISO country code for where the card acceptor/merchant is located. This is the country portion of the card acceptor location and should be validated against Country and Currency Codes. Possible values:
| |
ao | PinValidationCode Indicates the PIN validation result when DPS sends one. Helix stores one character from the raw 16-character PIN result field. Possible values:
| |
ap | AdditionalAmounts_Purchase Purchase portion of additional amounts supplied by the network. Possible values:
| |
aq | AdditionalAmounts_Gratuity Tip/gratuity amount supplied with the transaction. Possible values:
| |
ar | AdditionalFees_CCA Cardholder/acquirer additional fee amount supplied by the network. Possible values:
| |
au | AdditionalFees_ICA Interchange or issuer/acquirer additional fee amount supplied by the network. Possible values:
| |
av | NationalPointOfServiceCondition_TerminalUnattended Indicates whether the terminal was attended or unattended. Possible values:
| |
aw | NationalPointOfServiceCondition_TerminalOperator Indicates who operated the terminal. Possible values:
| |
ax | NationalPointOfServiceCondition_TerminalPremises Indicates whether the terminal was on/off merchant premises or ecommerce. Possible values:
| |
ay | NationalPointOfServiceCondition_CardPresentation Indicates whether/how the customer was present for the transaction. Possible values:
| |
az | NationalPointOfServiceCondition_CardPresence Indicates whether the card was present. Possible values:
| |
ba | NationalPointOfServiceCondition_CardRetention Indicates whether the terminal can retain the card. Possible values:
| |
bb | NationalPointOfServiceCondition_CardTransaction Describes special card-transaction handling. Possible values:
| |
bc | NationalPointOfServiceCondition_SecurityCondition Describes POS/security-related transaction condition. Possible values:
| |
bd | NationalPointOfServiceCondition_TerminalType Identifies the terminal or acceptance channel. Possible values:
| |
be | NationalPointOfServiceCondition_TerminalEntryCapability Identifies what entry methods the terminal supports. Possible values:
| |
bf | Advice_ReasonCode Reason for an advice or forced-post message. Use with
| |
bg | PrivatelyDefinedData_AcquirerNetworkIdCode Network from which DPS acquired the transaction. Possible values:
| |
bh | PrivatelyDefinedData_AdditionalTransactionElement_FallbackIndicator Shows whether the transaction fell back to magnetic stripe when chip/contactless was expected. Possible values:
| |
bi | PrivatelyDefinedData_ProcessingFlag_SpecialTransactionIndicator Flags special transaction handling. Possible values:
| |
bj | PrivatelyDefinedData_ProcessingFlag_ISAIndicator Visa international service assessment indicator for currency/fee assessment. Possible values:
| |
bk | PrivatelyDefinedData_ProcessingFlag_PartialAuthIndicator Whether the acquirer supports partial authorization. Possible values:
| |
bl | PrivatelyDefinedData_RiskData_ScoreSource Source of network risk score data. Possible values:
| |
bm | PrivatelyDefinedData_RiskData_ScoreValue Risk score value from the network risk source. Possible values:
| |
bn | PrivatelyDefinedData_RiskData_ResponseCode Response code from the Falcon/network risk service. Possible values:
| |
bo | PrivatelyDefinedData_RiskData_FalconReason1 First Falcon fraud/risk reason code. Possible values:
| |
bp | PrivatelyDefinedData_RiskData_FalconReason2 Second Falcon fraud/risk reason code. Possible values:
| |
bq | PrivatelyDefinedData_RiskData_FalconReason3 Third Falcon fraud/risk reason code. Possible values:
| |
br | PrivatelyDefinedData_RiskData_VisaRiskScore Visa risk score for the transaction. Possible values:
| |
bs | PrivatelyDefinedData_RiskData_VisaRiskReason Visa risk reason explaining the risk score. Possible values:
| |
bt | PrivatelyDefinedData_RiskData_VisaRiskConditionCode1 First Visa risk condition code. Possible values:
| |
bu | PrivatelyDefinedData_RiskData_VisaRiskConditionCode2 Second Visa risk condition code. Possible values:
| |
bv | PrivatelyDefinedData_RiskData_VisaRiskConditionCode3 Third Visa risk condition code. Possible values:
| |
bw | PrivatelyDefinedData_RiskData_VAAConditionCode1Rank Rank/priority for Visa advanced-authorization condition code 1. Possible values:
| |
bx | PrivatelyDefinedData_RiskData_RTDResultCode Real-time decisioning result code from network risk data. Possible values:
| |
bz | PrivatelyDefinedData_RiskData_TravelStatusIndicator Indicates travel-related risk/status for the cardholder or transaction. Possible values:
| |
ca | NetworkManagementInformationCode Network management information code for Falcon network-management or error messages. Possible values:
| |
cb | FalconCaseStatus Status of the Falcon fraud case. Possible values:
| |
cc | FalconCaseSubStatus More specific Falcon fraud case status. Possible values:
| |
cd | FalconBlockCode Falcon block code applied to the card or transaction. Possible values:
| |
ce | FalconFraudCode Falcon fraud classification code. Possible values:
| |
cf | Cvv2PresenceIndicator Indicates whether CVV2 was present in the authorization. Possible values:
| |
cg | Cvv2Result Result of CVV2 verification. Possible values:
| |
ch | Token Token value associated with a tokenized card transaction. Possible values:
| |
ci | TokenAssuranceLevel Confidence/assurance level for the payment token. Possible values:
| |
cj | DigitalWalletTokenRequestorTypeId Identifies the token requestor for a digital-wallet token. This table can grow dynamically, so clients should allow values beyond the seeded list. Possible values:
| |
ck | TokenExpirationDate Expiration date for the token. Possible values:
| |
cl | PaymentAccountReferenceNumber Stable reference tying tokenized credentials back to the underlying payment account. Possible values:
| |
cm | PrivatelyDefinedData_TransactionLevel_CredentialOnFileIndicator Indicates whether the transaction used a credential/card on file. Possible values:
| |
cn | PrivatelyDefinedData_TransactionLevel_CryptocurrencyPurchaseIndicator Indicates whether the transaction was a cryptocurrency purchase. Possible values:
| |
co | AvsResult Address Verification Service result. Possible values:
| |
cp | Advice_OriginatorCode Identifies who originated an advice message. Possible values:
| |
cq | Card Control Tag Client tag of the card control evaluated against the authorization. Possible values:
| |
cr | Card Control Rule Tag Client tag of the card-control rule that matched. Possible values:
| |
cs | Card Control Rule Source Who owns the matched card-control rule. Possible values:
| |
ct | Card Control Result Result of the matched card-control rule. Possible values:
| |
cu | In Auth Program Result Program/client's In Auth decision for the authorization. Possible values:
| |
cv | In Auth Helix Result Helix's result for the In Auth call to the program. Possible values:
| |
cw | Program Response Duration in Ms How long the program's In Auth response took, in milliseconds. Possible values:
| |
cx | Tap-to-Phone Indicator Identifies transactions initiated through Tap to Phone/contactless acceptance. Possible values:
| |
cy | Card Lock Status Current lock state indicator for the card in a card-modified event. Possible values:
| |
cz | Card Lock Reason Type Code Reason the card lock was applied. Possible values:
| |
da | Card Lock Type Code Type of card lock currently applied. Possible values:
| |
db | Visa Transaction ID Visa DPS original transaction identifier. Possible values:
| |
dc | Transaction Local Date Local date of the transaction at the merchant/acquirer. Possible values:
| |
dd | Transaction Local Time Local time of the transaction at the merchant/acquirer. Possible values:
| |
de | PrivatelyDefinedData_RiskData_MasterCardFraudScore Mastercard fraud score; higher values generally mean higher risk. Possible values:
| |
df | PrivatelyDefinedData_RiskData_MasterCardRiskCondition1 First Mastercard fraud condition indicator. Possible values:
| |
dg | PrivatelyDefinedData_RiskData_MasterCardRiskCondition2 Second Mastercard fraud condition indicator. Possible values:
| |
dh | PrivatelyDefinedData_RiskData_MasterCardFraudScoreReason Reason associated with the Mastercard fraud score. Possible values:
| |
di | In Auth Reason Code Program-supplied reason code for an In Auth result. Possible values:
| |
dj | CardholderCustomerId Customer ID for the business cardholder who performed the card transaction. Possible values:
| |
dk | RSM Rule ID Risk Services Manager rule that caused a debit-card decline. Possible values:
| |
dl | TransactionCurrencyCode Three-digit numeric ISO currency code for transaction and fee amounts. This maps to ISO 8583 Field 49 and should be validated against Country and Currency Codes. Possible values:
| |
dm | TransactionAmount Amount requested by the cardholder in local transaction currency, excluding transaction fee. Possible values:
| |
dn | SettlementAmount Amount transferred between acquirer and issuer for settlement. Possible values:
| |
do | SettlementConversionRate Rate used to convert transaction amount to settlement amount. Possible values:
| |
dp | TransmissionDateTime Date and time the network request was transmitted. Possible values:
| |
dq | CardIssuanceType Type of card issuance. Possible values:
| |
dr | AcquirerId Acquiring institution identifier. Possible values:
| |
ds | PrivatelyDefinedData_TransactionLevel_3DSIndicator 3-D Secure version/authentication method indicator. Possible values:
| |
dt | LargePrivateData_Ecommerce_3DSBrowserIPAddress Browser IP address from the 3DS requestor context. Possible values:
| |
du | LargePrivateData_Ecommerce_3DSAppIPAddress Public device/app IP address used by the 3DS requestor app. Possible values:
| |
dv | LargePrivateData_Ecommerce_3DSDeviceID Device identifier used across 3DS transactions for the same device. Possible values:
| |
dw | LargePrivateData_Ecommerce_3DSDeviceType Device type used for the 3DS transaction. Possible values:
| |
dx | LargePrivateData_Ecommerce_CAVVType Type/version of CAVV authentication value data. Possible values:
| |
dy | CAVV_3DSResultsCode Result code from 3DS/CAVV validation. Possible values:
| |
dz | AuthenticationMethod Authentication method used for the ecommerce/3DS transaction. Possible values:
| |
ea | SecureAuthenticationResultCode Secure-authentication result code. Possible values:
| |
eb | CAVV_KeyIndicator Key indicator used with CAVV data. Possible values:
| |
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:
| |
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
| |
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 | |
customerId | Unique Helix customer ID related to the event. Possible values:
| |
createdDate | The date the transaction was first created in Helix. | |
customerTag | Client-provided customer tag for the impacted/customer record, when available. Possible values:
| |
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. | |
dateOfLastCustomerContact | The date of the most recent interaction with the customer. | |
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. | |
feeCode | The programmatic value for the type of fee this transaction represents. Valid values include:
| |
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 | Helix user ID directly impacted by the event. Often matches
| |
institutionName | The name of the institution from which the transaction originated. Rarely contains data. | |
isCredit | Indicates whether the transaction is a credit rather than a debit. Possible values:
| |
lastCustomerContactType | Channel/type of the customer's most recent contact. Possible values:
| |
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.
| |
panEntryModeTypeCode | The method by which the card number was input to the merchant's device. Valid values include:
| |
PANSourceType | Conditionally sent by the acquirer. Valid values include:
| |
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
| |
pinValidationCode | Indicates successful PIN validation. Applicable only to debit card events. | |
programId | Unique Helix program ID for the program that owns the event. Possible values:
| |
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:
| |
responseCode | Visa DPS response code to Risk Factor message. Valid values include:
| |
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 subcategorization 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 transaction 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. | The identification code of the device at the merchant that accepted the card information. 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:
| |
terminalUnattendedTypeCode | Valid values include:
| |
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 | Current status of the transaction represented by the event. Possible values:
| |
transactionTag | Client-provided tag for the related transaction. Possible values:
| |
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 5 days ago

