| Table of Contents | ||||
|---|---|---|---|---|
|
...
The Event Notification subscription API Profile describes the flows and common functionality to allow an AISP/ PISP to:
Register an event subscription with an ASPSP to subscribe to event notifications.
A subscription can enable real time event notifications via an HTTP callback from the ASPSP, and aggregated polling by the AISP/PISP.
Specify a list of event types to be notified on.
Optionally read, update or delete a registered event subscription.
AISPs / PISPs can 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.
The following APIs have been elaborated below:
1.Real-Time Notification:
ASPSP shares the notifications with the AISP/ PISP real time, as soon as the event occurs.
2.Aggregated Polling (Pull Notifications):
ASPSP shares the notifications to AISPs/ PISPs in an aggregated set, upon request
1. Overview
The Event Subscription resource is used by an AISP/PISP to subscribe to events with an ASPSP.
...
S. No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
2.1 | event-subscription | POST | POST /event-subscriptions | Optional | accounts | Client Credentials | Signed Request | No | OBEventSubscription | OBEventSubscriptionResponse |
2.2 | event-subscription | GET | GET /event-subscriptions | Mandatory (if resource POST implemented) | accounts | Client Credentials | Signed Response | No | n/a | OBEventSubscriptionsResponse |
2.3 | event-subscription | PUT | PUT /event-subscriptions/{EventSubscriptionId} | Conditional (See Note 1) | accounts | Client Credentials | Signed Request Signed Response | No | OBEventSubscriptionResponse | OBEventSubscriptionResponse |
2.4 | event-subscription | DELETE | DELETE /event-subscriptions/{EventSubscriptionId} | Conditional (See Note 1) | accounts | Client Credentials | n/a | No | n/a | n/a |
Note 1
Implementation for an ASPSP is:
...
2.1 POST /event-subscriptions
...
The POST action allows the AISP/ PISP to register an event subscription for an AISP/ PISP to access event notifications.
The ASPSP creates the event-subscription resource and responds with a unique EventSubscriptionId to refer to the resource.
An ASPSP ASPSP must respond with a 409 error if an event-subscription exists for that AISP/ PISP.
...
AISP/ PISP must not provide CallbackUrl, when subscribing for Aggregated Polling only
AISP/ PISP must provide the Version of Resources, for which they want to subscribe the events for. E.g. if supplied with value "3.1", AISP/ PISP indicates the subscription for the change in state of resources created in v3.1 version
EventTypes usage:
o AISPs/ PISPs may provide a list of event types to subscribe to specific events.
o AISPs/ PISPs may omit this field to subscribe to all supported events
3.1.3 Data Dictionary
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBEventSubscription |
| OBEventSubscription |
| OBEventSubscription |
|
|
Data | 1..1 | OBEventSubscription/Data |
| OBEventSubscription/Data |
|
|
CallbackUrl | 0..1 | OBEventSubscription/Data/CallbackUrl | Callback URL for an AISP/ PISP hosted service. Will be used by ASPSPs, in conjunction with the resource name, to construct a URL to send event notifications to | String:URI |
|
|
Version | 1..1 | OBEventSubscription/Data/Version | Version for the event notification. | String |
|
|
EventTypes | 0..n | OBEventSubscription/Data/EventTypes | Array of event types the subscription applies to | Array:String | Enum:
|
|
3.2 Event Subscription - Response
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBEventSubscriptionResponse |
| OBEventSubscriptionResponse |
| OBEventSubscriptionResponse |
|
|
Data | 1..1 | OBEventSubscriptionResponse/Data |
| OBEventSubscriptionResponse/Data |
|
|
EventSubscriptionId | 1..1 | OBEventSubscriptionResponse/Data/EventSubscriptionId | Unique identification as assigned by the ASPSP to uniquely identify the callback URL resource. | String |
|
|
CallbackUrl | 0..1 | OBEventSubscriptionResponse/Data/CallbackUrl | Callback URL for an AISP/ PISP hosted service. Will be used by ASPSPs, in conjunction with the resource name, to construct a URL to send event notifications to | String:URI |
|
|
Version | 1..1 | OBEventSubscriptionResponse/Data/Version | Version for the event notification. | String |
|
|
EventTypes | 0..n | OBEventSubscriptionResponse/Data/EventTypes | Array of event types the subscription applies to | Array:String | Enum:
|
|
3.3 Event Subscriptions - Response
...
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBEventSubscriptionsResponse |
| OBEventSubscriptionsResponse |
| OBEventSubscriptionsResponse |
|
|
Data | 1..1 | OBEventSubscriptionsResponse/Data |
| OBEventSubscriptionsResponse/Data |
|
|
EventSubscription | 0..n | OBEventSubscriptionsResponse/Data/EventSubscription |
| OBEventSubscriptionsResponse/Data/EventSubscription |
|
|
EventSubscriptionId | 1..1 | OBEventSubscriptionsResponse/Data/EventSubscription/EventSubscriptionId | Unique identification as assigned by the ASPSP to uniquely identify the callback url resource. | String |
|
|
Url | 0..1 | OBEventSubscriptionsResponse/Data/EventSubscription/Url | Callback URL for an AISP/ PISP hosted service. Will be used by ASPSPs, in conjunction with the resource name, to construct a URL to send event notifications to. | String:URI |
|
|
Version | 1..1 | OBEventSubscriptionsResponse/Data/EventSubscription/Version | Version for the event notification. | String |
|
|
EventTypes | 0..n | OBEventSubscriptionsResponse/Data/EventSubscription/EventTypes | Array of event types the subscription applies to. | Array:String | Enum:
|
|
4. Usage Example
4.1 Create Event Subscription
...