event-notifications-swagger-flattened.json

{
  "swagger": "2.0",
  "info": {
    "title": "Event Notification API Specification - TPP Endpoints",
    "description": "Swagger for Event Notification API Specification - TPP Endpoints",
    "termsOfService": "https://www.openbanking.org.uk/terms",
    "contact": {
      "name": "Service Desk",
      "email": "ServiceDesk@openbanking.org.uk"
    },
    "license": {
      "name": "open-licence",
      "url": "https://www.openbanking.org.uk/open-licence"
    },
    "version": "v3.1.6"
  },
  "basePath": "/open-banking/v3.1",
  "schemes": [
    "https"
  ],
  "paths": {
    "/event-notifications": {
      "post": {
        "summary": "Send an event notification",
        "operationId": "CreateEventNotification",
        "consumes": [
          "application/jwt"
        ],
        "tags": [
          "Event Notification"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "OBEventNotification1Param",
            "description": "Create an Callback URI",
            "required": true,
            "schema": {
              "type": "string",
              "format": "base64"
            }
          },
          {
            "in": "header",
            "name": "x-fapi-financial-id",
            "type": "string",
            "required": true,
            "description": "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB."
          },
          {
            "in": "header",
            "name": "x-fapi-interaction-id",
            "type": "string",
            "required": false,
            "description": "An RFC4122 UID used as a correlation id."
          }
        ],
        "responses": {
          "202": {
            "description": "Accepted"
          }
        }
      }
    }
  },
  "securityDefinitions": {
    "TPPOAuth2Security": {
      "type": "oauth2",
      "flow": "application",
      "tokenUrl": "https://authserver.example/token",
      "scopes": {
        "accounts": "Ability to read Accounts information",
        "fundsconfirmations": "Ability to confirm funds",
        "payments": "Generic payment scope"
      },
      "description": "TPP client credential authorisation flow with the ASPSP"
    }
  }
}