event-notifications-openapi.yaml

openapi: "3.0.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: "3.1.9"
paths:
  /event-notifications:
    post:
      summary: "Send an event notification"
      operationId: "CreateEventNotification"
      tags:
        - "Event Notification"
      parameters:
        - $ref: "#/components/parameters/x-fapi-financial-id-Param"
        - $ref: "#/components/parameters/x-fapi-interaction-id-Param"
      requestBody:
        content:
          application/jwt:
            schema:
              type: "string"
              format: "base64"
        description: "Create an Callback URI"
        required: true
      responses:
        202:
          description: "Accepted"
servers:
  - url: "/open-banking/v3.1"
components:
  parameters:
    x-fapi-financial-id-Param:
      in: "header"
      name: "x-fapi-financial-id"
      required: true
      description: "The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB."
      schema:
        type: "string"
    x-fapi-interaction-id-Param:
      in: "header"
      name: "x-fapi-interaction-id"
      required: false
      description: "An RFC4122 UID used as a correlation id."
      schema:
        type: "string"
  securitySchemes:
    TPPOAuth2Security:
      type: "oauth2"
      description: "TPP client credential authorisation flow with the ASPSP"
      flows:
        clientCredentials:
          tokenUrl: "https://authserver.example/token"
          scopes:
            accounts: "Ability to read Accounts information"
            fundsconfirmations: "Ability to confirm funds"
            payments: "Generic payment scope"
  schemas:
    OBEvent1:
      description: "Events."
      type: "object"
      properties:
        urn:uk:org:openbanking:events:resource-update:
          $ref: "#/components/schemas/OBEventResourceUpdate1"
      required:
        - "urn:uk:org:openbanking:events:resource-update"
      additionalProperties: false
    OBEventLink1:
      description: "Resource links to other available versions of the resource."
      type: "object"
      properties:
        version:
          description: "Resource version."
          type: "string"
          minLength: 1
          maxLength: 10
        link:
          description: "Resource link."
          type: "string"
      required:
        - "version"
        - "link"
      additionalProperties: false
      minProperties: 1
    OBEventNotification1:
      description: "The resource-update event."
      type: "object"
      properties:
        iss:
          description: "Issuer."
          type: "string"
        iat:
          description: "Issued At. "
          type: "integer"
          format: "int32"
          minimum: 0
        jti:
          description: "JWT ID."
          type: "string"
          minLength: 1
          maxLength: 128
        aud:
          description: "Audience."
          type: "string"
          minLength: 1
          maxLength: 128
        sub:
          description: "Subject"
          type: "string"
          format: "uri"
        txn:
          description: "Transaction Identifier."
          type: "string"
          minLength: 1
          maxLength: 128
        toe:
          description: "Time of Event."
          type: "integer"
          format: "int32"
          minimum: 0
        events:
          $ref: "#/components/schemas/OBEvent1"
      required:
        - "iss"
        - "iat"
        - "jti"
        - "aud"
        - "sub"
        - "txn"
        - "toe"
        - "events"
      additionalProperties: false
    OBEventResourceUpdate1:
      description: "Resource-Update Event."
      type: "object"
      properties:
        subject:
          $ref: "#/components/schemas/OBEventSubject1"
      required:
        - "subject"
      additionalProperties: false
    OBEventSubject1:
      description: "The resource-update event."
      type: "object"
      properties:
        subject_type:
          description: "Subject type for the updated resource. "
          type: "string"
          minLength: 1
          maxLength: 128
        http://openbanking.org.uk/rid:
          description: "Resource Id for the updated resource."
          type: "string"
          minLength: 1
          maxLength: 128
        http://openbanking.org.uk/rty:
          description: "Resource Type for the updated resource."
          type: "string"
          minLength: 1
          maxLength: 128
        http://openbanking.org.uk/rlk:
          items:
            $ref: "#/components/schemas/OBEventLink1"
          type: "array"
          description: "Resource links to other available versions of the resource."
          minItems: 1
      required:
        - "subject_type"
        - "http://openbanking.org.uk/rid"
        - "http://openbanking.org.uk/rty"
        - "http://openbanking.org.uk/rlk"
      additionalProperties: false