Property Glossary

Defines aliases and properties that can appear in realtime event payloads.

Alias And Property Glossary

aa

MessageTypeIndicator Identifies the kind of original card-network request message. Possible values:
0100: Authorization Request
0101: Authorization Request Repeat
0110: Authorization Response
0120: Authorization Advice
0121: Authorization Advice Repeat
0130: Authorization Advice Response
0200: Financial Request
0201: Financial Request Repeat
0210: Financial Response
0220: Financial Advice
0221: Financial Advice Repeat
0230: Financial Advice Response
0382: Card Issuer File Update Request (AP)
0392: Card Issuer File Update Response (AP)
0420: Acquirer Reversal Advice
0421: Acquirer Reversal Advice Repeat
0430: Acquirer Reversal Response
0600: Administrative Request
0601: Administrative Request Repeat
0610: Administrative Response
0620: Administrative Advice

ab

OutputMessageTypeIndicator Identifies the response/output message type sent back through the network. Possible values:
0110: Authorization Response
0130: Authorization Advice Response
0210: Financial Response
0230: Financial Advice Response
0392: Card Issuer File Update Response (AP)
0430: Acquirer Reversal Response
0610: Administrative Response

ac

OutputResponseCode 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

SystemTraceAuditNumber Network trace number used to locate the transaction with the network provider. Possible values: Usually a six-digit numeric string, for example 000055.

ae

MerchantCategoryCode Merchant category code describing the merchant type. Possible values:
Four-digit MCC, for example 5411
5947
6010
6011

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: Three-digit numeric country code, for example 840 for the United States.

ag

PointOfServicePanEntryMode How the card number/PAN was entered at the point of sale. Possible values:
01: manual
02: magnetic stripe
03: optical code
04: OCR
05: integrated circuit card/chip
06: key entered
07: contactless chip using chip data rules
81: stored
82: digitally stored mobile browser
84: MICR
90: full magnetic stripe read
91: contactless using magnetic-stripe data rules
95: chip with possibly unreliable CVV, or unspecified/blank

ah

PointOfServicePinEntryMode How PIN entry was handled at the point of sale. Possible values:
0: unspecified
1: PIN entry capability
2: no PIN entry capability
6: PIN pad inoperative

ai

TransactionFeeAmount Fee amount associated with the transaction in transaction currency. Possible values: Decimal amount when present.

aj

SettlementFeeAmount Fee amount used for network settlement. Possible values: Decimal amount when present.

ak

Track2Data_ServiceCode Service code read from track 2 card data. Possible values: Typically a three-digit service code.

al

RetrievalReferenceNumber Network retrieval reference number used to locate/support the transaction. Possible values: Usually a 12-character numeric string.

am

ResponseCode Response/status code received from the original request message. Possible values:
00: Approved or completed successfully
01: Refer to card issuer
02: Refer to card issuer, special conditions
03: Invalid merchant
04: Pick-up card
05: Do not honor
06: Error
07: Pick-up card, special conditions
08: Honor with identification
09: Request in progress
10: Approved for partial amount
11: Approved (VIP)
12: Invalid transaction
13: Invalid amount
14: Invalid card number (no such number)
15: No such issuer
16: Approved, update Track 3
19: Re-enter transaction
20: Invalid response
23: Unacceptable transaction fee
24: File update not supported by receiver
25: Unable to locate record on file
26: Duplicate file update record, no action
27: File update field edit error
28: File update record locked out
29: File update not successful, contact acquirer
30: Format error
31: Bank not supported by switch
33: Expired card, pick-up
34: Suspected fraud, pick-up
35: Card acceptor contact acquirer, pick-up
36: Restricted card, pick-up
37: Card acceptor call acquirer security, pick-up
38: Allowable PIN tries exceeded, pick-up
39: No credit account
40: Requested function not supported
41: Lost card, pick-up
42: No universal account
43: Stolen card, pick-up
44: No investment account
45: Check rejected - NSF
46: Check rejected - stop payment
47: Check rejected - two signatures required
48: Check rejected - closed account
49: Check rejected - other reason
50: Check rejected - hold on funds
51: Insufficient funds
52: No checking account
53: No savings account
54: Expired card
55: Incorrect PIN
56: No card record
57: Transaction not permitted to cardholder
58: Transaction not permitted to terminal
59: Suspected fraud
60: Card acceptor contact acquirer
61: Exceeds amount limit
62: Restricted card
63: Security violation
65: Exceeds frequency limit
66: Card acceptor call acquirer security
67: Hard capture, pick-up
75: Allowable number of PIN tries exceeded
76: Key synchronization error
87: Check already posted
88: Information not on file
89: Card verification value (CVV) verification failed; no pickup
90: Cutoff is in progress
91: Issuer or switch is inoperative
92: Financial institution or intermediate network unknown for routing
93: Transaction cannot be completed; violation of law
94: Duplicate transaction
96: System malfunction
D1: NSF - overdraft fee eligible
R0: Payment cancellation order
R1: Revocation of authorization order
R3: Preauthorized payment revocation order
X4: Consumer transaction controls decline

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: Two-character alpha country code, for example US or GB.

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:
0: PIN was invalid
1: PIN was valid
2: 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

