{"type":"doc","content":[{"type":"paragraph","content":[{"text":"This document explains the flow of events related to the Event Notification APIs v3.1.2","type":"text"},{"text":".","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"0c26d2f2-ac7f-4ca6-b1e5-3ebf69c38aa2"}}]},{"text":" ","type":"text"},{"text":" ","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"Before you begin:","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"You need to configure and deploy the Event","type":"text"},{"text":" Notification APIs","type":"text"},{"text":" v3.1.2. ","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"cxhtml":" Click here to see how it is done...

ConfiguringAPIsINLINE

Configuring the Event Notification APIs

Open the <WSO2_OB_IAM_HOME>/repository/conf/deployment.toml file.
Update the placeholders in the following configurations:
xml:8243/open-banking/v3.1/event-notification\"\nsigning_alias = ]]>
Restart the Identity and Access Management server to reflect the changes.

Deploying the Event Notification APIs

To use the Event Notification feature an ASPSP should deploy both Event Notification and Aggregated Event Polling APIs.

Event Notification

You can configure APIs through the API Publisher by signing in as a user whose role includes Internal/publisher.

Sign in to the API Publisher Portal (https://<WSO2_OB_APIM_HOST>:9443/publisher).
In the APIs tab, select CREATE NEW API > I Have an Existing REST API.
Set the Input Type to OpenAPI File.
Click BROWSE FILE TO UPLOAD and select the Swagger definition. <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/Notifications/3.1.2/event-subscriptions-swagger-3.1.2.yaml Swagger definition.
Click Next.
Leave the Endpoint field empty as it is.
Set the business plan to Unlimited : Allows unlimited requests unless you want to limit the requests.
Click Create to create the API.
Once you get the message that the API is successfully updated, go to Runtime Configurations using the left menu panel.
Click the edit button under Request > Message Mediation.
Now, select the Custom Policy option.
Upload the <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/Notifications/3.1.2/event-subscriptions-dynamic-endpoint-insequence-3.1.2.xml in-sequence file and click SELECT.
Scroll down and click SAVE.
Go to Endpoints using the left menu panel.
Select Dynamic Endpoint.
Select the endpoint types; Production Endpoint/Sandbox Endpoint.
Click Save.
Now, go to Properties using the left menu panel.
Click Add New Property.
Add the API Properties according to your API and click the Add button.

API property name API property value
ob-spec uk
ob-api-type event
ob-api-version 3.1.2
For example:
Click SAVE.
Go back to Overview using the left menu panel.
Click PUBLISH.
The published API is available in the Developer Portal at \n https://<WSO2_OB_APIM_HOST>:9443/devportal.\n

API property name	API property value
ob-spec	uk
ob-api-type	event
ob-api-version	3.1.2

Aggregated Polling

You can configure APIs through the API Publisher by signing in as a user whose role includes Internal/publisher.

Sign in to the API Publisher Portal (https://<WSO2_OB_APIM_HOST>:9443/publisher).
In the APIs tab, select CREATE NEW API > I Have an Existing REST API.
Set the Input Type to OpenAPI File.
Click BROWSE FILE TO UPLOAD and select the Swagger definition. <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/Notifications/3.1.2/aggregated-polling-swagger-3.1.2.yaml Swagger definition.
Click Next.
Set the Endpoint as follows:
:9446/api/openbanking/event-notifications/uk300]]>
Set the business plan to Unlimited : Allows unlimited requests unless you want to limit the requests.
Click Create to create the API.
Once you get the message that the API is successfully updated, go to Runtime Configurations using the left menu panel.
Click the edit button under Request > Message Mediation.
Now, select the Custom Policy option.
Upload the <WSO2_OB_APIM_HOME>/repository/resources/finance/apis/openbanking.org.uk/Notifications/3.1.2/aggregated-polling-endpoint-insequence-3.1.2.xml in-sequence file and click SELECT.
Scroll down and click SAVE.
Now, go to Properties using the left menu panel.
Click Add New Property.
Add the API Properties according to your API and click the Add button.

API property name API property value
ob-spec uk
ob-api-type event
ob-api-version 3.1.2
For example:
Click SAVE.
Go back to Overview using the left menu panel.
Click PUBLISH.
The published API is available in the Developer Portal at \n https://<WSO2_OB_APIM_HOST>:9443/devportal.\n

API property name	API property value
ob-spec	uk
ob-api-type	event
ob-api-version	3.1.2

","nestedContent":{"type":"doc","content":[{"type":"expand","attrs":{"title":" Click here to see how it is done..."},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"multiexcerpt","parameters":{"macroParams":{"MultiExcerptName":{"value":"ConfiguringAPIs"},"atlassian-macro-output-type":{"value":"INLINE"}},"macroMetadata":{"macroId":{"value":"0586a0cc-b6e6-48f3-a9d7-cbffb9956fec"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://raw.githubusercontent.com/fuegokit/appfire-design-systems-brand-svg/main/single-color-brand-icons/af-logo-multi-excerpt-24.svg"}}],"title":"MultiExcerpt (legacy)"}}},"content":[{"type":"heading","attrs":{"level":5},"content":[{"text":"Configuring the Event Notification APIs","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Open the ","type":"text"},{"text":"/repository/conf/deployment.toml","type":"text","marks":[{"type":"code"}]},{"text":" file.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Update the placeholders in the following configurations:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"[open_banking.event_notifications]\nenable = true\ntoken_issuer = \"www.openbank.com\"\napi_url = \"https://:8243/open-banking/v3.1/event-notification\"\nsigning_alias = ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Restart the Identity and Access Management server to reflect the changes.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Deploying the Event Notification APIs","type":"text"}]},{"type":"paragraph","content":[{"text":"To use the Event Notification feature an ASPSP should deploy both Event Notification and Aggregated Event Polling APIs. ","type":"text"}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"cf6d34d1-ad3d-4148-bd03-41bccee69704"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Event Notification"}},"macroMetadata":{"macroId":{"value":"26b834c0-ddcb-4821-b3f5-3c1e0edd888c"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"paragraph","content":[{"text":"You can configure APIs through the API Publisher by signing in as a user whose role includes ","type":"text"},{"text":"Internal/publisher","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sign in to the API Publisher Portal (","type":"text"},{"text":"https://:9443/publisher","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"},{"type":"hardBreak"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"inline-media-image","parameters":{"width":"400","id":"3adca740-d735-4ce4-b30f-8b038faa4561","collection":"contentId-48630757","height":""}}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"APIs","type":"text","marks":[{"type":"strong"}]},{"text":" tab, select ","type":"text"},{"text":"CREATE NEW API > I Have an Existing REST API","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":300,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":555,"id":"891f0a86-c397-4068-92ef-65a8c8480079","collection":"contentId-48630757","type":"file","height":612}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the","type":"text"},{"text":" Input Type ","type":"text","marks":[{"type":"strong"}]},{"text":"to ","type":"text"},{"text":"OpenAPI File","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":500,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":959,"id":"ce5dbb38-d058-4e5c-a747-1edff025ad5c","collection":"contentId-48630757","type":"file","height":863}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"BROWSE FILE TO UPLOAD","type":"text","marks":[{"type":"strong"}]},{"text":" and select the Swagger definition. ","type":"text"},{"text":"/repository/resources/finance/apis/openbanking.org.uk/Notifications/3.1.2/event-subscriptions-swagger-3.1.2.yaml","type":"text","marks":[{"type":"code"}]},{"text":" Swagger definition.","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":500,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":980,"id":"12875c18-d851-4cde-bf06-ee19b69b0c50","collection":"contentId-48630757","type":"file","height":611}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Next","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Leave the ","type":"text"},{"text":"Endpoint","type":"text","marks":[{"type":"strong"}]},{"text":" field empty as it is.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the business plan to ","type":"text"},{"text":"Unlimited : Allows unlimited","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"requests","type":"text","marks":[{"type":"strong"}]},{"text":" unless you want to limit the requests. ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":450,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":922,"id":"a4a1717a-8db0-4a22-8f3d-5da640d7bc8a","collection":"contentId-48630757","type":"file","height":754}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Create ","type":"text","marks":[{"type":"strong"}]},{"text":"to create the API.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Once you get the message that the API is successfully updated, go to ","type":"text"},{"text":"Runtime Configurations ","type":"text","marks":[{"type":"strong"}]},{"text":"using the left menu panel. ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":200,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":285,"id":"02e2a904-b3ba-4cbc-9c32-8cc07805f27c","collection":"contentId-48630757","type":"file","height":366}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click the edit button under ","type":"text"},{"text":"Request > Message Mediation","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":500,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":879,"id":"0d1e0cdf-89d3-441b-8b4a-7b0109b4d1b6","collection":"contentId-48630757","type":"file","height":501}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Now, select the ","type":"text"},{"text":"Custom Policy ","type":"text","marks":[{"type":"strong"}]},{"text":"option.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Upload the ","type":"text"},{"text":"/repository/resources/finance/apis/openbanking.org.uk/Notifications/3.1.2/event-subscriptions-dynamic-endpoint-insequence-3.1.2.xml","type":"text","marks":[{"type":"code"}]},{"text":" in-sequence file and click ","type":"text"},{"text":"SELECT","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":423,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":651,"id":"8465994b-8b35-422a-a554-0589a919d597","collection":"contentId-48630757","type":"file","height":384}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Scroll down and click ","type":"text"},{"text":"SAVE","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to ","type":"text"},{"text":"Endpoints","type":"text","marks":[{"type":"strong"}]},{"text":" using the left menu panel.","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"inline-media-image","parameters":{"width":"","id":"542c67da-c74f-4e3a-ac04-ff1a89766e49","collection":"contentId-48630757","height":"250"}}},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select ","type":"text"},{"text":"Dynamic Endpoint","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"inline-media-image","parameters":{"width":"600","id":"4bb46240-5d2f-4061-b1dc-5eabc87bffb6","collection":"contentId-48630757","height":""}}},{"text":" ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select the endpoint types; Production Endpoint/Sandbox Endpoint.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Save","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Now, go to ","type":"text"},{"text":"Properties ","type":"text","marks":[{"type":"strong"}]},{"text":"using the left menu panel. ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":200,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":287,"id":"c87a0a6b-2669-4a56-8a35-f51c646270cb","collection":"contentId-48630757","type":"file","height":735}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Add New Property","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":400,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":603,"id":"bb9667b5-2c50-46a2-8e4b-440025440933","collection":"contentId-48630757","type":"file","height":184}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the API Properties according to your API and click the ","type":"text"},{"text":"Add","type":"text","marks":[{"type":"strong"}]},{"text":" button. ","type":"text"}]},{"type":"table","attrs":{"layout":"align-start"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"API property name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"API property value","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ob-spec","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"uk","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ob-api-type","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"event","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ob-api-version","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"3.1.2","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"For example: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":900,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1280,"id":"87bff6b4-0047-451d-8ac7-633794b2c359","collection":"contentId-48630757","type":"file","height":205}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"SAVE","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go back to ","type":"text"},{"text":"Overview ","type":"text","marks":[{"type":"strong"}]},{"text":"using the left menu panel. ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":200,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":282,"id":"8d983234-6c1a-40a8-9995-646743eed460","collection":"contentId-48630757","type":"file","height":362}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"PUBLISH","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":800,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1276,"id":"bfda28da-f6b7-449d-99f5-31c14aabed59","collection":"contentId-48630757","type":"file","height":173}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The published API is available in the Developer Portal at ","type":"text"},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":"https://:9443/devportal.","type":"text","marks":[{"type":"code"}]},{"text":"\n ","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Aggregated Polling"}},"macroMetadata":{"macroId":{"value":"183ccd37-e730-4c1e-ae91-aa4074c38925"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"paragraph","content":[{"text":"You can configure APIs through the API Publisher by signing in as a user whose role includes ","type":"text"},{"text":"Internal/publisher","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sign in to the API Publisher Portal (","type":"text"},{"text":"https://:9443/publisher","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"},{"type":"hardBreak"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"inline-media-image","parameters":{"width":"400","id":"3adca740-d735-4ce4-b30f-8b038faa4561","collection":"contentId-48630757","height":""}}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"APIs","type":"text","marks":[{"type":"strong"}]},{"text":" tab, select ","type":"text"},{"text":"CREATE NEW API > I Have an Existing REST API","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":300,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":555,"id":"891f0a86-c397-4068-92ef-65a8c8480079","collection":"contentId-48630757","type":"file","height":612}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the","type":"text"},{"text":" Input Type ","type":"text","marks":[{"type":"strong"}]},{"text":"to ","type":"text"},{"text":"OpenAPI File","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":500,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":959,"id":"ce5dbb38-d058-4e5c-a747-1edff025ad5c","collection":"contentId-48630757","type":"file","height":863}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"BROWSE FILE TO UPLOAD","type":"text","marks":[{"type":"strong"}]},{"text":" and select the Swagger definition. ","type":"text"},{"text":"/repository/resources/finance/apis/openbanking.org.uk/Notifications/3.1.2/aggregated-polling-swagger-3.1.2.yaml","type":"text","marks":[{"type":"code"}]},{"text":" Swagger definition.","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":450,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":926,"id":"58546bc2-a7ae-4f6d-abc6-ae4f6ff6aca2","collection":"contentId-48630757","type":"file","height":608}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Next","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"Endpoint","type":"text","marks":[{"type":"strong"},{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":" as follows: ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]},{"type":"codeBlock","content":[{"text":"https://:9446/api/openbanking/event-notifications/uk300","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the business plan to ","type":"text"},{"text":"Unlimited : Allows unlimited","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"requests","type":"text","marks":[{"type":"strong"}]},{"text":" unless you want to limit the requests. ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":450,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":935,"id":"5c452714-147e-4969-9c71-cc0c86966774","collection":"contentId-48630757","type":"file","height":724}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Create ","type":"text","marks":[{"type":"strong"}]},{"text":"to create the API.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Once you get the message that the API is successfully updated, go to ","type":"text"},{"text":"Runtime Configurations ","type":"text","marks":[{"type":"strong"}]},{"text":"using the left menu panel. ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":200,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":285,"id":"02e2a904-b3ba-4cbc-9c32-8cc07805f27c","collection":"contentId-48630757","type":"file","height":366}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click the edit button under ","type":"text"},{"text":"Request > Message Mediation","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":500,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":879,"id":"0d1e0cdf-89d3-441b-8b4a-7b0109b4d1b6","collection":"contentId-48630757","type":"file","height":501}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Now, select the ","type":"text"},{"text":"Custom Policy ","type":"text","marks":[{"type":"strong"}]},{"text":"option.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Upload the ","type":"text"},{"text":"/repository/resources/finance/apis/openbanking.org.uk/Notifications/3.1.2/aggregated-polling-endpoint-insequence-3.1.2.xml","type":"text","marks":[{"type":"code"}]},{"text":" in-sequence file and click ","type":"text"},{"text":"SELECT","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"},{"text":" ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":427,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":657,"id":"0d8b2233-a166-458c-84ea-553921897f54","collection":"contentId-48630757","type":"file","height":384}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Scroll down and click ","type":"text"},{"text":"SAVE","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Now, go to ","type":"text"},{"text":"Properties ","type":"text","marks":[{"type":"strong"}]},{"text":"using the left menu panel. ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":200,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":287,"id":"c87a0a6b-2669-4a56-8a35-f51c646270cb","collection":"contentId-48630757","type":"file","height":735}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"Add New Property","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":400,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":603,"id":"bb9667b5-2c50-46a2-8e4b-440025440933","collection":"contentId-48630757","type":"file","height":184}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add the API Properties according to your API and click the ","type":"text"},{"text":"Add","type":"text","marks":[{"type":"strong"}]},{"text":" button. ","type":"text"}]},{"type":"table","attrs":{"layout":"align-start"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"API property name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"API property value","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ob-spec","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"uk","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ob-api-type","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"event","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ob-api-version","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"3.1.2","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"For example: ","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":900,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1280,"id":"87bff6b4-0047-451d-8ac7-633794b2c359","collection":"contentId-48630757","type":"file","height":205}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"SAVE","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go back to ","type":"text"},{"text":"Overview ","type":"text","marks":[{"type":"strong"}]},{"text":"using the left menu panel. ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":200,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":282,"id":"8d983234-6c1a-40a8-9995-646743eed460","collection":"contentId-48630757","type":"file","height":362}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click ","type":"text"},{"text":"PUBLISH","type":"text","marks":[{"type":"strong"}]},{"text":". ","type":"text"},{"type":"hardBreak"}]},{"type":"mediaSingle","attrs":{"layout":"align-start","width":800,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1276,"id":"bfda28da-f6b7-449d-99f5-31c14aabed59","collection":"contentId-48630757","type":"file","height":173}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The published API is available in the Developer Portal at ","type":"text"},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":"https://:9443/devportal.","type":"text","marks":[{"type":"code"}]},{"text":"\n ","type":"text","marks":[{"type":"code"}]}]}]}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}],"version":1},"reason":"An expand macro in a panel macro can't be created or edited in the new editor."}}}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc-zone","parameters":{"macroParams":{"maxLevel":{"value":"3"},"location":{"value":"top"}},"macroMetadata":{"macroId":{"value":"63d80214-00f4-43ef-aa4c-5b3118a5c73b"},"schemaVersion":{"value":"1"},"title":"Table of Content Zone"}}},"content":[{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Step 1 - Sign up as a TPP ","type":"text"}]},{"type":"paragraph","content":[{"text":"In this step, the TPP registers its TPP application in the WSO2 Open Banking Developer portal.","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"cxhtml":"Click here to see how it is done...

Navigate to the WSO2 Open Banking Developer portal at https://<WSO2_OB_APIM_HOST>:9443/devportal.
Select Applications in the menu.
In the Sign-in form, click Create Account.
Provide a username and click Proceed Self Register.
Fill the Create New Account form to complete registration.
Read terms and conditions. Click the checkbox to agree to the terms and conditions.
Click Register.

Sign in to the Developer portal as the TPP at https://<WSO2_OB_APIM_HOST>:9443/devportal.
Enter the username and the password you entered when signing up as a TPP.
Click Continue.

The homepage of the Developer Portal is now displayed along with the published APIs.

Go to the Applications tab in the Developer Portal.
Click ADD NEW APPLICATION.
Enter application details.
WSO2 Open Banking currently authenticates the TPP applications using the Reference (Opaque) method.
Click SAVE.

An application can be used to subscribe to multiple APIs. See for the instructions.

Go to the APIs tab in the Developer portal.
Select the Event Notification Subscription API.
Go to Subscriptions at the bottom of the API and select SUBSCRIBE.
Select the Application from the drop-down list, set the Throttling Policy and click SUBSCRIBE.
Once you subscribe, you can find the list of subscriptions in the bottom.
Follow step 2,3, 4 and 5 and subscribe to the Aggregated Event Polling API using your application.

Now that you have subscribed to the APIs, generate access tokens and invoke the API.

Sign in to WSO2 Open Banking Developer portal as a TPP user.
Go to the Applications tab and select the application you used to subscribe to the APIs.
Scroll down and select either of the following types of keys:
1. Production Keys: Generates access tokens in the production environment.
2. Sandbox Keys: Generates access tokens in the sandbox environment.
Click Manage at the bottom of the page.

Provide the requested information as defined below:

Field	Description
Grant Types	These determine the credentials that are used to generate the access token. Code: This relates to the authorisation code grant type and is applicable when consuming the API as a user. Implicit: This is similar to the code grant type, but instead of generating code, this directly provides the access token. Refresh Token: This is to renew an expired access token. Client Credential: This relates to the client credentials grant type and is applicable when consuming the API as an application.
Callback URL	This is the URL used by the TPP to receive the authorisation code sent from the Account Servicing Payment Service Provider (ASPSP), e.g: bank. The authorisation code can be used later to generate an OAuth2 access token.
Application Certificate	This is the content between the BEGIN CERTIFICATE and END CERTIFICATE strings of the application certificate (.PEM). If you have configured the , for testing purposes, you can use the sample application certificate available here.

Field

Description

Grant Types

These determine the credentials that are used to generate the access token.

Code: This relates to the authorisation code grant type and is applicable when consuming the API as a user.
Implicit: This is similar to the code grant type, but instead of generating code, this directly provides the access token.
Refresh Token: This is to renew an expired access token.
Client Credential: This relates to the client credentials grant type and is applicable when consuming the API as an application.

Callback URL

This is the URL used by the TPP to receive the authorisation code sent from the Account Servicing Payment Service Provider (ASPSP), e.g: bank. The authorisation code can be used later to generate an OAuth2 access token.

Application Certificate

This is the content between the BEGIN CERTIFICATE and END CERTIFICATE strings of the application certificate (.PEM).

If you have configured the , for testing purposes, you can use the sample application certificate available here.

Click GENERATE KEYS to generate production or sandbox keys. It generates consumer key and consumer secret.

Once the client is successfully registered, sign in to WSO2 Open Banking Developer Portal and go to the Applications tab.
Select your client application from the Application List.
You can view the keys you generated at the bottom of this page:
The Consumer Key shown above is the client ID of your application.
Now, generate the client assertion by signing the following JSON payload using the supported algorithms.
If you have configured the , you may use the attached certificate and keys for signing and transports layer security testing purposes.
client_assertion formattext>\", \n\"kid\": \"<>\", \n\"typ\": \"JWT\" \n} \n\n{ \n\"iss\": \"<>\", \n\"sub\": \"<>\", \n\"exp\": <>, \n\"iat\": <>, \n\"jti\": \"<>\", \n\"aud\": \"<>:8243/token>>\" \n} \n\n]]>sample client_assertion
The value of the aud claim should contain the same value as the Identity Provider Entity ID.
Click here to view the Identity Provider Entity ID:
Sign in to the Identity and Access Management console at \n \n https://<WSO2_OB_IAM_HOST>t:9446/carbon\n \n .
In the Main menu, go to Home > Identity > Identity Providers > Resident.
View the value in Resident Identity Provider > Inbound Authentication Configuration > OAuth2/OpenID Connect Configuration > Identity Provider Entity ID. By default this value is set to \n \n \n https://<WSO2_OB_APIM>:8243/token\n \n \n .
Run the following cURL command in a command prompt to generate the access token. Update the placeholders with the relevant values. You need an
:8243/token \\\n -H 'Cache-Control: no-cache' \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n --cert --key \\\n -d 'client_id=&grant_type=client_credentials&scope=accounts%20payments%20fundsconfirmations&client_assertion=&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&redirect_uri=']]>
The access token is now generated.
You can use the same cURL command to regenerate the access token.

","nestedContent":{"type":"doc","content":[{"type":"expand","attrs":{"title":"Click here to see how it is done..."},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Once the client is successfully registered, sign in to WSO2 Open Banking Developer Portal and go to the ","type":"text"},{"text":"Applications","type":"text","marks":[{"type":"strong"}]},{"text":" tab.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select your client application from the Application List. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can view the keys you generated at the bottom of this page: ","type":"text"},{"type":"hardBreak"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"inline-media-image","parameters":{"width":"500","id":"1c5f104c-1b68-42e1-ab1a-b5081f598efe","collection":"contentId-48630757","height":""}}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"Consumer Key","type":"text","marks":[{"type":"strong"}]},{"text":" shown above is the client ID of your application.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Now, generate the client assertion by signing the following JSON payload using the supported algorithms. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"If you have configured the ","type":"text"},{"text":"OB certificates","type":"text","marks":[{"type":"link","attrs":{"href":"https://wso2docs.atlassian.net/wiki/spaces/OB200/pages/48630757"}}]},{"text":", you may use the ","type":"text"},{"text":"attached","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.wso2.com/download/attachments/150017632/certificates.zip?api=v2"}}]},{"text":" certificate and keys for signing and transports layer security testing purposes.","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"dffb8a22-081f-4e24-bb3d-bf566f1c2d14"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"client_assertion format"}},"macroMetadata":{"macroId":{"value":"2f82acbc-b67c-488e-a4d0-c8df2a236f3a"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"{ \n\"alg\": \"<>\", \n\"kid\": \"<>\", \n\"typ\": \"JWT\" \n} \n\n{ \n\"iss\": \"<>\", \n\"sub\": \"<>\", \n\"exp\": <>, \n\"iat\": <>, \n\"jti\": \"<>\", \n\"aud\": \"<>:8243/token>>\" \n} \n\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"sample client_assertion"}},"macroMetadata":{"macroId":{"value":"c8060a9e-5ff2-4e32-a786-5c0a96fbcfc3"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"eyJraWQiOiJfTG03VFVWNF8yS3dydWhJQzZUWTdtel82WTQxMlhabG54dHl5QXB6eEw4IiwiYWxnIjoiUFMyNTYifQ.eyJzdWIiOiI0RWJRZmpSZFV2UVJxZThmNlJrMDlWb1Q5bFVhIiwiYXVkIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6ODI0My90b2tlbiIsImlzcyI6IjRFYlFmalJkVXZRUnFlOGY2UmswOVZvVDlsVWEiLCJleHAiOjE2Mzg3ODg0NDIsImlhdCI6MTYwMjI0NjAwOCwianRpIjoiMTYwMjI0NjAwOCJ9.lwPCemtdRZFgIBR65oxJkYP2AeyHC40gl_JjQO0sPK8QQo-PeL2PA6Bi7ULS9Ir05MHwmz9Lam4mDpzN3evBYXzkwYC-eHmeJw5gw-h-l7gq7tFT0x0ZX4Grh_tI2PZHJA6KMyBFksgKN4-cCjjPJJjZEqzyWTrtmzgV4rYGhnUDhjKdxIqzqqm1NDzWwCGK0e42cbp5NxGWTlk2vYM3dC6bGA2uJLaTYxU3r7iUIj6a0DEX21kpHJ7h4cNzbWRDhZCui661H-83zJ-Ijkg47tkdJp-BTrAeyEdyMGL3WiUfP9z0Zqpk4vUsXOZWMEBn719iekOWG4MInFiaSNlhhw","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"The value of the ","type":"text"},{"text":"aud","type":"text","marks":[{"type":"code"}]},{"text":" claim should contain the same value as the ","type":"text"},{"text":"Identity Provider Entity ID.","type":"text","marks":[{"type":"code"}]}]},{"type":"expand","attrs":{"title":"Click here to view the Identity Provider Entity ID:"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sign in to the Identity and Access Management console at ","type":"text"},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":"\n https://t:9446/carbon\n ","type":"text","marks":[{"type":"code"}]},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Main","type":"text","marks":[{"type":"strong"}]},{"text":" menu, go to ","type":"text"},{"text":"Home > Identity > Identity Providers > Resident","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"View the value in ","type":"text"},{"text":"Resident Identity Provider > Inbound Authentication Configuration >","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"OAuth2/OpenID Connect Configuration > Identity Provider Entity ID","type":"text","marks":[{"type":"strong"}]},{"text":". By default this value is set to ","type":"text"},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":"\n \n https://:8243/token\n \n ","type":"text","marks":[{"type":"code"}]},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run the following cURL command in a command prompt to generate the access token. Update the placeholders with the relevant values. You need an ","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -X POST \\\n https://:8243/token \\\n -H 'Cache-Control: no-cache' \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n --cert --key \\\n -d 'client_id=&grant_type=client_credentials&scope=accounts%20payments%20fundsconfirmations&client_assertion=&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&redirect_uri='","type":"text"}]},{"type":"paragraph","content":[{"text":"The access token is now generated.","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"You can use the same cURL command to regenerate the access token.","type":"text"}]}]}]}]}]}],"version":1},"reason":"An expand macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"paragraph"},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Step 8 - Create an event-subscription resource","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"POST /event-subscriptions ","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP requests the ASPSP to create a new event-subscription resource using this API endpoint. On successful creation, the ASPSP responds with a unique ","type":"text"},{"text":"EventSubscriptionId","type":"text","marks":[{"type":"code"}]},{"text":" to refer to the resource. The TPP uses this resource to access event notifications.","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"adca4a7b-b1da-4401-8182-3723a0f8acfc"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Request"}},"macroMetadata":{"macroId":{"value":"0739a1ab-c8a2-4a32-9eb9-8f154e573cf5"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"curl -X POST \\\n https://:8243/open-banking/v3.1.2/event-subscriptions \\\n -H 'accept: application/json; charset=utf-8' \\\n -H 'Authorization: Bearer ' \\\n -H 'x-fapi-financial-id: open-bank' \\\n -H 'x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiYjY0IiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImI2NCI6ZmFsc2UsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTgwNzA0LCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..IoHS0_KF7LBg8XuN0eO_N3W_0VnC1gIfTo3kAsXbb0HAkpqbVj8YUjJQt2baLQRz4dZBxWWlFlM1CaXBjtS1pM-efIY9T4hfq_iKARTBEZh1sY3HaGHKzNDPZ7udfyH2JlrSWp2PYXzRhY8n1S-_jl4sv79qPAkettwSFah8kUhsZP3U4oxKvuBXpUxWR18wvCufGqvMvPkd4H3KpfOI__pkI5GApAAZPDJ2o5IpQtd5Y2b1wAgxF6vT8KBSsy780TSWo3bGMPudymbzrwnviizRbf72pl2AoYr9Ojp8mFMFoO8TJiXQPW5y8ryQajCAVKLsQCEN1vJWlTOUQpO9xQ' \\\n --cert --key \\\n -H 'Content-Type: application/json; charset=utf-8' \\ \n -d '{\n \"Data\": {\n \"CallbackUrl\": \"https://wso2.com/\",\n \"Version\": \"3.1.2\",\n \"EventTypes\": [\n \"UK.OBIE.Consent-Authorization-Revoked\",\n \"UK.OBIE.Resource-Update\",\n \"UK.OBIE.Acount-Access-Consent-Linked-Account-Update\"\n ]\n }\n}'","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Response"}},"macroMetadata":{"macroId":{"value":"3291e994-9d7a-4c40-970f-4e5b3003eb01"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"{\n \"Data\":{\n \"CallbackUrl\":\"https://www.tpp.com/v3.1.2/event-notifications\",\n \"Version\":\"3.1.2\",\n \"EventSubscriptionId\":\"6\",\n \"EventTypes\":[\n \"UK.OBIE.Consent-Authorization-Revoked\",\n \"UK.OBIE.Resource-Update\",\n \"UK.OBIE.Acount-Access-Consent-Linked-Account-Update\"\n ]\n },\n \"Links\":{\n \"Self\":\"https://ob-uk-testserver-2:8243/open-banking/v3.1/event-notification/event-subscriptions/6\"\n },\n \"Meta\":{\n \"TotalPages\":1\n }\n}","type":"text"}]}]}]}],"version":1},"cxhtml":"

Request

:8243/open-banking/v3.1.2/event-subscriptions \\\n -H 'accept: application/json; charset=utf-8' \\\n -H 'Authorization: Bearer ' \\\n -H 'x-fapi-financial-id: open-bank' \\\n -H 'x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiYjY0IiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImI2NCI6ZmFsc2UsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTgwNzA0LCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..IoHS0_KF7LBg8XuN0eO_N3W_0VnC1gIfTo3kAsXbb0HAkpqbVj8YUjJQt2baLQRz4dZBxWWlFlM1CaXBjtS1pM-efIY9T4hfq_iKARTBEZh1sY3HaGHKzNDPZ7udfyH2JlrSWp2PYXzRhY8n1S-_jl4sv79qPAkettwSFah8kUhsZP3U4oxKvuBXpUxWR18wvCufGqvMvPkd4H3KpfOI__pkI5GApAAZPDJ2o5IpQtd5Y2b1wAgxF6vT8KBSsy780TSWo3bGMPudymbzrwnviizRbf72pl2AoYr9Ojp8mFMFoO8TJiXQPW5y8ryQajCAVKLsQCEN1vJWlTOUQpO9xQ' \\\n --cert --key \\\n -H 'Content-Type: application/json; charset=utf-8' \\ \n -d '{\n \"Data\": {\n \"CallbackUrl\": \"https://wso2.com/\",\n \"Version\": \"3.1.2\",\n \"EventTypes\": [\n \"UK.OBIE.Consent-Authorization-Revoked\",\n \"UK.OBIE.Resource-Update\",\n \"UK.OBIE.Acount-Access-Consent-Linked-Account-Update\"\n ]\n }\n}']]>

