API Documentation
Table of Contents:[Hide]
- Platform Overview [active]
- Get Started [active]
- User Interface Restrictions [active]
- FAQ [active]
- Learning Center Review [active]
- Learning Center [active]
- Request / Response [active]
-
Batch Processing
- Overview [active]
- Account Balance File [active]
- Bulk Transfer Process [active]
- Customer File [active]
- Customer Registration File [active]
- Event Notification File [active]
- Card Event Notification File [active]
- Statement Event Notification File [active]
- Posted Transaction File [active]
- ACH Transaction File [active]
- Card Transaction File [active]
- Recurring Contribution Process [active]
- Admin Activity Files [active]
-
API Objects
- Overview [active]
- Account [active]
- Account Access [active]
- Address [active]
- Bank Document [active]
- Bin [active]
- Card [active]
- Check [active]
- Customer [active]
- Customer Beneficiary [active]
- Customer Document [active]
- Deposit Availability [active]
- Document [active]
- Error [active]
- External Account [active]
- External Account Document [active]
- Limit [active]
- Phone [active]
- Program [active]
- Product [active]
- Statement [active]
- Transaction [active]
- Transfer [active]
- Realtime Objects
[Mobile] Table of Contents:
- Overview [active]
- Get Started [active]
- Test Drive[active]
- Recipes[active]
- FAQ [active]
- Request / Response [active]
- User Interface Restrictions [active]
- API Learning Center Review [active]
- Learning Center [active]
-
Batch Processing
- Overview [active]
- Account Balance File [active]
- Bulk Transfer Process [active]
- Customer File [active]
- Customer Registration File [active]
- Event Notification File [active]
- Statement Event Notification File [active]
- Posted Transaction File [active]
- ACH Transaction File [active]
- Card Transaction File [active]
- Recurring Contribution Process [active]
- Admin Activity Files [active]
-
Objects
- Overview [active]
- Account [active]
- Account Access [active]
- Address [active]
- Bank Document [active]
- Bin [active]
- Card [active]
- Check [active]
- Customer [active]
- Customer Beneficiary [active]
- Customer Document [active]
- Deposit Availability [active]
- Document [active]
- Error [active]
- External Account [active]
- External Account Document [active]
- Limit [active]
- Phone [active]
- Program [active]
- Statement [active]
- Transaction [active]
- Transfer [active]
A product that shares moments in realtime. The Realtime Product is an Opt-In service available to all CorePro Platform clients that enables clients to be notified regarding key events. Let's use an example to illustrate what this means.
Example 1 - "Bob":Is the Realtime Product required?Bob is a Customer of a CorePro client. (this is you!) Bob has two accounts on CorePro. One is his Primary Account and the other is a Sub-Account that he created to automatically receive deposits every thirty days. On the fifteenth of the month, Bob likes to move half of his deposit from his Sub-Account to his Primary. His Primary account is linked to a debit card that he has on file and has registered the debit card with his phone's payment application for phone based payment. Bob buys a coffee on Tuesday.
What realtime provides for the CorePro Client
- The moment the POS purchase of the coffee occurs
- The moment Bob transfers money from his Sub-Account to his Primary
- The moment Bob receives the automatic recurring deposit into his Sub-Account
It's up to you if the Realtime product is required in your business model. Some clients do not have a need for Realtime Processing. Some like to present toast notifications to their Customer when a transaction occurs regarding their accounts. The choice is yours.
Are there any known limitations?Realtime Notifications provides reasonable assurances of delivery of messages; however, similar to the issues faced in other realtime networks (such as SMS) there are no guarantees of delivery. In critical business processing, it is recommended to perform reconciliation and failure for realtime events using the Event Notification File described in this online help.
Can I get the events related to my Customers without going through realtime?We provide an "Events" file that provides the event data. The file is recommended for scenarios where critical business operations need to occur based on Customer events. An example of this scenario is a billing model. Let us say that for every ten transactions on a Sub-Account your busineses model requires a fee to be assessed. We strongly encourage and in some scenarios require that no billing be derived off the realtime product, but that instead that billing be derived off the file.
What expertise and technologies are required?The realtime product makes use of an AMQP transport protocol, the Azure Service Bus, and a Json payload structure. Familiarity with the CorePro API, the previously listed technologies, and enterprise architectures are strongly recommended. Additionally, please refer to the design considerations page for more information that should be incorporated into your technical specification.
Do you have a box diagram of how this works at 60,000 feet?Yes! See below.
