API Documentation
Event Types
CorePro raises a wide variety of events in response to API interaction, batch processing, or Admin console use. They are broken out into the following categories, each of which has its own distinct structure for the actual payload.
| Category | Description | Source | Example |
|---|---|---|---|
| Common | These are actions that took place that are not specifically related to financial transactions or an attempt to create a financial transaction. | Admin console, API request, Batch processing | Someone using the Admin console unlocked an external account |
| Customer Account Deposits | These are actions that move funds into a customer account | Admin console, API request, Batch processing | ACH file was received and processing resulted in funds being "pushed into" the customer's account |
| Customer Account Transfers | These are actions that move funds into a customer account from another one of the same customer's accounts | Admin console, API request, Batch processing | An API request was made to transfer funds from the customer's primary checking account to their secondary checking account |
| Customer Account Withdrawals | These are actions that move funds out of a customer account | Admin console, API request, Batch processing | A Bulk Transfer File was received and processing it resulted in funds being "pushed out" of the customer's account via ACH |
| Program Account Deposits | These are actions that move funds into a program account but never touch a customer account | Admin console, API request, Batch processing | ACH file was received and processing resulted in funds being "pushed into" the program's account |
| Program Account Withdrawals | These are actions that move funds out of a program account but never touch a customer account | Admin console, API request, Batch processing | During NACHA processing, program clearing account funds are "pushed out" to an external account via ACH |
| Debit Card Deposits | These are actions that move funds into a customer account due to debit card usage or debit card network provider administrative actions | Debit card usage, Debit card background processing, Admin console | An end user returns an item previously purchased a department store |
| Debit Card Transfers | These are actions that moves funds between two accounts for the same customer due to debit card usage or debit card network provider administrative actions | Debit card usage, Debit card background processing, Admin console | An end user uses an ATM to transfer funds between their checking account and their savings account |
| Debit Card Withdrawals | These are actions that move funds out of a customer account due to debit card usage or debit card network provider administrative actions | Debit card usage, Debit card background processing, Admin console | An end user purchases an item at a department store |
| Debit Card Declined | These are actions that attempt to move funds using a debit card, but are denied for some reason | Debit card usage, Debit card background processing | An end user attempts to purchase an item for $20 but there is only $17 available in their primary account assigned to the debit card |
Common Events
These events are not related to or caused by a transaction, but rather some other action taking place within CorePro.
Payload Type: Common Payload (1)
| Event Type Id | Description | Detail |
|---|---|---|
| 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 | |
| 3061 | Modified Customer Account Information | |
| 3062 | Monthly Statement Available | |
| 3063 | Customer Closed | |
| 3064 | Recurring Contribution Initiated | |
| 3065 | Customer Identity Screening | |
| 3066 | eCode Purchase | |
| 3067 | External Account - Awaiting Verification | |
| 3068 | Customer Verification - Application Abandon | |
| 3069 | Customer External Account Archived | |
| 3070 | Target Amount Has Been Met | |
| 3101 | Transaction Settled | |
| 3102 | Transaction Funds Available | |
| 3501 | Tax 1099-INT Available Production only event | |
| 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 | Debit Card Initiated | |
| 10002 | Debit Card Pending | |
| 10003 | Debit Card PendingVerification | |
| 10004 | Debit Card Verified | |
| 10005 | Debit Card Denied | |
| 10006 | Debit Card Expired | |
| 10007 | Debit Card Archived | |
| 10009 | Debit Card Locked By Customer | |
| 10010 | Debit Card Unlocked By Customer | |
| 10011 | Debit Card Locked By Admin | |
| 10012 | Debit Card Unlocked By Admin | |
| 10013 | Debit Card Added Account | |
| 10014 | Debit Card Removed Account | |
| 10015 | Debit Card Lost Or Stolen | |
| 10016 | Debit Card Reset Requested | |
| 10017 | Debit Card Authorization Hold | Deprecated; see Debit Card Deposit / Withdrawal / Transfer / etc. events |
| 10018 | Debit Card Reissued With Existing PAN | |
| 10019 | Debit Card Reissued With New PAN | |
| 3001001 | Admin - Accepted Customer Document | |
| 3001002 | Admin - Rejected Customer Document | |
| 3060000 | Generic Transaction Unknown | Deprecated; see Customer Account Deposit / Withdrawal / Transfer / etc. events |
| 3060500 | Check Deposit Authorization | |
| 3060501 | Check Deposit | |
| 3060502 | Check Deposit Reversal |
Customer Account Deposit Events
These events are caused by funds moving into a customer's account by any means except debit card.
Payload Type: Customer Account Deposit (200)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060005 | Transaction Bank Income to Internal | Funds moved in from a program account, typically for reversing fees applied by the financial institution |
| 3060010 | Transaction Cash to Internal | Funds moved in from an outside source manually by a financial institution employee |
| 3060035 | Transaction External to Internal | Funds "pulled in" from another financial institution via generating a NACHA file |
| 3060100 | Transaction Miscellaneous to Internal | Funds moved in from a program account, typically for reversing fees |
| 3060115 | Transaction Program External to Internal | Funds moved in from a program account, typically due to NACHA returns of billpay |
| 3060125 | Transaction Program Reserve to Internal | Funds moved in from a program account, typically for purposes specific to the client, such as paying incentives to customers |
| 3060135 | Transaction Retail Clearing to Internal | Deprecated |
| 3060145 | Transaction Return Clearing to Internal | |
| 3060155 | Transaction Return Withdraw | Funds "pushed in" from another financial institution via receiving a NACHA return file |
| 3060165 | Transaction Unknown External to Internal | Funds "pushed in" from another financial institution via receiving a NACHA file |
Customer Account Transfer Events
These events are caused by funds moving between two accounts owned by the same customer by any means except debit card.
Payload Type: Customer Account Transfer (201)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060070 | Transaction Internal to Internal | Funds moved from one account to another account, both owned by the same customer |
Customer Account Withdrawal Events
These events are caused by funds moving out of a customer's account by any means except debit card.
Payload Type: Customer Account Withdrawal (202)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060055 | Transaction Internal to Cash | Funds moved out to a cash account, typically via Admin console and typically for cutting physical checks |
| 3060060 | Transaction Internal to External | Funds "pushed out" to another financial institution via generating a NACHA file |
| 3060075 | Transaction Internal to Miscellaneous | Funds moved out to a program account, typically for collecting fees |
| 3060080 | Transaction Internal to Program Clearing | Funds moved out to a program account, typically for bill pay |
| 3060085 | Transaction Internal to Program Reserve | Funds moved out to a program account, typically for purposes specific to the client, such as collecting fees |
| 3060090 | Transaction Internal to Retail Clearing | Deprecated |
| 3060095 | Transaction Internal to Unknown External | Funds "pulled out" to another financial institution via receiving a NACHA file |
| 3060150 | Transaction Return Deposit | Funds "pulled out" to another financial institution via receiving a NACHA return file |
Program Account Deposit Events
These events are caused by funds moving into a program's account but never touching a customer account.
Payload Type: Program Account Deposit (300)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060015 | Transaction Cash to Program Reserve | |
| 3060025 | Transaction Cash to Return Clearing | |
| 3060030 | Transaction Cash to Verification Fund | |
| 3060170 | Transaction Unknown External to Program Account |
Program Account Withdrawal Events
These events are caused by funds moving out of a program's account but never touching a customer account.
Payload Type: Program Account Withdrawal (302)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060105 | Transaction Program Account to Unknown External | |
| 3060110 | Transaction Program Clearing to Program External | |
| 3060120 | Transaction Program Reserve to Cash | |
| 3060130 | Transaction Program Reserve to Verification Fund | |
| 3060140 | Transaction Retail Clearing to Retail External | |
| 3060175 | Transaction Verification Fund to External |
Debit Card Deposit Events
These events are caused by funds moving into the customer's account due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Deposit (400)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060351 | Card Deposit - Merchandise Return | Return of goods or services |
| 3060353 | Card Deposit - Deposit | Cash or check is deposited into an ATM |
| 3060355 | Card Deposit - Credit Adjustment | When card network provider manually Credits funds - Typically rare |
| 3060357 | Card Deposit - Point Of Business Deposit | TBD |
| 3060359 | Card Deposit - Funds Transfer Credit | P2P Deposit |
Debit Card Transfer Events
These events are caused by funds moving between two accounts owned by the same customer due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Transfer (401)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060361 | Card Transfer | Transfer between accounts tied to same card |
Debit Card Withdrawal Events
These events are caused by funds moving out of the customer's account due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Withdrawal (402)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060341 | Card Withdrawal - Purchase | POS transaction as Debit Typically if PIN or Chip were used |
| 3060343 | Card Withdrawal - Cash Withdrawal | ATM Cash Withdrawal |
| 3060345 | Card Withdrawal - Debit Adjustment | When card network provider manually Debits funds - Typically rare |
| 3060347 | Card Withdrawal - Billpay | Debit transaction for Billpay |
| 3060349 | Card Withdrawal - Funds Transfer Debit | P2P Withdrawal |
| 3060363 | Card Withdrawal - AFD (Automated Fuel Dispenser) | When fuel transaction completes |
Debit Card Withdrawal Authorization Events
These events are caused by funds being held on the customer's account due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Withdrawal Authorization (403)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060240 | Card Authorization - Purchase | User performs a purchase either online or by selecting "Credit" at the POS device |
| 3060242 | Card Authorization - Cash Withdrawal | Future use |
| 3060244 | Card Authorization - Debit Adjustment | Future use |
| 3060246 | Card Authorization - Billpay | Future use |
| 3060248 | Card Authorization - Funds Transfer Debit | Future use |
| 3060262 | Card Authorization - AFD (Automated Fuel Dispenser) | Fuel transaction initiated at an AFD device |
Debit Card Declined Events
These events are caused by a failed attempt to move funds due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Declined (410)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060640 | Declined Card Purchase Auth | |
| 3060642 | Declined Card Cash Withdrawal Auth | |
| 3060644 | Declined Card Debit Adjustment Authoriz410ation | |
| 3060646 | Declined Card Billpay Auth | |
| 3060648 | Declined Card Funds Transfer Debit Auth | |
| 3060660 | Declined Card Transfer Funds Auth | |
| 3060662 | Declined Card AFD Auth | |
| 3060694 | Declined Card Available Inquiry Authorization Reversal | |
| 3060695 | Declined Card Balance Inquiry Authorization Reversal | |
| 3060741 | Declined Card Purchase | |
| 3060743 | Declined Card Cash Withdrawal | |
| 3060745 | Declined Card Debit Adjustment | |
| 3060747 | Declined Card Billpay | |
| 3060749 | Declined Card Funds Transfer Debit | |
| 3060751 | Declined Card Merchandise Return | |
| 3060753 | Declined Card Deposit | |
| 3060755 | Declined Card Credit Adjustment | |
| 3060757 | Declined Card Point Of Business Deposit | |
| 3060759 | Declined Card Funds Transfer Credit | |
| 3060761 | Declined Card Transfer Funds | |
| 3060763 | Declined Card AFD | |
| 3060794 | Declined Card Available Inquiry Reversal | |
| 3060795 | Declined Card Balance Inquiry Reversal | |
| 3060871 | Declined Card Purchase Authorization Reversal | |
| 3060873 | Declined Card Cash Authorization Reversal | |
| 3060875 | Declined Card Debit Adjustment Authorization Reversal | |
| 3060877 | Declined Card Billpay Authorization Reversal | |
| 3060879 | Declined Card Funds Transfer Debit Authorization Reversal | |
| 3060893 | Declined Card AFD Authorization Reversal | |
| 3060971 | Declined Card Purchase Reversal | |
| 3060973 | Declined Card Cash Reversal | |
| 3060975 | Declined Card Debit Adjustment Reversal | |
| 3060977 | Declined Card Billpay Reversal | |
| 3060979 | Declined Card Funds Transfer Debit Reversal | |
| 3060981 | Declined Card Merchandise Return Reversal | A reversal of a merchandise return was attempted, but was declined. Very rare. |
| 3060983 | Declined Card Deposit Reversal | A reversal of a cash or check deposit into an ATM was attempted, but was declined. Very rare. |
| 3060985 | Declined Card Credit Adjustment Reversal | |
| 3060987 | Declined Card Point of Business Reversal | |
| 3060989 | Declined Card Funds Transfer Credit Reversal | |
| 3060993 | Declined Card AFD Reversal |
Debit Card Balance Inquiry Events
These events are caused by balance inquiries due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Balance Inquiry (490)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060294 | Card Authorization - Available Inquiry | Available Balance Inquiry typically performed via a non-ATM device |
| 3060295 | Card Authorization - Ledger Inquiry | Account Balance Inquiry typically performed via a non-ATM device |
| 3060394 | Card Inquiry - Available Inquiry | Available Balance Inquiry typically performed via ATM |
| 3060395 | Card Inquiry - Ledger Inquiry | Account Balance Inquiry typically performed via ATM |
Debit Card Deposit Reversal Events
These events are caused by the reversal of moving funds into the customer's account due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Deposit Reversal (500)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060481 | Card Reversal - Merchandise Return | Error occurred when performing a merchandise return, and it was reversed |
| 3060483 | Card Reversal - Deposit | Error occurred when depositing a cash or check via ATM, and it was reversed |
| 3060485 | Card Reversal - Credit Adjustment | Error occurred when performing a credit adjustment, and it was reversed |
| 3060487 | Card Reversal - Point of Business | Error occurred when performing a Point of Business deposit, and it was reversed |
| 3060489 | Card Reversal - Funds Transfer Credit | Error occurred when performing a P2P deposit, and it was reversed
Debit Card Transfer Reversal Events
These events are caused by the reversal of moving funds between two accounts owned by the same customer due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Transfer Reversal (501)
| Event Type Id | Description | Detail |
|---|
Debit Card Withdrawal Reversal Events
These events are caused by the reversal of moving funds out of the customer's account due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Withdrawal Reversal (502)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060471 | Card Reversal - Purchase | Error occurred on merchant device (ie, POS) and reverses a corresponding purchase |
| 3060473 | Card Reversal - Cash | Error occurred with ATM and the corresponding transaction was reversed |
| 3060475 | Card Reversal - Debit Adjustment | Error occurred when performing a debit adjustment, and it was reversed |
| 3060477 | Card Reversal - Billpay | Error occurred when performing a billpay, and it was reversed |
| 3060479 | Card Reversal - Funds Transfer Debit | Error occurred when performing a P2P withdrawal, and it was reversed |
| 3060493 | Card Reversal - AFD (Automated Fuel Dispenser) | Error occurred when performing an AFD purchase, and it was reversed |
Debit Card Withdrawal Authorization Reversal Events
These events are caused by the reversal of holding funds on the customer's account due to debit card usage or debit card network provider processing.
Payload Type: Debit Card Withdrawal Authorization Reversal (503)
| Event Type Id | Description | Detail |
|---|---|---|
| 3060571 | Card Reversal - Purchase Authorization | Error occurred on merchant device (ie, POS) and reverses a corresponding purchase |
| 3060573 | Card Reversal - Cash Authorization | Error occurred with ATM and corresponding transaction is reversed |
| 3060575 | Card Reversal - Debit Adjustment Authorization | |
| 3060577 | Card Reversal - Billpay Authorization | |
| 3060579 | Card Reversal - Funds Transfer Debit Authorization | |
| 3060593 | Card Reversal - AFD Authorization |