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
1Authenticate - Successful
2Authenticate - Failed
1001Created New Bank Holiday
1002Modified Bank Holiday
1003Removed Bank Holiday
1004Modified Bank Information
2001Modified Program Information
2002Modified Program Settings - Deposit
2003Modified Program Settings - Interest
2004Modified Program Settings - Regulator
2005Modified Program Settings - Withdrawal
3001Modified Customer Details
3002Added Note Customer
3003Added Note Customer Verification
3004Manually Approved Customer Verification
3005Manually Denied Customer Verification
3006Locked Customer Account
3007Unlocked Customer Account
3008Locked External Account
3009Unlocked External Account
3010Created External Account
3011Modified External Account
3012Verified External Account
3013Resend Verify External Account
3014Voided Account Transaction
3015Voided External Account Transaction
3016Reversed Account Transaction
3017Reversed External Account Transaction
3018Added Fee or Credit to Customer Account
3019Modified Recurring Contribution
3020Modified Customer Information
3021Modified Customer Beneficiary Information
3022Modified Customer Contact Information
3023Modified Customer Residential Address
3024Modified Customer Mailing Address
3025Modified Customer CorePro Information
3026Closed Customer Account
3027Modified Customer Account Number
3028Petty Cash - Check Issued
3029Petty Cash - Check Issuance Cancelled
3050Customer Name Change - Approved
3051Customer Name Change - Denied
3052Customer Address Change - Approved
3053Customer Address Change - Denied
3054Auto Approved Customer Verification
3055Auto Denied Customer Verification
3056Auto Expired Customer Verification - Initiated
3057Auto Expired Customer Verification - Manual Review
3058Funding Source Verified
3059Created Customer Account
3060Created Account Transaction
3061Modified Customer Account Information
3062Monthly Statement Available
3063Customer Closed
3064Recurring Contribution Initiated
3065Customer Identity Screening
3066eCode Purchase
3067External Account - Awaiting Verification
3068Customer Verification - Application Abandon
3069Customer External Account Archived
3070Target Amount Has Been Met
3101Transaction Settled
3102Transaction Funds Available
3501Tax 1099-INT Available

Production only event