AdditionalAmounts_Purchase Purchase portion of additional amounts supplied by the network. Possible values: Decimal amount, often 0.0 when not applicable.

aq

AdditionalAmounts_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

AdditionalFees_CCA Cardholder/acquirer additional fee amount supplied by the network. Possible values: Decimal amount, often 0.0 when not applicable.

au

AdditionalFees_ICA Interchange or issuer/acquirer additional fee amount supplied by the network. Possible values: Decimal amount, often 0.0 when not applicable.

av

NationalPointOfServiceCondition_TerminalUnattended Indicates whether the terminal was attended or unattended. Possible values:
0: attended
1: unattended

aw

NationalPointOfServiceCondition_TerminalOperator Indicates who operated the terminal. Possible values:
0: customer operated
1: card acceptor operated
2: administrative

ax

NationalPointOfServiceCondition_TerminalPremises Indicates whether the terminal was on/off merchant premises or ecommerce. Possible values:
0: on premise
1: off premise
3: electronic commerce

ay

NationalPointOfServiceCondition_CardPresentation Indicates whether/how the customer was present for the transaction. Possible values:
0: customer present
1: customer not present
2: mail/telephone order unknown classification
4: recurring
5: installment
6: account top-up
8: pre-authorized purchase
9: single mail/telephone order

az

NationalPointOfServiceCondition_CardPresence Indicates whether the card was present. Possible values:
0: card present
1: card not present
8: pre-authorized purchase

ba

NationalPointOfServiceCondition_CardRetention Indicates whether the terminal can retain the card. Possible values:
0: no card-retention capability
1: has card-retention capability

bb

NationalPointOfServiceCondition_CardTransaction Describes special card-transaction handling. Possible values:
1: incremental authorization
2: delayed charges
3: no-show
4: merchant authorized transaction
5: resubmission
6: reauthorization

bc

NationalPointOfServiceCondition_SecurityCondition Describes POS/security-related transaction condition. Possible values:
0: unspecified
1: incremental authorization
2: delayed charges
3: no-show
4: merchant authorized transaction
5: resubmission
6: reauthorization
8: unspecified; examples can show 0 and 8

bd

NationalPointOfServiceCondition_TerminalType Identifies the terminal or acceptance channel. Possible values:
00: Administrative terminal
01: POS terminal
02: ATM
03: Home terminal
04: ECR
05: Dial terminal
06: Travelers check machine
07: Fuel machine
08: Scrip machine
09: Coupon machine
10: Ticket machine
11: Point-of-banking terminal
12: Teller
13: Franchise teller
14: Personal banking
15: Public utility
16: Vending
17: Self-service
18: Authorization
19: Payment
20: VRU
21: Smart phone
22: Interactive television
23: PDA
24: Screen phone
25: Internet terminal
26: MICR terminal
27: Mobile acceptance solution

