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]
- 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]
- 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]
Design Considerations
Before designing your notification service(s), be sure to take into account all related regulatory requirements and any rules that your partner bank may have in effect. For example, are you familiar with the CAN-SPAM Act? A full analysis is beyond the scope of this article. Please refer to your Q2 Expert and your banking partner for additional assistance.
Any realtime notification system needs to contend with or be aware of a concept that, in this segment, we will refer to as "Gaps in Time". These are situations where an event occurs for a moment in the lifecycle of your Customer, but that for a variety of reasons the notification does not see final delivery to the Customer for some length of time after the moment. Let's use an example.
Bob's Card PurchaseBob buys a coffee using his debit card. This triggers a toast notification to be raised across the push notification network. A delay occurs at some point between the Customer and the Push notification registered with the device, most likely the carrier. Bob is informed he purchased the coffee at 1:00 AM at night, when the purchase took place at 1:00 PM in the afternoon. In one purchase of coffee, the notification never arrived.
For a variety of reasons, the answer is no. For example, what if a service subscribed to the bus plucking off the message fails to .Complete() the event correctly and then, for a technical reason, the message does not move to the deadletter queue?
Yes, by importing the Event Notification file.
| What | Who | From | To |
|---|---|---|---|
| Originating event | CorePro Platform | CorePro API | Service Bus |
| Email to Customer | FinTech (You) | FinTech (You) | Customer |
| Toast Notification to Customer | FinTech (You) | FinTech (You) | Customer |
| Event Notification File | CorePro Platform | CorePro | FinTech (You) |
Yes! Contact us and we'll ensure we provide the relative examples.