4001Modified Client Information
5001Unknown Event Logon User
5002Modified Admin Logon User
5003Deleted Admin Logon User
5004Locked Admin Logon User
5005Requested Password Reset on Logon User
5006Password Reset on Logon User
5007Archived Admin Logon User
6001Sent NACHA File to Shazam
7001R07 - Initiated
7002R07 - Completed
7003R10 - Initiated
7004R10 - Completed
7005R08 - Initiated
7006R08 - Completed
10001Debit Card Initiated
10002Debit Card Pending
10003Debit Card PendingVerification
10004Debit Card Verified
10005Debit Card Denied
10006Debit Card Expired
10007Debit Card Archived
10009Debit Card Locked By Customer
10010Debit Card Unlocked By Customer
10011Debit Card Locked By Admin
10012Debit Card Unlocked By Admin
10013Debit Card Added Account
10014Debit Card Removed Account
10015Debit Card Lost Or Stolen
10016Debit Card Reset Requested
10017Debit Card Authorization HoldDeprecated; see Debit Card Deposit / Withdrawal / Transfer / etc. events
10018Debit Card Reissued With Existing PAN
10019Debit Card Reissued With New PAN
3001001Admin - Accepted Customer Document
3001002Admin - Rejected Customer Document
3060000Generic Transaction UnknownDeprecated; see Customer Account Deposit / Withdrawal / Transfer / etc. events
3060500Check Deposit Authorization
3060501Check Deposit
3060502Check 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
3060005Transaction Bank Income to InternalFunds moved in from a program account, typically for reversing fees applied by the financial institution
3060010Transaction Cash to InternalFunds moved in from an outside source manually by a financial institution employee
3060035Transaction External to InternalFunds "pulled in" from another financial institution via generating a NACHA file
3060100Transaction Miscellaneous to InternalFunds moved in from a program account, typically for reversing fees
3060115Transaction Program External to InternalFunds moved in from a program account, typically due to NACHA returns of billpay
3060125Transaction Program Reserve to InternalFunds moved in from a program account, typically for purposes specific to the client, such as paying incentives to customers
3060135Transaction Retail Clearing to InternalDeprecated
3060145Transaction Return Clearing to Internal
3060155Transaction Return WithdrawFunds "pushed in" from another financial institution via receiving a NACHA return file
3060165Transaction Unknown External to InternalFunds "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
3060070Transaction Internal to InternalFunds 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
3060055Transaction Internal to CashFunds moved out to a cash account, typically via Admin console and typically for cutting physical checks
3060060Transaction Internal to ExternalFunds "pushed out" to another financial institution via generating a NACHA file
3060075Transaction Internal to MiscellaneousFunds moved out to a program account, typically for collecting fees
3060080Transaction Internal to Program ClearingFunds moved out to a program account, typically for bill pay
3060085Transaction Internal to Program ReserveFunds moved out to a program account, typically for purposes specific to the client, such as collecting fees
3060090Transaction Internal to Retail ClearingDeprecated
3060095Transaction Internal to Unknown ExternalFunds "pulled out" to another financial institution via receiving a NACHA file
3060150Transaction Return DepositFunds "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
3060015Transaction Cash to Program Reserve
3060025Transaction Cash to Return Clearing
3060030Transaction Cash to Verification Fund
3060170Transaction 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
3060105Transaction Program Account to Unknown External
3060110Transaction Program Clearing to Program External
3060120Transaction Program Reserve to Cash
3060130Transaction Program Reserve to Verification Fund
3060140Transaction Retail Clearing to Retail External
3060175Transaction 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
3060351Card Deposit - Merchandise ReturnReturn of goods or services
3060353Card Deposit - DepositCash or check is deposited into an ATM
3060355Card Deposit - Credit AdjustmentWhen card network provider manually Credits funds - Typically rare
3060357Card Deposit - Point Of Business DepositTBD
3060359Card Deposit - Funds Transfer CreditP2P 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
3060361Card TransferTransfer 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
3060341Card Withdrawal - PurchasePOS transaction as Debit
Typically if PIN or Chip were used
3060343Card Withdrawal - Cash WithdrawalATM Cash Withdrawal
3060345Card Withdrawal - Debit AdjustmentWhen card network provider manually Debits funds - Typically rare
3060347Card Withdrawal - BillpayDebit transaction for Billpay
3060349Card Withdrawal - Funds Transfer DebitP2P Withdrawal
3060363Card 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
3060240Card Authorization - PurchaseUser performs a purchase either online or by selecting "Credit" at the POS device
3060242Card Authorization - Cash WithdrawalFuture use
3060244Card Authorization - Debit AdjustmentFuture use
3060246Card Authorization - BillpayFuture use
3060248Card Authorization - Funds Transfer DebitFuture use
3060262Card 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
3060640Declined Card Purchase Auth
3060642Declined Card Cash Withdrawal Auth
3060644Declined Card Debit Adjustment Authoriz410ation
3060646Declined Card Billpay Auth
3060648Declined Card Funds Transfer Debit Auth
3060660Declined Card Transfer Funds Auth
3060662Declined Card AFD Auth
3060694Declined Card Available Inquiry Authorization Reversal
3060695Declined Card Balance Inquiry Authorization Reversal
3060741Declined Card Purchase
3060743Declined Card Cash Withdrawal
3060745Declined Card Debit Adjustment
3060747Declined Card Billpay
3060749Declined Card Funds Transfer Debit
3060751Declined Card Merchandise Return
3060753Declined Card Deposit
3060755Declined Card Credit Adjustment
3060757Declined Card Point Of Business Deposit
3060759Declined Card Funds Transfer Credit
3060761Declined Card Transfer Funds
3060763Declined Card AFD
3060794Declined Card Available Inquiry Reversal
3060795Declined Card Balance Inquiry Reversal
3060871Declined Card Purchase Authorization Reversal
3060873Declined Card Cash Authorization Reversal
3060875Declined Card Debit Adjustment Authorization Reversal
3060877Declined Card Billpay Authorization Reversal
3060879Declined Card Funds Transfer Debit Authorization Reversal
3060893Declined Card AFD Authorization Reversal
3060971Declined Card Purchase Reversal
3060973Declined Card Cash Reversal
3060975Declined Card Debit Adjustment Reversal
3060977Declined Card Billpay Reversal
3060979Declined Card Funds Transfer Debit Reversal
3060981Declined Card Merchandise Return ReversalA reversal of a merchandise return was attempted, but was declined. Very rare.
3060983Declined Card Deposit ReversalA reversal of a cash or check deposit into an ATM was attempted, but was declined. Very rare.
3060985Declined Card Credit Adjustment Reversal
3060987Declined Card Point of Business Reversal
3060989Declined Card Funds Transfer Credit Reversal
3060993Declined 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
3060294Card Authorization - Available InquiryAvailable Balance Inquiry typically performed via a non-ATM device
3060295Card Authorization - Ledger InquiryAccount Balance Inquiry typically performed via a non-ATM device
3060394Card Inquiry - Available InquiryAvailable Balance Inquiry typically performed via ATM
3060395Card Inquiry - Ledger InquiryAccount 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)

Error occurred when performing a P2P deposit, and it was reversed
Event Type Id Description Detail
3060481Card Reversal - Merchandise ReturnError occurred when performing a merchandise return, and it was reversed
3060483Card Reversal - DepositError occurred when depositing a cash or check via ATM, and it was reversed
3060485Card Reversal - Credit AdjustmentError occurred when performing a credit adjustment, and it was reversed
3060487Card Reversal - Point of BusinessError occurred when performing a Point of Business deposit, and it was reversed
3060489Card Reversal - Funds Transfer Credit

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
3060471Card Reversal - PurchaseError occurred on merchant device (ie, POS) and reverses a corresponding purchase
3060473Card Reversal - CashError occurred with ATM and the corresponding transaction was reversed
3060475Card Reversal - Debit AdjustmentError occurred when performing a debit adjustment, and it was reversed
3060477Card Reversal - BillpayError occurred when performing a billpay, and it was reversed
3060479Card Reversal - Funds Transfer DebitError occurred when performing a P2P withdrawal, and it was reversed
3060493Card 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
3060571Card Reversal - Purchase AuthorizationError occurred on merchant device (ie, POS) and reverses a corresponding purchase
3060573Card Reversal - Cash AuthorizationError occurred with ATM and corresponding transaction is reversed
3060575Card Reversal - Debit Adjustment Authorization
3060577Card Reversal - Billpay Authorization
3060579Card Reversal - Funds Transfer Debit Authorization
3060593Card Reversal - AFD Authorization

Ready to start a conversation?

Email Us