be

NationalPointOfServiceCondition_TerminalEntryCapability Identifies what entry methods the terminal supports. Possible values:
0: unknown
1: manual/no terminal
2: magnetic stripe
3: QR code
4: OCR
5: ICC/chip
6: key entered
9: file
S: MICR reader
T: contactless
U: contactless via magnetic-stripe rules

bf

Advice_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 0
1: Timed-out request
2: Issuer not available
3: Issuer signed off
4: Within business agreement
5: POS alternate authorization
6: POS merchant authorization
7: POS switch authorization under floor limit
8: Encryption key not established
9: AFD completion advice
A: Merchant fraud assessment decline
B: Transaction blocked
C: Suspended
D: Deactivated
E: Batch clearing from dual-message merchant
F: Clearing below floor limit
G: Clearing with no authorization performed
H: Clearing of an authorized transaction
I: Clearing of an unauthorized transaction

bg

PrivatelyDefinedData_AcquirerNetworkIdCode Network from which DPS acquired the transaction. Possible values:
Network identifier, examples VSN
MNP
APT

bh

PrivatelyDefinedData_AdditionalTransactionElement_FallbackIndicator Shows whether the transaction fell back to magnetic stripe when chip/contactless was expected. Possible values:
Blank or 0: not fallback
1: fallback

bi

PrivatelyDefinedData_ProcessingFlag_SpecialTransactionIndicator Flags special transaction handling. Possible values:
A: ASI
B: token account verification
C: cloud/HCE
D: device binding
T: tokenized
V: Verified by Visa enrollment
Blank: no special handling

bj

PrivatelyDefinedData_ProcessingFlag_ISAIndicator Visa international service assessment indicator for currency/fee assessment. Possible values:
C: single-currency ISA
S: multi-currency ISA
R: assessed and rebated
Blank: not applicable

bk

PrivatelyDefinedData_ProcessingFlag_PartialAuthIndicator Whether the acquirer supports partial authorization. Possible values:
Y: supports partial auth
Blank: does not support partial auth

bl

PrivatelyDefinedData_RiskData_ScoreSource Source of network risk score data. Possible values:
0: no Falcon processing
1: Online
2: Online Plus
3: Real-Time
Blank: not populated

bm

PrivatelyDefinedData_RiskData_ScoreValue Risk score value from the network risk source. Possible values:
Falcon score 0000 to 0999; higher means more likely fraud
9998: or 9999 can mean fraud-monitoring suppression
Blank-filled: when not populated

bn

PrivatelyDefinedData_RiskData_ResponseCode Response code from the Falcon/network risk service. Possible values:
0: no response generated
1: approve
2: decline
3: refer
4: approve with identification
5: pick up card
Blank: not applicable

bo

PrivatelyDefinedData_RiskData_FalconReason1 First Falcon fraud/risk reason code. Possible values:
00: no code
01: unusual time
02: unusual MCC
03: high-risk MCC
04: suspicious high dollar
05: suspicious dollar amounts
06: suspicious geographic
07: suspicious approve/decline
08: suspicious auth velocity
09: suspicious post velocity
10: suspicious transaction type
11: suspicious account info
12: suspicious keyed activity
13: high-risk keyed activity
14: suspicious ATM cash
15: suspicious non-ATM cash
16: suspicious cash
17: suspicious phone
18: suspicious unattended gas
19: suspicious CAT activity
20: high-risk MCC amount
21: suspicious foreign activity
22: CVV/expiration mismatch
51: suspicious payment activity
52: suspicious payment amount
53: suspicious payment amount numbers
Blank-filled: not applicable

bp

PrivatelyDefinedData_RiskData_FalconReason2 Second Falcon fraud/risk reason code. Possible values: Same value set as bo.

bq

PrivatelyDefinedData_RiskData_FalconReason3 Third Falcon fraud/risk reason code. Possible values: Same value set as bo.

br

