Event Notification
- Version 3.1.11
- Protocol: HTTPS
- Sandbox well-known endpoint: see brand and market specific API documentation
- Production well-known endpoint: see brand and market specific API documentation
Introduction
This API provides access to the Event Notification API
- Create Event Subscription
- Get Event Subscription
- Change Event Subscription
- Delete Event Subscription
- Create Events
Version
Change log and release history:
Version |
Sandbox Status |
---|---|
V3.1.11 | Live |
Feedback and Support
Dive in and start coding your applications. If you get stuck or require additional support, please contact our team using the Contact Us form found under the Help menu.
Event Notification
Summary
Event Notification / polling is a mechanism for the bank server to create a notification event when resources change in the bank domain, and to provide notification of the resource change to the Third Party using the Open Banking API.
Endpoint | Function | API Supported | Market Supported |
---|---|---|---|
POST /event-subscriptions | Create Event Subscription | Account Information | UK, Europe |
Funds Confirmation | UK | ||
GET /event-subscriptions | Get Event Subscription | Account Information | UK, Europe |
Funds Confirmation | UK | ||
PUT /event-subscriptions/{EventSubscriptionId} | Change Event Subscription | Account Information | UK, Europe |
Funds Confirmation | UK | ||
DELETE /event-subscriptions/{EventSubscriptionId} | Delete Event Subscription | Account Information | UK, Europe |
Funds Confirmation | UK | ||
POST /events | Create outstanding notification events from the bank and to send event acknowledgement to the bank | Account Information | UK, Europe, Hong Kong |
Funds Confirmation | UK |
API Request Headers
Key | Type | Required | Example Value | Description |
---|---|---|---|---|
Content-Type | String | Yes | application/json | This indicates the media type of the resource and the value must be application/json |
Accept-Language | String | Optional | Standard HTTP header to indicate the natural language set used in the response. Available values : en-HK, zh-HK, zh-CN |
|
Authorisation | String | Yes | Standard HTTP header that allows credentials to be provided to the authorisation/resource server. Based on the OAuth 2.0/OIDC framework, this consists of basic or bearer authentication schemes | |
x-fapi-auth-date | String | Optional | Customer last logged-in time with the TSP application. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC | |
x-fapi-customer-ip-addres | String | Optional | Customer IP address when making a request with the TSP application | |
x-fapi-interaction-id | String | Optional | Unique correlation ID to playback response for each request |
API Request Object
Name | Type | Required | Example Value | Description |
---|---|---|---|---|
ack | String | Optional | “4d3559ec67504aaba65d40b0363faad8” | List of successfully handled “jti” |
returnImmediately | Boolean | Mandatory | true, false |
Optional JSON Boolean value that indicates the SET transmitter should return an immediate response even if no results are available (short polling) |
maxEvents | Integer | Mandatory | 20 | Size limit for the event collection size in the response, null or zero input for the field indicates the bank returned an empty set of outstanding events |
API Response Object
Name | Description | Class | Enumeration |
---|---|---|---|
sets | JSON object containing zero or more SETs being returned. Each member name is the "jti" of a SET to be delivered, and its value is a JSON string representing the corresponding SET. If there are no outstanding SETs to be transmitted, the JSON object shall be empty. Note that both SETs being transmitted for the first time and SETs that are being retransmitted after not having been acknowledged are communicated here. | String | N/A |
Error
Scenario | HTTP Code | Error Code | Error Description |
---|---|---|---|
Input Data Validations - "maxEvents" is greater than 10 |
400 |
OB.Field.Invalid |
maxEvents is not within the limits allowed by ASPSP |
Input Data Validations - "returnImmediately" = false |
400 |
OB.Field.Invalid |
Invalid field |
Input Data Validations - without maxEvents blocker |
400 |
OB.FieldHeader |
Bad Request - Missing headers Bad Request - Incorrect headers |
[Pool and acknowledge] Validation - return an error when querying 'POST /events' with 1 mismatched ack |
400 |
OB.Unexpectederror |
Jti in the request are not valid |
[Pool and acknowledge] Validate - return an error when querying "POST /events" with 2 mismatched ack |
400 |
OB.Unexpectederror |
Jti in the request are not valid |
[Pool and acknowledge] Validate - return an error when querying "POST /events" with 2 mismatched ack |
400 |
OB.Unexpectederror |
Jti in the request are not valid |
POST /events request
@POST /events request
POST /events response
@POST /events response