Event Notification File
A record of notable events which have occurred in CorePro in the past hour.
Event Notification File Definition
This file is created by CorePro on an hourly basis. It has the following properties:
- Fixed-length. Header row is 129 bytes excluding line endings. Each content row is 637 bytes excluding line endings.
- 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_EVENTNOTIFICATION.TXT - Root-relative path on
sftp.corepro.iofor that file would be:/EventNotification/201809060605_EVENTNOTIFICATION.TXT
Format Disclaimer
Q2 Open 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.
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.
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on the FileCreatedDate or FileEffectiveDate 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 | 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. Will be named following this pattern:
|
RecordCount |
integer (10) | Right | 52 | The number of records represented within the file. NOTE: This field is zero-padded on the left side. e.g.: 0000000872 |
FileCreatedDate |
datetime (34) | Right | 62 |
The date the file was created. Follows same format as API e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
|
FileEffectiveDate |
datetime (34) | Right | 96 |
The date to which the data in the file pertains. Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.
|
Content Row
| Property | Alignment | Start Position | Description | |
|---|---|---|---|---|
CustomerId |
integer (10) | Right | 1 | The unique identifier for a Customer. NOTE: This field is zero-padded on the left side. e.g.: 0000000872 |
CustomerTag |
string (50) | Left | 11 |
The client-supplied unique identifier for the customer, aka the tag property on the customer object. This may be empty as it is an optional property.
|
AccountId |
integer (10) | Right | 61 |
The unique identifier for the account to which this event applies. May be 0000000000 if this event does not apply to a specific AccountId.NOTE: This field is zero-padded on the left side. e.g.: 0008309285This is NOT an accountNumber. It is the accountIdof an account object.
|
AccountTag |
string (50) | Left | 71 |
The client-supplied unique identifier for the account, aka the tag property on the account object to which this event applies. This is an optional field and may be empty.
|
ExternalAccountId |
integer (10) | Right | 121 |
The unique identifier for the externalAccount object to which this event applies. May be 0000000000 if this event does not apply to a specific ExternalAccountId.NOTE: This field is zero-padded on the left side. e.g.: 0008309285This is NOT an accountNumber. It is the externalAccountIdof an externalAccount object.
|
ExternalAccountTag |
string (50) | Left | 131 |
The client-supplied unique identifier for the externalAccount, aka the tag property on the externalAccount object. This may be empty as it is an optional property.
|
TransactionId |
integer (19) | Right | 181 |
The unique identifier for the transaction. NOTE: This field is zero-padded on the left side. e.g.: 0008309285 |
TransactionTag |
string (50) | Left | 200 | The client-supplied unique identifier for the transaction. See transaction object definition for details. |
Description |
string (50) | Left | 250 |
A human-readable description of the event. See EventTypeId definition below for list of possible values.
|
EventTypeId |
integer (10) | Right | 300 |
The type of event that occurred. See the following list for all possible values:
|
TransactionTypeCode |
string (6) | Left | 310 | A programmatic code for the type of transaction. See transaction object definition for details. |
TransactionSettledDate |
string (34) | Left | 316 | The date and time the transaction was settled. See transaction object definition for details. |
TransactionAvailableDate |
string (34) | Left | 350 | The date and time the funds associated with the transaction became available. See transaction object definition for details. |
UserEventID |
integer (19) | Right | 384 | This is a unique identifier for each event. Can be used to cross reference against the Card Event Notification File or the Realtime Event sent via Azure Service Bus. |
MasterId |
integer (19) | Right | 403 | All related transactions will have the same MasterId. |
TransactionAmount |
integer (15) | Right | 422 | 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. |
TransactionCreatedDate |
string (34) | Left | 437 | The date and time the transaction was requested. See transaction object definition for details. |
TransactionSubTypeCode |
string (6) | Left | 471 | The Merchant Category Code of the merchant where the transaction originated. Categorizes merchants with similar lines of business together. Merchant Category Codes (and the Merchant Groups to which they belong) |
TransactionTypeCode |
string (6) | Left | 477 |
The typeCode of the transaction object.
|
FromAccountId |
integer (10) | Right | 483 |
The unique identifier for the account from which funds were withdrawn (i.e. account was debited). NOTE: This field is zero-padded on the left side. e.g.: 0008309285This is NOT an accountNumber. It is the accountIdof an account or an externalAccountId of an externalAccount object.
|
FromAvailableBalance |
integer (15) | Right | 493 |
The availableBalance property of the account object that was debited as a result of the action that caused the event.
NOTE: This field is zero-padded on the left side, and two decimals will be assumed. e.g.: 000000000000832 represents an amount of $8.32.-00000000000832 represents an amount of -$8.32. |
FromAccountBalance |
integer (15) | Right | 508 |
The accountBalance property of the account object that was debited as a result of the action that caused the event.
NOTE: This field is zero-padded on the left side, and two decimals will be assumed. e.g.: 000000000000832 represents an amount of $8.32.-00000000000832 represents an amount of -$8.32. |
FromPendingBalance |
integer (15) | Right | 523 |
The pendingBalance property of the account object that was debited as a result of the action that caused the event.
NOTE: This field is zero-padded on the left side, and two decimals will be assumed. e.g.: 000000000000832 represents an amount of $8.32.-00000000000832 represents an amount of -$8.32. |
ToAccountId |
integer (10) | Right | 538 |
The unique identifier for the account to which funds were deposited (i.e. account was credited). NOTE: This field is zero-padded on the left side. e.g.: 0008309285This is NOT an accountNumber. It is the accountIdof an account or an externalAccountId of an externalAccount object.
|
ToAvailableBalance |
integer (15) | Right | 548 |
The availableBalance property of the account object that was debited as a result of the action that caused the event.
NOTE: This field is zero-padded on the left side, and two decimals will be assumed. e.g.: 000000000000832 represents an amount of $8.32.-00000000000832 represents an amount of -$8.32. |
ToAccountBalance |
integer (15) | Right | 563 |
The accountBalance property of the account object that was credited as a result of the action that caused the event.
NOTE: This field is zero-padded on the left side, and two decimals will be assumed. e.g.: 000000000000832 represents an amount of $8.32.-00000000000832 represents an amount of -$8.32. |
ToPendingBalance |
integer (15) | Right | 578 |
The pendingBalance property of the account object that was credited as a result of the action that caused the event.
NOTE: This field is zero-padded on the left side, and two decimals will be assumed. e.g.: 000000000000832 represents an amount of $8.32.-00000000000832 represents an amount of -$8.32. |
ModifiedById |
integer (10) | Right | 593 |
The unique identifier for the Customer, Admin User, or 0 for system generated events. NOTE: This field is zero-padded on the left side. e.g.: 0008309285 |
EventDate |
string (34) | Left | 603 | The date and time the event was triggered on. |
IsAdminUser |
integer (1) | Left | 637 | Flag to indicate if ModifiedById is an Admin User. Value will be 1 if ModifiedById is an Admin User and 0 otherwise. |
Example Event Notification File
Content: See 201909181350_EVENTNOTIFICATION.TXT
NOTE: Your browser or text editor may wrap the text to fit the window or silently convert the delimiter tab characters to spaces. Actual source file does not wrap and has delimiter tab characters.