PrivatelyDefinedData_RiskData_VisaRiskScore Visa risk score for the transaction. Possible values:
Visa score/code, examples 09
87
Blank: not applicable

bs

PrivatelyDefinedData_RiskData_VisaRiskReason Visa risk reason explaining the risk score. Possible values:
Visa reason code, example 5A
Blank-filled: not applicable

bt

PrivatelyDefinedData_RiskData_VisaRiskConditionCode1 First Visa risk condition code. Possible values:
Visa condition code, examples 02
15
Blank: not applicable

bu

PrivatelyDefinedData_RiskData_VisaRiskConditionCode2 Second Visa risk condition code. Possible values:
Visa condition code, example C2
Blank: not applicable

bv

PrivatelyDefinedData_RiskData_VisaRiskConditionCode3 Third Visa risk condition code. Possible values:
Visa condition code, examples 00
BT
Blank: not applicable

bw

PrivatelyDefinedData_RiskData_VAAConditionCode1Rank Rank/priority for Visa advanced-authorization condition code 1. Possible values:
2: high risk for fraud
1: medium risk for fraud
0: low risk for fraud
Blank: not applicable

bx

PrivatelyDefinedData_RiskData_RTDResultCode Real-time decisioning result code from network risk data. Possible values:
D: declined by RTD
R: referred by RTD
Blank: no RTD result

bz

PrivatelyDefinedData_RiskData_TravelStatusIndicator Indicates travel-related risk/status for the cardholder or transaction. Possible values:
A: cardholder may be traveling and destination matches
B: cardholder may be traveling and destination unknown
Blank: no travel status

ca

NetworkManagementInformationCode Network management information code for Falcon network-management or error messages. Possible values:
830: Falcon case management message
831: Falcon action
832: Falcon comment
850: Falcon online scoring request message
851: Falcon real-time scoring request message
900: message format / syntax error message

cb

FalconCaseStatus Status of the Falcon fraud case. Possible values: Falcon status code when present.

cc

FalconCaseSubStatus More specific Falcon fraud case status. Possible values: Falcon substatus code when present.

cd

FalconBlockCode Falcon block code applied to the card or transaction. Possible values: Falcon block code when present.

ce

FalconFraudCode Falcon fraud classification code. Possible values: Falcon fraud code when present.

cf

Cvv2PresenceIndicator Indicates whether CVV2 was present in the authorization. Possible values:
0: CVV2 bypassed/not provided
1: CVV2 present
2: CVV2 on card but illegible
9: cardholder says card has no CVV2 imprint

cg

Cvv2Result Result of CVV2 verification. Possible values:
M: match
N: no match
P: not processed
S: should be on card but merchant says not present
U: issuer not certified or keys not provided

ch

Token Token value associated with a tokenized card transaction. Possible values: Token string when present.

ci

TokenAssuranceLevel Confidence/assurance level for the payment token. Possible values: Network token assurance code when present.

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:
40010030273: Apple Pay
40010075001: Google Pay
40010043095: Samsung Pay
40010075338: Visa Checkout
40010075449: Facebook
40010075839: Netflix

ck

TokenExpirationDate Expiration date for the token. Possible values: Date-like network value when present.

cl

PaymentAccountReferenceNumber Stable reference tying tokenized credentials back to the underlying payment account. Possible values: Payment account reference string, example 10010014621056636090615846428.

cm

PrivatelyDefinedData_TransactionLevel_CredentialOnFileIndicator Indicates whether the transaction used a credential/card on file. Possible values: Network flag, examples N or blank.

cn

PrivatelyDefinedData_TransactionLevel_CryptocurrencyPurchaseIndicator Indicates whether the transaction was a cryptocurrency purchase. Possible values: Network flag, examples N or blank.

co

AvsResult Address Verification Service result. Possible values:
A: street address only partial match
N: non-match
R: indeterminate/retry
U: unable to verify
Y: full match
Z: postal/ZIP only partial match

cp

Advice_OriginatorCode Identifies who originated an advice message. Possible values:
0: not an advice
1: card acceptor
2: acquirer
3: stand-in agent

