Card Event Notification File
A record of debit card properties which tie back to events in the corresponding Event Notification File.
Card Event Notification File Definition
The 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 |
---|---|---|---|---|
| string (1) | Left | 1 | The flag for the header row. Will always be |
| string (50) | Left | 2 | The name of this request file excluding path. |
| integer (10) | Right | 52 | The number of records represented within the file. This field is zero-padded on the left side. |
| datetime (34) | Left | 62 | The date the file was created. Follows same format as API. |
| 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 |
---|---|---|---|---|
| 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. |
| integer (10) | Right | 20 | The Helix-assigned unique ID for a customer. This field is zero-padded on the left side. |
| 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. |
| integer (19) | Right | 40 | The Helix-assigned unique ID for the transaction object to which this event applies. May be |
| integer (19) | Right | 59 | The unique identifier for the associated authorization transaction. May be |
| string (3) | Left | 78 | The method of request from the debit rails. Possible values:
|
| string (12) | Left | 81 | This range of bytes is reserved for future use. |
| string (4) | Left | 93 | The exact Merchant Category Code value received from the network provider. |
| string (6) | Left | 97 | A grouping of multiple Merchant Category Codes into fewer, more useful sets. See Merchant Group Codes for more information. |
| 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., |
| 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., |
| 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., |
| 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., |
| string (15) | Left | 143 | The identification code of the device at the merchant that accepted the card information. (Field #41 from the ISO-8583 specification) |
| string (15) | Left | 158 | The identification code of the merchant that accepted the card information. (Field #42 from the ISO-8583 specification) |
| string (25) | Left | 173 | The location of the merchant at which the transaction originated. (Field #34, Positions 1-23 from the ISO-8583 specification) |
| string (13) | Left | 198 | The city of the merchant at which the transaction originated. (Field #34, Positions 24-36 from the ISO-8583 specification) |
| string (2) | Left | 211 | The two-character state abbreviation of the merchant at which the transaction originated. |
| string (9) | Left | 213 | The postal code of the merchant at which the transaction originated. |
| string (2) | Left | 222 | The two-character country abbreviation of the merchant at which the transaction originated. |
| string (10) | Left | 224 | The method by which the card number was input to the merchant's device. Possible values for Shazam:
Possible values for Visa DPS:
|
| string (10) | Left | 234 | The method by which the card holder was validated at the merchant's device. Possible values:
|
| string (10) | Left | 244 | The presence of the card holder at the time the transaction was originated. Possible values for Shazam:
Possible values for Visa DPS:
|
| string (10) | Left | 254 | The presence of the physical card at the time the transaction was originated. Possible values for Shazam:
Possible values for VisaDPS:
|
| string (10) | Left | 264 | Possible values:
|
| string (10) | Left | 274 | Location of the merchant's device in relation to the merchant's location. Possible values:
|
| string (50) | Left | 284 | The |
| string (50) | Left | 334 | The |
| 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., |
| datetime (34) | Left | 394 | The date the transaction was made available / is projected to be made available. Follows same format as API. |
| datetime (34) | Left | 428 | The date the transaction was created. Follows same format as API. |
| string (50) | Left | 462 | The |
| string (255) | Left | 512 | The NACHA-supplied description for this transaction. |
| string (255) | Left | 767 | Text describing why a transaction was denied from taking place. |
| string (3) | Left | 1022 | The programmatic value for the type of fee this transaction represents. Possible values:
|
| string (50) | Left | 1025 | A human-readable description of the |
| string (255) | Left | 1075 | A human-readable, automatically generated description of the transaction that caused the event. Driven by the |
| 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., |
| integer (10) | Right | 1340 | The unique identifier for the customer account that was debited. This field is zero-padded on the left side. |
| string (50) | Left | 1350 | Masked version of the Account number of the customer account that was debited. |
| 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., |
| string (50) | Left | 1410 | The caller-specified category to which the customer account that was debited belongs. |
| string (34) | Left | 1460 | Date the customer account was created. |
| string (50) | Left | 1494 | The |
| string (50) | Left | 1544 | The |
| string (50) | Left | 1594 | The |
| string (50) | Left | 1644 | The |
| string (50) | Left | 1694 | The |
| string (100) | Left | 1744 | The first legal name used to identify the customer account that was debited. |
| string (100) | Left | 1844 | A secondary legal name used to identify the customer account that was debited. |
| string (50) | Left | 1944 | A caller-specified, user-friendly name for the customer account that was debited. |
| 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., |
| 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. |
| string (50) | Left | 2014 | The caller-specified subcategory to which the customer account that was debited belongs. |
| string (50) | Left | 2064 | A caller-specified, unique identifier for the customer account that was debited. |
| string (50) | Left | 2114 | The name of the institution from which the transaction originated. |
| 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. |
| 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. |
| integer (10) | Right | 2193 | The "type" of payload in the |
| datetime (34) | Left | 2203 | The date the transaction was settled / is projected to settle. Follows same format as API. |
| string (255) | Left | 2237 | The description of the |
| string (6) | Left | 2492 | The Merchant Category Code of the merchant where the transaction originated. Categorizes merchants with similar lines of business together. |
| string (50) | Left | 2498 | The |
| 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., |
| integer (10) | Right | 2558 | The unique identifier for the customer account that was credited. This field is zero-padded on the left side. |
| string (50) | Left | 2568 | Masked version of the Account number of the customer account that was credited. |
| 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., |
| string (50) | Left | 2628 | The caller-specified category to which the customer account that was credited belongs. |
| datetime (34) | Left | 2678 | Date the customer account was created. |
| string (50) | Left | 2712 | The |
| string (50) | Left | 2762 | The |
| string (50) | Left | 2812 | The |
| string (50) | Left | 2862 | The |
| string (50) | Left | 2912 | The |
| string (100) | Left | 2962 | The first legal name used to identify the customer account that was credited. |
| string (100) | Left | 3062 | A secondary legal name used to identify the customer account that was credited. |
| string (50) | Left | 3162 | The |
| 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., |
| 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. |
| string (50) | Left | 3232 | The caller-specified subcategory to which the customer account that was credited belongs. |
| string (50) | Left | 3282 | A caller-specified, unique identifier for the customer account that was credited. |
| string (50) | Left | 3332 | A human-readable representation of the type of transaction that caused this event. |
| string (6) | Left | 3382 | The |
| integer (10) | Right | 3388 | The Event Type Id of event that occurred. |
| integer (1) | Left | 3398 | The id of card's network provider.
|
| string (2) | Left | 3399 | The Point of Service PAN Entry Mode (Field #22, Positions 1-2 from the ISO-8583 specification). Useful when determining how the PAN was entered.
|
| string (1) | Left | 3401 | The Point of Service PIN Entry Mode (Field #22, Position 3 from the ISO-8583 specification). Useful when determining how the PIN was entered.
|
| string (1) | Left | 3402 | CVV2 Presence Indicator (Field #123, Usage 3, Position 3 from the ISO-8583 specification).
|
| string (1) | Left | 3403 | CVV2 Result (Field#123, Usage 3, Position 9 from the ISO-8583 specification).
|
| string (19) | Left | 3404 | Payment Account Reference Number (PAR) with a maximum length of 29. This field only applies if |
| string (2) | Left | 3423 | Cardholder Verification Method. This field only applies if
|
| integer (2) | Right | 3425 | Digital Commerce Indicator. This field only applies if
|
| string (4) | Left | 3427 | The year and month the token expires (YYMM). This field only applies if |
| string (29) | Left | 3431 | The Payment Account Reference Number |
| string (4) | Left | 3460 | The incoming message type |
| string (4) | Left | 3464 | The outgoing message type |
| string (2) | Left | 3468 | Helix's response code |
| string (6) | Left | 3470 | The System Trace Audit Number (Field #11 from the ISO-8583 specification) as defined by the network provider. Useful when interfacing with the network provider's support tools or staff. |
| string (3) | Left | 3476 | |
| string (12) | Left | 3479 | The authorization code for the transaction (Field #38 from the ISO-8583 specification). |
| string (2) | Left | 3491 | The code that defines the disposition of a message when present in a response, advice, or reversal.
|
| string (1) | Left | 3493 | Indicates whether the entered PIN was Valid (1). |
| 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.: |
| 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.: |
| string (1) | Left | 3514 | |
| string (1) | Left | 3515 | The identifying reason for an advice and/or reversal. |
| string (3) | Left | 3516 | |
| string (1) | Left | 3519 | The fallback indicator (Field #63.4, Position 5 from the ISO-8583 specification). |
| string (1) | Left | 3520 | The special transaction indicator (Field #63.7, Position 1 from the ISO-8583 specification).
|
| string (1) | Left | 3521 | Visa International Service Assessment (ISA) Indicator (Field #63.7, Position 2 from the ISO-8583 specification), used to indicate whether a transaction is single or multi-currency.
|
| string (1) | Left | 3522 | Transaction eligibility for Partial Authorization Indicator (Field #63.7, Position 3 from the ISO-8583 specification).
|
| string (1) | Left | 3523 | (Field #63.8, Position 1 from the ISO-8583 specification)
|
| 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. (Field #63.8, Positions 2-5 from the ISO-8583 specification) |
| string (1) | Left | 3528 | Response code generated by Falcon Expert (Field #63.8, Position 6 from the ISO-8583 specification)
|
| string (2) | Left | 3529 | Falcon Reason 1 (Field #63.8, Positions 7-8 from the ISO-8583 specification)
|
| string (2) | Left | 3531 | Falcon Reason 2 (Field #63.8, Positions 9-10 from the ISO-8583 specification). See example values in |
| string (2) | Left | 3533 | Falcon Reason 3 (Field #63.8, Positions 11-12 from the ISO-8583 specification). See example values in |
| 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. (Field #63.8, Positions 13-14 from the ISO-8583 specification). |
| string (2) | Left | 3537 | A code that represents the logic behind the |
| string (2) | Left | 3539 | Contains a value relative to a high-risk Compromised Account Management System (CAMS) event. (Field #63.8, Positions 17-18 from the ISO-8583 specification). |
| string (2) | Left | 3541 | Contains the Compromised Event Reference (CER) ID assigned to a significant CAMS event. (Field #63.8, Positions 19-20 from the ISO-8583 specification). |
| string (2) | Left | 3543 | Reserved for future release |
| string (2) | Left | 3545 | Grouping value assigned to VAA Risk Condition Code 1. (Field #63.8, Position 23 from the ISO-8583 specification).
|
| string (1) | Left | 3547 | The Real Time Decisioning result code. (Field #63.8, Position 24 from the ISO-8583 specification)
|
| string (1) | Left | 3548 | Describes the cardholder's travel status. (Field #63.8, Position 34 from the ISO-8583 specification)
|
| string (255) | Left | 3549 | |
| string (3) | Left | 3804 | The Service Code encoded on Track 2 of the magnetic stripe |
| string (12) | Left | 3807 | The Retrieval Reference Number (Field #37 from the ISO-8583 specification) as defined by the network provider. Useful when interfacing with the network provider's support tools or staff. |
| string (3) | Left | 3819 | |
| string (255) | Left | 3822 | Falcon Case Status (Field #105 from the ISO-8583 specification). Possible values:
|
| string (255) | Left | 4077 | Falcon Case Sub Status (Field #106 from the ISO-8583 specification). Possible values:
|
| string (255) | Left | 4332 | Falcon Block Code (Field #107 from the ISO-8583 specification). Possible values:
|
| string (255) | Left | 4587 | The Falcon Fraud Code (Field #108 from the ISO-8583 specification) only populated when the case has a sub status of
|
| integer (10) | Left | 4842 | The Total Transaction Fee Amount (Field #28 from the ISO-8583 specification). Contains the surcharge amount. |
| integer (10) | Left | 4852 | The Settlement Fee Amount (Field #29 from the ISO-8583 specification). Contains the surcharge amount in the issuer's currency. |
| integer (10) | Left | 4862 | |
| integer (10) | Left | 4872 | |
| string (2) | Left | 4882 | The region code of the card acceptor (Field #34, Positions 37-38 from the ISO-8583 specification). |
| string (2) | Left | 4884 | The country code of the card acceptor (Field #34, Positions 39-40 from the ISO-8583 specification). |
| string (1) | Left | 4886 | Terminal Unattended (Field #58, Position 1 from the ISO-8583 specification).
|
| string (1) | Left | 4887 | Terminal Operator (Field #58, Position 2 from the ISO-8583 specification).
|
| string (1) | Left | 4888 | Terminal Premise (Field #58, Position 3 from the ISO-8583 specification).
|
| string (1) | Left | 4889 | Presentation Type (Field #58, Position 4 from the ISO-8583 specification).
|
| string (1) | Left | 4890 | Card Presence (Field #58, Position 5 from the ISO-8583 specification).
|
| string (1) | Left | 4891 | Card Retention (Field #58, Position 6 from the ISO-8583 specification).
|
| string (1) | Left | 4892 | Card Transaction (Field #58, Position 7 from the ISO-8583 specification).
|
| string (1) | Left | 4893 | Security Condition (Field #58, Position 8 from the ISO-8583 specification).
|
| string (2) | Left | 4894 | Terminal Type (Field #58, Positions 9-10 from the ISO-8583 specification).
|
| string (1) | Left | 4896 | Terminal Entry Capability Mode (Field #58, Position 11 from the ISO-8583 specification).
|
| string (1) | Left | 4897 | Credential On File Indicator (Field #63.8, Position 2 from the ISO-8583 specification). Indicates whether a Credential on File is present.
|
| string (1) | Left | 4898 | Cryptocurrency Purchase Indicator (Field #63.8, Position 5 from the ISO-8583 specification). Identifies Visa transactions used to purchase cryptocurrency.
|
| string (1) | Left | 4899 | Address Verification Service Result
|
Take me to the Example Card Event Notification File
Updated 22 days ago