This API, provides the ability for approved/authorised account information service providers (AISPs) and Card Based Payment Instrument Issuers (CBPIIs) to retrieve a list of all revoked consents that have been made against the Account & Transactions and/or the Confirmation of Funds APIs. This API is developed according to the Open Banking Read/Write API Specifications and fulfils PSD2 regulation. see https://www.openbanking.org.uk
Key Features:
An endpoint that allows, by Client ID, a TPP to retrieve a list of Consent IDs that have been revoked in the last 30 days or since they last called the API endpoint, whichever is the shorter. This only applies to consents created against the Account & Transactions and Confirmation of Funds APIs.
Who can have access to the API?
Access to the Event Polling API is limited to approved/authorised AISPs and CBPIIs, using eIDAS certificates. Approval and authorisation is managed by the Financial Conduct Authority in the UK (FCA, see https://www.fca.org.uk/ and other relevant competent authorities across the EU. Approved/Authorised organisations should then be enrolled to use the Open Banking Directory. By successfully accomplishing these prerequisites, an AISP will obtain the necessary digital identities and certificates which enable organisations to securely connect and communicate via the Open Banking Security Profile (OIDC) in a standard manner and to best protect all parties within the Open Banking ecosystem.
Endpoint for Open Banking TLS MA only
Paths
/events
createEvents
TPP client credential authorisation flow with the ASPSP and Funds Confirmation
TPP client credential authorisation flow with the ASPSP and Funds Confirmation
obEventPolling1Param
x-fapi-customer-ip-address
x-fapi-interaction-id
xFapiAuthDate
Authorization
application/json; charset=utf-8
application/jose+jwe
Events successfully retrieved
Created
Bad Request
Unauthorized
Forbidden
Not Found
Method Not Allowed
Not Acceptable
Too Many Requests
Internal Server Error
Definitions
{
"type": "object",
"properties": {
"ack": {
"type": "array",
"items": {
"type": "string"
}
},
"errs": {
"type": "object",
"additionalProperties": {
"$ref": "#\/definitions\/OBEventPolling1SetErrs"
}
},
"maxEvents": {
"type": "integer",
"format": "int32",
"description": "Maximum number of events to be returned. A value of zero indicates the ASPSP should not return events even if available"
},
"returnImmediately": {
"type": "boolean",
"description": "Indicates whether an ASPSP should return a response immediately or provide a long poll"
},
"setErrs": {
"type": "object",
"description": "An object that encapsulates all negative acknowledgements transmitted by the TPP",
"additionalProperties": {
"$ref": "#\/definitions\/OBEventPolling1SetErrs"
}
}
},
"title": "OBEventPolling1"
}
{
"type": "object",
"required": [
"description",
"err"
],
"properties": {
"description": {
"type": "string",
"description": "A human-readable string that provides additional diagnostic information"
},
"err": {
"type": "string",
"description": "A value from the IANA \"Security Event Token Delivery Error Codes\" registry that identifies the error as defined here https:\/\/tools.ietf.org\/id\/draft-ietf-secevent-http-push-03.html#error_codes"
}
},
"title": "OBEventPolling1SetErrs"
}
{
"type": "object",
"required": [
"moreAvailable",
"sets"
],
"properties": {
"moreAvailable": {
"type": "boolean",
"description": "A JSON boolean value that indicates if more unacknowledged event notifications are available to be returned."
},
"sets": {
"type": "object",
"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.",
"additionalProperties": {
"type": "string"
}
}
},
"title": "OBEventPollingResponse1"
}