...
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.
...
S. No. | Resource | HTTP Operation | Endpoint | Mandatory ? | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
3.1 | event- notification | POST | POST / event- notifications | Mandatory | accounts payments | n/a | No | No | OBEventNotification |
...
AISP/ PISP must make available an event notification endpoint to receive event notifications.
AISP/ PISP must acknowledge an event notification with a 202 HTTP response and include the provided x-fapi-interaction-id.
3.1 POST/event-notifications
...
3.2 Transport Level Security
AISP/ PISP hosted endpoints must be endpoints must be protected using TLS 1.2, as per the FAPI Read/Write specification.
AISP/ PISP hosted endpoints must be endpoints must be protected using a network certificate issued by a Trust Anchor supported by the ASPSP.
...
Note, the OBEventNotification object is aligned with the Security Event Token (https://tools.ietf.org/html/rfc8417). It acts as a wrapper for events contained within the events claim.
4.1.1 UML Diagram
...
4.1.2 Notes
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..
4.1.3 Data Dictionary
Name | Occurrence | XPath | Enhanced Definition | Class | Pattern |
OBEventNotification | OBEventNotification |
|
| OBEventNotification |
|
Iss | 1.1 | OBEventNotification/iss | Issuer. | String |
|
Iat | 1.1 | OBEventNotification/iat | Issued At. | Number |
|
Jti | 1.1 | OBEventNotification/jti | JWT ID. | String |
|
Aud | 1.1 | OBEventNotification/aud | Audience. | String |
|
Sub | 1.1 | OBEventNotification/sub | Subject. | String : URI |
|
Txn | 1.1 | OBEventNotification/txn | Transaction Identifier. | String |
|
Toe | 1.1 | OBEventNotification/toe | Time of Event. | Number |
|
Events | 1.1 | OBEventNotification/events | Events. | OBEvent |
|
urn:bh:org:openbanking:events:resource-update | 0..1 | OBEventNotification/events/ urn:bh:org:cbb_openbanking:events:resource-update | Resource-Update Event. | OBEventResourceUpdate |
|
urn:bh:org:openbanking:events:account-access-consent-linked-account-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 | 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 |
|
...
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.
The array of resource links (http://openbanking.org.bh/rlk) must contain links to all supported versions of the resource.
4.2.3 Data Dictionary
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 |
|
http://openbanking.org.bh/rid | 1..1 | OBEventSubject/http://openbanking.org.bh/rid | Resource Id for the updated resource. | String |
|
|
http://openbanking.org.bh/rty | 1..1 | OBEventSubject/http://openbanking.org.bh/rty | Resource Type for the updated resource. | String |
|
|
http://openbanking.org.bh/rlk | 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 |
|
|
4.3 OBEventResourceUpdate
...
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.
The array of resource links (http://openbanking.org.bh/rlk) must contain links to all supported versions of the resource.
4.3.3 Data Dictionary
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 |
|
|
4.4 OBEventConsentAuthorizationRevoked
This section describes the OBEventConsentAuthorizationRevoked class which is used in the OBEventNotification resource.
4.4.1 UML Diagram
...
4.4.2 Notes
...
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 |
|
|
4.5 OBEventAccountAccessConsentLinkedAccountUpdate
...
The http://openbanking.org.bh/rty claim must be populated with "account-access-consent".
4.5.3 Data Dictionary
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 |
|
|
4.6 Event Notification Retry Policy
...
An Event Notification Retry Policy must define Policy must define an Exponential Backoff Policy to calculate the Retry Time Interval.
An Event Notification Retry Policy must define 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 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.
4.6.2 AISP/ PISP
An AISP/ PISP may make 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 Event Notification Retry Policy.
...