Response

"}}},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"cxhtml":"Click here to see the other endpoints

GET /event-subscriptions

The TPP requests the ASPSP to retrieve its event-subscription resource.

Request

:8243/open-banking/v3.1.2/event-subscriptions' \\\n--cert --key \\\n-H 'accept: application/json; charset=utf-8' \\\n-H 'x-fapi-financial-id: open-bank' \\\n-H 'Authorization: Bearer ']]>

Response

PUT /event-subscriptions/{EventSubscriptionId}

The TPP to requests the ASPSP to update an event-subscription resource.

Request

:8243/open-banking/v3.1.2/event-subscriptions \\\n -H 'accept: application/json; charset=utf-8' \\\n -H 'Authorization: Bearer ' \\\n -H 'x-fapi-financial-id: open-bank' \\\n -H 'x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiYjY0IiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImI2NCI6ZmFsc2UsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTgwNzA1LCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..hxgZHzKAYho_tJul0BmRA2TIdyOZtPGnRKjnHdLeTfPw41VSbydB5qPUJWOn0lC0d278YFkN0VA3bdMyGZV4N8TPwqqwNa-Jl8bKDRa3tm5Obi1lQkTs5e9FZjF8WSmX5NzRuu7joi79wlX4-jjH47Ax46h6xVZ8H8EtCFm017h6mZAwNZlvGZ_g0w5OtHSpN27ZgAAAzlHa-Z6JwXWfN6ZYHhOb0i4MVpTiab6HnkoWVKeiC0LlMvbIEPJjXx6wmRt4fXpRG-oue8ENu1yYV0puwF8AnqN5ZEVHg-Q1-2-x5Hnab2tOgK9zIDCIEh9EcW46undWHD4WozAzBLBazg' \\\n --cert --key \\\n -H 'Content-Type: application/json; charset=utf-8' \\ \n -d '{\n \"Data\":{\n \"EventSubscriptionId\":\"6\",\n \"CallbackUrl\":\"https://www.updatedtppdomain.com/v3.1.2/event-notifications\",\n \"Version\":\"3.1.2\",\n \"EventTypes\":[\n \"UK.OBIE.Resource-Update\"\n ]\n }\n}'\n]]>

