"openapi: 3.0.1\ninfo:\n title: 'Open Banking Aggregated Polling API'\n x-technical-name: open-banking-event-polling\n version: 1.0.0\n description: \"This API provides the ability for approved\/authorised Account Information Service Providers (AISPs), Card Based Payment Instrument Issuers (CBPIIs) and Payment Initiation Service Providers (PISPs) to retrieve a list of all revoked or cancelled consents that have been made against the Account & Transactions APIs and\/or the Confirmation of Funds APIs and\/or the VariableRecurringPayment APIs. This API is developed according to the Open Banking Read\/Write API Specifications and fulfils PSD2 regulation. See https:\/\/www.openbanking.org.uk\"\n termsOfService: https:\/\/www.openbanking.org.uk\/terms\n contact:\n name: OpenBanking Consents Management team\n url: https:\/\/github.com\/santandergroup-uk\/openbanking-cm-ext-api\n email: obchannelssupport@santander.co.uk\n license:\n name: License\n url: http:\/\/www.santander.co.uk\/uk\/website-legal\n x-api-type: OpenBanking\n x-santander-catalogation:\n bian-business-area: Sales and Service\n bian-service-domain: OpenBanking Consents Management\n bian-business-domain: OpenBanking Consents Management\n bian-landscape-version: \"8\"\nservers:\n - url: https:\/\/personal-api-ob.omni.slz.santander.co.uk\n - url: https:\/\/business-api-ob.omni.slz.santander.co.uk\npaths:\n \/open-banking\/v4.0\/checkhealth:\n get:\n summary: \"Checks the health of the API and this could be used as part of the synthetic checks.\"\n description: \"Checks the health of the API and this could be used as part of the synthetic checks that can be executed on a regular basis and metrics through Kibana & alerting through Prometheus can be sent, so engineers can be aware of the health of the API, as well as receive alerts of any availability issue.\"\n tags:\n - health-check-controller\n operationId: checkHealth\n responses:\n \"200\":\n description: OK\n content:\n text\/html:\n schema:\n type: string\n \"400\":\n description: Bad request\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 400\n message:\n example: Bad request\n \"401\":\n description: Unauthorized\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 401\n message:\n example: Unauthorized\n \"403\":\n description: Forbidden\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 403\n message:\n example: Forbidden\n \"404\":\n description: Not Found\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 404\n message:\n example: Not Found\n \"429\":\n description: Too Many Requests\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 429\n message:\n example: Too Many Requests\n \"500\":\n description: Internal Server Error\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 500\n message:\n example: Internal Server Error\n \"501\":\n description: Not Implemented\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 501\n message:\n example: Not Implemented\n \"503\":\n description: Service Unavailable\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 503\n message:\n example: Service Unavailable\n \"502\":\n description: Bad Gateway\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 502\n message:\n example: Bad Gateway\n \"504\":\n description: Gateway Timeout\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 504\n message:\n example: Gateway Timeout\n \/open-banking\/v4.0\/events:\n post:\n summary: \"This will return the list of Revoked and Cancelled consents that can no longer be accessed by the TPP, since the last time data it was polled.\"\n description: \"This will return the list of Revoked and Cancelled consents that can no longer be accessed by the TPP, since the last time data it was polled. Includes details of AISP\/CBPII\/VRP consents.\"\n tags:\n - events-controller\n operationId: createEvents\n parameters:\n - name: Authorization\n in: header\n required: true\n schema:\n type: string\n - name: x-fapi-interaction-id\n in: header\n required: false\n schema:\n type: string\n requestBody:\n content:\n application\/json:\n schema:\n $ref: '#\/components\/schemas\/EventPollingRequest'\n required: true\n responses:\n \"200\":\n description: OK\n content:\n application\/json:\n schema:\n $ref: '#\/components\/schemas\/OBEventPollingResponse'\n \"400\":\n description: Bad request\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 400\n message:\n example: Bad request\n \"401\":\n description: Unauthorized\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 401\n message:\n example: Unauthorized\n \"403\":\n description: Forbidden\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 403\n message:\n example: Forbidden\n \"404\":\n description: Not Found\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 404\n message:\n example: Not Found\n \"429\":\n description: Too Many Requests\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 429\n message:\n example: Too Many Requests\n \"500\":\n description: Internal Server Error\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 500\n message:\n example: Internal Server Error\n \"501\":\n description: Not Implemented\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 501\n message:\n example: Not Implemented\n \"503\":\n description: Service Unavailable\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 503\n message:\n example: Service Unavailable\n \"502\":\n description: Bad Gateway\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 502\n message:\n example: Bad Gateway\n \"504\":\n description: Gateway Timeout\n content:\n application\/json:\n schema:\n allOf:\n - $ref: '#\/components\/schemas\/ApiError'\n - type: object\n properties:\n httpCode:\n example: 504\n message:\n example: Gateway Timeout\ncomponents:\n schemas:\n ApiError:\n type: object\n properties:\n httpCode:\n type: integer\n description: Error code which represents the problem that occurred during processing\n message:\n type: string\n description: Error message which represents the problem that occurred during processing\n timestamp:\n type: string\n description: Additional information about the error returned\n example: 2025-01-10T20:30:15Z\n serviceInError:\n type: string\n description: This field holds the service or component which is responsible for the error.\n example: ob-event-polling\n EventPollingRequest:\n type: object\n properties:\n maxEvents:\n type: integer\n description: Maximum number of events to be returned. A value of zero indicates the ASPSP should not return events even if available\n example: 50\n returnImmediately:\n type: boolean\n description: Indicates whether an ASPSP should return a response immediately or provide a long poll\n example: true\n ack:\n type: array\n description: An object that encapsulates all negative acknowledgements transmitted by the TPP\n items:\n type: string\n OBEventPollingResponse:\n type: object\n properties:\n moreAvailable:\n type: boolean\n description: A JSON boolean value that indicates if more unacknowledged event notifications are available to be returned.\n sets:\n type: object\n description: A JSON object that contains zero or more nested JSON attributes. If there are no outstanding event notifications to be transmitted, the JSON object SHALL be empty.\n additionalProperties:\n type: string\n"

{}