Crediterium®
api

Chirp Notifications

Full support for real time notifications from Chirp

Using the Ping / Callback API extensions to support real-time Chirp integrations.

This use case illustrates handling of real time, asynchronous events reported by Chirp Instant Financial Verification services. Customers can leverage this API and affiliated services to build their own automated workflows, responding in real time to changes in the client position.

The Chirp IFV subscription is triggered through any of the supported mechanism. For this example, the IFV request will be sent via the Chirp API, as depicted in the following figure.

%%{init: { 'theme':'base', 'themeVariables': { 'primaryColor': '#BB2528', 'primaryTextColor': '#000', 'primaryBorderColor': '#7C0000', 'lineColor': '#F8B229', 'secondaryColor': '#006100', 'tertiaryColor': '#000', 'fontFamily': 'Raleway, Verdana, Arial', 'fontSize': '30px' } } }%% sequenceDiagram participant back as Crediterium participant prov as Chirp opt Request IFV back->>prov: Request IFV activate prov prov->>back: Ack request with requestCode end

The response from Chirp will contain a requestCode to uniquely identify this particular subscription over time.

After this point, and depending on the specific trigger conditions configured within the Chirp environment for the specific customer, various types of events can be sent as per the figure below.

%%{init: { 'theme':'base', 'themeVariables': { 'primaryColor': '#BB2528', 'primaryTextColor': '#000', 'primaryBorderColor': '#7C0000', 'lineColor': '#F8B229', 'secondaryColor': '#006100', 'tertiaryColor': '#000', 'fontFamily': 'Raleway, Verdana, Arial', 'fontSize': '30px' } } }%% sequenceDiagram participant back as Crediterium participant prov as Chirp opt Callback notifications prov-->>back: Balance callback notification prov-->>back: Deposit callback notification prov-->>back: Account disconnect notification prov-->>back: Request status update prov-->>back: Refresh status update prov-->>back: Keyword match notification prov-->>back: Unsupported bank notification end

Example Requests

The Chirp Implementation Guide provides examples and details for each supported request.

curl "https://sandbox.ping.api.crediterium.net/v1/chirp" \
  -X POST \
  --header "Content-Type: application/json" \
  --data '<example payload from the documentation>'
Back to our APIs