Response

DELETE /event-subscriptions/{EventSubscriptionId}

The TPP requests the ASPSP to delete an event-subscription resource.

Request

:8243/open-banking/v3.1.2/event-subscriptions/5' \\\n--cert --key \\\n-H 'accept: application/json; charset=utf-8' \\\n-H 'x-fapi-financial-id: open-bank' \\\n-H 'Authorization: Bearer ']]>

Response

","nestedContent":{"type":"doc","content":[{"type":"expand","attrs":{"title":"Click here to see the other endpoints"},"content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"GET /event-subscriptions","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP requests the ASPSP to retrieve its event-subscription resource.","type":"text"}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"8299d0d5-819f-4c28-bd14-54b53e7dc88a"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Request"}},"macroMetadata":{"macroId":{"value":"2bcfd8bf-2b9a-4c45-b9cf-a7bae050db7b"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"curl GET 'https://:8243/open-banking/v3.1.2/event-subscriptions' \\\n--cert --key \\\n-H 'accept: application/json; charset=utf-8' \\\n-H 'x-fapi-financial-id: open-bank' \\\n-H 'Authorization: Bearer '","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Response"}},"macroMetadata":{"macroId":{"value":"4a3e4142-1584-4e26-9398-284f24e82b3c"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"{\n \"Data\":{\n \"EventSubscription\":[\n {\n \"CallbackUrl\":\"https://www.tpp.com/v3.1.2/event-notifications\",\n \"Version\":\"3.1.2\",\n \"EventSubscriptionId\":\"6\",\n \"EventTypes\":[\n \"UK.OBIE.Acount-Access-Consent-Linked-Account-Update\",\n \"UK.OBIE.Consent-Authorization-Revoked\",\n \"UK.OBIE.Resource-Update\"\n ]\n }\n ]\n },\n \"Links\":{\n \"Self\":\"https://ob-uk-testserver-2:8243/open-banking/v3.1/event-notification/event-subscriptions/6\"\n },\n \"Meta\":{\n \"TotalPages\":1\n }\n}","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"PUT /event-subscriptions/{EventSubscriptionId}","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP to requests the ASPSP to update an event-subscription resource.","type":"text"}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"8ac6a018-5fe9-488e-a718-a9c807d98795"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Request"}},"macroMetadata":{"macroId":{"value":"e6b0c221-3691-42b0-8335-aae814d3e8f7"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Request"}},"macroMetadata":{"macroId":{"value":"67787697-ba66-4424-bb65-237a102f0455"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"curl -X PUT \\\n https://:8243/open-banking/v3.1.2/event-subscriptions \\\n -H 'accept: application/json; charset=utf-8' \\\n -H 'Authorization: Bearer ' \\\n -H 'x-fapi-financial-id: open-bank' \\\n -H 'x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiYjY0IiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImI2NCI6ZmFsc2UsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTgwNzA0LCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..IoHS0_KF7LBg8XuN0eO_N3W_0VnC1gIfTo3kAsXbb0HAkpqbVj8YUjJQt2baLQRz4dZBxWWlFlM1CaXBjtS1pM-efIY9T4hfq_iKARTBEZh1sY3HaGHKzNDPZ7udfyH2JlrSWp2PYXzRhY8n1S-_jl4sv79qPAkettwSFah8kUhsZP3U4oxKvuBXpUxWR18wvCufGqvMvPkd4H3KpfOI__pkI5GApAAZPDJ2o5IpQtd5Y2b1wAgxF6vT8KBSsy780TSWo3bGMPudymbzrwnviizRbf72pl2AoYr9Ojp8mFMFoO8TJiXQPW5y8ryQajCAVKLsQCEN1vJWlTOUQpO9xQ' \\\n --cert --key \\\n -H 'Content-Type: application/json; charset=utf-8' \\ \n -d '{\n \"Data\": {\n \"CallbackUrl\": \"https://wso2.com/\",\n \"Version\": \"3.1.2\",\n \"EventTypes\": [\n \"UK.OBIE.Consent-Authorization-Revoked\",\n \"UK.OBIE.Resource-Update\",\n \"UK.OBIE.Acount-Access-Consent-Linked-Account-Update\"\n ]\n }\n}'","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -X PUT \\\n https://:8243/open-banking/v3.1.2/event-subscriptions \\\n -H 'accept: application/json; charset=utf-8' \\\n -H 'Authorization: Bearer ' \\\n -H 'x-fapi-financial-id: open-bank' \\\n -H 'x-jws-signature: eyJhbGciOiJQUzI1NiIsImtpZCI6Imp5UlVjeXQxa1ZDbGNJdmxVbGNEdWtWWjN0VSIsImNyaXQiOlsiYjY0IiwiaHR0cDovL29wZW5iYW5raW5nLm9yZy51ay9pYXQiLCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIl0sImI2NCI6ZmFsc2UsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaWF0IjoxNjAxOTgwNzA1LCJodHRwOi8vb3BlbmJhbmtpbmcub3JnLnVrL3RhbiI6Im9wZW5iYW5raW5nLm9yZy51ayIsImh0dHA6Ly9vcGVuYmFua2luZy5vcmcudWsvaXNzIjoiQ049U0NtRXY5R1FlQnJuZFBaTlo1QVdObiwgT1U9MDAxNTgwMDAwMUhRUXJaQUFYLCBPPU9wZW5CYW5raW5nLCBDPUdCIn0..hxgZHzKAYho_tJul0BmRA2TIdyOZtPGnRKjnHdLeTfPw41VSbydB5qPUJWOn0lC0d278YFkN0VA3bdMyGZV4N8TPwqqwNa-Jl8bKDRa3tm5Obi1lQkTs5e9FZjF8WSmX5NzRuu7joi79wlX4-jjH47Ax46h6xVZ8H8EtCFm017h6mZAwNZlvGZ_g0w5OtHSpN27ZgAAAzlHa-Z6JwXWfN6ZYHhOb0i4MVpTiab6HnkoWVKeiC0LlMvbIEPJjXx6wmRt4fXpRG-oue8ENu1yYV0puwF8AnqN5ZEVHg-Q1-2-x5Hnab2tOgK9zIDCIEh9EcW46undWHD4WozAzBLBazg' \\\n --cert --key \\\n -H 'Content-Type: application/json; charset=utf-8' \\ \n -d '{\n \"Data\":{\n \"EventSubscriptionId\":\"6\",\n \"CallbackUrl\":\"https://www.updatedtppdomain.com/v3.1.2/event-notifications\",\n \"Version\":\"3.1.2\",\n \"EventTypes\":[\n \"UK.OBIE.Resource-Update\"\n ]\n }\n}'\n","type":"text"}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Response"}},"macroMetadata":{"macroId":{"value":"5fcf6b56-6303-4397-8921-54c5a0db7199"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"{\n \"Data\":{\n \"CallbackUrl\":\"https://www.updatedtppdomain.com/v3.1.2/event-notifications\",\n \"Version\":\"3.1.2\",\n \"EventSubscriptionId\":\"6\",\n \"EventTypes\":[\n \"UK.OBIE.Resource-Update\"\n ]\n },\n \"Links\":{\n \"Self\":\"https://ob-uk-testserver-2:8243/open-banking/v3.1/event-notification/event-notifications/6\"\n },\n \"Meta\":{\n \"TotalPages\":1\n }\n}","type":"text"}]}]}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"DELETE /event-subscriptions/{EventSubscriptionId}","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPP requests the ASPSP to delete an event-subscription resource.","type":"text"}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"65967b6e-efe2-4ead-bc6c-018dc8f77185"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Request"}},"macroMetadata":{"macroId":{"value":"00b52117-723b-4cc7-aaca-8752b9ad1cc9"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"curl DELETE 'https://:8243/open-banking/v3.1.2/event-subscriptions/5' \\\n--cert --key \\\n-H 'accept: application/json; charset=utf-8' \\\n-H 'x-fapi-financial-id: open-bank' \\\n-H 'Authorization: Bearer '","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Response"}},"macroMetadata":{"macroId":{"value":"da5ba6ca-b20e-47ff-a5f2-70028d55e76a"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"204 No Content","type":"text"}]}]}]}]}],"version":1},"reason":"An expand macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Step 9 - Generate application access token","type":"text"}]},{"type":"paragraph","content":[{"text":"When invoking the Aggregated Event Polling API in the Event Notification flow, application access tokens must be generated using the client credential grant type. The generated application access token is used to invoke the API.","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"cxhtml":"Click here to see how it is done...

Once the client is successfully registered, sign in to WSO2 Open Banking Developer Portal and go to the Applications tab.
Select your client application from the Application List.
You can view the keys you generated at the bottom of this page:
The Consumer Key shown above is the client ID of your application.
Now, generate the client assertion by signing the following JSON payload using the supported algorithms.
If you have configured the , you may use the attached certificate and keys for signing and transports layer security testing purposes.
client_assertion formattext>\", \n\"kid\": \"<>\", \n\"typ\": \"JWT\" \n} \n\n{ \n\"iss\": \"<>\", \n\"sub\": \"<>\", \n\"exp\": <>, \n\"iat\": <>, \n\"jti\": \"<>\", \n\"aud\": \"<>:8243/token>>\" \n} \n\n]]>sample client_assertion
The value of the aud claim should contain the same value as the Identity Provider Entity ID.
Click here to view the Identity Provider Entity ID:
Sign in to the Identity and Access Management console at \n \n https://<WSO2_OB_IAM_HOST>t:9446/carbon\n \n .
In the Main menu, go to Home > Identity > Identity Providers > Resident.
View the value in Resident Identity Provider > Inbound Authentication Configuration > OAuth2/OpenID Connect Configuration > Identity Provider Entity ID. By default this value is set to \n \n \n https://<WSO2_OB_APIM>:8243/token\n \n \n .
Run the following cURL command in a command prompt to generate the access token. Update the placeholders with the relevant values. You need an
:8243/token \\\n -H 'Cache-Control: no-cache' \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n --cert --key \\\n -d 'client_id=&grant_type=client_credentials&scope=eventpolling&client_assertion=&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&redirect_uri=']]>
The access token is now generated.
You can use the same cURL command to regenerate the access token.

