1. Overview

The Event Subscription resource is used by a TPP to subscribe to events with an ASPSP.

This resource description should be read in conjunction with a compatible Event Notification Subscription Profile.

2. Endpoints

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 _payments _{fundsconfirmations}	_{Client Credentials}	_{Signed Request} _{Signed Response}	_No	_{OBEventSubscription}	_{OBEventSubscriptionResponse}
_2.2	_{event-subscription}	_GET	_{GET /event-subscriptions}	_{Mandatory (if resource POST implemented)}	_accounts _payments _{fundsconfirmations}	_{Client Credentials}	_{Signed Response}	_No	_n/a	_{OBEventSubscriptionsResponse}
_2.3	_{event-subscription}	_PUT	_{PUT /event-subscriptions/{EventSubscriptionId}}	_{Conditional (See Note 1)}	_accounts _payments _{fundsconfirmations}	_{Client Credentials}	_{Signed Request} _{Signed Response}	_No	_{OBEventSubscriptionResponse}	_{OBEventSubscriptionResponse}
_2.4	_{event-subscription}	_DELETE	_{DELETE /event-subscriptions/{EventSubscriptionId}}	_{Conditional (See Note 1)}	_accounts _payments _{fundsconfirmations}	_{Client Credentials}	_n/a	_No	_n/a	_n/a

Note 1

Implementation for an ASPSP is:

Optional, where both the following are true:
- The ASPSP supports aggregated polling only
- The ASPSP only supports a single event type for aggregated polling
Mandatory, when the above is not true and ASPSP implemented POST /event-subscriptions

2.1. POST /event-subscriptions

The API endpoint allows the TPP to ask an ASPSP to create a new event-subscription resource.

The POST action allows the TPP to register an event subscription for a TPP to access event notifications.
The ASPSP creates the event-subscription resource and responds with a unique EventSubscriptionId to refer to the resource.
An ASPSP must respond with a 409 error if an event-subscription exists for that TPP.

2.2. GET /event-subscriptions

The API endpoint allows the TPP to ask an ASPSP to retrieve its event-subscription resource.

The ASPSP retrieves the event-subscription resource and responds with the resource.

2.3. PUT /event-subscriptions/{EventSubscriptionId}

The API endpoint allows the TPP to ask an ASPSP to update an event-subscription resource.

The PUT action allows the TPP to update an event subscription for a TPP to access event notifications.
The ASPSP updates the event-subscription resource and responds with the updated resource

2.4. DELETE /event-subscriptions/{EventSubscriptionId}

The API endpoint allows the TPP to ask an ASPSP to delete an event-subscription resource.

The ASPSP deletes the event-subscription resource.

3. Data Model

3.1. Event Subscription - Request

The OBEventSubscription object will be used for the call to:

POST /event-subscriptions.

3.1.1 UML Diagram

Bahrain OBF (Dev) > Event Subscription > Event Subscription - Request UML.png

3.1.2 Notes

For the OBEventSubscription object:

TPP must not provide CallbackUrl, when subscribing for Aggregated Polling only
TPP must provide the Version of Resources, for which they want to subscribe the events for. E.g. if supplied with value "3.1", TPP indicates the subscription for the change in state of resources created in v3.1 version
EventTypes usage:
- TPPs may provide a list of event types to subscribe to specific events.
- 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:

POST /event-subscriptions
PUT /event-subscriptions/{EventSubscriptionId}

The OBEventSubscriptionResponse object will also be used for the call to:

PUT /event-subscriptions

3.2.1 UML Diagram

Bahrain OBF (Dev) > Event Subscription > Event Subscription - Response UML.png

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

The OBEventSubscriptionsResponse object will be used for a response to a call to:

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

POST /event-subscriptions

Authorization: Bearer 4ZopnFZFKjr5zDsicSQpLL

x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==

x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f

Content-Type: application/json

Accept: application/json

{ "Data": { "CallbackUrl": "https://tpp.com/open-banking/event-notifications", "Version": "2.2" } }

4.1.2 POST Event Subscription Response

201 Created

x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K

x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865

Content-Type: application/json

{ "Data": { "EventSubscriptionId": "CB-101", "CallbackUrl": "https://tpp.com/open-banking/event-notifications", "Version": "2.2" }, "Links": { "Self": "www.tbc.com" }, "Meta": {} }

4.2. GET Event Subscriptions

4.2.1 GET Event Subscription Request

GET /event-subscriptions

Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA

x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865

Accept: application/json

4.2.2 GET Event Subscription Response

200 OK

x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K

x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865

Content-Type: application/json

{ "Data": { "EventSubscription": [{ "EventSubscriptionId": "CB-101", "CallbackUrl": "https://tpp.com/open-banking/event-notifications", "Version": "2.2" }] }, "Links": { "Self": "www.tbc.com" }, "Meta": {} }