Debit Card Event Notification File
This is an extension fileThis 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 |
---|---|---|---|---|
Record Type | string (1) | Left | 1 | The flag for the header row. Will always be |
File Name | string (50) | Left | 2 | The name of this request file excluding path. |
Record Count | integer (10) | Right | 52 | The number of records represented within the file. This field is zero-padded on the left side. |
File Created Date | datetime (34) | Left | 62 | The date the file was created. Follows same format as API. |
File Effective Date | datetime (34) | Left | 96 | The date to which the data in the file pertains. Follows same format as API. |
Content Row
Property | Data Type (Length) | Alignment | Start Position | Description |
---|---|---|---|---|
User Event ID | 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. |
Customer ID | integer (10) | Right | 20 | The Helix-assigned unique ID for a customer. This field is zero-padded on the left side. |
Card ID | 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. |
Transaction ID | integer (19) | Right | 40 | The Helix-assigned unique ID for the transaction object to which this event applies. May be |
Authorization Transaction ID | integer (19) | Right | 59 | The unique identifier for the associated authorization transaction. May be |
Request Type Code | string (3) | Left | 78 | The method of request from the debit rails. Possible values:
|
RESERVED | string (12) | Left | 81 | This range of bytes is reserved for future use. |
Merchant Category Code | string (4) | Left | 93 | The exact Merchant Category Code value received from the network provider. |
Merchant Group Type Code | string (6) | Left | 97 | A grouping of multiple Merchant Category Codes into fewer, more useful sets. See Merchant Group Codes for more information. |
Cashback Amount | 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., |
Surcharge Amount | 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., |
Cash Deposit Amount | 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., |
Check Deposit Amount | 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., |
Terminal ID | string (15) | Left | 143 | The identification code of the device at the merchant that accepted the card information. |
Merchant ID | string (15) | Left | 158 | The identification code of the merchant that accepted the card information. |
Merchant Location | string (25) | Left | 173 | The location of the merchant at which the transaction originated. |
Merchant City | string (13) | Left | 198 | The city of the merchant at which the transaction originated. |
Merchant State Code | string (2) | Left | 211 | The two-character state abbreviation of the merchant at which the transaction originated. |
Merchant Zip Code | string (9) | Left | 213 | The postal code of the merchant at which the transaction originated. |
Merchant Country Code | string (2) | Left | 222 | The two-character country abbreviation of the merchant at which the transaction originated. |
PAN Entry Mode Type Code | string (10) | Left | 224 | The method by which the card number was input to the merchant's device. Possible values for Shazam:
|
PIN Entry Mode Type Code | string (10) | Left | 234 | The method by which the card holder was validated at the merchant's device. Possible values:
|
Cardholder Presence Type Code | string (10) | Left | 244 | The presence of the card holder at the time the transaction was originated. Possible values for Shazam:
|
Card Presence Type Code | string (10) | Left | 254 | The presence of the physical card at the time the transaction was originated. Possible values for Shazam:
|
Terminal Unattended Type Code | string (10) | Left | 264 | Possible values:
|
Terminal Premises Type Code | string (10) | Left | 274 | Location of the merchant's device in relation to the merchant's location. Possible values:
|
Customer Tag | string (50) | Left | 284 | The |
Card Tag | string (50) | Left | 334 | The |
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., |
Available Date | datetime (34) | Left | 394 | The date the transaction was made available / is projected to be made available. Follows same format as API. |
Created Date | datetime (34) | Left | 428 | The date the transaction was created. Follows same format as API. |
Custom Field 1 | string (50) | Left | 462 | The |
Description | string (255) | Left | 512 | The NACHA-supplied description for this transaction. |
Denial Reason | string (255) | Left | 767 | Text describing why a transaction was denied from taking place. |
Fee Code | string (3) | Left | 1022 | The programmatic value for the type of fee this transaction represents. Possible values:
|
Fee Description | string (50) | Left | 1025 | A human-readable description of the |
Friendly Description | string (255) | Left | 1075 | A human-readable, automatically generated description of the transaction that caused the event. Driven by the |
From Account Amount | 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., |
From Account ID | integer (10) | Right | 1340 | The unique identifier for the customer account that was debited. This field is zero-padded on the left side. |
From Account Number Masked | string (50) | Left | 1350 | Masked version of the Account number of the customer account that was debited. |
From Available Amount | 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., |
From Category | string (50) | Left | 1410 | The caller-specified category to which the customer account that was debited belongs. |
From Created Date | string (34) | Left | 1460 | Date the customer account was created. |
From Custom Field 1 | string (50) | Left | 1494 | The |
From Custom Field 2 | string (50) | Left | 1544 | The |
From Custom Field 3 | string (50) | Left | 1594 | The |
From Custom Field 4 | string (50) | Left | 1644 | The |
From Custom Field 5 | string (50) | Left | 1694 | The |
From Legal Name 1 | string (100) | Left | 1744 | The first legal name used to identify the customer account that was debited. |
From Legal Name 2 | string (100) | Left | 1844 | A secondary legal name used to identify the customer account that was debited. |
From Name | string (50) | Left | 1944 | A caller-specified, user-friendly name for the customer account that was debited. |
From Pending Amount | 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., |
From Primary Customer ID | 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. |
From Subcategory | string (50) | Left | 2014 | The caller-specified subcategory to which the customer account that was debited belongs. |
From Tag | string (50) | Left | 2064 | A caller-specified, unique identifier for the customer account that was debited. |
Institution Name | string (50) | Left | 2114 | The name of the institution from which the transaction originated. |
Master ID | 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. |
Modified By ID | 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. |
Payload Type ID | integer (10) | Right | 2193 | The "type" of payload in the |
Settled Date | datetime (34) | Left | 2203 | The date the transaction was settled / is projected to settle. Follows same format as API. |
Subtype | string (255) | Left | 2237 | The description of the |
Subtype Code | 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 |
To Account Amount | 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., |
To Account ID | integer (10) | Right | 2558 | The unique identifier for the customer account that was credited. This field is zero-padded on the left side. |
To Account Number Masked | string (50) | Left | 2568 | Masked version of the Account number of the customer account that was credited. |
To Available Amount | 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., |
To Category | string (50) | Left | 2628 | The caller-specified category to which the customer account that was credited belongs. |
To Created Date | datetime (34) | Left | 2678 | Date the customer account was created. |
To Custom Field 1 | string (50) | Left | 2712 | The |
To Custom Field 2 | string (50) | Left | 2762 | The |
To Custom Field 3 | string (50) | Left | 2812 | The |
To Custom Field 4 | string (50) | Left | 2862 | The |
To Custom Field 5 | string (50) | Left | 2912 | The |
To Legal Name 1 | string (100) | Left | 2962 | The first legal name used to identify the customer account that was credited. |
To Legal Name 2 | string (100) | Left | 3062 | A secondary legal name used to identify the customer account that was credited. |
To Name | string (50) | Left | 3162 | The |
To Pending Amount | 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., |
To Primary Customer ID | 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. |
To Subcategory | string (50) | Left | 3232 | The caller-specified subcategory to which the customer account that was credited belongs. |
To Tag | 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. |
Type Code | string (6) | Left | 3382 | The |
Event Type ID | integer (10) | Right | 3388 | The Event Type Id of event that occurred. |
Network Provider Type ID | integer (1) | Left | 3398 | The id of card's network provider.
|
Point Of Service Pan Entry Mode | string (2) | Left | 3399 | Useful when determining how the PAN was entered.
|
Point Of Service PIN Entry Mode | string (1) | Left | 3401 | Useful when determining how the PIN was entered.
|
CVV2 Presence Indicator | string (1) | Left | 3402 | CVV2 Presence Indicator
|
CVV2 Result | string (1) | Left | 3403 | CVV2 Result
|
Token | string (19) | Left | 3404 | Payment Account Reference Number (PAR) with a maximum length of 29. This field only applies if |
Token Assurance Level | string (2) | Left | 3423 | Cardholder Verification Method. This field only applies if
|
Digital Wallet Token Requestor Type ID | integer (2) | Right | 3425 | Digital Commerce Indicator. This field only applies if
|
Token Expiration Date | string (4) | Left | 3427 | The year and month the token expires (YYMM). This field only applies if |
Payment Account Reference Number | string (29) | Left | 3431 | The Payment Account Reference Number |
Message Type Indicator | string (4) | Left | 3460 | The four-digit message type identifier from the original request message. |
Output Message Type Indicator | string (4) | Left | 3464 | The four-digit message type identifier from the response message. |
Output Response Code | string (2) | Left | 3468 | The two-digit status code from the response message sent by Helix. |
System Trace Audit Number | 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. |
Acquirer Institution Country Code | string (3) | Left | 3476 | 3 digit numeric code for the country where the acquiring institution is located. |
Authorization Identification Response | string (12) | Left | 3479 | The authorization code for the transaction. |
Response Code | string (2) | Left | 3491 | The code that defines the disposition of a message when present in a response, advice, or reversal.
|
PIN Validation Code | string (1) | Left | 3493 | Indicates whether the entered PIN was Valid (1). |
Additional Amounts 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.: |
Additional Amounts 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.: |
Advice Originator Code | string (1) | Left | 3514 | Advice Reason Codes
|
Advice Reason Code | string (1) | Left | 3515 |
|
Privately Defined Data Issuer Network ID Code | string (3) | Left | 3516 | |
Privately Defined Data Additional Transaction Element Fallback Indicator | string (1) | Left | 3519 | Indicates whether the transaction was processed as magnetic stripe even though the card and terminal are EMV capable. |
Privately Defined Data Processing Flag Special Transaction Indicator | string (1) | Left | 3520 | The special transaction indicator
|
Privately Defined Data Processing Flag ISA Indicator | string (1) | Left | 3521 | Visa International Service Assessment, used to indicate whether a transaction is single or multi-currency.
|
Privately Defined Data Processing Flag Partial AuthIndicator | string (1) | Left | 3522 | Transaction eligibility for Partial Authorization Indicator
|
Privately Defined Data Risk Data Score Source | string (1) | Left | 3523 | Defines the Falcon processing option used. Valid values: |
Privately Defined Data Risk Data Score Value | string (4) | Left | 3524 | Numeric score generated by Falcon ranging from |
Privately Defined Data Risk Data Response Code | string (1) | Left | 3528 | Response code generated by Falcon Expert. Valid values:
|
Privately Defined Data Risk Data Falcon Reason 1 | string (2) | Left | 3529 | Falcon Reason 1
|
Privately Defined Data Risk Data Falcon Reason 2 | string (2) | Left | 3531 | Falcon Reason 2 - See values in |
Privately Defined Data Risk Data Falcon Reason 3 | string (2) | Left | 3533 | Falcon Reason 3 - See example values in |
Privately Defined Data Risk Data Visa Risk Score | 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. |
Privately Defined Data Risk Data Visa Risk Reason | string (2) | Left | 3537 | A code that represents the logic behind the |
Privately Defined Data Risk Data Visa Risk Condition Code 1 | string (2) | Left | 3539 | Contains a value relative to a high-risk Compromised Account Management System (CAMS) event. |
Privately Defined Data Risk Data Visa Risk ConditionCode 2 | string (2) | Left | 3541 | Contains the Compromised Event Reference (CER) ID assigned to a significant CAMS event. |
Privately Defined Data Risk Data Visa Risk Condition Code 3 | string (2) | Left | 3543 | Reserved for future release |
Privately Defined Data Risk Data VAA Condition Code 1 Rank | string (2) | Left | 3545 | Grouping value assigned to VAA Risk Condition Code 1.
|
Privately Defined Data Risk Data RTD Result Code | string (1) | Left | 3547 | The Real Time Decisioning result code.
|
Privately Defined Data Risk Data Travel Status Indicator | string (1) | Left | 3548 | Describes the cardholder's travel status.
|
Text Info | string (255) | Left | 3549 | Contents will vary based on ISO message type. |
Track 2 Data Service Code | string (3) | Left | 3804 | The Service Code encoded on Track 2 of the magnetic stripe |
Retrieval Reference Number | 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. |
Network Management Information Code | string (3) | Left | 3819 | |
Falcon Case Status | string (255) | Left | 3822 | Falcon Case Status Possible values:
|
Falcon Case Sub Status | string (255) | Left | 4077 | Falcon Case Sub Status Possible values: |
Falcon Block Code | string (255) | Left | 4332 | One or more can be present as a result of case updates. Possible values: |
Falcon Fraud Code | string (255) | Left | 4587 | The Falcon Fraud Code only populated when the case has a sub status of |
Transaction Fee Amount | integer (10) | Right | 4842 | The Total Transaction Fee Amount contains the surcharge amount. |
Settlement Fee Amount | integer (10) | Right | 4852 | The Settlement Fee Amount contains the surcharge amount in the issuer's currency. |
Additional Fees CCA | integer (10) | Right | 4862 | |
Additional Fees ICA | integer (10) | Left | 4872 | |
Card Acceptor Region Code | string (2) | Left | 4882 | The region code of the card acceptor. |
Card Acceptor Country Code | string (2) | Left | 4884 | The country code of the card acceptor. |
National Point Of Service Condition Terminal Unattended | string (1) | Left | 4886 | Terminal Unattended
|
National Point Of Service Condition Terminal Operator | string (1) | Left | 4887 | Terminal Operator
|
National Point Of Service Condition Terminal Premises | string (1) | Left | 4888 | Terminal Premise
|
National Point Of Service Condition Card Presentation | string (1) | Left | 4889 | Presentation Type
|
National Point Of Service Condition Card Presence | string (1) | Left | 4890 | Card Presence
|
National Point Of Service Condition Card Retention | string (1) | Left | 4891 | Card Retention
|
National Point Of Service Condition Card Transaction | string (1) | Left | 4892 | Card Transaction
|
National Point Of Service Condition Security Condition | string (1) | Left | 4893 | Security Condition
|
National Point Of Service Condition Terminal Type | string (2) | Left | 4894 | Terminal Type
|
National Point Of Service Condition Terminal Entry Capability | string (1) | Left | 4896 | Terminal Entry Capability Mode
|
Privately Defined Data Transaction Level Credential On File Indicator | string (1) | Left | 4897 | Indicates whether a Credential on File is present.
|
Privately Defined Data Transaction Level Cryptocurrency Purchase Indicator | string (1) | Left | 4898 | Identifies Visa transactions used to purchase cryptocurrency.
|
AVS Result | string (1) | Left | 4899 | Current Address Verification Service Results:
|
Card Control Tag | string (50) | Left | 4900 | Tag of the card control that was evaluated against this authorization. |
Card Control Rule Tag | string (50) | Left | 4950 | Tag of the rule that matched this authorization. |
Card Control Rule Source | string (8) | Left | 5000 | Source of the card control rule that matched this authorization. Possible values:
|
Card Control Result | integer (1) | Left | 5008 | Result of executing the matched card control rule. Possible values: |
In Auth Helix Result | integer (2) | Right | 5009 | Helix result from In Auth processing. Possible values: |
In Auth Program Result | integer (2) | Right | 5011 | Program result from In Auth processing. Possible values: |
In Auth Program Response Duration in MS | integer (10) | Right | 5013 | Program response duration in milliseconds for In Auth. |
Tap To Phone Indicator | string (4) | Right | 5023 | Tap to Phone Indicator result. Possible values: |
Lock Status | integer (1) | Left | 5027 | Card lock status. Possible values: |
Lock Reason Type Code | string (3) | Left | 5028 | The reason the lock was applied to the card. Possible values:
|
Lock Type Code | string (3) | Left | 5031 | The type of lock applied to the card. Possible values: |
Visa Transaction ID | string (15) | Left | 5034 | The Visa DPS original transaction identifier |
Transaction Local Date | string (4) | Left | 5049 | The local month and day the transaction takes place at the card acceptor location |
Transaction Local Time | string (6) | Left | 5053 | The time the transaction takes place as expressed in the local time of the card acceptor location |
Privately Defined Data Risk Data Mastercard Fraud Score | string (3) | Left | 5059 | Available if client participates in a Mastercard or non-Visa Network Fraud Scoring service. |
Privately Defined Data Risk Data Mastercard Risk Condition 1 | string (2) | Left | 5062 | Available if client participates in Mastercard Fraud Scoring service. Values: |
Privately Defined Data Risk Data Mastercard Risk Condition 2 | string (2) | Left | 5064 | Available if client participates in Mastercard Fraud Scoring service. Values: |
Privately Defined Data Risk Data Mastercard Fraud Score Reason | string (2) | Left | 5066 | Available if client participates in Mastercard Fraud Scoring service. Values: |
Context ID | string (36) | Right | 5068 | Globally unique identifier (GUID) for card message ( |
Cardholder Customer ID | integer (10) | Right | 5104 | Identifies the business customer performing card transactions on a business account with multiple cardholders |
RSM Rule ID | string (8) | Left | 5114 | Identifies the Falcon Risk Services Manager (RSM) rule that applied to the declined transaction |
In Auth Reason Code | string (128) | Right | 5122 | Reason code specified by the client in the in-auth response message. |
Card Issuance Type | string (56) | Left | 5250 | Identifies the type of card issuance. Valid values are: |
Transaction Currency Code | string (3) | Left | 5306 | The currency used in transaction amount and transaction fee amount and contains a code defining the local currency of the acquirer or source location of the transaction. |
Transaction Amount | decimal (10) | Right | 5309 | Funds requested by the cardholder in the local currency of the acquirer or source location of the transaction, not including transaction fee amounts. |
Settlement Amount | decimal (10) | Right | 5319 | Amount to be transferred between the acquirer and the issuer. |
Settlement Conversion Rate | decimal (10) | Right | 5329 | The factor used in the conversion from the transaction amount to settlement amount set by the acquirer. |
Transmission Date Time | string (10) | Left | 5339 | Date and time the request was submitted. |
Acquirer Institution ID | string (11) | Left | 5349 | Identifies the acquiring institution’s institution identification code (IID). |
Privately Defined Data Transaction Level 3DS Indicator | string (1) | Left | 5360 | Identifies the version and authentication method. |
Large Private Data Ecommerce 3DS Browser IP address | string (45) | Left | 5361 | IP address of the browser as returned by the hypertext transfer protocol (HTTP) headers to the 3D Secure (3DS) requestor |
Large Private Data Ecommerce 3DS App IP address | string (45) | Left | 5406 | IP address that is the device public IP address used by the 3DS requestor application when it connects to the 3DS requestor environment |
Large Private Data Ecommerce 3DS Device ID | string (64) | Left | 5451 | Identifier linked to a device that is consistent across 3DS transactions for the specific user device |
Large Private Data Ecommerce 3DS Device Type | string (2) | Left | 5515 | Indicates device type |
Large Private Data Ecommerce CAVV Type | string (2) | Left | 5517 | Indicates the Cardholder Authentication Verification Value (CAVV) type for Visa Secure (3D Secure) card-not-present transactions |
National Additional Data Secure Authentication Result Code | string (2) | Left | 5519 | Indicates the outcome of the 3D Secure (3DS) authentication process |
National Additional Data Authentication Method | string (2) | Left | 5521 | Identifies Fast IDentity Online (FIDOâ„¢) authentication |
National Additional Data CAVV Key Indicator | string (2) | Left | 5523 | Indicates the Cardholder Authentication Verification Value (CAVV) generated during Visa Secure (3D Secure) authentication that confirms a cardholder's authorization in online transactions |
National Additional Data CAVV 3DS Result Code | string (2) | Left | 5525 | Indicates the outcome of a cardholder's authentication attempt, often part of 3D Secure (3DS) protocol |
Take me to the Example Debit Card Event Notification File
Updated 5 days ago