cq

Card 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

Card Control Rule Tag Client tag of the card-control rule that matched. Possible values: Rule tag string when a rule matched.

cs

Card Control Rule Source Who owns the matched card-control rule. Possible values:
Customer
Program
null: or omitted when not applicable

ct

Card Control Result Result of the matched card-control rule. Possible values:
0: declined
1: allowed

cu

In Auth Program Result Program/client's In Auth decision for the authorization. Possible values:
1: Approve
2: Decline
3: Abstain

cv

In Auth Helix Result Helix's result for the In Auth call to the program. Possible values:
1: Success
2: Error
3: Timeout
4: Customer token not set
5: Program HTTP error
6: Unknown timeout

cw

Program Response Duration in Ms How long the program's In Auth response took, in milliseconds. Possible values: Integer millisecond duration.

cx

Tap-to-Phone Indicator Identifies transactions initiated through Tap to Phone/contactless acceptance. Possible values: Network indicator, example 0001.

cy

Card 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

Card Lock Reason Type Code Reason the card lock was applied. Possible values:
UNK: Unknown
STL: Stolen
LST: Lost
FRD: Suspected fraud
DMG: Physical damage
DMR: Prepaid in-branch replacement with stock card
ADM: Administrative
TMP: Temporary
PIN: PIN retry exceeded
NAM: Name change
UPG: Due to upgrade
DEC: Deceased
ESC: Escheatment
DES: Destroyed
ACL: Account closure
STA: Stale
VOD: Voided

da

Card Lock Type Code Type of card lock currently applied. Possible values:
UNL: Unlocked
CST: Customer locked
SYS: System locked

db

Visa Transaction ID Visa DPS original transaction identifier. Possible values: Visa transaction identifier string, for example 000055202507289.

dc

Transaction Local Date Local date of the transaction at the merchant/acquirer. Possible values:
MMDD-style string, for example 0326
1116.

dd

Transaction Local Time Local time of the transaction at the merchant/acquirer. Possible values:
HHMMSS-style string, for example 022827
160135.

de

PrivatelyDefinedData_RiskData_MasterCardFraudScore Mastercard fraud score; higher values generally mean higher risk. Possible values:
Three-character score/code
XXX: unable to return score
ZZZ: fraud server unavailable
Blank-filled: not populated

df

PrivatelyDefinedData_RiskData_MasterCardRiskCondition1 First Mastercard fraud condition indicator. Possible values: Mastercard condition code, examples 00 or blank-filled.

dg

PrivatelyDefinedData_RiskData_MasterCardRiskCondition2 Second Mastercard fraud condition indicator. Possible values: Mastercard condition code, examples 00 or blank-filled.

dh

PrivatelyDefinedData_RiskData_MasterCardFraudScoreReason Reason associated with the Mastercard fraud score. Possible values: Mastercard reason code, examples 00 or blank-filled.

di

In Auth Reason Code Program-supplied reason code for an In Auth result. Possible values: Program-defined reason code when supplied.

dj

CardholderCustomerId Customer ID for the business cardholder who performed the card transaction. Possible values: Numeric Helix customer ID; 0 can appear when not applicable.

dk

RSM Rule ID Risk Services Manager rule that caused a debit-card decline. Possible values: RSM rule identifier.

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:
Three-digit numeric currency code, for example 840 for USD
978 for EUR, including Bulgaria-originated original Visa DPS transactions after December 31, 2025 at 22:00 GMT.

dm

TransactionAmount Amount requested by the cardholder in local transaction currency, excluding transaction fee. Possible values:
Decimal amount, examples 0.0
20.0
2000.0.

dn

SettlementAmount Amount transferred between acquirer and issuer for settlement. Possible values: Decimal amount, example 400.0.

do

SettlementConversionRate Rate used to convert transaction amount to settlement amount. Possible values: Decimal/rate value when conversion applies.

dp

TransmissionDateTime Date and time the network request was transmitted. Possible values:
MMDDHHMMSS-style string, for example 0326022827
1021220135.

