Debit Card Event Notification File
This is an extension file
This file is an extension of the master Event Notification File and is meant to provide additional data points for debit card events. A single event will appear in both files and share the same
UserEventId
.
Debit Card Event Notification File Definition
The Debit Card Event Notification File is created by Helix on an hourly basis. It has the following properties:
- Fixed-length
- ANSI encoded
- Line endings are Windows-style CarriageReturn + LineFeed (
\r\n
, or0x0D0A
) - File will be available in the relative directory of
/EventNotification
- File name follows a specific, case-sensitive pattern of:
yyyyMMddhhmm_DEBITCARDEVENTNOTIFICATION.TXT
Format Disclaimer
Helix reserves the right to append new field(s) to the end of any Header or Content line without notice. This is to allow new data points to be added as needed in a timely fashion.Implementation Note
Your code should be written such that unexpected characters after the "last" field but prior to the end of each line should be ignored. That is, if the file is documented as being 872 bytes per line, receiving a file with 984 bytes per line should not disrupt your processing. This applies to both Header and Content lines.File Name Disclaimer
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on theFileCreatedDate
orFileEffectiveDate
contained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.
Header Row
Property | Data Type (Length) | Alignment | Start Position | Description |
---|---|---|---|---|
RecordType | string (1) | Left | 1 | The flag for the header row. Will always be H . |
FileName | string (50) | Left | 2 | The name of this request file excluding path. Format: yyyyMMddhhmm_DEBITCARDEVENTNOTIFICATION.TXT Example: 201901210939_DEBITCARDEVENTNOTIFICATION.TXT |
RecordCount | integer (10) | Right | 52 | The number of records represented within the file. This field is zero-padded on the left side. Example: 0000000872 |
FileCreatedDate | datetime (34) | Left | 62 | The date the file was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines |
FileEffectiveDate | datetime (34) | Left | 96 | The date to which the data in the file pertains. Follows same format as API. Example: 2014-10-20T23:59:59.999-05:00 See data format guidelines |
Content Row
Property | Data Type (Length) | Alignment | Start Position | Description |
---|---|---|---|---|
UserEventID | integer (19) | Right | 1 | The unique identifier for an event. Use this field alone to cross reference against the Event Notification File or the Realtime Event sent via Azure Service Bus. This field is zero-padded on the left side. Example: 0000000872 |
CustomerId | integer (10) | Right | 20 | The Helix-assigned unique ID for a customer. This field is zero-padded on the left side. Example: 0000000872 |
CardId | integer (10) | Right | 30 | The Helix-assigned unique ID for the card to which this event applies. This field is zero-padded on the left side. Example: 0008309285 |
TransactionId | integer (19) | Right | 40 | The Helix-assigned unique ID for the transaction object to which this event applies. May be 0000000000 if this event does not apply to a specific transaction. This field is zero-padded on the left side.Example: 0008309285 |
AuthorizationTransactionId | integer (19) | Right | 59 | The unique identifier for the associated authorization transaction. May be 0000000000 if it does not apply. This field is zero-padded on the left side.Example: 0008309285 |
RequestTypeCode | string (3) | Left | 78 | The method of request from the debit rails. Possible values: - REQ : (Request; Helix approved or denied the message)- ADV : (Advice; The network provider approved or denied the message and notified Helix afterwards). |
RESERVED | string (12) | Left | 81 | This range of bytes is reserved for future use. |
MerchantCategoryCode | string (4) | Left | 93 | The exact Merchant Category Code value received from the network provider. |
MerchantGroupTypeCode | string (6) | Left | 97 | A grouping of multiple Merchant Category Codes into fewer, more useful sets. See Merchant Group Codes for more information. |
CashbackAmount | integer (10) | Right | 103 | The amount of cashback provided when the transaction occurred. This field is zero-padded on the left side and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
SurchargeAmount | integer (10) | Right | 113 | The amount of the surcharge applied when the transaction occurred. This field is zero-padded on the left side and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
CashDepositAmount | integer (10) | Right | 123 | The amount of cash deposited when the transaction occurred. This field is zero-padded on the left side and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
CheckDepositAmount | integer (10) | Right | 133 | The amount of the check deposited when the transaction occurred. This field is zero-padded on the left side and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
TerminalId | string (15) | Left | 143 | The identification code of the device at the merchant that accepted the card information. |
MerchantId | string (15) | Left | 158 | The identification code of the merchant that accepted the card information. |
MerchantLocation | string (25) | Left | 173 | The location of the merchant at which the transaction originated. |
MerchantCity | string (13) | Left | 198 | The city of the merchant at which the transaction originated. |
MerchantStateCode | string (2) | Left | 211 | The two-character state abbreviation of the merchant at which the transaction originated. |
MerchantZipCode | string (9) | Left | 213 | The postal code of the merchant at which the transaction originated. |
MerchantCountryCode | string (2) | Left | 222 | The two-character country abbreviation of the merchant at which the transaction originated. |
PanEntryModeTypeCode | string (10) | Left | 224 | The method by which the card number was input to the merchant's device. Possible values for Shazam: - KEY : Manually (key) entered- MAG : Magnetic stripe read- MAN : Manual, no terminal- UNK : UnknownPossible values for Visa DPS:- UNK : Unknown- MAN : Manual/no terminal- MAG : Magnetic stripe read- QRC : QR code- OCR : OCR- ICC : Integrated Circuit Card- KEY : Key entered- FIL : File- MCR : MICR reader- CLS : Contactless- CLM : Contactless via Mag Stripe Rules |
PinEntryModeTypeCode | string (10) | Left | 234 | The method by which the card holder was validated at the merchant's device. Possible values: - N/A : Not Applicable- PIN : Network Provider-verified PIN- PWD : Password authentication- NOPIN : NO PIN entry capability- PININOP : PIN pad inoperative |
CardHolderPresenceTypeCode | string (10) | Left | 244 | The presence of the card holder at the time the transaction was originated. Possible values for Shazam: - 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 : WebPossible values for Visa DPS:- INSTALL : Installment Payment- MAILTEL : Mail/Telephone Order (unknown classification)- NOTPRESENT : Customer not present- PRESENT : Customer present- RECUR : Recurring transaction- TOPUP : Account top up- MAILTEL1 : Single transaction for Mail/Telephone Order |
CardPresenceTypeCode | string (10) | Left | 254 | The presence of the physical card at the time the transaction was originated. Possible values for Shazam: - NOTPRESENT : Card not present- PRESENT : Card presentPossible values for VisaDPS:- NOTPRESENT : Card not present- PRESENT : Card present- PREAUTH : Pre-authorized purchase |
TerminalUnattendedTypeCode | string (10) | Left | 264 | Possible values: - ATTENDED : Terminal was attended- NOTERM : No terminal- UNATTENDED : Terminal was unattended |
TerminalPremisesTypeCode | string (10) | Left | 274 | Location of the merchant's device in relation to the merchant's location. Possible values: - ECOMM : Electronic Commerce- OFFPREM : Off premise- ONPREM : On premise |
CustomerTag | string (50) | Left | 284 | The tag property of the customer object. |
CardTag | string (50) | Left | 334 | The tag property of the card object. |
Amount | integer (10) | Right | 384 | The amount of funds this transaction represents. This field is zero-padded on the left side and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
AvailableDate | datetime (34) | Left | 394 | The date the transaction was made available / is projected to be made available. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines |
CreatedDate | datetime (34) | Left | 428 | The date the transaction was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines |
CustomField1 | string (50) | Left | 462 | The customField1 property of the transaction object. |
Description | string (255) | Left | 512 | The NACHA-supplied description for this transaction. |
DenialReason | string (255) | Left | 767 | Text describing why a transaction was denied from taking place. |
FeeCode | string (3) | Left | 1022 | The programmatic value for the type of fee this transaction represents. Possible values: - RGD : Regulation D Fee- RTN : Return Item Fee- NSF : Insufficient Funds Fee |
FeeDescription | string (50) | Left | 1025 | A human-readable description of the feeCode |
FriendlyDescription | string (255) | Left | 1075 | A human-readable, automatically generated description of the transaction that caused the event. Driven by the typeCode of the transaction. |
FromAccountAmount | integer (10) | Right | 1330 | 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. This field is zero-padded on the left side, and two decimals will be assumed. e.g., 000000000000832 represents an amount of $8.32. |
FromAccountId | integer (10) | Right | 1340 | The unique identifier for the customer account that was debited. This field is zero-padded on the left side. Example: 0008309285 |
FromAccountNumberMasked | string (50) | Left | 1350 | Masked version of the Account number of the customer account that was debited. Example: ********1234 |
FromAvailableAmount | integer (10) | Right | 1400 | Balance available for immediate withdrawal from the customer account that was debited after the debit was applied. This field is zero-padded on the left side and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
FromCategory | string (50) | Left | 1410 | The caller-specified category to which the customer account that was debited belongs. |
FromCreatedDate | string (34) | Left | 1460 | Date the customer account was created. |
FromCustomField1 | string (50) | Left | 1494 | The customField1 property of the account object that was debited. |
FromCustomField2 | string (50) | Left | 1544 | The customField2 property of the account object that was debited. |
FromCustomField3 | string (50) | Left | 1594 | The customField3 property of the account object that was debited. |
FromCustomField4 | string (50) | Left | 1644 | The customField4 property of the account object that was debited. |
FromCustomField5 | string (50) | Left | 1694 | The customField5 property of the account object that was debited. |
FromLegalName1 | string (100) | Left | 1744 | The first legal name used to identify the customer account that was debited. |
FromLegalName2 | string (100) | Left | 1844 | A secondary legal name used to identify the customer account that was debited. |
FromName | string (50) | Left | 1944 | A caller-specified, user-friendly name for the customer account that was debited. |
FromPendingAmount | integer (10) | Right | 1994 | Balance of pending deposit transactions on the customer account that was debited, after the debit was applied. This field is zero-padded on the left side, and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
FromPrimaryCustomerId | integer (10) | Right | 2004 | Denotes the customer considered the primary owner for the account that was debited. This field is zero-padded on the left side. Example: 0008309285 |
FromSubCategory | string (50) | Left | 2014 | The caller-specified subcategory to which the customer account that was debited belongs. |
FromTag | string (50) | Left | 2064 | A caller-specified, unique identifier for the customer account that was debited. |
InstitutionName | string (50) | Left | 2114 | The name of the institution from which the transaction originated. |
MasterId | long integer (19) | Right | 2164 | The unique identifier created by Helix used to group related transactions together that caused this event. This field is zero-padded on the left side. Example: 0000000123458309285 |
ModifiedById | integer (10) | Right | 2183 | The unique identifier for the Customer, Admin User, or 0 for system generated events. This field is zero-padded on the left side. Example: 0008309285 |
PayloadTypeId | integer (10) | Right | 2193 | 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) |
SettledDate | datetime (34) | Left | 2203 | The date the transaction was settled / is projected to settle. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines |
SubType | string (255) | Left | 2237 | The description of the SubTypeCode for this transaction. |
SubTypeCode | string (6) | Left | 2492 | The Merchant Category Code of the merchant where the transaction originated. Categorizes merchants with similar lines of business together. |
Tag | string (50) | Left | 2498 | The tag property from the transaction object. |
ToAccountAmount | integer (10) | Right | 2548 | 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. This field is zero-padded on the left side and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
ToAccountId | integer (10) | Right | 2558 | The unique identifier for the customer account that was credited. This field is zero-padded on the left side. Example: 0008309285 |
ToAccountNumberMasked | string (50) | Left | 2568 | Masked version of the Account number of the customer account that was credited. Example: ********1234 |
ToAvailableAmount | integer (10) | Right | 2618 | Balance available for immediate withdrawal from the customer account that was credited after the credit was applied. This field is zero-padded on the left side and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
ToCategory | string (50) | Left | 2628 | The caller-specified category to which the customer account that was credited belongs. |
ToCreatedDate | datetime (34) | Left | 2678 | Date the customer account was created. |
ToCustomField1 | string (50) | Left | 2712 | The customField1 property of the account object that was credited. |
ToCustomField2 | string (50) | Left | 2762 | The customField2 property of the account object that was credited. |
ToCustomField3 | string (50) | Left | 2812 | The customField3 property of the account object that was credited. |
ToCustomField4 | string (50) | Left | 2862 | The customField4 property of the account object that was credited. |
ToCustomField5 | string (50) | Left | 2912 | The customField5 property of the account object that was credited. |
ToLegalName1 | string (100) | Left | 2962 | The first legal name used to identify the customer account that was credited. |
ToLegalName2 | string (100) | Left | 3062 | A secondary legal name used to identify the customer account that was credited. |
ToName | string (50) | Left | 3162 | The name property of the account object that was credited. |
ToPendingAmount | integer (10) | Right | 3212 | Balance of pending deposit transactions on the customer account that was credited, after the credit was applied. This field is zero-padded on the left side and two decimals will be assumed, e.g., 000000000000832 represents an amount of $8.32. |
ToPrimaryCustomerId | integer (10) | Right | 3222 | Denotes the customer considered the primary owner for the account that was credited. This field is zero-padded on the left side. Example: 0008309285 |
ToSubCategory | string (50) | Left | 3232 | The caller-specified subcategory to which the customer account that was credited belongs. |
ToTag | string (50) | Left | 3282 | A caller-specified, unique identifier for the customer account that was credited. |
Type | string (50) | Left | 3332 | A human-readable representation of the type of transaction that caused this event. |
TypeCode | string (6) | Left | 3382 | The typeCode of the transaction object. |
EventTypeId | integer (10) | Right | 3388 | The Event Type Id of event that occurred. |
NetworkProviderTypeId | integer (1) | Left | 3398 | The id of card's network provider. - 1 : Shazam- 2 : VisaDps |
PointOfServicePanEntryMode | string (2) | Left | 3399 | Useful when determining how the PAN was entered. - 00 : Unspecified- 01 : Manual- 02 : Magnetic stripe- 03 : Optical Code- 04 : OCR- 05 :Integrated circuit card- 06 : Manual (key-entered)- 07 : Contactless chip transaction using chip data rules- 90 : Full magnetic stripe read |
PointOfServicePinEntryMode | string (1) | Left | 3401 | Useful when determining how the PIN was entered. - 0 : Unspecified- 1 : PIN entry capability- 2 : No PIN entry capability- 6 : PIN pad inoperative |
Cvv2PresenceIndicator | string (1) | Left | 3402 | CVV2 Presence Indicator - 0 : CVV2 Value is deliberately bypassed or is not provided by the merchant- 1 : CVV2 Value is present- 2 : CVV2 Value is on the card but is illegible- 9 : Cardholder states that the card has no CVV2 imprint |
Cvv2Result | string (1) | Left | 3403 | CVV2 Result - M : Match- N : No Match- P : Not Processed- S : CVV2 should be on the card, but the merchant has indicated that CVV2 is not present- U : Issuer is not certified and/or has not provided Visa with the encryption keys |
Token | string (19) | Left | 3404 | Payment Account Reference Number (PAR) with a maximum length of 29. This field only applies if PrivatelyDefinedData_ProcessingFlags=T |
TokenAssuranceLevel | string (2) | Left | 3423 | Cardholder Verification Method. This field only applies if PrivatelyDefinedData_ProcessingFlags=T .- 1 : Unknown- 2 : None- 3 : Signature- 4 : Online PIN- 5 : Offline PIN or Passcode- 6 : Cardholder Device Code- 7 : Fingerprint biometric verified by cardholder device- 8 : Cardholder device pattern |
DigitalWalletTokenRequestorTypeId | integer (2) | Right | 3425 | Digital Commerce Indicator. This field only applies if PrivatelyDefinedData_ProcessingFlags=T .- 01 : Visa Digital Commerce- 10 : Apple Pay- 20 : Google Pay- 30 : Samsung Pay- 40 : Visa Checkout (Click to Pay)- 50 : Facebook- 60 : NetflixNote: Other tokenized merchants may be undefined |
TokenExpirationDate | string (4) | Left | 3427 | The year and month the token expires (YYMM). This field only applies if PrivatelyDefinedData_ProcessingFlags=T |
PaymentAccountReferenceNumber | string (29) | Left | 3431 | The Payment Account Reference Number |
MessageTypeIndicator | string (4) | Left | 3460 | The four-digit message type identifier from the original request message. |
OutputMessageTypeIndicator | string (4) | Left | 3464 | The four-digit message type identifier from the response message. |
OutputResponseCode | string (2) | Left | 3468 | The two-digit status code from the response message sent by Helix. |
SystemTraceAuditNumber | string (6) | Left | 3470 | The System Trace Audit Number as defined by the network provider. Useful when interfacing with the network provider's support tools or staff. |
AcquirerInstitutionCountryCode | string (3) | Left | 3476 | 3 digit numeric code for the country where the acquiring institution is located. |
AuthorizationIdentificationResponse | string (12) | Left | 3479 | The authorization code for the transaction. |
ResponseCode | string (2) | Left | 3491 | The code that defines the disposition of a message when present in a response, advice, or reversal. - 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. Use only in 03xx messages.- 25 : Unable to locate record on file. Use only in 03xx messages.- 26 : Duplicate file update record, no action. Use only in 03xx messages.- 27 : File update field edit error. Use only in 03xx messages. See Field 44 - Additional Response Data to determine the field number in error.- 28 : File update record locked out. Use only in 03xx messages- 29 : File update not successful, contact acquirer. Use only in 03xx messages.- 30 : Format error. See Field 44 - Additional Response Data to determine the field number in 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 amount- 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- LK : Cardholder Blocked- R0 - Payment Cancellation Order- R1 : Revocation of Authorization Order- R3 : Preauthorized Payment Revocation Order (block all recurring transactions for closed account)- X4 : Consumer Transaction Controls Decline |
PinValidationCode | string (1) | Left | 3493 | Indicates whether the entered PIN was Valid (1). |
AdditionalAmounts_Purchase | integer (10) | Right | 3494 | The amount of the partial pay. This field is zero-padded on the left side, and two decimals will be assumed. e.g.: 000000000000832 represents an amount of $8.32. |
AdditionalAmounts_Gratuity | int (10) | Right | 3504 | The amount of gratuity provided when the transaction occurred. This field is zero-padded on the left side, and two decimals will be assumed. e.g.: 000000000000832 represents an amount of $8.32. |
Advice_OriginatorCode | string (1) | Left | 3514 | Advice Reason Codes0 : Not an advice1 : Advice originated by card acceptor2 : Advice originated by acquirer3 : Advice originated by stand-in agent |
Advice_ReasonCode | string (1) | Left | 3515 | 0 : Not an advice (forced post)1 : Timed-out request message2 : Issuer not available (in delay)3 : Issuer signed off (logged off)4 : Within business agreement6 : POS merchant authorization8 : Encryption key not established9 : AFD Completion AdviceA : Merchant Fraud Assessment Service DeclineE : Batch clearing from dual-message (online authorization, followed by batch file clearing) merchantH : Clearing of an authorized transactionj : Visa payment fraud disruption block |
PrivatelyDefinedData_IssuerNetworkIdCode | string (3) | Left | 3516 | |
PrivatelyDefinedData_AdditionalTransactionElement_FallbackIndicator | string (1) | Left | 3519 | Indicates whether the transaction was processed as magnetic stripe even though the card and terminal are EMV capable. |
PrivatelyDefinedData_ProcessingFlag_SpecialTransactionIndicator | string (1) | Left | 3520 | The special transaction indicator - A : Payment Account Status Inquiry (ASI) Transaction- B : Token account verification- C : Cloud based payment/HCE- D : Device Binding- T : Tokenized Message- V : Verified by Visa enrollment authorization request- blank: No special transaction considerations |
PrivatelyDefinedData_ProcessingFlag_ISAIndicator | string (1) | Left | 3521 | Visa International Service Assessment, used to indicate whether a transaction is single or multi-currency. - C : Single Currency ISA (0.8%)- S : Multi-Currency ISA (1.0%)- R : ISA assessed and rebated- blank: Transaction does not qualify for fee assessment. |
PrivatelyDefinedData_ProcessingFlag_PartialAuthIndicator | string (1) | Left | 3522 | Transaction eligibility for Partial Authorization Indicator - Y : Acquirer supports a partial authorization for transaction- blank: Acquirer does not support a partial authorization for transaction |
PrivatelyDefinedData_RiskData_ScoreSource | string (1) | Left | 3523 | Defines the Falcon processing option used. Valid values: - 0 : No Falcon processing- 1 : Online- 2 : Online Plus- 3 : Real-Time |
PrivatelyDefinedData_RiskData_ScoreValue | string (4) | Left | 3524 | Numeric score generated by Falcon ranging from 0000 to 0999 . Higher score indicates a greater likelihood of fraud. If the card is currently in fraud monitoring suppression, the Score Value is 9998 or 9999 . This field is populated for Falcon Real-Time transactions only. |
PrivatelyDefinedData_RiskData_ResponseCode | string (1) | Left | 3528 | Response code generated by Falcon Expert. Valid values: - 0 : No response code generated- 1 : Approve- 2 : Decline- 3 : Refer- 4 : Approve with identification- 5 : Pick up card- blank: Card is currently in fraud monitoring suppression |
PrivatelyDefinedData_RiskData_FalconReason1 | string (2) | Left | 3529 | Falcon Reason 1 - 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 Apprv Decln- 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 Date Mismatch- 51 : Suspicious Payment Activity- 52 : Suspicious Payment Amount- 53 : Suspicious Payment Amount Nums- blank: Card is currently in fraud monitoring suppression |
PrivatelyDefinedData_RiskData_FalconReason2 | string (2) | Left | 3531 | Falcon Reason 2 - See values in _FalconReason1 . |
PrivatelyDefinedData_RiskData_FalconReason3 | string (2) | Left | 3533 | Falcon Reason 3 - See example values in _FalconReason1 . |
PrivatelyDefinedData_RiskData_VisaRiskScore | string (2) | Left | 3535 | A value that indicates the degree of risk associated with the transaction. Higher values indicate higher authorization risk. Valid values: 01-99, blank if card is in fraud monitoring or data is not present. |
PrivatelyDefinedData_RiskData_VisaRiskReason | string (2) | Left | 3537 | A code that represents the logic behind the VisaRiskScore . |
PrivatelyDefinedData_RiskData_VisaRiskConditionCode1 | string (2) | Left | 3539 | Contains a value relative to a high-risk Compromised Account Management System (CAMS) event. |
PrivatelyDefinedData_RiskData_VisaRiskConditionCode2 | string (2) | Left | 3541 | Contains the Compromised Event Reference (CER) ID assigned to a significant CAMS event. |
PrivatelyDefinedData_RiskData_VisaRiskConditionCode3 | string (2) | Left | 3543 | Reserved for future release |
PrivatelyDefinedData_RiskData_VAAConditionCode1Rank | string (2) | Left | 3545 | Grouping value assigned to VAA Risk Condition Code 1. - 0 : Low Risk for Fraud- 1 : Medium Risk for Fraud- 2 : High Risk for Fraud- blank: Card is currently in fraud monitoring suppression |
PrivatelyDefinedData_RiskData_RTDResultCode | string (1) | Left | 3547 | The Real Time Decisioning result code. - D : Transaction declined by RTD- R : Transaction referred b RTD- blank: No RTD result code provided |
PrivatelyDefinedData_RiskData_TravelStatusIndicator | string (1) | Left | 3548 | Describes the cardholder's travel status. - A : Cardholder may be traveling, destination matches- B : Cardholder may be traveling, destination unknown- blank: Card is currently in fraud monitoring suppression |
TextInfo | string (255) | Left | 3549 | Contents will vary based on ISO message type. |
Track2Data_ServiceCode | string (3) | Left | 3804 | The Service Code encoded on Track 2 of the magnetic stripe |
RetrievalReferenceNumber | string (12) | Left | 3807 | The Retrieval Reference Number as defined by the network provider. Useful when interfacing with the network provider's support tools or staff. |
NetworkManagementInformationCode | string (3) | Left | 3819 | |
FalconCaseStatus | string (255) | Left | 3822 | Falcon Case Status Possible values: - ACTIVE - OPEN - CLOSED |
FalconCaseSubStatus | string (255) | Left | 4077 | Falcon Case Sub Status Possible values: - CONFIRMED_FRAUD - UNABLE_NOT_FRAUD - ACTIVE_CASE_SUBSTATUS_DLR_IVR_DISCONNECT - ACTIVE_CASE_SUBSTATUS_DLR_SMS_FRD_CNFD - ACTIVE_CASE_SUBSTATUS_CCS_TO_ANALYST - ACTIVE_CASE_SUBSTATUS_DLR_EML_FRD_CNFD - ACTIVE_CASE_SUBSTATUS_CCS_LEFT_MESSAGE - ACTIVE_CASE_SUBSTATUS_DLR_ACTIVE - ACTIVE_CASE_SUBSTATUS_CCS_OPEN - NOT_FRAUD - ACTIVE_CASE_SUBSTATUS_DLR_IVR_FRD_CNFD - UNABLE_CONFIRMED_FRAUD - ACTIVE_CASE_SUBSTATUS_SMS_CALL_REQUEST - ACTIVE_CASE_CALLBACK - ACTIVE_CASE_SUBSTATUS_CCS_NO_CONTACT - ACTIVE_CASE_SUBSTATUS_VIP - ACTIVE_CASE_INVESTIGATION |
FalconBlockCode | string (255) | Left | 4332 | One or more can be present as a result of case updates. Possible values: - VRU_FRAUD_BLOCK_SERVICE| - NO_BLOCK_SERVICE| - REMOVE_BLOCK_SERVICE| - TEMPORARY_BLOCK_SERVICE| - FRAUD_BLOCK_SERVICE| - VRU_REMOVE_BLOCK_SERVICE| - CASE_ACTION_TYPE_SERVICE_CCS_BAD_PHONE| - REMOVE_BLOCK_SERVICE| - VRU_REMOVE_BLOCK_SERVICE| |
FalconFraudCode | string (255) | Left | 4587 | The Falcon Fraud Code only populated when the case has a sub status of CONFIRMED_FRAUD . Possible values:- CASE_FRAUD_TYPE_MAIL_PHONE_FRD - CASE_FRAUD_TYPE_SKIMMING_FRD - CASE_FRAUD_TYPE_PHISH - CASE_FRAUD_TYPE_ID_THEFT - CASE_FRAUD_TYPE_APP_FRD - CASE_FRAUD_TYPE_INT_ORDER_FRD - CASE_FRAUD_CHCK_FRD_AP_CUST_VICT - CASE_FRAUD_TYPE_VISA_STOLEN - CASE_FRAUD_TYPE_NON_RECEIPT - CASE_FRAUD_CHCK_FRD_CUST_RESP - CASE_FRAUD_DEP_BAD_CRDT_OVDRFT - CASE_FRAUD_TYPE_FRIENDLY_FRD - CASE_FRAUD_TYPE_ZERO_LOSS_FRD - CASE_FRAUD_TYPE_SCAMFRD - CASE_FRAUD_TYPE_NMBR_PRTNG - CASE_FRAUD_TYPE_FIRST_PARTY_FRD - CASE_FRAUD_TYPE_KIDNAP - CASE_FRAUD_TYPE_CHECK_KITING - CASE_FRAUD_CHCK_FRD_CUST_VIST - CASE_FRAUD_TYPE_CNTRFIT_FRD - CASE_FRAUD_DEP_BAD_ADVNC - CASE_FRAUD_TYPE_OTHER - CASE_FRAUD_TYPE_VISA_LOST - CASE_FRAUD_TYPE_LOST_STOLEN - CASE_FRAUD_TYPE_CONV_CHECK_FRD - CASE_FRAUD_TYPE_TAKEOVER_FRD - CASE_FRAUD_DEP_FRD_INT_EMP - CASE_FRAUD_TYPE_MALWARE - CASE_FRAUD_TYPE_SIM_RLTD - CASE_FRAUD_TYPE_SEF |
TransactionFeeAmount | integer (10) | Right | 4842 | The Total Transaction Fee Amount contains the surcharge amount. |
SettlementFeeAmount | integer (10) | Right | 4852 | The Settlement Fee Amount contains the surcharge amount in the issuer's currency. |
AdditionalFees_CCA | integer (10) | Right | 4862 | |
AdditionalFees_ICA | integer (10) | Left | 4872 | |
CardAcceptorRegionCode | string (2) | Left | 4882 | The region code of the card acceptor. |
CardAcceptorCountryCode | string (2) | Left | 4884 | The country code of the card acceptor. |
NationalPointOfServiceCondition_TerminalUnattended | string (1) | Left | 4886 | Terminal Unattended - 0 : Attended- 1 : Unattended |
NationalPointOfServiceCondition_TerminalOperator | string (1) | Left | 4887 | Terminal Operator - 0 : Customer operated- 1 : Card acceptor-operated- 2 : Administrative |
NationalPointOfServiceCondition_TerminalPremises | string (1) | Left | 4888 | Terminal Premise - 0 : On premise- 1 : On premise- 3 : Electronic commerce |
NationalPointOfServiceCondition_CardPresentation | string (1) | Left | 4889 | Presentation Type - 0 : Customer present- 1 : Customer not present- 2 : Mail/Telephone Order- 4 : Recurring transaction- 5 : Installment Payment- 6 : Account top up- 7 : Pre-authorized purchase- 9 : Single transaction for Mail/telephone Order |
NationalPointOfServiceCondition_CardPresence | string (1) | Left | 4890 | Card Presence - 0 : Card present- 1 : Card not present- 8 : Pre-authorized purchase |
NationalPointOfServiceCondition_CardRetention | string (1) | Left | 4891 | Card Retention - 0 : Device does not have card retention capability- 1 : Device has card retention capability |
NationalPointOfServiceCondition_CardTransaction | string (1) | Left | 4892 | Card Transaction - 0 : Original transaction/clearing- 1 : Incremental authorization- 2 : Delayed charges- 3 : No show- 4 : Merchant authorized transaction- 5 : Resubmission- 6 : Reauthorization |
NationalPointOfServiceCondition_SecurityCondition | string (1) | Left | 4893 | Security Condition - 0 : No security concern- 1 : Suspected fraud- 2 : Identification verified- 3 : Secure Electronic Commerce transaction- 4 : Non-authorized security transaction at a 3-D Secure capable merchant. Merchant attempted to authenticate the cardholder using 3-D Secure.- 5 : Non-authenticated security transaction- 6 : Non-secure transaction- 7 : Non-authenticated security transaction at a SET capable merchant- 8 : CVV, dynamic CVV, or iCVV validated and valid- 9 : CVV, dynamic CVV, or iCVV validated and invalid |
NationalPointOfServiceCondition_TerminalType | string (2) | Left | 4894 | Terminal Type - 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 : Personal Digital Assistant (PDA)- 24 : Screen Phone- 25 : Internet terminal- 26 : MICR terminal- 27 : Mobile acceptance solution |
NationalPointOfServiceCondition_TerminalEntryCapability | string (1) | Left | 4896 | Terminal Entry Capability Mode - 0 : Unknown- 1 : Manual/no terminal- 2 : Magnetic stripe read- 3 : QR code- 4 : OCR- 5 : ICC- 6 : Key entered- 9 : File- S : MICR reader- T : Contactless- U : Contactless via Mag Stripe Rules |
PrivatelyDefinedData_TransactionLevel_CredentialOnFileIndicator | string (1) | Left | 4897 | Indicates whether a Credential on File is present. - Y : Credential on File- N : Not a Credential on File |
PrivatelyDefinedData_TransactionLevel_CryptocurrencyPurchaseIndicator | string (1) | Left | 4898 | Identifies Visa transactions used to purchase cryptocurrency. - Y : Purchase of Cryptocurrency- N : Not a Purchase of Cryptocurrency |
AvsResult | string (1) | Left | 4899 | Current Address Verification Service Results: - A : AVS street address only (partial match)- N : AVS non-match- R : AVS indeterminate outcome (retry)- U : AVS unable to verify- Y : AVS full match- Z : AVS postal/ZIP code only (partial match)Retired Address Verification Service Results as of 6/2023: - B : Street address match for international transaction, but postal code not verified due to incompatible formats- C : Street address and postal code not verified for international transaction due to incompatible formats- D : Street address and postal code match for international transaction- G : Address information not verified for international transaction. Issuer is not an AVS participant, or AVS data was present in the request but issuer did not return an AVS result, or Visa performs AVS on behalf of the issuer and there was no address record on file for this account.- I : Address information not verified- M : Street address not verified- P : Postal code match for international transaction, but street address not verified due to incompatible formats |
CardControlTag | string (50) | Left | 4900 | Tag of the card control that was evaluated against this authorization. |
CardControlRuleTag | string (50) | Left | 4950 | Tag of the rule that matched this authorization. |
CardControlRuleSource | string (8) | Left | 5000 | Source of the card control rule that matched this authorization. Possible values: - Customer - Program - NULL |
CardControlResult | integer (1) | Left | 5008 | Result of executing the matched card control rule. Possible values:0 : Declined1 : AllowedNULL: Non-matched control or rule |
InAuthHelixResult | integer (2) | Right | 5009 | Helix result from In Auth processing. Possible values:1 : Success2 : Error3 : Timeout4 : Customer token not set5 : Program HTTP error6 : Unknown timeout |
InAuthProgramResult | integer (2) | Right | 5011 | Program result from In Auth processing. Possible values:1 : Approve2 : Decline3 : Abstain |
InAuthProgramResponseDurationinMS | integer (10) | Right | 5013 | Program response duration in milliseconds for In Auth. |
TapToPhoneIndicator | string (4) | Right | 5023 | Tap to Phone Indicator result. Possible values:0001 : Tap-to-Phone Indicator |
LockStatus | integer (1) | Left | 5027 | Card lock status. Possible values:0 : Unlocked1 : Locked |
LockReasonTypeCode | string (3) | Left | 5028 | The reason the lock was applied to the card. Possible values:UNK : UnknownSTL : StolenLST : LostFRD : Suspected FraudDMG : Physical DamageADM : Administrative**TMP : TemporaryPIN : PIN Retries Exceeded*** Can be set via /card/hotlist API endpoint only. Cannot be subsequently unlocked. ** Can be set via Helix Admin Console or background processing only |
LockTypeCode | string (3) | Left | 5031 | The type of lock applied to the card. Possible values:UNL : UnlockedCST : Customer Locked (locked via the API, or, if a Helix Admin Console user specifies the lock can be unlocked by the customer via the API)SYS : System Locked (locked via Helix Admin Console or an automated process; the Helix Admin Console user-specified customer should not be able to unlock it via the API or the network provider deemed the card is locked and was reflected as such in Helix) Note: customers can unlock most CST locks but none of the SYS locks. See /card/unlock for more details |
VisaTransactionId | string (15) | Left | 5034 | The Visa DPS original transaction identifier |
TransactionLocalDate | string (4) | Left | 5049 | The local month and day the transaction takes place at the card acceptor location |
TransactionLocalTime | string (6) | Left | 5053 | The time the transaction takes place as expressed in the local time of the card acceptor location |
PrivatelyDefinedData_RiskData_MasterCardFraudScore | string (3) | Left | 5059 | Available if client participates in a Mastercard or non-Visa Network Fraud Scoring service. Valid value: 000-999, XXX, or ZZZ Values: 000 : Actual score (where 999 is more likely to be fraudulent than a score of 000)XXX : Unable to return scoresZZZ : Fraud server is unavailable |
PrivatelyDefinedData_RiskData_MasterCardRiskCondition1 | string (2) | Left | 5062 | Available if client participates in Mastercard Fraud Scoring service. Values: NL : (Network Monitor Alert Only)NM : (Network Monitor)XX : Suspicious transactionYY : Four or more swiped transactions on a self-service terminal in the past two daysZZ : Suspicious activity during the past three days |
PrivatelyDefinedData_RiskData_MasterCardRiskCondition2 | string (2) | Left | 5064 | Available if client participates in Mastercard Fraud Scoring service. Values: 00 : No suspicious activity01 : Suspicious pattern of transaction amounts–cardholder02 : Suspicious pattern of account activity at device or merchant03 : Suspicious pattern of geographical distances between transaction locations04 : Unusual amount or number of transaction fees05 : Unusual transaction frequency–account06 : Suspicious geographic location of transactions07 : Suspicious pattern of transaction merchant categories–account08 : Unusual/Suspicious pattern of transaction amounts–device09 : High/Unusual transaction frequency–device10 : Suspicious pattern of transaction time11 : Unusual/abnormal transmitted data |
PrivatelyDefinedData_RiskData_MasterCardFraudScoreReason | string (2) | Left | 5066 | Available if client participates in Mastercard Fraud Scoring service. Values: 00 : No suspicious activity01 : Suspicious pattern of transaction amounts–cardholder02 : Suspicious pattern of account activity at device or merchant03 : Suspicious pattern of geographical distances between transaction locations04 : Unusual amount or number of transaction fees05 : Unusual transaction frequency–account06 : Suspicious geographic location of transactions07 : Suspicious pattern of transaction merchant categories–account08 : Unusual/Suspicious pattern of transaction amounts–device09 High/Unusual transaction frequency–device10 : Suspicious pattern of transaction time11 : Unusual/abnormal transmitted data |
ContextId | string (36) | Right | 5068 | Globally unique identifier (GUID) for card message (correlationId for In Auth) |
CardholderCustomerId | integer (10) | Right | 5104 | Identifies the business customer performing card transactions on a business account with multiple cardholders |
RSMRuleId | string (8) | Left | 5114 | Identifies the Falcon Risk Services Manager (RSM) rule that applied to the declined transaction |
InAuthReasonCode | string (128) | Right | 5122 | Reason code specified by the client in the in-auth response message. |
Take me to the Example Debit Card Event Notification File
Updated 3 months ago