...
This resource description should be read in conjunction with a compatible Aggregated Polling Profile
2. Endpoints 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.
The POST method allows the TPP to transmit their polling parameters and event notification acknowledgements.
The ASPSP responds accordingly, sending event notifications as indicated by the TPPs polling parameters
3. Data Data Model
3.1. Aggregated Aggregated Polling - Request
The OBEventPolling will be used as the request payload for:
...
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 |
|
|
3.2. Aggregated Aggregated Polling - Response
The OBEventPollingResponse will be used as the response payload for:
...
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.2. Acknowledge Acknowledge Only
4.2.1 POST Events Request
...
|
|
4.3. POST POST and Acknowledge with Errors
4.3.1 POST 1 POST Events Request
|
...