dq

CardIssuanceType Type of card issuance. Possible values:
Physical
Digital with Physical
Digital without Physical
Virtual

dr

AcquirerId Acquiring institution identifier. Possible values:
Acquirer/IID string, examples 12345678901
59123456789.

ds

PrivatelyDefinedData_TransactionLevel_3DSIndicator 3-D Secure version/authentication method indicator. Possible values:
0: 3DS 1.0.2
1: static passcode
2: SMS OTP
3: key fob/card reader OTP
4: app OTP
5: other OTP
6: KBA
7: OOB biometric
8: OOB app login
9: other OOB
A: other method
B: unrecognized
C: push confirmation
D: frictionless RBA review
E: attempts server
F: frictionless RBA
G: ACS-specific/MC 3DS 1.0
H: ACS-specific 2/MC 3DS 2.0
I: through K ACS-specific methods
L: delegated trusted auth
M: decoupled
N: WebAuthn
O: secure payment confirmation
P: behavioral biometrics
Z: unknown
Blank: not applicable

dt

LargePrivateData_Ecommerce_3DSBrowserIPAddress Browser IP address from the 3DS requestor context. Possible values: IP address string.

du

LargePrivateData_Ecommerce_3DSAppIPAddress Public device/app IP address used by the 3DS requestor app. Possible values: IP address string.

dv

LargePrivateData_Ecommerce_3DSDeviceID Device identifier used across 3DS transactions for the same device. Possible values: Device ID string.

dw

LargePrivateData_Ecommerce_3DSDeviceType Device type used for the 3DS transaction. Possible values:
01: desktop
02: TV connected
03: tablet/mobile
04: headless/voice
05: wearable
06: IoT
99: other

dx

LargePrivateData_Ecommerce_CAVVType Type/version of CAVV authentication value data. Possible values: Network CAVV type code when present.

dy

CAVV_3DSResultsCode Result code from 3DS/CAVV validation. Possible values: Network 3DS/CAVV result code when present.

dz

AuthenticationMethod Authentication method used for the ecommerce/3DS transaction. Possible values: Network authentication method code when present.

ea

SecureAuthenticationResultCode Secure-authentication result code. Possible values: Network secure-auth result code when present.

eb

CAVV_KeyIndicator Key indicator used with CAVV data. Possible values: Network CAVV key indicator when present.

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.

authorizationTransactionId

The transactionId of the authorization that this transaction completed.

availableDate

The date the funds associated with the transaction were applied to the availableAmount and therefore made available for withdrawal.

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.

checkAmount

The amount of the mobile check deposit that was submitted. Applicable only to mobile check deposit events.

checkDepositAmount

The amount of the check deposited by the transaction. Applicable only to debit card 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.

createdDate

The date the transaction was first created in Helix.

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.

customerId

Unique Helix customer ID related to the event. Possible values: Numeric Helix customer ID.

customerTag

Client-provided customer tag for the impacted/customer record, when available. Possible values: Freeform client tag string.

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:
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.

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.

fromAccountId

The unique identifier for the customer account that was debited.

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 impactedCustomerId for customer-level events. Possible values: Numeric Helix user ID.

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: Boolean-style value when present, typically true or false.

lastCustomerContactType

Channel/type of the customer's most recent contact. Possible values: Contact-type code from customer contact configuration.

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 the card's network provider. Applicable only to debit card events. Possible values:
1: Shazam
2: Visa DPS

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

Unique Helix program ID for the program that owns the event. Possible values: Numeric Helix program ID.

provisionalCreditReversalApplied

Applicable 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 transaction
0 or null: Coverage was not used

provisionalCreditReversalAmount

Applicable 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

Applicable 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

Applicable 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

Applicable 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

Applicable 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

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 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.

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

Current status of the transaction represented by the event. Possible values: Transaction status string/code from the transaction object.

transactionTag

Client-provided tag for the related transaction. Possible values: Freeform transaction tag string.

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.