Table of Contents
Overview.. 2
Endpoints. 2
Note 1. 2
2.1. POST /event-subscriptions. 2
2.2. GET /event-subscriptions. 2
2.3. PUT /event-subscriptions/{EventSubscriptionId} 2
2.4. DELETE /event-subscriptions/{EventSubscriptionId} 3
Data Model 3
3.1. Event Subscription - Request 3
3.1.1 UML Diagram.. 3
3.1.2 Notes. 3
3.1.3 Data Dictionary. 3
3.2. Event Subscription - Response. 4
3.2.1 UML Diagram.. 4
3.2.2 Data Dictionary. 4
3.3. Event Subscriptions - Response. 5
3.3.1 UML Diagram.. 5
3.3.2 Data Dictionary. 5
Usage Example. 6
4.1. Create Event Subscription. 6
4.1.1 POST Event Subscription Request 6
4.1.2 POST Event Subscription Response. 6
4.2. GET Event Subscriptions. 7
4.2.1 GET Event Subscription Request 7
4.2.2 GET Event Subscription Response. 7
1. Overview
The Event Subscription resource is used by a TPP to subscribe to events with an ASPSP.
...
A TPP will set up and maintain its event subscription details (URL, event types and version number) using the event-subscription resource.
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 Signed Response | 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:
...
POST /event-subscriptions.
3.1.1 UML Diagram
...
3.1.2 Notes
For the OBEventSubscription object:
...
o TPPs 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 a TPP 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 |
|
|
3.2. Event Subscription - Response
The OBEventSubscriptionResponse object will be used for a response to a call to:
...
PUT /event-subscriptions
3.2.1 UML Diagram
...
3.2.2 Data Dictionary
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 a TPP 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 |
|
|
3.3. Event Subscriptions - Response
...
GET /event-subscriptions
3.3.1 UML Diagram
...
3.3.2 Data Dictionary
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 a TPP 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 |
|
|
|
4. Usage Example
4.1. Create Event Subscription
4.1.1 POST Event Subscription Request
|
...
| Code Block |
|
...
4.1.2 POST Event Subscription Response
|
...
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
...
4.2. GET GET Event Subscriptions
4.2.
...
1 GET Event Subscription Request
|
...
...
4.2.2 GET Event Subscription Response
|
...
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|