Event Notifications
1. Version Control
Version | Date | Description of Changes |
Bahrain OBF v1.0.0 | 28th Oct 2020 | Initial Release |
2. Overview
The Event Notification API Profile describes the flows and common functionality to allow an AISP/PISP to receive event notifications.
The Event Notification Subscription API Profile provide mechanisms for AISPs/PISPs to register for event notifications.
The Event Notification Subscription API allows AISPs/ PISPs to register to receive all or specific event types via the Real Time Event Notification API and/or the Aggregated Polling API.
This profile should be read in conjunction with the other API profiles which detail the circumstances under which an event notification may be delivered.
3. Basis
3.1 Overview
The steps and sequence diagram below provide a general outline of a notification flow for all resources in the Read/Write APIs.
In this outline AISP/PISP registration for event notifications is performed using the Event Notification Subscription API.
3.2 Steps
Step 1: Setup Event Notification Subscription
This flow begins with an AISP/PISP creating an event-subscription resource with an ASPSP. This may optionally contain a callback url, and a series of event types
Step 2: Deliver Event Notification
An event corresponding to one of an ASPSP's event types occurs on a resource
Step 2a: ASPSP Sends Real Time Event Notification
AISP/PISP must have provided a callback URL with the event-subscription resource in order to receive the real time event notification
The ASPSP sends a signed event notification to the callback URL, detailing the nature of the event and identifying the affected resource
The AISP/PISP may optionally initiate a client credential grant to retrieve the resource using the details contained in the event notification
Step 2b: AISP/PISP Requests Event Notifications
AISP/PISP may request event notifications using aggregated polling
Step 3: Retrieve/Update/Delete Event Notification Subscription
AISP/PISP may Retrieve/Update/Delete the event notification subscription
3.3 Sequence Diagram
CENTRAL BANK OF BAHRAIN © 2020