","nestedContent":{"type":"doc","content":[{"type":"expand","attrs":{"title":"Click here to see how it is done..."},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Once the client is successfully registered, sign in to WSO2 Open Banking Developer Portal and go to the ","type":"text"},{"text":"Applications","type":"text","marks":[{"type":"strong"}]},{"text":" tab.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Select your client application from the Application List. ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You can view the keys you generated at the bottom of this page: ","type":"text"},{"type":"hardBreak"},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"inline-media-image","parameters":{"width":"500","id":"1c5f104c-1b68-42e1-ab1a-b5081f598efe","collection":"contentId-48630757","height":""}}}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"Consumer Key","type":"text","marks":[{"type":"strong"}]},{"text":" shown above is the client ID of your application.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Now, generate the client assertion by signing the following JSON payload using the supported algorithms. ","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"If you have configured the ","type":"text"},{"text":"OB certificates","type":"text","marks":[{"type":"link","attrs":{"href":"https://wso2docs.atlassian.net/wiki/spaces/OB200/pages/48630757"}}]},{"text":", you may use the attached ","type":"text"},{"text":"certificate","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.wso2.com/download/attachments/150017632/jyRUcyt1kVClcIvlUlcDukVZ3tU.pem?api=v2"}}]},{"text":" and ","type":"text"},{"text":"keys","type":"text","marks":[{"type":"link","attrs":{"href":"https://docs.wso2.com/download/attachments/150017632/TSCmEv9GQeBrndPZNZ5AWNn.key?api=v2"}}]},{"text":" for signing and transports layer security testing purposes.","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"38f0ab5a-6858-42e2-8ab5-8fd59a061307"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"client_assertion format"}},"macroMetadata":{"macroId":{"value":"d76a4786-40db-4957-8802-b4d4e5815bf4"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","attrs":{"language":"plaintext"},"content":[{"text":"{ \n\"alg\": \"<>\", \n\"kid\": \"<>\", \n\"typ\": \"JWT\" \n} \n\n{ \n\"iss\": \"<>\", \n\"sub\": \"<>\", \n\"exp\": <>, \n\"iat\": <>, \n\"jti\": \"<>\", \n\"aud\": \"<>:8243/token>>\" \n} \n\n","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"sample client_assertion"}},"macroMetadata":{"macroId":{"value":"2f3949ca-ba8f-4050-abed-6f1463fb3d6a"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"eyJraWQiOiJfTG03VFVWNF8yS3dydWhJQzZUWTdtel82WTQxMlhabG54dHl5QXB6eEw4IiwiYWxnIjoiUFMyNTYifQ.eyJzdWIiOiI0RWJRZmpSZFV2UVJxZThmNlJrMDlWb1Q5bFVhIiwiYXVkIjoiaHR0cHM6Ly9sb2NhbGhvc3Q6ODI0My90b2tlbiIsImlzcyI6IjRFYlFmalJkVXZRUnFlOGY2UmswOVZvVDlsVWEiLCJleHAiOjE2Mzg3ODg0NDIsImlhdCI6MTYwMjI0NjAwOCwianRpIjoiMTYwMjI0NjAwOCJ9.lwPCemtdRZFgIBR65oxJkYP2AeyHC40gl_JjQO0sPK8QQo-PeL2PA6Bi7ULS9Ir05MHwmz9Lam4mDpzN3evBYXzkwYC-eHmeJw5gw-h-l7gq7tFT0x0ZX4Grh_tI2PZHJA6KMyBFksgKN4-cCjjPJJjZEqzyWTrtmzgV4rYGhnUDhjKdxIqzqqm1NDzWwCGK0e42cbp5NxGWTlk2vYM3dC6bGA2uJLaTYxU3r7iUIj6a0DEX21kpHJ7h4cNzbWRDhZCui661H-83zJ-Ijkg47tkdJp-BTrAeyEdyMGL3WiUfP9z0Zqpk4vUsXOZWMEBn719iekOWG4MInFiaSNlhhw","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"The value of the ","type":"text"},{"text":"aud","type":"text","marks":[{"type":"code"}]},{"text":" claim should contain the same value as the ","type":"text"},{"text":"Identity Provider Entity ID.","type":"text","marks":[{"type":"code"}]}]},{"type":"expand","attrs":{"title":"Click here to view the Identity Provider Entity ID:"},"content":[{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Sign in to the Identity and Access Management console at ","type":"text"},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":"\n https://t:9446/carbon\n ","type":"text","marks":[{"type":"code"}]},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":". ","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Main","type":"text","marks":[{"type":"strong"}]},{"text":" menu, go to ","type":"text"},{"text":"Home > Identity > Identity Providers > Resident","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"View the value in ","type":"text"},{"text":"Resident Identity Provider > Inbound Authentication Configuration >","type":"text","marks":[{"type":"strong"}]},{"text":" ","type":"text"},{"text":"OAuth2/OpenID Connect Configuration > Identity Provider Entity ID","type":"text","marks":[{"type":"strong"}]},{"text":". By default this value is set to ","type":"text"},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":"\n \n https://:8243/token\n \n ","type":"text","marks":[{"type":"code"}]},{"text":"\n ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run the following cURL command in a command prompt to generate the access token. Update the placeholders with the relevant values. You need an ","type":"text"}]},{"type":"codeBlock","content":[{"text":"curl -X POST \\\n https://:8243/token \\\n -H 'Cache-Control: no-cache' \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n --cert --key \\\n -d 'client_id=&grant_type=client_credentials&scope=eventpolling&client_assertion=&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&redirect_uri='","type":"text"}]},{"type":"paragraph","content":[{"text":"The access token is now generated.","type":"text"}]},{"type":"panel","attrs":{"panelType":"success"},"content":[{"type":"paragraph","content":[{"text":"You can use the same cURL command to regenerate the access token.","type":"text"}]}]}]}]}]}],"version":1},"reason":"An expand macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"rule"},{"type":"heading","attrs":{"level":3},"content":[{"text":"Step 10 - Invoke Aggregated Event Polling API","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"POST /events","type":"text"}]},{"type":"paragraph","content":[{"text":"The endpoint allows a TPP to poll for, acknowledge, and receive event notifications. The TPPs communicate their polling parameters and event notification acknowledgements using this endpoint. The ASPSP responds accordingly, sending event notifications as indicated by the TPP's polling parameters.","type":"text"}]},{"type":"paragraph","content":[{"text":"The TPPs are able to perform the following using the ","type":"text"},{"text":"POST","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"/events","type":"text","marks":[{"type":"code"}]},{"text":" endpoint using different payloads:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Poll for events","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Acknowledge the received events","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Poll for new events and acknowledge the received events at once","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"The TPPs send two polling parameters to indicate the polling behaviours:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#091e42"}}]},{"text":"returnImmediately","type":"text","marks":[{"type":"code"}]},{"text":": Indicates whether an ASPSP should return a response immediately or provide a long poll. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#091e42"}}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"panel","attrs":{"panelType":"error"},"content":[{"type":"paragraph","content":[{"text":"Long polling is currently not supported by WSO2 Open Banking. Therefore, the value of ","type":"text"},{"text":"returnImmediately","type":"text","marks":[{"type":"code"}]},{"text":" is always ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}],"version":1},"cxhtml":"

Long polling is currently not supported by WSO2 Open Banking. Therefore, the value of returnImmediately is always true.

"}}}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"maxEvents","type":"text","marks":[{"type":"code"}]},{"text":": The maximum number of events to be returned. A value of zero indicates the ASPSP should not return events even if available. The upper bound value of the parameter depends on the size of the payload and the connection. If ","type":"text"},{"text":"maxEvents","type":"text","marks":[{"type":"code"}]},{"text":" is not defined in the payload, the ASPSP sets the value according to the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" configuration in ","type":"text"},{"text":" ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]},{"text":"/repository/conf/finance/open-banking.xml","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]}]}]}]},{"type":"paragraph","content":[{"text":"Given below is a sample request where the TPP is requesting for a response immediately, only to make sure there are events available. ","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"18ab994e-0602-442f-a21e-506114898064"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Request"}},"macroMetadata":{"macroId":{"value":"9b3fdb4d-bd35-4485-b98e-96695cf83d90"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"curl POST 'https://:8243/open-banking/v3.1/events' \\\n--cert --key \\\n-H 'Authorization: Bearer ' \\\n-H 'Content-Type: application/json; charset=utf-8' \\\n-H 'x-fapi-financial-id: open-bank' \\\n-d '{\n \"returnImmediately\":true,\n \"maxEvents\":0\n}'","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Response"}},"macroMetadata":{"macroId":{"value":"ac3b206b-8065-4ef0-91d9-173f81203601"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"{\n \"sets\": { },\n \"moreAvailable\":true\n}","type":"text"}]}]}]}],"version":1},"cxhtml":"

