Table of Contents
Overview.. 2
Endpoints. 2
2.1. POST /events. 2
Data Model 2
3.1. Aggregated Polling - Request 2
3.1.1 UML Diagram.. 2
3.1.2 Data Dictionary. 2
3.2. Aggregated Polling - Response. 3
3.2.1 UML Diagram.. 3
3.2.2 Data Dictionary. 3
Usage Example. 4
4.1. Poll Only. 4
4.1.1 POST Events Request 4
4.1.2 POST Event Response. 4
4.2. Acknowledge Only. 4
4.2.1 POST Events Request 4
4.2.2 POST Event Response. 4
4.3. POST and Acknowledge with Errors. 5
4.3.1 POST Events Request 5
4.3.2 POST Events Response. 5
...
| Table of Contents |
|---|
1. Overview
The Events resource is used by a TPP to retrieve multiple signed event notifications from an ASPSP.
This resource description should be read in conjunction with a compatible Aggregated Polling Profile
2. Endpoints
S.No. | Resource | HTTP Operation | Endpoint | Mandatory | Scope | Grant Type | Message Signing | Idempotency Key | Request Object | Response Object |
2.1 | events | POST | POST /events | Optional | accounts fundsconfirmations | Client Credentials | N/A | No | OBEventPolling | OBEventPollingResponse |
2.1. POST /events
The endpoint allows a TPP to poll for and acknowledge and receive event notifications.
...
POST /events.
3.1.1 UML Diagram
...
3.1.2 Data Dictionary
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBEventPolling |
| OBEventPolling |
| OBEventPolling |
|
|
maxEvents | 0..1 | OBEventPolling/maxEvents | Maximum number of events to be returned. A value of zero indicates the ASPSP should not return events even if available | Integer |
|
|
returnImmediately | 0..1 | OBEventPolling/returnImmediately | Indicates whether an ASPSP should return a response immediately or provide a long poll | Boolean |
|
|
ack | 0..n | OBEventPolling/ack | An array of | Array:String |
|
|
setErrs | 0..1 | OBEventPolling/setErrs | An object that encapsulates all negative acknowledgements transmitted by the TPP | OBEventPolling/setErrs |
|
|
| 0..n |
| A event notification error object entitled using the |
|
|
|
err | 1..1 |
| A value from the IANA "Security Event Token Delivery Error Codes" registry that identifies the error as defined here | String |
|
|
description | 1..1 |
| A human-readable string that provides additional diagnostic information | String |
|
|
...
POST /events.
3.2.1 UML Diagram
...
3.2.2 Data Dictionary
Name | Occurrence | XPath | Definition | Class/ Datatype | Codes | Pattern |
OBEventPollingResponse | 1..1 | OBEventPollingResponse |
| OBEventPollingResponse |
|
|
moreAvailable | 1..1 | OBEventPollingResponse/moreAvailable | A JSON boolean value that indicates if more unacknowledged event notifications are available to be returned. | Boolean |
|
|
sets | 1..1 | OBEventPollingResponse/sets | A JSON object that contains zero or more nested JSON attributes. If there are no outstanding event notifications to be transmitted, the JSON object SHALL be empty. | OBEventPollingResponse/sets |
|
|
| 0..n |
| An object named with the |
|
|
|
4. Usage Example
Note for the sake of readability the SETs shown in examples are shorted
4.1. Poll Only
4.1.1 POST Events Request
|
...
|
...
|
|
|
|
|
...
4.1.2 POST Event Response
|
...
|
...
|
...
| Code Block |
|
|
|
|
|
|
|
|
|
|
|
|
|
|---|
...
4.2. Acknowledge Only
4.2.
...
1 POST Events Request
|
...
|
...
|
...
|
...
...
|
4.2.2 POST Event Response
|
...
|
...
|
...
|
|
|
|
|
|
...
4.3. POST and Acknowledge with Errors
4.3.
...
1 POST Events Request
|
...
|
...
|
...
|
...
| Code Block |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|---|
...
4.3.2 POST Events Response
|
...
|
...
|
...
| Code Block |
|
|
|
|
|
|
|
|
|
|
|
|
|
|---|
...