---
swagger: "2.0"
info:
  description: API for PSD2 Subscription V2
  version: "2.0"
  title: PSD2_Subscription_API_V2
  contact:
    name: Bank Of Cyprus
  x-ibm-name: PSD2_Subscription_API_V2
host: localhost:443
basePath: /psd2
schemes:
- https
paths:
  /v2/subscriptions:
    post:
      description: Create Subscription after user authentication
      operationId: createSubscription
      schemes:
      - http
      - https
      produces:
      - application/json
      parameters:
      - name: journeyId
        in: header
        description: Global transaction Id
        required: true
        type: string
      - name: app_name
        in: header
        required: false
        type: string
      - name: originSourceId
        in: header
        description: ID of the source system invoking
        required: false
        type: string
      - name: originChannelId
        in: header
        description: ID of the channel from which the invocation occurred
        required: false
        type: string
      - name: originDeptId
        in: header
        description: ID of the department from which the invocation occurred
        required: false
        type: string
      - name: originUserId
        in: header
        description: User ID of the requester (as per LDAP)
        required: false
        type: string
      - name: originEmployeeId
        in: header
        description: Employee ID of the requester (as per employee HR record)
        required: false
        type: string
      - name: originTerminalId
        in: header
        description: Terminal ID of the requester
        required: false
        type: string
      - name: timeStamp
        in: header
        description: The time stamp when the request was sent to system
        required: true
        type: string
      - name: correlationId
        in: header
        description: Correlation ID passed by the requesting system
        required: false
        type: string
      - name: tppId
        in: header
        description: Third party Provide ( TPP ) ID
        required: false
        type: string
      - name: client_id
        in: query
        description: Third party Provide ( TPP ) Application Id
        required: false
        type: string
      - name: Authorization
        in: header
        description: 'Encrypted access token '
        required: true
        type: string
      - name: lang
        in: header
        description: 2-character iso code for preferred language.  If empty the default
          will be English
        required: false
        type: string
      - name: client_secret
        in: query
        description: Unique ID for TPP
        required: false
        type: string
      - name: customerIP
        type: string
        required: false
        in: header
        description: The PSU's IP address if the PSU is currently logged in with the
          TPP
      - name: customerSessionId
        type: string
        required: false
        in: header
        description: The PSU’s Session Identifier with the TPP
      - name: customerDevice
        type: string
        required: false
        in: header
        description: The PSU’s Web Browser Agent or Device Type (Whatever is available
          from Platform, OS Version, Model) if this is a Mobile App
      - name: loginTimeStamp
        type: string
        required: false
        in: header
        description: The time of PSU’s last login with the TPP related to the Session
          Id provided above
      - in: body
        name: requestBody
        required: true
        schema:
          $ref: '#/definitions/CreateSubscriptionRequest'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/CreateSubscriptionResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        201:
          description: Created
          schema:
            $ref: '#/definitions/CreateSubscriptionResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        202:
          description: Accepted
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        302:
          description: Found
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        404:
          description: API URL Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        405:
          description: Method not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        406:
          description: Not Acceptable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        429:
          description: Too many Requests
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        503:
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
      consumes:
      - application/json
  /v2/subscriptions/accounts/{accountId}:
    get:
      description: Retrieve subscriptions for customer account based on accountId
        in path parameter
      operationId: getSubscriptionForAccount
      schemes:
      - http
      - https
      produces:
      - application/json
      parameters:
      - name: accountId
        in: path
        description: AccountId of account
        required: true
        type: string
      - name: subscriptionId
        in: header
        required: false
        type: string
      - name: journeyId
        in: header
        description: Global transaction Id
        required: true
        type: string
      - name: originSourceId
        in: header
        description: ID of the source system invoking
        required: false
        type: string
      - name: originChannelId
        in: header
        description: ID of the channel from which the invocation occurred
        required: false
        type: string
      - name: originDeptId
        in: header
        description: ID of the department from which the invocation occurred
        required: false
        type: string
      - name: originUserId
        in: header
        description: User ID of the requester (as per LDAP)
        required: false
        type: string
      - name: originEmployeeId
        in: header
        description: Employee ID of the requester (as per employee HR record)
        required: false
        type: string
      - name: originTerminalId
        in: header
        description: Terminal ID of the requester
        required: false
        type: string
      - name: timeStamp
        in: header
        description: The time stamp when the request was sent to system
        required: true
        type: string
      - name: correlationId
        in: header
        description: Correlation ID passed by the requesting system
        required: false
        type: string
      - name: tppId
        in: header
        description: Third party Provide ( TPP ) ID
        required: false
        type: string
      - name: client_id
        in: query
        description: Third party Provide ( TPP ) Application Id
        required: false
        type: string
      - name: Authorization
        in: header
        description: 'Encrypted access token '
        required: true
        type: string
      - name: lang
        in: header
        description: 2-character iso code for preferred language.  If empty the default
          will be English
        required: false
        type: string
      - name: client_secret
        in: query
        description: Unique ID for TPP
        required: false
        type: string
      - name: customerIP
        type: string
        required: false
        in: header
        description: The PSU's IP address if the PSU is currently logged in with the
          TPP
      - name: customerSessionId
        type: string
        required: false
        in: header
        description: The PSU’s Session Identifier with the TPP
      - name: customerDevice
        type: string
        required: false
        in: header
        description: The PSU’s Web Browser Agent or Device Type (Whatever is available
          from Platform, OS Version, Model) if this is a Mobile App
      - name: loginTimeStamp
        type: string
        required: false
        in: header
        description: The time of PSU’s last login with the TPP related to the Session
          Id provided above
      responses:
        200:
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/SubscriptionView'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        302:
          description: Found
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        404:
          description: API URL Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        405:
          description: Method not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        406:
          description: Not Acceptable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        429:
          description: Too many Requests
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        503:
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
  /v2/subscriptions/{subscriptionId}:
    get:
      description: Get subscription for TPP based on subscriptionId in header
      operationId: getSubscriptionsForTPP
      schemes:
      - http
      - https
      parameters:
      - name: subscriptionId
        in: path
        description: 'Subscription ID of a subscriber '
        required: true
        type: string
      - name: journeyId
        in: header
        description: Global transaction Id
        required: true
        type: string
      - name: originSourceId
        in: header
        description: ID of the source system invoking
        required: false
        type: string
      - name: originChannelId
        in: header
        description: ID of the channel from which the invocation occurred
        required: false
        type: string
      - name: originDeptId
        in: header
        description: ID of the department from which the invocation occurred
        required: false
        type: string
      - name: originUserId
        in: header
        description: User ID of the requester (as per LDAP)
        required: false
        type: string
      - name: originEmployeeId
        in: header
        description: Employee ID of the requester (as per employee HR record)
        required: false
        type: string
      - name: originTerminalId
        in: header
        description: Terminal ID of the requester
        required: false
        type: string
      - name: timeStamp
        in: header
        description: The time stamp when the request was sent to system
        required: true
        type: string
      - name: correlationId
        in: header
        description: Correlation ID passed by the requesting system
        required: false
        type: string
      - name: tppId
        in: header
        description: Third party Provide ( TPP ) ID
        required: false
        type: string
      - name: client_id
        in: query
        description: Third party Provide ( TPP ) Application Id
        required: false
        type: string
      - name: Authorization
        in: header
        description: 'Encrypted access token '
        required: true
        type: string
      - name: lang
        in: header
        description: 2-character iso code for preferred language.  If empty the default
          will be English
        required: false
        type: string
      - name: client_secret
        in: query
        description: Unique ID for TPP
        required: false
        type: string
      - name: customerIP
        type: string
        required: false
        in: header
        description: The PSU's IP address if the PSU is currently logged in with the
          TPP
      - name: customerSessionId
        type: string
        required: false
        in: header
        description: The PSU’s Session Identifier with the TPP
      - name: customerDevice
        type: string
        required: false
        in: header
        description: The PSU’s Web Browser Agent or Device Type (Whatever is available
          from Platform, OS Version, Model) if this is a Mobile App
      - name: loginTimeStamp
        type: string
        required: false
        in: header
        description: The time of PSU’s last login with the TPP related to the Session
          Id provided above
      responses:
        200:
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/SubscriptionView'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        302:
          description: Found
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        404:
          description: API URL Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        405:
          description: Method not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        406:
          description: Not Acceptable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        429:
          description: Too many Requests
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        503:
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
    delete:
      description: Revoke subscription based on subscriptionId
      operationId: revokeSubscription
      schemes:
      - http
      - https
      produces:
      - application/json
      parameters:
      - name: subscriptionId
        in: path
        description: SubscriptionId for which subscription needs to be revoked
        required: true
        type: string
      - name: journeyId
        in: header
        description: Global transaction Id
        required: true
        type: string
      - name: originSourceId
        in: header
        description: ID of the source system invoking
        required: false
        type: string
      - name: originChannelId
        in: header
        description: ID of the channel from which the invocation occurred
        required: false
        type: string
      - name: originDeptId
        in: header
        description: ID of the department from which the invocation occurred
        required: false
        type: string
      - name: originUserId
        in: header
        description: User ID of the requester (as per LDAP)
        required: false
        type: string
      - name: originEmployeeId
        in: header
        description: Employee ID of the requester (as per employee HR record)
        required: false
        type: string
      - name: originTerminalId
        in: header
        description: Terminal ID of the requester
        required: false
        type: string
      - name: timeStamp
        in: header
        description: The time stamp when the request was sent to system
        required: true
        type: string
      - name: correlationId
        in: header
        description: Correlation ID passed by the requesting system
        required: false
        type: string
      - name: tppId
        in: header
        description: Third party Provide ( TPP ) ID
        required: false
        type: string
      - name: client_id
        in: query
        description: Third party Provide ( TPP ) Application Id
        required: false
        type: string
      - name: Authorization
        in: header
        description: 'Encrypted access token '
        required: true
        type: string
      - name: lang
        in: header
        description: 2-character iso code for preferred language.  If empty the default
          will be English
        required: false
        type: string
      - name: client_secret
        in: query
        description: Unique ID for TPP
        required: false
        type: string
      - name: customerIP
        type: string
        required: false
        in: header
        description: The PSU's IP address if the PSU is currently logged in with the
          TPP
      - name: customerSessionId
        type: string
        required: false
        in: header
        description: The PSU’s Session Identifier with the TPP
      - name: customerDevice
        type: string
        required: false
        in: header
        description: The PSU’s Web Browser Agent or Device Type (Whatever is available
          from Platform, OS Version, Model) if this is a Mobile App
      - name: loginTimeStamp
        type: string
        required: false
        in: header
        description: The time of PSU’s last login with the TPP related to the Session
          Id provided above
      responses:
        200:
          description: OK
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        202:
          description: Accepted
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        302:
          description: Found
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        404:
          description: API URL Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        405:
          description: Method not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        406:
          description: Not Acceptable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        429:
          description: Too many Requests
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        503:
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
    patch:
      description: Update subscription details based on subscriptionId
      operationId: updateSubscription
      schemes:
      - http
      - https
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: subscriptionId
        in: path
        description: SubscriptionId for which subscription needs to be updated
        required: true
        type: string
      - name: journeyId
        in: header
        description: Global transaction Id
        required: true
        type: string
      - name: originSourceId
        in: header
        description: ID of the source system invoking
        required: false
        type: string
      - name: originChannelId
        in: header
        description: ID of the channel from which the invocation occurred
        required: false
        type: string
      - name: originDeptId
        in: header
        description: ID of the department from which the invocation occurred
        required: false
        type: string
      - name: originUserId
        in: header
        description: User ID of the requester (as per LDAP)
        required: false
        type: string
      - name: originEmployeeId
        in: header
        description: Employee ID of the requester (as per employee HR record)
        required: false
        type: string
      - name: originTerminalId
        in: header
        description: Terminal ID of the requester
        required: false
        type: string
      - name: timeStamp
        in: header
        description: The time stamp when the request was sent to system
        required: true
        type: string
      - name: correlationId
        in: header
        description: Correlation ID passed by the requesting system
        required: false
        type: string
      - name: tppId
        in: header
        description: Third party Provide ( TPP ) ID
        required: false
        type: string
      - name: client_id
        in: query
        description: Third party Provide ( TPP ) Application Id
        required: false
        type: string
      - name: Authorization
        in: header
        description: 'Encrypted access token '
        required: true
        type: string
      - name: lang
        in: header
        description: 2-character iso code for preferred language.  If empty the default
          will be English
        required: false
        type: string
      - name: client_secret
        in: query
        description: Unique ID for TPP
        required: false
        type: string
      - name: customerIP
        type: string
        required: false
        in: header
        description: The PSU's IP address if the PSU is currently logged in with the
          TPP
      - name: customerSessionId
        type: string
        required: false
        in: header
        description: The PSU’s Session Identifier with the TPP
      - name: customerDevice
        type: string
        required: false
        in: header
        description: The PSU’s Web Browser Agent or Device Type (Whatever is available
          from Platform, OS Version, Model) if this is a Mobile App
      - name: loginTimeStamp
        type: string
        required: false
        in: header
        description: The time of PSU’s last login with the TPP related to the Session
          Id provided above
      - in: body
        name: requestBody
        required: true
        schema:
          $ref: '#/definitions/UpdateSubscriptionRequest'
      responses:
        200:
          description: OK
          schema:
            $ref: '#/definitions/UpdateSubscriptionResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        201:
          description: Created
          schema:
            $ref: '#/definitions/UpdateSubscriptionResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        202:
          description: Accepted
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        302:
          description: Found
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        400:
          description: Bad Request
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        401:
          description: Unauthorized
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        403:
          description: Forbidden
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        404:
          description: API URL Not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        405:
          description: Method not Found
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        406:
          description: Not Acceptable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        429:
          description: Too many Requests
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
        500:
          description: Internal Server Error
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
        503:
          description: Service Unavailable
          schema:
            $ref: '#/definitions/ErrorResponse'
          headers:
            journeyId:
              type: string
              description: Global Transaction id/Journey ID
            timeStamp:
              type: string
              description: The time stamp when the message was received from the system
            correlationId:
              type: string
              description: Correlation ID passed by the requesting system
      security:
      - Access Code - Oauth:
        - UserOAuth2Security
  /v2/subscription/healthCheck:
    get:
      responses:
        200:
          description: 200 OK
      operationId: healthCheck
      tags:
      - healthCheck
      produces: []
      consumes: []
      security:
      - []
