An AISP/ PISP can set up and maintain its event subscription details (URL, event types and version number) using the event-subscription resource.
The API endpoint allows the AISP/PISP to ask an ASPSP to create a new event-subscription resource.
Request:
https://host:port/api/bobf/release1.0.0/event-subscriptions
Authorization: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
Accept: application/json
{
"Data": {
"CallbackUrl": "https://AISP/ PISP.com/open-banking/event-notifications",
"Version": "1.0.0"
"EventTypes": [
"urn:bh:org:openbanking:events:consent-authorization-revoked"
]
}
}
Response:
201 Created
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865
Content-Type: application/json
{
"Data": {
"EventSubscriptionId": "H5SuvA2GQhieBdl2WwHPIQ",
"CallbackUrl": "https://AISP/ PISP.com/open-banking/event-notifications",
"Version": "1.0.0",
"EventTypes": [
"urn:bh:org:openbanking:events:consent-authorization-revoked"
]
},
"Links": {},
"Meta": {}
}
The API endpoint allows the AISP/ PISP to ask an ASPSP to retrieve its event-subscription resource.
The ASPSP retrieves the event-subscription resource and responds with the resource
Request:
https://host:port/api/bobf/release1.0.0/event-subscriptions
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865
Accept: application/json
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865
Content-Type: application/json
{
"Data": {
"OBEventSubscription": [
{
"EventSubscriptionId": "H5SuvA2GQhieBdl2WwHPIQ",
"CallbackUrl": "https://AISP/ PISP.com/open-banking/event-notifications",
"Version": "1.0.0",
"EventTypes": [
"urn:bh:org:openbanking:events:consent-authorization-revoked"
]
}
]
},
"Links": {},
"Meta": {}
}
The API endpoint allows the AISP/ PISP to ask an ASPSP to update an event-subscription resource.
The PUT action allows the AISP/ PISP to update an event subscription for an AISP/ PISP to access event notifications
The ASPSP updates the event-subscription resource and responds with the updated resource
Request:
https://host:port/api/bobf/release1.0.0/event-subscriptions/Pu7UHV5ZTzyQx3XP6W9oWA
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865
Accept: application/json
{
"Data": {
"EventSubscriptionId": "Pu7UHV5ZTzyQx3XP6W9oWA",
"CallbackUrl": "https://AISP/ PISP.com/open-banking/event-notifications",
"Version": "1.0.0",
"EventTypes": [
"urn:bh:org:openbanking:events:consent-authorization-revoked",
"urn:bh:org:openbanking:events:resource-update"
]
}}
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865
Content-Type: application/json
{
"Data": {
"EventSubscriptionId": "Pu7UHV5ZTzyQx3XP6W9oWA",
"CallbackUrl": "https://AISP/ PISP.com/open-banking/event-notifications",
"Version": "1.0.0",
"EventTypes": [
"urn:bh:org:openbanking:events:consent-authorization-revoked",
"urn:bh:org:openbanking:events:resource-update"
]
}
}
The API endpoint allows the AISP/ PISP to ask an ASPSP to delete an event-subscription resource.
The ASPSP deletes the event-subscription resource
Request:
https://host:port/api/bobf/release1.0.0/event-subscriptions/Pu7UHV5ZTzyQx3XP6W9oWA
Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-interaction-id: 86ebcd82-8e38-4f2d-a79c-965b41d15865
Accept: application/json
Response:
204 No content