openapi: 3.0.1
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
servers:
  - url: /open-banking/v3.1
paths:
  /event-notifications:
    post:
      tags:
        - Event Notification
      summary: Send an event notification
      operationId: CreateEventNotification
      parameters:
        - name: x-fapi-financial-id
          in: header
          description: The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
          required: true
          schema:
            type: string
        - name: x-fapi-interaction-id
          in: header
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
      requestBody:
        description: Create an Callback URI
        content:
          application/jwt:
            schema:
              type: string
              format: base64
        required: true
      responses:
        '202':
          description: Accepted
          content: {}
      x-codegen-request-body-name: OBEventNotification1Param
components:
  schemas:
    OBEvent1:
      required:
        - 'urn:uk:org:openbanking:events:resource-update'
      type: object
      properties:
        'urn:uk:org:openbanking:events:resource-update':
          $ref: '#/components/schemas/OBEventResourceUpdate1'
      description: Events.
    OBEventLink1:
      required:
        - link
        - version
      type: object
      properties:
        version:
          maxLength: 10
          minLength: 1
          type: string
          description: Resource version.
        link:
          type: string
          description: Resource link.
      description: Resource links to other available versions of the resource.
    OBEventNotification1:
      required:
        - aud
        - events
        - iat
        - iss
        - jti
        - sub
        - toe
        - txn
      type: object
      properties:
        iss:
          type: string
          description: Issuer.
        iat:
          minimum: 0
          type: integer
          description: 'Issued At. '
          format: int32
        jti:
          maxLength: 128
          minLength: 1
          type: string
          description: JWT ID.
        aud:
          maxLength: 128
          minLength: 1
          type: string
          description: Audience.
        sub:
          type: string
          description: Subject
          format: uri
        txn:
          maxLength: 128
          minLength: 1
          type: string
          description: Transaction Identifier.
        toe:
          minimum: 0
          type: integer
          description: Time of Event.
          format: int32
        events:
          $ref: '#/components/schemas/OBEvent1'
      description: The resource-update event.
    OBEventResourceUpdate1:
      required:
        - subject
      type: object
      properties:
        subject:
          $ref: '#/components/schemas/OBEventSubject1'
      description: Resource-Update Event.
    OBEventSubject1:
      required:
        - 'http://openbanking.org.uk/rid'
        - 'http://openbanking.org.uk/rlk'
        - 'http://openbanking.org.uk/rty'
        - subject_type
      type: object
      properties:
        subject_type:
          maxLength: 128
          minLength: 1
          type: string
          description: 'Subject type for the updated resource. '
        'http://openbanking.org.uk/rid':
          maxLength: 128
          minLength: 1
          type: string
          description: Resource Id for the updated resource.
        'http://openbanking.org.uk/rty':
          maxLength: 128
          minLength: 1
          type: string
          description: Resource Type for the updated resource.
        'http://openbanking.org.uk/rlk':
          minItems: 1
          type: array
          description: Resource links to other available versions of the resource.
          items:
            $ref: '#/components/schemas/OBEventLink1'
      description: The resource-update event.
  parameters:
    x-fapi-financial-id-Param:
      name: x-fapi-financial-id
      in: header
      description: The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.
      required: true
      schema:
        type: string
    x-fapi-interaction-id-Param:
      name: x-fapi-interaction-id
      in: header
      description: An RFC4122 UID used as a correlation id.
      schema:
        type: string
  requestBodies:
    OBEventNotification1Param:
      description: Create an Callback URI
      content:
        '*/*':
          schema:
            type: string
            format: base64
      required: true
  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