Property Glossary
Defines aliases and properties that can appear in realtime event payloads.
Alias And Property Glossary
aa
aaMessageTypeIndicator Identifies the kind of original card-network request message. Possible values:0100: Authorization Request0101: Authorization Request Repeat0110: Authorization Response0120: Authorization Advice0121: Authorization Advice Repeat0130: Authorization Advice Response0200: Financial Request0201: Financial Request Repeat0210: Financial Response0220: Financial Advice0221: Financial Advice Repeat0230: Financial Advice Response0382: Card Issuer File Update Request (AP)0392: Card Issuer File Update Response (AP)0420: Acquirer Reversal Advice0421: Acquirer Reversal Advice Repeat0430: Acquirer Reversal Response0600: Administrative Request0601: Administrative Request Repeat0610: Administrative Response0620: Administrative Advice
ab
abOutputMessageTypeIndicator Identifies the response/output message type sent back through the network. Possible values:0110: Authorization Response0130: Authorization Advice Response0210: Financial Response0230: Financial Advice Response0392: Card Issuer File Update Response (AP)0430: Acquirer Reversal Response0610: Administrative Response
ac
acOutputResponseCode Response/status code sent back in the output/response message. Possible values: Same response-code set as am, for example 00 approved or 05 do not honor.
ad
adSystemTraceAuditNumber Network trace number used to locate the transaction with the network provider. Possible values: Usually a six-digit numeric string, for example 000055.
ae
aeMerchantCategoryCode Merchant category code describing the merchant type. Possible values:
Four-digit MCC, for example 5411594760106011
af
afAcquirerInstitutionCountryCode 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: Three-digit numeric country code, for example 840 for the United States.
ag
agPointOfServicePanEntryMode How the card number/PAN was entered at the point of sale. Possible values:01: manual02: magnetic stripe03: optical code04: OCR05: integrated circuit card/chip06: key entered07: contactless chip using chip data rules81: stored82: digitally stored mobile browser84: MICR90: full magnetic stripe read91: contactless using magnetic-stripe data rules95: chip with possibly unreliable CVV, or unspecified/blank
ah
ahPointOfServicePinEntryMode How PIN entry was handled at the point of sale. Possible values:0: unspecified1: PIN entry capability2: no PIN entry capability6: PIN pad inoperative
ai
aiTransactionFeeAmount Fee amount associated with the transaction in transaction currency. Possible values: Decimal amount when present.
aj
ajSettlementFeeAmount Fee amount used for network settlement. Possible values: Decimal amount when present.
ak
akTrack2Data_ServiceCode Service code read from track 2 card data. Possible values: Typically a three-digit service code.
al
alRetrievalReferenceNumber Network retrieval reference number used to locate/support the transaction. Possible values: Usually a 12-character numeric string.
am
amResponseCode Response/status code received from the original request message. Possible values:00: Approved or completed successfully01: Refer to card issuer02: Refer to card issuer, special conditions03: Invalid merchant04: Pick-up card05: Do not honor06: Error07: Pick-up card, special conditions08: Honor with identification09: Request in progress10: Approved for partial amount11: Approved (VIP)12: Invalid transaction13: Invalid amount14: Invalid card number (no such number)15: No such issuer16: Approved, update Track 319: Re-enter transaction20: Invalid response23: Unacceptable transaction fee24: File update not supported by receiver25: Unable to locate record on file26: Duplicate file update record, no action27: File update field edit error28: File update record locked out29: File update not successful, contact acquirer30: Format error31: Bank not supported by switch33: Expired card, pick-up34: Suspected fraud, pick-up35: Card acceptor contact acquirer, pick-up36: Restricted card, pick-up37: Card acceptor call acquirer security, pick-up38: Allowable PIN tries exceeded, pick-up39: No credit account40: Requested function not supported41: Lost card, pick-up42: No universal account43: Stolen card, pick-up44: No investment account45: Check rejected - NSF46: Check rejected - stop payment47: Check rejected - two signatures required48: Check rejected - closed account49: Check rejected - other reason50: Check rejected - hold on funds51: Insufficient funds52: No checking account53: No savings account54: Expired card55: Incorrect PIN56: No card record57: Transaction not permitted to cardholder58: Transaction not permitted to terminal59: Suspected fraud60: Card acceptor contact acquirer61: Exceeds amount limit62: Restricted card63: Security violation65: Exceeds frequency limit66: Card acceptor call acquirer security67: Hard capture, pick-up75: Allowable number of PIN tries exceeded76: Key synchronization error87: Check already posted88: Information not on file89: Card verification value (CVV) verification failed; no pickup90: Cutoff is in progress91: Issuer or switch is inoperative92: Financial institution or intermediate network unknown for routing93: Transaction cannot be completed; violation of law94: Duplicate transaction96: System malfunctionD1: NSF - overdraft fee eligibleR0: Payment cancellation orderR1: Revocation of authorization orderR3: Preauthorized payment revocation orderX4: Consumer transaction controls decline
an
anCardAcceptorCountryCode 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: Two-character alpha country code, for example US or GB.
ao
aoPinValidationCode Indicates the PIN validation result when DPS sends one. Helix stores one character from the raw 16-character PIN result field. Possible values:0: PIN was invalid1: PIN was valid2: PIN was not validated or DPS did not replace the PIN data with a valid/invalid result. This can happen when the transaction did not contain track data, the institution is not configured for DPS PIN validation, or the institution has not enabled the DPS option to replace the PIN with a validation result.
ap
apAdditionalAmounts_Purchase Purchase portion of additional amounts supplied by the network. Possible values: Decimal amount, often 0.0 when not applicable.
aq
aqAdditionalAmounts_Gratuity Tip/gratuity amount supplied with the transaction. Possible values: Decimal amount in payload examples; glossary also notes zero-padded source values with implied two decimals.
ar
arAdditionalFees_CCA Cardholder/acquirer additional fee amount supplied by the network. Possible values: Decimal amount, often 0.0 when not applicable.
au
auAdditionalFees_ICA Interchange or issuer/acquirer additional fee amount supplied by the network. Possible values: Decimal amount, often 0.0 when not applicable.
av
avNationalPointOfServiceCondition_TerminalUnattended Indicates whether the terminal was attended or unattended. Possible values:0: attended1: unattended
aw
awNationalPointOfServiceCondition_TerminalOperator Indicates who operated the terminal. Possible values:0: customer operated1: card acceptor operated2: administrative
ax
axNationalPointOfServiceCondition_TerminalPremises Indicates whether the terminal was on/off merchant premises or ecommerce. Possible values:0: on premise1: off premise3: electronic commerce
ay
ayNationalPointOfServiceCondition_CardPresentation Indicates whether/how the customer was present for the transaction. Possible values:0: customer present1: customer not present2: mail/telephone order unknown classification4: recurring5: installment6: account top-up8: pre-authorized purchase9: single mail/telephone order
az
azNationalPointOfServiceCondition_CardPresence Indicates whether the card was present. Possible values:0: card present1: card not present8: pre-authorized purchase
ba
baNationalPointOfServiceCondition_CardRetention Indicates whether the terminal can retain the card. Possible values:0: no card-retention capability1: has card-retention capability
bb
bbNationalPointOfServiceCondition_CardTransaction Describes special card-transaction handling. Possible values:1: incremental authorization2: delayed charges3: no-show4: merchant authorized transaction5: resubmission6: reauthorization
bc
bcNationalPointOfServiceCondition_SecurityCondition Describes POS/security-related transaction condition. Possible values:0: unspecified1: incremental authorization2: delayed charges3: no-show4: merchant authorized transaction5: resubmission6: reauthorization8: unspecified; examples can show 0 and 8
bd
bdNationalPointOfServiceCondition_TerminalType Identifies the terminal or acceptance channel. Possible values:00: Administrative terminal01: POS terminal02: ATM03: Home terminal04: ECR05: Dial terminal06: Travelers check machine07: Fuel machine08: Scrip machine09: Coupon machine10: Ticket machine11: Point-of-banking terminal12: Teller13: Franchise teller14: Personal banking15: Public utility16: Vending17: Self-service18: Authorization19: Payment20: VRU21: Smart phone22: Interactive television23: PDA24: Screen phone25: Internet terminal26: MICR terminal27: Mobile acceptance solution
be
beNationalPointOfServiceCondition_TerminalEntryCapability Identifies what entry methods the terminal supports. Possible values:0: unknown1: manual/no terminal2: magnetic stripe3: QR code4: OCR5: ICC/chip6: key entered9: fileS: MICR readerT: contactlessU: contactless via magnetic-stripe rules
bf
bfAdvice_ReasonCode Reason for an advice or forced-post message. Use with cp (Advice_OriginatorCode) to understand who originated the advice. Possible values:0: Not an advice; cp should also be 01: Timed-out request2: Issuer not available3: Issuer signed off4: Within business agreement5: POS alternate authorization6: POS merchant authorization7: POS switch authorization under floor limit8: Encryption key not established9: AFD completion adviceA: Merchant fraud assessment declineB: Transaction blockedC: SuspendedD: DeactivatedE: Batch clearing from dual-message merchantF: Clearing below floor limitG: Clearing with no authorization performedH: Clearing of an authorized transactionI: Clearing of an unauthorized transaction
bg
bgPrivatelyDefinedData_AcquirerNetworkIdCode Network from which DPS acquired the transaction. Possible values:
Network identifier, examples VSNMNPAPT
bh
bhPrivatelyDefinedData_AdditionalTransactionElement_FallbackIndicator Shows whether the transaction fell back to magnetic stripe when chip/contactless was expected. Possible values:
Blank or 0: not fallback1: fallback
bi
biPrivatelyDefinedData_ProcessingFlag_SpecialTransactionIndicator Flags special transaction handling. Possible values:A: ASIB: token account verificationC: cloud/HCED: device bindingT: tokenizedV: Verified by Visa enrollment
Blank: no special handling
bj
bjPrivatelyDefinedData_ProcessingFlag_ISAIndicator Visa international service assessment indicator for currency/fee assessment. Possible values:C: single-currency ISAS: multi-currency ISAR: assessed and rebated
Blank: not applicable
bk
bkPrivatelyDefinedData_ProcessingFlag_PartialAuthIndicator Whether the acquirer supports partial authorization. Possible values:Y: supports partial auth
Blank: does not support partial auth
bl
blPrivatelyDefinedData_RiskData_ScoreSource Source of network risk score data. Possible values:0: no Falcon processing1: Online2: Online Plus3: Real-Time
Blank: not populated
bm
bmPrivatelyDefinedData_RiskData_ScoreValue Risk score value from the network risk source. Possible values:
Falcon score 0000 to 0999; higher means more likely fraud9998: or 9999 can mean fraud-monitoring suppression
Blank-filled: when not populated
bn
bnPrivatelyDefinedData_RiskData_ResponseCode Response code from the Falcon/network risk service. Possible values:0: no response generated1: approve2: decline3: refer4: approve with identification5: pick up card
Blank: not applicable
bo
boPrivatelyDefinedData_RiskData_FalconReason1 First Falcon fraud/risk reason code. Possible values:00: no code01: unusual time02: unusual MCC03: high-risk MCC04: suspicious high dollar05: suspicious dollar amounts06: suspicious geographic07: suspicious approve/decline08: suspicious auth velocity09: suspicious post velocity10: suspicious transaction type11: suspicious account info12: suspicious keyed activity13: high-risk keyed activity14: suspicious ATM cash15: suspicious non-ATM cash16: suspicious cash17: suspicious phone18: suspicious unattended gas19: suspicious CAT activity20: high-risk MCC amount21: suspicious foreign activity22: CVV/expiration mismatch51: suspicious payment activity52: suspicious payment amount53: suspicious payment amount numbers
Blank-filled: not applicable
bp
bpPrivatelyDefinedData_RiskData_FalconReason2 Second Falcon fraud/risk reason code. Possible values: Same value set as bo.
bq
bqPrivatelyDefinedData_RiskData_FalconReason3 Third Falcon fraud/risk reason code. Possible values: Same value set as bo.
br
brPrivatelyDefinedData_RiskData_VisaRiskScore Visa risk score for the transaction. Possible values:
Visa score/code, examples 0987
Blank: not applicable
bs
bsPrivatelyDefinedData_RiskData_VisaRiskReason Visa risk reason explaining the risk score. Possible values:
Visa reason code, example 5A
Blank-filled: not applicable
bt
btPrivatelyDefinedData_RiskData_VisaRiskConditionCode1 First Visa risk condition code. Possible values:
Visa condition code, examples 0215
Blank: not applicable
bu
buPrivatelyDefinedData_RiskData_VisaRiskConditionCode2 Second Visa risk condition code. Possible values:
Visa condition code, example C2
Blank: not applicable
bv
bvPrivatelyDefinedData_RiskData_VisaRiskConditionCode3 Third Visa risk condition code. Possible values:
Visa condition code, examples 00BT
Blank: not applicable
bw
bwPrivatelyDefinedData_RiskData_VAAConditionCode1Rank Rank/priority for Visa advanced-authorization condition code 1. Possible values:2: high risk for fraud1: medium risk for fraud0: low risk for fraud
Blank: not applicable
bx
bxPrivatelyDefinedData_RiskData_RTDResultCode Real-time decisioning result code from network risk data. Possible values:D: declined by RTDR: referred by RTD
Blank: no RTD result
bz
bzPrivatelyDefinedData_RiskData_TravelStatusIndicator Indicates travel-related risk/status for the cardholder or transaction. Possible values:A: cardholder may be traveling and destination matchesB: cardholder may be traveling and destination unknown
Blank: no travel status
ca
caNetworkManagementInformationCode Network management information code for Falcon network-management or error messages. Possible values:830: Falcon case management message831: Falcon action832: Falcon comment850: Falcon online scoring request message851: Falcon real-time scoring request message900: message format / syntax error message
cb
cbFalconCaseStatus Status of the Falcon fraud case. Possible values: Falcon status code when present.
cc
ccFalconCaseSubStatus More specific Falcon fraud case status. Possible values: Falcon substatus code when present.
cd
cdFalconBlockCode Falcon block code applied to the card or transaction. Possible values: Falcon block code when present.
ce
ceFalconFraudCode Falcon fraud classification code. Possible values: Falcon fraud code when present.
cf
cfCvv2PresenceIndicator Indicates whether CVV2 was present in the authorization. Possible values:0: CVV2 bypassed/not provided1: CVV2 present2: CVV2 on card but illegible9: cardholder says card has no CVV2 imprint
cg
cgCvv2Result Result of CVV2 verification. Possible values:M: matchN: no matchP: not processedS: should be on card but merchant says not presentU: issuer not certified or keys not provided
ch
chToken Token value associated with a tokenized card transaction. Possible values: Token string when present.
ci
ciTokenAssuranceLevel Confidence/assurance level for the payment token. Possible values: Network token assurance code when present.
cj
cjDigitalWalletTokenRequestorTypeId 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:40010030273: Apple Pay40010075001: Google Pay40010043095: Samsung Pay40010075338: Visa Checkout40010075449: Facebook40010075839: Netflix
ck
ckTokenExpirationDate Expiration date for the token. Possible values: Date-like network value when present.
cl
clPaymentAccountReferenceNumber Stable reference tying tokenized credentials back to the underlying payment account. Possible values: Payment account reference string, example 10010014621056636090615846428.
cm
cmPrivatelyDefinedData_TransactionLevel_CredentialOnFileIndicator Indicates whether the transaction used a credential/card on file. Possible values: Network flag, examples N or blank.
cn
cnPrivatelyDefinedData_TransactionLevel_CryptocurrencyPurchaseIndicator Indicates whether the transaction was a cryptocurrency purchase. Possible values: Network flag, examples N or blank.
co
coAvsResult Address Verification Service result. Possible values:A: street address only partial matchN: non-matchR: indeterminate/retryU: unable to verifyY: full matchZ: postal/ZIP only partial match
cp
cpAdvice_OriginatorCode Identifies who originated an advice message. Possible values:0: not an advice1: card acceptor2: acquirer3: stand-in agent
cq
cqCard Control Tag Client tag of the card control evaluated against the authorization. Possible values: Card-control tag string when a card control was evaluated.
cr
crCard Control Rule Tag Client tag of the card-control rule that matched. Possible values: Rule tag string when a rule matched.
cs
csCard Control Rule Source Who owns the matched card-control rule. Possible values:CustomerProgramnull: or omitted when not applicable
ct
ctCard Control Result Result of the matched card-control rule. Possible values:0: declined1: allowed
cu
cuIn Auth Program Result Program/client's In Auth decision for the authorization. Possible values:1: Approve2: Decline3: Abstain
cv
cvIn Auth Helix Result Helix's result for the In Auth call to the program. Possible values:1: Success2: Error3: Timeout4: Customer token not set5: Program HTTP error6: Unknown timeout
cw
cwProgram Response Duration in Ms How long the program's In Auth response took, in milliseconds. Possible values: Integer millisecond duration.
cx
cxTap-to-Phone Indicator Identifies transactions initiated through Tap to Phone/contactless acceptance. Possible values: Network indicator, example 0001.
cy
cyCard Lock Status Current lock state indicator for the card in a card-modified event. Possible values: Numeric lock-state value from card state; examples can show 0. Use da for the user-friendly lock type code when present.
cz
czCard Lock Reason Type Code Reason the card lock was applied. Possible values:UNK: UnknownSTL: StolenLST: LostFRD: Suspected fraudDMG: Physical damageDMR: Prepaid in-branch replacement with stock cardADM: AdministrativeTMP: TemporaryPIN: PIN retry exceededNAM: Name changeUPG: Due to upgradeDEC: DeceasedESC: EscheatmentDES: DestroyedACL: Account closureSTA: StaleVOD: Voided
da
daCard Lock Type Code Type of card lock currently applied. Possible values:UNL: UnlockedCST: Customer lockedSYS: System locked
db
dbVisa Transaction ID Visa DPS original transaction identifier. Possible values: Visa transaction identifier string, for example 000055202507289.
dc
dcTransaction Local Date Local date of the transaction at the merchant/acquirer. Possible values:
MMDD-style string, for example 03261116.
dd
ddTransaction Local Time Local time of the transaction at the merchant/acquirer. Possible values:
HHMMSS-style string, for example 022827160135.
de
dePrivatelyDefinedData_RiskData_MasterCardFraudScore Mastercard fraud score; higher values generally mean higher risk. Possible values:
Three-character score/codeXXX: unable to return scoreZZZ: fraud server unavailable
Blank-filled: not populated
df
dfPrivatelyDefinedData_RiskData_MasterCardRiskCondition1 First Mastercard fraud condition indicator. Possible values: Mastercard condition code, examples 00 or blank-filled.
dg
dgPrivatelyDefinedData_RiskData_MasterCardRiskCondition2 Second Mastercard fraud condition indicator. Possible values: Mastercard condition code, examples 00 or blank-filled.
dh
dhPrivatelyDefinedData_RiskData_MasterCardFraudScoreReason Reason associated with the Mastercard fraud score. Possible values: Mastercard reason code, examples 00 or blank-filled.
di
diIn Auth Reason Code Program-supplied reason code for an In Auth result. Possible values: Program-defined reason code when supplied.
dj
djCardholderCustomerId Customer ID for the business cardholder who performed the card transaction. Possible values: Numeric Helix customer ID; 0 can appear when not applicable.
dk
dkRSM Rule ID Risk Services Manager rule that caused a debit-card decline. Possible values: RSM rule identifier.
dl
dlTransactionCurrencyCode 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:
Three-digit numeric currency code, for example 840 for USD978 for EUR, including Bulgaria-originated original Visa DPS transactions after December 31, 2025 at 22:00 GMT.
dm
dmTransactionAmount Amount requested by the cardholder in local transaction currency, excluding transaction fee. Possible values:
Decimal amount, examples 0.020.02000.0.
dn
dnSettlementAmount Amount transferred between acquirer and issuer for settlement. Possible values: Decimal amount, example 400.0.
do
doSettlementConversionRate Rate used to convert transaction amount to settlement amount. Possible values: Decimal/rate value when conversion applies.
dp
dpTransmissionDateTime Date and time the network request was transmitted. Possible values:
MMDDHHMMSS-style string, for example 03260228271021220135.
dq
dqCardIssuanceType Type of card issuance. Possible values:PhysicalDigital with PhysicalDigital without PhysicalVirtual
dr
drAcquirerId Acquiring institution identifier. Possible values:
Acquirer/IID string, examples 1234567890159123456789.
ds
dsPrivatelyDefinedData_TransactionLevel_3DSIndicator 3-D Secure version/authentication method indicator. Possible values:0: 3DS 1.0.21: static passcode2: SMS OTP3: key fob/card reader OTP4: app OTP5: other OTP6: KBA7: OOB biometric8: OOB app login9: other OOBA: other methodB: unrecognizedC: push confirmationD: frictionless RBA reviewE: attempts serverF: frictionless RBAG: ACS-specific/MC 3DS 1.0H: ACS-specific 2/MC 3DS 2.0I: through K ACS-specific methodsL: delegated trusted authM: decoupledN: WebAuthnO: secure payment confirmationP: behavioral biometricsZ: unknown
Blank: not applicable
dt
dtLargePrivateData_Ecommerce_3DSBrowserIPAddress Browser IP address from the 3DS requestor context. Possible values: IP address string.
du
duLargePrivateData_Ecommerce_3DSAppIPAddress Public device/app IP address used by the 3DS requestor app. Possible values: IP address string.
dv
dvLargePrivateData_Ecommerce_3DSDeviceID Device identifier used across 3DS transactions for the same device. Possible values: Device ID string.
dw
dwLargePrivateData_Ecommerce_3DSDeviceType Device type used for the 3DS transaction. Possible values:01: desktop02: TV connected03: tablet/mobile04: headless/voice05: wearable06: IoT99: other
dx
dxLargePrivateData_Ecommerce_CAVVType Type/version of CAVV authentication value data. Possible values: Network CAVV type code when present.
dy
dyCAVV_3DSResultsCode Result code from 3DS/CAVV validation. Possible values: Network 3DS/CAVV result code when present.
dz
dzAuthenticationMethod Authentication method used for the ecommerce/3DS transaction. Possible values: Network authentication method code when present.
ea
eaSecureAuthenticationResultCode Secure-authentication result code. Possible values: Network secure-auth result code when present.
eb
ebCAVV_KeyIndicator Key indicator used with CAVV data. Possible values: Network CAVV key indicator when present.
amount
amountThe amount of the transaction that caused this event.
approvedAmount
approvedAmountThe amount of the mobile check deposit that was approved by the bank. Applicable only to mobile check deposit events.
approvedDate
approvedDateThe date the mobile check deposit was approved by the bank. Applicable only to mobile check deposit events.
authorizationTransactionId
authorizationTransactionIdThe transactionId of the authorization that this transaction completed.
availableDate
availableDateThe date the funds associated with the transaction were applied to the availableAmount and therefore made available for withdrawal.
cardHolderPresenceTypeCode
cardHolderPresenceTypeCodeThe presence of the card holder at the time the transaction was originated. Valid values include:INSTALL: Cardholder not present, installment paymentMAILTEL: Cardholder not present, mail or telephone orderMOBILE: MobileNOTPRESENT: Cardholder not present, unspecifiedPRESENT: Cardholder presentRECUR: Cardholder not present, recurring paymentTRANSFER: Money TransferUNKNOWN: UnknownWEB: Web
cardId
cardIdThe card associated with the transaction. Applicable only to debit card events.
cardPresenceTypeCode
cardPresenceTypeCodeThe presence of the physical card at the time the transaction was originated. Valid values include:NOTPRESENT: Card not presentPRESENT: Card presentPREAUTH: Pre-authorized purchase
cashbackAmount
cashbackAmountThe amount of cash the end user received during a debit card withdrawal at a non-ATM device. Applicable only to debit card events.
cashDepositAmount
cashDepositAmountThe amount of cash deposited by the transaction. Applicable only to debit card events.
checkAmount
checkAmountThe amount of the mobile check deposit that was submitted. Applicable only to mobile check deposit events.
checkDepositAmount
checkDepositAmountThe amount of the check deposited by the transaction. Applicable only to debit card events.
clientId
clientIdThe unique ID of the client with which the line item is associated.
comment
commentA notation applied by Helix employees internally containing any special extra information about the transaction. Very rare.
contextId
contextIdGUID correlation identifier for tracking.
createdDate
createdDateThe date the transaction was first created in Helix.
customField
customFieldA property for holding client-defined data. There is no business logic in Helix for a custom field.
customField1
customField1A caller-specified, freeform value assigned to this particular transaction.
customerId
customerIdUnique Helix customer ID related to the event. Possible values: Numeric Helix customer ID.
customerTag
customerTagClient-provided customer tag for the impacted/customer record, when available. Possible values: Freeform client tag string.
dateOfLastCustomerContact
dateOfLastCustomerContactThe date of the most recent interaction with the customer.
denialReason
denialReasonText describing why a transaction was denied from taking place. Applicable only to debit card events.
depositRiskFactorId
depositRiskFactorIdIdentification of the risk factor.
description
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.
feeCode
feeCodeThe programmatic value for the type of fee this transaction represents. Valid values include:RGD: Regulation D FeeRTN: Return Item FeeNSF: Insufficient Funds Fee
feeDescription
feeDescriptionA human-readable description of the feeCode.
friendlyDescription
friendlyDescriptionA human-readable, automatically generated description of the transaction that caused the event. Driven by the typeCode of the transaction.
fromAccountAmount
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.
fromAccountId
fromAccountIdThe unique identifier for the customer account that was debited.
fromAccountNumberMasked
fromAccountNumberMaskedMasked version of the account number of the customer account that was debited. e.g. ********1234
fromAvailableAmount
fromAvailableAmountBalance available for immediate withdrawal from the customer account that was debited after the debit was applied.
fromCategory
fromCategoryThe caller-specified category to which the customer account that was debited belongs.
fromCreatedDate
fromCreatedDateDate the customer account was created.
fromCustomField1
fromCustomField1A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField2
fromCustomField2A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField3
fromCustomField3A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField4
fromCustomField4A caller-specified, freeform value assigned to the customer account that was debited.
fromCustomField5
fromCustomField5A caller-specified, freeform value assigned to the customer account that was debited.
fromLegalName1
fromLegalName1The first legal name used to identify the customer account that was debited.
fromLegalName2
fromLegalName2The second legal name used to identify the customer account that was debited.
fromName
fromNameA caller-specified, user-friendly name for the customer account that was debited.
fromPendingAmount
fromPendingAmountBalance of pending deposit transactions on the customer account that was debited, after the debit was applied.
fromPrimaryCustomerId
fromPrimaryCustomerIdDenotes the customer considered the primary owner for the account that was debited.
fromSubCategory
fromSubCategoryThe caller-specified subcategory to which the customer account that was debited belongs.
fromTag
fromTagA caller-specified, unique identifier for the customer account that was debited.
fromTargetAmount
fromTargetAmountThe amount the customer wants the fromAvailableAmount to reach on the account that was debited.
fromTargetDate
fromTargetDateThe date the customer would like the fromTargetAmount to be reached on the account that was debited.
fromTargetMetDate
fromTargetMetDateThe first date the availableAmount reached or exceeded the fromTargetAmount on the account that was debited.
impactedCustomerId
impactedCustomerIdThe unique identifier for the customer in Helix impacted by this event.
impactedUserId
impactedUserIdHelix user ID directly impacted by the event. Often matches impactedCustomerId for customer-level events. Possible values: Numeric Helix user ID.
institutionName
institutionNameThe name of the institution from which the transaction originated. Rarely contains data.
isCredit
isCreditIndicates whether the transaction is a credit rather than a debit. Possible values: Boolean-style value when present, typically true or false.
lastCustomerContactType
lastCustomerContactTypeChannel/type of the customer's most recent contact. Possible values: Contact-type code from customer contact configuration.
masterId
masterIdThe unique identifier created by Helix used to group related transactions together that caused this event.
merchantCity
merchantCityThe city of the merchant at which the transaction originated. Applicable only to debit card events.
merchantCountryCode
merchantCountryCodeThe two-character country abbreviation of the merchant at which the transaction originated. Applicable only to debit card events.
merchantGroupTypeCode
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.
merchantId
merchantIdThe identification code of the merchant that accepted the card information. Applicable only to debit card events.
merchantLocation
merchantLocationThe location of the merchant at which the transaction originated. Applicable only to debit card events.
merchantStateCode
merchantStateCodeThe two-character state abbreviation of the merchant at which the transaction originated. Applicable only to debit card events.
merchantZipCode
merchantZipCodeThe postal code of the merchant at which the transaction originated. Applicable only to debit card events.
modifiedById
modifiedByIdThe customerId or the Admin userId that last modified the transaction.
networkProviderTypeId
networkProviderTypeIdThe ID of the card's network provider. Applicable only to debit card events. Possible values:1: Shazam2: Visa DPS
panEntryModeTypeCode
panEntryModeTypeCodeThe method by which the card number was input to the merchant's device. Valid values include:KEY: Manually (key) enteredMAG: Magnetic stripe readMAN: Manual, no terminalUNK: Unknown
PANSourceType
PANSourceTypeConditionally sent by the acquirer. Valid values include:01: Key Entered02: On File03: Mobile Banking App04: PAN Source05: Chip dip06: Contactless tap
payloadTypeId
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.
pinEntryModeTypeCode
pinEntryModeTypeCodeThe method by which the card holder was validated at the merchant's device. Valid values include:N/A: Not ApplicablePIN: Network Provider-verified PINPWD: Password authentication
pinValidationCode
pinValidationCodeIndicates successful PIN validation. Applicable only to debit card events.
programId
programIdUnique Helix program ID for the program that owns the event. Possible values: Numeric Helix program ID.
provisionalCreditReversalApplied
provisionalCreditReversalAppliedApplicable only to Visa DPS debit card events; null when networkProviderTypeId is not 2. Indicates whether provisional credit reversal coverage was used for the originating transaction. Valid values include:1: Coverage was used for the originating transaction0 or null: Coverage was not used
provisionalCreditReversalAmount
provisionalCreditReversalAmountApplicable only to Visa DPS debit card events; null when networkProviderTypeId is not 2. The original provisional credit reversal amount established on the coverage record. Represents the total coverage that was made available for this account.
provisionalCreditReversalAvailableCoverageAmount
provisionalCreditReversalAvailableCoverageAmountApplicable only to Visa DPS debit card events; null when networkProviderTypeId is not 2. The remaining coverage amount available at the time of the transaction, after any prior usage has been deducted from the original coverage amount.
provisionalCreditReversalUsedAmount
provisionalCreditReversalUsedAmountApplicable only to Visa DPS debit card events; null when networkProviderTypeId is not 2. The amount of provisional credit reversal coverage consumed for the originating transaction to supplement an insufficient account balance.
provisionalCreditReversalUsageDate
provisionalCreditReversalUsageDateApplicable only to Visa DPS debit card events; null when networkProviderTypeId is not 2. The date and time at which provisional credit reversal coverage was consumed for the originating transaction.
provisionalCreditReversalWindowExpireDate
provisionalCreditReversalWindowExpireDateApplicable only to Visa DPS debit card events; null when networkProviderTypeId is not 2. The date and time at which the provisional credit reversal window expires. Coverage cannot be applied after this date.
purchaseAmount
purchaseAmountThe amount of the purchase for the transaction. Applicable only to debit card events.
receiptId
receiptIdThe unique identifier of a mobile check deposit record. Applicable only to mobile check deposit events.
rejectDate
rejectDateThe date the mobile check deposit was rejected by the bank. Applicable only to mobile check deposit events.
rejectReason
rejectReasonThe reason the mobile check deposit was rejected by the bank. Applicable only to mobile check deposit events.
requestTypeCode
requestTypeCodeThe 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
responseCodeVisa DPS response code to Risk Factor message. Valid values include:24: Visa cannot accept msg25: Wrong PAN27: Invalid Data28: File currently open and in use29: Update failed
returnCode
returnCodeThe ACH-specified return code applied to the transaction.
settledDate
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.
submissionDate
submissionDateThe date the mobile check deposit was originally submitted by the customer. Applicable only to mobile check deposit events.
subType
subTypeA 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
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.
surchargeAmount
surchargeAmountThe 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.
tag
tagA caller-specified unique value to represent the transaction that caused this event.
terminalId
terminalIdThe identification code of the device at the merchant that accepted the card information. Applicable only to debit card events.
terminalPremisesTypeCode
terminalPremisesTypeCodeLocation of the merchant's device in relation to the merchant's location. Valid values include:ECOMM: Electronic CommerceOFFPREM: Off premiseONPREM: On premise
terminalUnattendedTypeCode
terminalUnattendedTypeCodeValid values include:ATTENDED: Terminal was attendedNOTERM: No terminalUNATTENDED: Terminal was unattended
toAccountAmount
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.
toAccountId
toAccountIdThe unique identifier for the customer account that was credited.
toAccountNumberMasked
toAccountNumberMaskedMasked version of the account number of the customer account that was credited. e.g. ********1234
toAvailableAmount
toAvailableAmountBalance available for immediate withdrawal from the customer account that was credited after the credit was applied.
toCategory
toCategoryThe caller-specified category to which the customer account that was credited belongs.
toCreatedDate
toCreatedDateDate the customer account was created.
toCustomField1
toCustomField1A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField2
toCustomField2A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField3
toCustomField3A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField4
toCustomField4A caller-specified, freeform value assigned to the customer account that was credited.
toCustomField5
toCustomField5A caller-specified, freeform value assigned to the customer account that was credited.
toLegalName1
toLegalName1The first legal name used to identify the customer account that was credited.
toLegalName2
toLegalName2The second legal name used to identify the customer account that was credited.
toName
toNameA caller-specified, user-friendly name for the customer account that was credited.
toPendingAmount
toPendingAmountBalance of pending deposit transactions on the customer account that was credited, after the credit was applied.
toPrimaryCustomerId
toPrimaryCustomerIdDenotes the customer considered the primary owner for the account that was credited.
toSubCategory
toSubCategoryThe caller-specified subcategory to which the customer account that was credited belongs.
toTag
toTagA caller-specified, unique identifier for the customer account that was credited.
toTargetAmount
toTargetAmountThe amount the customer wants the toAvailableAmount to reach on the account that was credited.
toTargetDate
toTargetDateThe date the customer would like the toTargetAmount to be reached on the account that was credited.
toTargetMetDate
toTargetMetDateThe first date the availableAmount reached or exceeded the targetAmount on the account that was credited.
transactionId
transactionIdThe unique identifier created by Helix for the particular transaction that caused this event.
transactionStatus
transactionStatusCurrent status of the transaction represented by the event. Possible values: Transaction status string/code from the transaction object.
transactionTag
transactionTagClient-provided tag for the related transaction. Possible values: Freeform transaction tag string.
type
typeA human-readable representation of the type of transaction that caused this event.
typeCode
typeCodeProgrammatic value for the type of transaction that caused this event. See the typeCode property on the transaction object for possible values.
version
versionThe version of the payload in the data node.
visaRiskFactorRequestId
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.
voidedDate
voidedDateThe date the transaction was voided in Helix.
Updated 5 days ago