definitions:
  AdditionalDetails:
    type: object
    properties:
      description:
        type: string
      errorCode:
        type: string
      severity:
        type: string
      status:
        type: string
  UpdateSubscriptionResponse:
    type: object
    required:
    - duration
    properties:
      accounts:
        $ref: '#/definitions/AccountView'
      description:
        type: string
      duration:
        $ref: '#/definitions/Duration'
      payments:
        $ref: '#/definitions/PaymentView'
      customerInformation:
        $ref: '#/definitions/CustomerInformation'
      selectedAccounts:
        type: array
        items:
          $ref: '#/definitions/SelectedAccount'
      status:
        type: string
      subscriptionId:
        type: string
  CustomerInformation:
    type: object
    properties:
      address:
        type: boolean
      identification:
        type: boolean
      pepinformation:
        type: boolean
      personalInformation:
        type: boolean
      telephone:
        type: boolean
      reviewInformation:
        type: boolean
  UpdateSubscriptionRequest:
    type: object
    properties:
      accounts:
        $ref: '#/definitions/AccountView'
      payments:
        $ref: '#/definitions/PaymentView'
      customerInformation:
        $ref: '#/definitions/CustomerInformation'
      selectedAccounts:
        type: array
        items:
          $ref: '#/definitions/SelectedAccount'
  SubscriptionView:
    type: object
    properties:
      accounts:
        $ref: '#/definitions/AccountView'
      description:
        type: string
      payments:
        $ref: '#/definitions/PaymentView'
      customerInformation:
        $ref: '#/definitions/CustomerInformation'
      selectedAccounts:
        type: array
        items:
          $ref: '#/definitions/SelectedAccount'
      status:
        type: string
      subscriptionId:
        type: string
      expirationDate:
        type: string
  SelectedAccount:
    type: object
    required:
    - accountId
    properties:
      accountId:
        type: string
  Error:
    type: object
    properties:
      additionalDetails:
        type: array
        items:
          $ref: '#/definitions/AdditionalDetails'
      code:
        type: string
      description:
        type: string
      severity:
        type: string
        enum:
        - error
        - warning
        - Info
  Duration:
    type: object
    required:
    - endDate
    - startDate
    properties:
      endDate:
        type: string
      startDate:
        type: string
  CreateSubscriptionRequest:
    type: object
    properties:
      accounts:
        $ref: '#/definitions/AccountView'
      customerInformation:
        $ref: '#/definitions/CustomerInformation'
      payments:
        $ref: '#/definitions/PaymentView'
      selectedAccounts:
        type: array
        items:
          $ref: '#/definitions/SelectedAccount'
  ErrorResponse:
    type: object
    properties:
      error:
        $ref: '#/definitions/Error'
      fatalError:
        type: boolean
        example: false
  PaymentView:
    type: object
    required:
    - amount
    - currency
    - limit
    properties:
      amount:
        type: number
      currency:
        type: string
      limit:
        type: number
  AccountView:
    type: object
    required:
    - balance
    - checkFundsAvailability
    - details
    - transactionHistory
    properties:
      balance:
        type: boolean
        example: false
      checkFundsAvailability:
        type: boolean
        example: false
      details:
        type: boolean
        example: false
      transactionHistory:
        type: boolean
        example: false
  CreateSubscriptionResponse:
    type: object
    required:
    - duration
    properties:
      accounts:
        $ref: '#/definitions/AccountView'
      description:
        type: string
      duration:
        $ref: '#/definitions/Duration'
      payments:
        $ref: '#/definitions/PaymentView'
      customerInformation:
        $ref: '#/definitions/CustomerInformation'
      selectedAccounts:
        type: array
        items:
          $ref: '#/definitions/SelectedAccount'
      status:
        type: string
      subscriptionId:
        type: string
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  Access Code - Oauth:
    type: oauth2
    description: ""
    flow: accessCode
    scopes:
      UserOAuth2Security: ""
    authorizationUrl: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/psd2/v2/oauth2/authorize
    x-tokenIntrospect:
      url: ""
    tokenUrl: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v2/oauth2/token
  Application - Oauth:
    type: oauth2
    description: ""
    flow: application
    scopes:
      TPPOAuth2Security: TPPOAuth2Security
    tokenUrl: https://$(api.endpoint.address)/$(api.org.name)/$(env.path)/v2/oauth2/token
    x-tokenIntrospect:
      url: ""
security:
- Access Code - Oauth:
  - UserOAuth2Security
  Application - Oauth:
  - TPPOAuth2Security
consumes:
- application/json
produces:
- application/json
x-ibm-endpoints:
- endpointUrl: https://apis.bankofcyprus.com/df-boc-org-prd/prod
  description: APIC Gateway Server
  type:
  - production
...