Request

Response

"}}},{"type":"paragraph","content":[{"text":"The TPP confirmed that there are events. For example, if there are 5 events available with the ASPSP and the TPP wants to receive only 3 events, the request looks as follows:","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"128ec837-a099-4417-9404-fde05d8b77c9"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Request"}},"macroMetadata":{"macroId":{"value":"217a9d75-7c4c-4654-a77a-9c062c53132e"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"curl POST 'https://:8243/open-banking/v3.1/events' \\\n--cert --key \\\n-H 'Authorization: Bearer ' \\\n-H 'Content-Type: application/json; charset=utf-8' \\\n-H 'x-fapi-financial-id: open-bank' \\\n-d '{\n \"returnImmediately\":true,\n \"maxEvents\":3\n}'","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Response"}},"macroMetadata":{"macroId":{"value":"2148bb2e-1aa5-4d54-8937-abcaf5250bfb"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"{\n \"sets\":{\n \"b6a68c1db7fc4c178fd7d8a41b9ef85c\":\"eyJhbG...NEysZ4\",\n \"2644f8cbc8294325ad103ddfc4a5b15d\":\"eyJhbG...Qssw5c\",\n \"1fd954d5fb964afb97deee232bb88d1f\":\"eyJhbG...9kogfI\"\n },\n \"moreAvailable\":true\n}","type":"text"}]}]}]}],"version":1},"cxhtml":"

