The Q2 CorePro Developer Hub

Welcome to the Q2 CorePro developer hub. You'll find comprehensive guides and documentation to help you start working with the CorePro API as quickly as possible.

Get Started    

The CorePro API is designed to handle typical web usage patterns. That is, human users clicking on website links and subsequently performing typical human user volumes of CorePro API calls. To enforce this, the throttling mechanism detailed in API Call Limit was introduced to ensure the health of the system as a whole.

However, with any system integration, there are times when mass quantities of data need to be transferred. CorePro supports this need via the following files:

File Type

Delivery Frequency

Summary

Account Balance File

Once Daily

Contains basic account information (including balances) for all accounts in an Open status or all accounts which moved to a Closed status on a given day.

ACH Transaction File

Once Daily

Contains all ACH transactions that posted on a given day

Admin Activity Files

Multiple Times Daily

Contains Admin Portal activity that has occurred since the previous file

Archived Customer Extract File

Once Daily

Contains all Customers in CorePro for a given program that moved to status=Archived on a given day.

Bulk Account Close Process

As Requested
Note: This file is processed manually. Users must open a support ticket for the file to be processed. Allow up to 4 business days.

Process large numbers of /account/close API calls

Bulk Account Lock Process

Multiple Times Daily

Process large numbers of /account/lock API calls

Bulk Account Unlock Process

Multiple Times Daily

Process large numbers of /account/unlock API calls

Bulk Transfer Process

Multiple Times Daily

Process large numbers of /transfer/create API calls

Card Event Notification File

Multiple Times Daily

Contains debit card properties which tie back to events in the corresponding Event Notification File

Card Transaction File

Once Daily

Contains all card transactions on a given day

Customer File

Once Daily

Contains basic customer information for all customers in a Verified status or all customers which moved to an Archived status on a given day.

Customer Registration File

Once Daily

Contains all newly registered customers

Event Notification File

Multiple Times Daily

Contains all notable events that have occurred since the previous event notification file

External Account File

Once Daily

Contains all external accounts for customers in a Verified status or customers which moved to an Archived status on a given day.

Posted Transaction File

Once Daily

Contains all transactions that posted on a given day

Recurring Contribution Process

Once Daily

Outlines the process for configuring and managing recurring deposits into CorePro accounts

Statement Event Notification File

Once Hourly

Contains statement properties which tie back to events in the corresponding Event Notification File

Trial Balance File

Once Daily

A listing of all accounts and program accounts

If your organization has the need to perform a large volume of requests to any other routes in the CorePro API, or access to other data points within CorePro, please contact us to discuss.

🚧

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.

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.

Updated 25 days ago

Overview


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.