Method

Sample Request

Sample Response

POST

POST /event-subscriptions HTTP/1.1

Authorization: Bearer *********
x-jws-signature: **..**
Content-Type: application/json

{
   "Data": {
     "CallbackUrl": "https://tpp.com/open-banking/v3.1/event-notifications",
     "Version": "3.1"
   }
}

HTTP/1.1 201 Event Subscription Created

x-jws-signature: **..**
x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865
Content-Type: application/json; charset=utf-8

{
   "Data": {
     "EventSubscriptionId": "END-1001",
     "CallbackUrl": "https://tpp.com/open-banking/v3.1/event-notifications",
     "Version": "3.1"
   },
   "Links": {
     "Self": "https://ob-ybs.sandbox.ybs.co.uk/open-banking/v3.1/events/event-subscriptions/END-1001"
   },
   "Meta": {}
}

GET

GET /event-subscriptions HTTP/1.1

Authorization: Bearer *********
 

HTTP/1.1 200 Event Subscription Read

x-jws-signature: **..**
x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15866
Content-Type: application/json; charset=utf-8

{
   "Data": {
     "EventSubscriptionId": "ENS-1001",
     "CallbackUrl": "https://tpp.com/open-banking/v3.1/event-notifications",
     "Version": "3.1",
     "EventTypes": ["UK.OBIE.Consent-Authorization-Revoked"] ,
   "Links": {
     "Self": "https://ob-ybs.sandbox.ybs.co.uk/open-banking/v3.1/events/event-subscriptions/ENS-1001"
   },
   "Meta": {}
}

PUT

PUT /event-subscriptions/END-1001 HTTP/1.1

Authorization: Bearer *********
x-jws-signature: **..**
Content-Type: application/json

{
   "Data": {
     "CallbackUrl": "https://updatetpp.com/open-banking/v3.1/event-notifications",
     "Version": "3.1"
   }
}

HTTP/1.1 200 Event Subscription Changed

x-jws-signature: **..**
x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15867
Content-Type: application/json; charset=utf-8

{
   "Data": {
     "EventSubscriptionId": "END-1001",
     "CallbackUrl": "https://updatetpp.com/open-banking/v3.1/event-notifications",
     "Version": "3.1"
   },
   "Links": {
     "Self": "https://ob-ybs.sandbox.ybs.co.uk/open-banking/v3.1/events/event-subscriptions/END-1001"
   },
   "Meta": {}
}

DELETE

DELETE /event-subscriptions/END-1001 HTTP/1.1

Authorization: Bearer *********

HTTP/1.1 204 Event Subscription Deleted

x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865