Request

Response

"}}},{"type":"paragraph","content":[{"text":"Now the TPP acknowledges the received events (both positive and negative acknowledgements) while accepting more events. As per the response, there are more events available with the ASPSP. The TPP continues requesting for events until there are no more events and the value of ","type":"text"},{"text":"moreAvailable","type":"text","marks":[{"type":"code"}]},{"text":" is ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtabgroup","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"dc93c61d-1682-47bf-8618-29354d267fcf"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab Group"}}},"content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Request"}},"macroMetadata":{"macroId":{"value":"1ecaffd8-86e7-46b5-a701-13e30c3567c2"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"curl POST 'https://:8243/open-banking/v3.1/events' \\\n--cert --key \\\n-H 'Authorization: Bearer ' \\\n-H 'Content-Type: application/json; charset=utf-8' \\\n-H 'x-fapi-financial-id: open-bank' \\\n-d '{\n \"returnImmediately\":true,\n \"maxEvents\":1,\n \"ack\":[\n \"2644f8cbc8294325ad103ddfc4a5b15d\",\n \"b6a68c1db7fc4c178fd7d8a41b9ef85c\"\n ],\n \"setErrs\":{\n \"1fd954d5fb964afb97deee232bb88d1f\":{\n \"err\":\"jwtIss\",\n \"description\":\"Issuer is invalid or could not be verified\"\n }\n }\n}'","type":"text"}]}]},{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"localtab","parameters":{"macroParams":{"title":{"value":"Response"}},"macroMetadata":{"macroId":{"value":"ff889c4d-85a4-4598-89a5-d425cdee5440"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://us.navitabs-static-assets.aws.bitvoodoo.cloud/static/4.0.7/images/macro-icon.png"}}],"title":"Tab (Deprecated)"}}},"content":[{"type":"codeBlock","content":[{"text":"{\n \"sets\":{\n \"25fd4432da4e4e609033a733aea68a54\":\"eyJhbG...8o8PLY\"\n },\n \"moreAvailable\":true\n}","type":"text"}]}]}]}],"version":1},"cxhtml":"

Request

:8243/open-banking/v3.1/events' \\\n--cert --key \\\n-H 'Authorization: Bearer ' \\\n-H 'Content-Type: application/json; charset=utf-8' \\\n-H 'x-fapi-financial-id: open-bank' \\\n-d '{\n \"returnImmediately\":true,\n \"maxEvents\":1,\n \"ack\":[\n \"2644f8cbc8294325ad103ddfc4a5b15d\",\n \"b6a68c1db7fc4c178fd7d8a41b9ef85c\"\n ],\n \"setErrs\":{\n \"1fd954d5fb964afb97deee232bb88d1f\":{\n \"err\":\"jwtIss\",\n \"description\":\"Issuer is invalid or could not be verified\"\n }\n }\n}']]>

Response

"}}}]}],"version":1}

Event Notification API v3.1.2