API Documentation

Event Notification File

A record of notable events which have occurred in CorePro in the past hour. If no notable events have occurred, no file will be created.

Event Notification File Definition

This file is created by CorePro on an hourly basis. It has the following properties:

  1. Fixed-length. Header row is 129 bytes excluding line endings. Each content row is 363 bytes excluding line endings.
  2. ANSI encoded
  3. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
  4. File will be available in the relative directory of /EventNotification
  5. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_EVENTNOTIFICATION.TXT
  6. Root-relative path on sftp.corepro.io for that file would be: /EventNotification/201407161923_EVENTNOTIFICATION.TXT

Format Disclaimer
Social Money 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 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 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. Will be named following this pattern:
  1. yyyyMMddhhmm_EVENTNOTIFICATION.TXT
  2. Example: 201410210215_EVENTNOTIFICATION.TXT
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 Data Type (Length) 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.: 0008309285
This 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.: 0008309285
This 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:
  • 1 : Authenticate - Successful
  • 2 : Authenticate - Failed
  • 1001 : Created New Bank Holiday
  • 1002 : Modified Bank Holiday
  • 1003 : Removed Bank Holiday
  • 1004 : Modified Bank Information
  • 2001 : Modified Program Information
  • 2002 : Modified Program Settings - Deposit
  • 2003 : Modified Program Settings - Interest
  • 2004 : Modified Program Settings - Regulator
  • 2005 : Modified Program Settings - Withdrawal
  • 3001 : Modified Customer Details
  • 3002 : Added Note Customer
  • 3003 : Added Note Customer Verification
  • 3004 : Manually Approved Customer Verification
  • 3005 : Manually Denied Customer Verification
  • 3006 : Locked Customer Account
  • 3007 : Unlocked Customer Account
  • 3008 : Locked External Account
  • 3009 : Unlocked External Account
  • 3010 : Created External Account
  • 3011 : Modified External Account
  • 3012 : Verified External Account
  • 3013 : Resend Verify External Account
  • 3014 : Voided Account Transaction
  • 3015 : Voided External Account Transaction
  • 3016 : Reversed Account Transaction
  • 3017 : Reversed External Account Transaction
  • 3018 : Added Fee or Credit to Customer Account
  • 3019 : Modified Recurring Contribution
  • 3020 : Modified Customer Information
  • 3021 : Modified Customer Beneficiary Information
  • 3022 : Modified Customer Contact Information
  • 3023 : Modified Customer Residential Address
  • 3024 : Modified Customer Mailing Address
  • 3025 : Modified Customer CorePro Information
  • 3026 : Closed Customer Account
  • 3027 : Modified Customer Account Number
  • 3028 : Petty Cash - Check Issued
  • 3029 : Petty Cash - Check Issuance Cancelled
  • 3050 : Customer Name Change - Approved
  • 3051 : Customer Name Change - Denied
  • 3052 : Customer Address Change - Approved
  • 3053 : Customer Address Change - Denied
  • 3054 : Auto Approved Customer Verification
  • 3055 : Auto Denied Customer Verification
  • 3056 : Auto Expired Customer Verification - Initiated
  • 3057 : Auto Expired Customer Verification - Manual Review
  • 3058 : Funding Source Verified
  • 3059 : Created Customer Account
  • 3060 : Created Account Transaction

    Deprecated; broken out to 3060XXX values

  • 3061 : Modified Customer Account Information
  • 3062 : Monthly Statement Available
  • 3063 : Customer Closed
  • 4001 : Modified Client Information
  • 5001 : Unknown Event Logon User
  • 5002 : Modified Admin Logon User
  • 5003 : Deleted Admin Logon User
  • 5004 : Locked Admin Logon User
  • 5005 : Requested Password Reset on Logon User
  • 5006 : Password Reset on Logon User
  • 5007 : Archived Admin Logon User
  • 6001 : Sent NACHA File to Shazam
  • 7001 : R07 - Initiated
  • 7002 : R07 - Completed
  • 7003 : R10 - Initiated
  • 7004 : R10 - Completed
  • 7005 : R08 - Initiated
  • 7006 : R08 - Completed
  • 10001 : Card - Initiated
  • 10002 : Card - Pending
  • 10003 : Card - PendingVerification
  • 10004 : Card - Verified
  • 10005 : Card - Denied
  • 10006 : Card - Expired
  • 10007 : Card - Archived
  • 10009 : Card - Locked By Customer
  • 10010 : Card - Unlocked By Customer
  • 10011 : Card - Locked By Admin
  • 10012 : Card - Unlocked By Admin
  • 10013 : Card - Added Account
  • 10014 : Card - Removed Account
  • 10015 : Card - Lost Or Stolen
  • 10016 : Card - Reset Requested
  • 3060000 : Transaction - Generic / Unknown
  • 3060005 : Transaction - Bank Income to Internal (BNKDEP)
  • 3060010 : Transaction - Cash to Internal (CSHWTH)
  • 3060015 : Transaction - Cash to Program Reserve (CSHRSV)
  • 3060025 : Transaction - Cash to Return Clearing (CSHRET)
  • 3060030 : Transaction - Cash to Verification Fund (CSHVER)
  • 3060035 : Transaction - External to Internal (CPDEP)
  • 3060040 : Transaction - General Journal Deposit (GENDEP)
  • 3060045 : Transaction - General Journal Withdrawal (GENWTH)
  • 3060050 : Transaction - Interest Adjustment (INTADJ)
  • 3060055 : Transaction - Internal to Cash (CSHDEP)
  • 3060060 : Transaction - Internal to External (CPWTH)
  • 3060065 : Transaction - Internal to Interest Expense ()
  • 3060070 : Transaction - Internal to Internal (CPXFR)
  • 3060075 : Transaction - Internal to Miscellaneous (MSCWTH)
  • 3060080 : Transaction - Internal to Program Clearing (PCLWTH)
  • 3060085 : Transaction - Internal to Program Reserve (RSVWTH)
  • 3060090 : Transaction - Internal to Retail Clearing (RTLWTH)
  • 3060095 : Transaction - Internal to Unknown External (UNKWTH)
  • 3060100 : Transaction - Miscellaneous to Internal (MSCDEP)
  • 3060105 : Transaction - Program Account to Unknown External (RSVUNK)
  • 3060110 : Transaction - Program Clearing to Program External (PCLWTH)
  • 3060115 : Transaction - Program External to Internal (PXTDEP)
  • 3060120 : Transaction - Program Reserve to Cash (RSVCSH)
  • 3060125 : Transaction - Program Reserve to Internal (RSVDEP)
  • 3060130 : Transaction - Program Reserve to Verification Fund (RSVVER)
  • 3060135 : Transaction - Retail Clearing to Internal (RTLDEP)
  • 3060140 : Transaction - Retail Clearing to Retail External (RTLWTH)
  • 3060145 : Transaction - Return Clearing to Internal (RCLDEP)
  • 3060150 : Transaction - Return Deposit (RTNDEP)
  • 3060155 : Transaction - Return Withdraw (RTNWTH)
  • 3060165 : Transaction - Unknown External to Internal (UNKDEP)
  • 3060170 : Transaction - Unknown External to Program Account (UNKRET)
  • 3060175 : Transaction - Verification Fund to External (VERWTH)
  • 3060240 : Card Authorization - Purchase (ATHPCH)
  • 3060242 : Card Authorization - Cash Withdrawal (ATHCSH)
  • 3060244 : Card Authorization - Debit Adjustment (ATHDBT)
  • 3060246 : Card Authorization - Billpay (ATHBLP)
  • 3060248 : Card Authorization - Funds Transfer Debit (ATHFTD)
  • 3060250 : Card Authorization - Merchandise Return (ATHRTN)
  • 3060252 : Card Authorization - Deposit (ATHDEP)
  • 3060254 : Card Authorization - Credit Adjustment (ATHCDT)
  • 3060256 : Card Authorization - Point Of Business Deposit (ATHPOB)
  • 3060258 : Card Authorization - Funds Transfer Credit (ATHFTC)
  • 3060260 : Card Authorization - Transfer Funds (ATHXFR)
  • 3060262 : Card Authorization - AFD (ATHAFD)
  • 3060341 : Card Transaction - Purchase (CRDPCH)
  • 3060343 : Card Transaction - Cash Withdrawal (CRDCSH)
  • 3060345 : Card Transaction - Debit Adjustment (CRDDBT)
  • 3060347 : Card Transaction - Billpay (CRDBLP)
  • 3060349 : Card Transaction - Funds Transfer Debit (CRDFTD)
  • 3060351 : Card Transaction - Merchandise Return (CRDRTN)
  • 3060353 : Card Transaction - Deposit (CRDDEP)
  • 3060355 : Card Transaction - Credit Adjustment (CRDCDT)
  • 3060357 : Card Transaction - Point Of Business Deposit (CRDPOB)
  • 3060359 : Card Transaction - Funds Transfer Credit (CRDFTC)
  • 3060361 : Card Transaction - Transfer Funds (CRDXFR)
  • 3060363 : Card Transaction - AFD (CRDAFD)
  • 3060471 : Card Reversal - Purchase (REVPCH)
  • 3060473 : Card Reversal - Cash (REVCSH)
  • 3060475 : Card Reversal - Debit Adjustment (REVDBT)
  • 3060477 : Card Reversal - Billpay (REVBLP)
  • 3060479 : Card Reversal - Funds Transfer Debit (REVFTD)
  • 3060481 : Card Reversal - Merchandise Return (REVRTN)
  • 3060483 : Card Reversal - Deposit (REVDEP)
  • 3060485 : Card Reversal - Credit Adjustment (REVCDT)
  • 3060487 : Card Reversal - Point of Business (REVPOB)
  • 3060489 : Card Reversal - Funds Transfer Credit (REVFTC)
  • 3060493 : Card Reversal - AFD (REVAFD)
TransactionTypeCode string (6) Left 310 A programmatic code for the type of transaction. See transaction object definition for details.
TransactionSettledDate string (24) Left 316 The date and time the transaction was settled. See transaction object definition for details.
TransactionAvailableDate string (24) Left 340 The date and time the funds associated with the transaction became available. See transaction object definition for details.

Example Event Notification File

Content: See 201407161923_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.

Ready to start a conversation?

Email Us