| Table of Contents | ||||
|---|---|---|---|---|
|
The Real Time Event Notification API Profile describes the flows common functionality for the Real Time Event Notification API, which allows ASPSPs to notify an AISP/ PISP that an event has occurred.
Step: Send Event Notification
When an event occurs on a resource that requires a notification, the ASPSP identifies the callback-url associated with the AISP/ PISP owning the affected resource.
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.
This functionality enables an ASPSP to notify the AISP/ PISP in real time after an event occurs. Upon receipt of this notification, AISPs/ PISPs can notify the user/customer, if required, regarding completion of the event.
1. Overview
The Event Notification resource is used by a an ASPSP to notify an AISP/ PISP of an event.
...
The API endpoint allows the ASPSP to send an event-notification resource to a an AISP/ PISP.
2.2 Transport Level Security
AISP/ PISP hosted endpoints must be protected using TLS 1.2, as per the FAPI RRead/W Write specification.
AISP/ PISP hosted endpoints must be protected using a network certificate issued by a Trust Anchor supported by the ASPSP.
MA-TLS is not applicable to AISP/ PISP hosted endpoints.
3. Data Model
3.1 Event Notification - Request
...
The rid, rty and rlk claims are prefixed with the OB namespace http://openbanking.org.bh in the data model. The namespace has been removed from the diagram for clarity..
3.1.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | ClassCodes | Pattern | |
OBEventNotification | OBEventNotification |
|
| OBEventNotification |
|
|
issIss | 1..1 | OBEventNotification/iss | Issuer. | String |
|
|
iatIat | 1..1 | OBEventNotification/iat | Issued At. | Number |
|
|
jtiJti | 1..1 | OBEventNotification/jti | JWT ID. | String |
|
|
audAud | 1..1 | OBEventNotification/aud | Audience. | String |
|
|
subSub | 1..1 | OBEventNotification/sub | Subject. | String : URI |
|
|
txnTxn | 1..1 | OBEventNotification/txn | Transaction Identifier. | String |
|
|
toeToe | 1..1 | OBEventNotification/toe | Time of Event. | Number |
|
|
eventsEvents | 1..1 | OBEventNotification/events | Events. | OBEvent |
| |
urn:bh:org:openbanking:events:resource-update update | 0..1 | OBEventNotification/events/ urn:bh:org:cbb_openbanking:events:resource-update update | Resource-Update Event. | OBEventResourceUpdate |
|
|
urn:bh:org:openbanking:events:account-access-consent-linked-account-update update | 0..1 | OBEventNotification/events/ urn:bh:org:cbb_openbanking:events:account-access-consent-linked-account-update | An event that indicates an account linked to a consent has move in/out of scope of the consent. | OBEventAccountAccessConsentLinkedAccountUpdate |
|
|
urn:bh:org:openbanking:events:consent-authorization-revoked revoked | 0..1 | OBEventNotification/events/ urn:bh:org:cbb_openbanking:events:consent-authorization-revoked | An event that indicates a consent resource has had its authorisation revoked. | OBEventConsentAuthorizationRevoked |
|
3.2 OBEventSubject
This section describes the OBEventSubject class which is used in the OBEventResourceUpdate, OBEventConsentAuthorizationRevoked and OBEventAccountAccessConsentLinkedAccountUpdateclasses.
...
Name | Occurrence | XPath | Enhanced Definition | Class | Codes | Pattern |
OBEventSubject |
|
|
| OBEventSubject |
|
|
subject_type | 1..1 | OBEventSubject/subject_type | Subject type for the updated resource. | String | http://openbanking.org.bh/rid_http://openbanking.org.bh/rty |
|
1..1 | OBEventSubject/http://openbanking.org.bh/rid | Resource Id for the updated resource. | String |
|
| |
1..1 | OBEventSubject/http://openbanking.org.bh/rty | Resource Type for the updated resource. | String |
|
| |
1..n | OBEventSubject/http://openbanking.org.bh/rlk | Resource links to other available versions of the resource. | OBEventSubject/http://openbanking.org.bh/rlk |
|
| |
version | 1..1 | OBEventSubject/http://openbanking.org.bh/rlk/version | Resource version. | String |
|
|
link | 1..1 | OBEventSubject/http://openbanking.org.bh/rlk/link | Resource link. | String |
|
|
3.3 OBEventResourceUpdate
...
Name | Occurrence | XPath | Enhanced Definition | Class | Codes | Pattern |
urn:bh:org:openbanking:events:resource-update |
|
| An event that indicates a resource has been updated. | OBEventResourceUpdate |
|
|
subject | 1..1 | urn:bh:org:cbb_openbanking:events:resource-update /subject | The subject of the event. | OBEventSubject |
|
|
3.4 OBEventConsentAuthorizationRevoked
This This section describes the OBEventConsentAuthorizationRevoked class which is used in the OBEventNotification resource
...
The subject claim must be populated if the Event Notification does not include a urn:bh:org:cbb_openbanking:events:resource-update event
...
Name | Occurrence | XPath | Enhanced Definition | Class | Codes | Pattern |
urn:bh:org:openbanking:events:consent-authorization-revoked |
|
| An event that indicates a consent resource has had its authorisation revoked. | OBEventConsentAuthorizationRevoked |
|
|
reason | 0..1 | urn:bh:org:cbb_openbanking:events:consent-authorization-revoked/reason | Reason for the Consent Authorization Revoked event. | String |
|
|
subject | 0..1 | urn:bh:org: cbb_openbanking:events:consent-authorization-revoked/subject | The subject of the event. | OBEventSubject |
|
|
...
Name | Occurrence | XPath | Enhanced Definition | Class | Codes | Pattern |
urn:bh:org:openbanking:events:account-access-consent-linked-account-update |
|
| An event that indicates an account linked to a consent has move in/out of scope of the consent. | OBEventAccountAccessConsentLinkedAccountUpdate |
|
|
reason | 0..1 | urn:bh:org:cbb_openbanking:events:account-access-consent-linked-account-update/reason | Reason for the Account Access Consent Linked Account Update event. | String |
|
|
subject | 1..1 | urn:bh:org:cbb_openbanking:events:account-access-consent-linked-account-update/subject | The subject of the event. | OBEventSubject |
|
|
3.6 Event Notification Retry Policy
3.6.1 ASPSP
An ASPSP's ASPSP’s Event Notification Retry Policy defines behaviour when an event notification is unacknowledged or the ASPSP receives a 5xx error.
An Event Notification Retry Policy must define an Exponential Backoff Policy to calculate the Retry Time Interval.
An Event Notification Retry Policy must define the Maximum Number of Retries an ASPSP will make before declaring the AISP/ PISP Event Notification endpoint unresponsive and ceasing further attempts.
An Event Notification Retry Policy must define the Maximum Time Interval for Retries, after which an ASPSP will declare the AISP/ PISP Event Notification endpoint unresponsive and cease further attempts.
3.6.2 AISP/ PISP
A An AISP/ PISP may make GET requests for its resources if its /event-notifications endpoint was unavailable for the Maximum Time Interval for Retries, as defined in an ASPSP's ASPSP’s Event Notification Retry Policy.
...