---
swagger: "2.0"
info:
  version: 1.0.0
  title: VTM Test
  x-ibm-name: vtm-tst
  description: ""
schemes:
- https
produces:
- application/json
consumes:
- application/json
paths:
  /sibs/v1/vtm-test:
    post:
      operationId: vtmtest
      tags:
      - Create Payment Owner Fee Request
      summary: Requests a Payment Owner Fee creation request at the SIBS.
      description: Requests a Payment Owner Fee creation request at the SIBS.
      parameters:
      - $ref: '#/parameters/payment-owner'
      - $ref: '#/parameters/X-Message-ID'
      - $ref: '#/parameters/Date'
      - $ref: '#/parameters/Digest'
      - $ref: '#/parameters/CreatePaymentOwnerFeeRequest'
      responses:
        200:
          description: Ok
          headers:
            Date:
              type: string
              format: date-time
              pattern: yyyyMMddhhMMss
              description: 'Format: yyyyMMddhhMMss'
            SIBS-AFFINITY-HOST:
              type: string
            SIBS-AFFINITY-SITE:
              type: string
          schema:
            $ref: '#/definitions/CreatePaymentOwnerFeeResponseResource'
        400:
          description: Bad Request.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        401:
          description: Unauthorized.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        403:
          description: Forbidden.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        404:
          description: Not Found.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        405:
          description: Method Not Allowed.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        406:
          description: Not Acceptable.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        408:
          description: Request Timeout.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        415:
          description: Unsupported Media Type.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        429:
          description: Too Many Requests.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        500:
          description: Internal Server Error.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        503:
          description: Service Unavailable.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
        504:
          description: Gateway Timeout.
          schema:
            $ref: '#/definitions/ErrorMessageWithStatus'
definitions:
  FeeResource:
    description: Fee Resource
    type: object
    properties:
      classification:
        description: 'Possible Values: \n 01 - Fee for Payment of Services \n 02 -
          Reference Generation Fee'
        type: string
        maxLength: 2
        pattern: ^[0-9]{2,2}$
        default: "01"
        enum:
        - "01"
        - "02"
      fixedAndOrPercentageValue:
        description: Should be present if Fixed Amount and/or Percentage Value.
        $ref: '#/definitions/FixedAndOrPercentageValueResource'
      tiered:
        description: Should be present if Fees by level (number of transactions /
          month) and on success responses. List of Tiered Fees.
        $ref: '#/definitions/TieredArray'
    required:
    - classification
    additionalProperties: false
  FeeUpdateResource:
    description: Fee Update Resource
    type: object
    properties:
      fixedAndOrPercentageValue:
        description: Should be present if  Fixed Amount and/or Percentage Value.
        $ref: '#/definitions/FixedAndOrPercentageValueResource'
      tiered:
        description: Should be present if Fees by level (number of transactions /
          month) and on success responses. List of Tiered Fees.
        $ref: '#/definitions/TieredArray'
    additionalProperties: false
  FeesArray:
    type: array
    items:
      type: object
      properties:
        code:
          description: Code of the Fee associated to a Payment Owner.
          type: string
          maxLength: 3
          pattern: ^[0-9]{0,3}$
          default: "111"
    maxItems: 99
    minItems: 1
    description: Array of Tiered object
  FeeDetailsResource:
    description: Payment Owner Fee Details Response.
    type: object
    properties:
      classification:
        description: 'Possible Values: \n 01 - Fee for Payment of Services \n 02 -
          Reference Generation Fee'
        type: string
        maxLength: 2
        pattern: ^[0-9]{2,2}$
        default: "01"
        enum:
        - "01"
        - "02"
      code:
        description: Code of the Fee associated to a Payment Owner.
        type: string
        maxLength: 3
        pattern: ^[0-9]{0,3}$
        default: "111"
      level:
        description: Fee level Tier
        type: string
        maxLength: 1
        pattern: ^[0-9]{0,1}$
        default: "1"
      levelInitiationDate:
        description: Date from which the tiered is vali
        type: string
        maxLength: 8
        pattern: ^[0-9]{0,8}$
        default: 03092022
      logSystem:
        description: Log system associated to the transaction
        type: string
        maxLength: 2
      centralLogPeriodIdentifier:
        description: Central log period identification
        type: string
        maxLength: 4
        pattern: ^[0-9]{1,4}$
        default: "1111"
      centralLogRecordNumber:
        description: Central log record number
        type: string
        maxLength: 8
        pattern: ^[0-9]{1,8}$
        default: "11111111"
      lastOperationDate:
        description: Last Update Date
        type: string
        maxLength: 8
        pattern: ^[0-9]{1,8}$
        default: "11111111"
      lastOperationTime:
        description: Last Update Time
        type: string
        maxLength: 6
        pattern: ^[0-9]{1,6}$
        default: "111111"
      lastUserId:
        description: Last User Update
        type: string
        maxLength: 8
        pattern: ^[0-9]{1,8}$
        default: "11111111"
      fixedAndOrPercentageValue:
        description: Should be present if  Fixed Amount and/or Percentage Value.
        $ref: '#/definitions/FixedAndOrPercentageValueResource'
      tiered:
        description: Should be present if Fees by level (number of transactions /
          month) and on success responses. List of Tiered Fees.
        $ref: '#/definitions/TieredArray'
    additionalProperties: false
    required:
    - classification
  FixedAndOrPercentageValueResource:
    description: Fixed And Or Percentage Value Resource
    type: object
    properties:
      percentage:
        description: Percentage value for fee.
        type: string
        maxLength: 6
        pattern: ^[0-9]{0,3}(\.[0-9]{0,2}){0,1}$
        default: "111.11"
      minimumAmount:
        description: Minimum amount to be apply.
        type: string
        maxLength: 6
        pattern: ^[0-9]{0,3}(\.[0-9]{0,2}){0,1}$
        default: "111.11"
      maximumAmount:
        description: Maximum amount to be apply.
        type: string
        maxLength: 6
        pattern: ^[0-9]{0,3}(\.[0-9]{0,2}){0,1}$
        default: "111.11"
      amount:
        description: Fee Fixed Amount. Basic value for fee in Euro.
        type: string
        pattern: ^[0-9]{0,3}(\.[0-9]{0,2}){0,1}$
        maxLength: 6
        default: "111.11"
    additionalProperties: false
  PaymentOwnerResource:
    description: Payment Owner Resource
    type: object
    properties:
      code:
        description: Code that allows the characterisation of a payment owner.
        type: string
        maxLength: 7
        pattern: ^[0-9]{1,7}$
        default: "1111111"
      fee:
        $ref: '#/definitions/FeeResource'
    required:
    - code
    additionalProperties: false
  PaymentOwnerResponseResource:
    description: Payment Owner Resource
    type: object
    properties:
      code:
        description: Code that allows the characterisation of a payment owner.
        type: string
        maxLength: 7
        pattern: ^[0-9]{1,7}$
        default: "1111111"
      shortName:
        description: Payment Owner Short Name
        type: string
        maxLength: 20
      fee:
        allOf:
        - type: object
          properties:
            code:
              description: Code of the Fee associated to a Payment Owner.
              type: string
              maxLength: 3
              pattern: ^\d{1,3}$
              default: "999"
        - $ref: '#/definitions/FeeResource'
    required:
    - code
    additionalProperties: false
  PaymentOwnerInquiryResource:
    description: Payment Owner Inquiry Resource
    type: object
    properties:
      code:
        description: Code that allows the characterisation of a payment owner.
        type: string
        maxLength: 7
        pattern: ^[0-9]{1,7}$
        default: "1111111"
      fees:
        $ref: '#/definitions/FeesArray'
    required:
    - code
    additionalProperties: false
  TieredResource:
    description: Tiered Data Data
    type: object
    properties:
      code:
        description: 'Tiered Fee Codes . Possible values: \n 1 -> from 1 to 500 \n
          2 –> from 501 to 2.000 \n 3 –> from 2.001 to 5.000 \n 4 –> from 5.001 to
          50.000 \n 5 –> from 50.001 to 100.000 \n 6 –> from 100.001 to 150.000 \n
          7 –> more then 150.000'
        type: string
        maxLength: 1
        pattern: ^[0-9]{1,1}$
        default: "1"
      value:
        description: Fee Value. The fee amount includes the applicable VAT.
        type: string
        maxLength: 6
        pattern: ^[0-9]{0,3}(\.[0-9]{0,2}){0,1}$
        default: "111.11"
    additionalProperties: false
  TieredArray:
    type: array
    items:
      $ref: '#/definitions/TieredResource'
      description: Tiered Data Data
      type: object
      properties:
        code:
          description: 'Tiered Fee Codes . Possible values: \n 1 -> from 1 to 500
            \n 2 –> from 501 to 2.000 \n 3 –> from 2.001 to 5.000 \n 4 –> from 5.001
            to 50.000 \n 5 –> from 50.001 to 100.000 \n 6 –> from 100.001 to 150.000
            \n 7 –> more then 150.000'
          type: string
          maxLength: 1
          pattern: ^[0-9]{1,1}$
          default: "1"
        value:
          description: Fee Value. The fee amount includes the applicable VAT.
          type: string
          maxLength: 6
          pattern: ^[0-9]{0,3}(\.[0-9]{0,2}){0,1}$
          default: "111.11"
      additionalProperties: false
    maxItems: 7
    minItems: 0
    description: Array of Tiered object
  ErrorMessageWithStatus:
    description: Error and status Information.
    type: object
    properties:
      transactionStatus:
        $ref: '#/definitions/TransactionStatusType'
        description: The transaction status is filled with codes of the ISO 20022
          corresponding element.
      tppMessages:
        $ref: '#/definitions/TppMessageArray'
        description: Messages to the TPP on operational issues.
    additionalProperties: false
  CreatePaymentOwnerFeeRequestResource:
    description: Create Payment Owner Fee Request.
    type: object
    properties:
      fee:
        $ref: '#/definitions/FeeResource'
    additionalProperties: false
    required:
    - fee
  CreatePaymentOwnerFeeResponseResource:
    description: Create Payment Owner Fee response to TPP.
    type: object
    properties:
      transactionStatus:
        $ref: '#/definitions/TransactionStatusType'
        description: 'Transaction Status Code. \n Possible values: \n - "ACTC" - "Accepted
          Technical Validation"; \n - "RJCT" - "Rejected"'
      logSystem:
        description: Log System associated to the transaction
        type: string
        maxLength: 2
      centralLogPeriodIdentifier:
        description: Central log period identification
        type: string
        maxLength: 4
        pattern: ^[0-9]{1,4}$
        default: "1111"
      centralLogRecordNumber:
        description: Central log record number
        type: string
        maxLength: 8
        pattern: ^[0-9]{1,8}$
        default: "11111111"
      paymentOwner:
        description: .
        $ref: '#/definitions/PaymentOwnerResponseResource'
      tppMessages:
        $ref: '#/definitions/TppMessageArray'
        description: Messages to the TPP on operational issues.
    additionalProperties: false
    required:
    - transactionStatus
  PaymentOwnerFeeDetailsResponseResource:
    description: Payment Owner Fee Inquiry Response.
    type: object
    properties:
      transactionStatus:
        $ref: '#/definitions/TransactionStatusType'
        description: 'Transaction Status Code. \n Possible values: \n - "ACTC" - "Accepted
          Technical Validation"; \n - "RJCT" - "Rejected"'
      logSystem:
        description: Log system associated to the transaction
        type: string
        maxLength: 2
      centralLogPeriodIdentifier:
        description: Central log period identification
        type: string
        maxLength: 4
        pattern: ^[0-9]{1,4}$
        default: "1111"
      centralLogRecordNumber:
        description: Central log record number
        type: string
        maxLength: 8
        pattern: ^[0-9]{1,8}$
        default: "11111111"
      paymentOwner:
        description: Only present on success responses.
        allOf:
        - type: object
          properties:
            shortName:
              description: Payment Owner Short Name
              type: string
              maxLength: 20
        - $ref: '#/definitions/PaymentOwnerInquiryResource'
      tppMessages:
        $ref: '#/definitions/TppMessageArray'
        description: Messages to the TPP on operational issues.
    additionalProperties: false
    required:
    - transactionStatus
  PaymentOwnerFeeInquiryResponseResource:
    description: Payment Owner Fee Details Response.
    type: object
    properties:
      transactionStatus:
        $ref: '#/definitions/TransactionStatusType'
        description: 'Transaction Status Code. \n Possible values: \n - "ACTC" - "Accepted
          Technical Validation"; \n - "RJCT" - "Rejected"'
      logSystem:
        description: Log system associated to the transaction
        type: string
        maxLength: 2
      centralLogPeriodIdentifier:
        description: Central log period identification
        type: string
        maxLength: 4
        pattern: ^[0-9]{1,4}$
        default: "1111"
      centralLogRecordNumber:
        description: Central log record number
        type: string
        maxLength: 8
        pattern: ^[0-9]{1,8}$
        default: "11111111"
      paymentOwner:
        description: Only present on success responses.
        type: object
        properties:
          code:
            description: Code that allows the characterisation of a payment owner.
            type: string
            maxLength: 7
            pattern: ^[0-9]{1,7}$
            default: "1111111"
          shortName:
            description: Payment Owner Short Name.
            type: string
            maxLength: 20
          fee:
            $ref: '#/definitions/FeeDetailsResource'
      tppMessages:
        $ref: '#/definitions/TppMessageArray'
        description: Messages to the TPP on operational issues.
    additionalProperties: false
    required:
    - transactionStatus
  UpdatePaymentOwnerFeeRequestResource:
    description: Create Payment Owner Fee Request.
    type: object
    properties:
      fee:
        $ref: '#/definitions/FeeUpdateResource'
    additionalProperties: false
    required:
    - fee
  UpdatePaymentOwnerFeeResponseResource:
    description: Update Payment Owner Fee response to TPP.
    type: object
    properties:
      transactionStatus:
        $ref: '#/definitions/TransactionStatusType'
        description: 'Transaction Status Code. \n Possible values: \n - "ACTC" - "Accepted
          Technical Validation"; \n - "RJCT" - "Rejected"'
      logSystem:
        description: Log System associated to the transaction
        type: string
        maxLength: 2
      centralLogPeriodIdentifier:
        description: Central log period identification
        type: string
        maxLength: 4
        pattern: ^[0-9]{1,4}$
        default: "1111"
      centralLogRecordNumber:
        description: Central log record number
        type: string
        maxLength: 8
        pattern: ^[0-9]{1,8}$
        default: "11111111"
      paymentOwner:
        description: .
        $ref: '#/definitions/PaymentOwnerResponseResource'
      tppMessages:
        $ref: '#/definitions/TppMessageArray'
        description: Messages to the TPP on operational issues.
    additionalProperties: false
    required:
    - transactionStatus
  DeletePaymentOwnerFeeResponseResource:
    description: Delete Payment Owner Fee response to TPP.
    type: object
    properties:
      transactionStatus:
        $ref: '#/definitions/TransactionStatusType'
        description: 'Transaction Status Code. \n Possible values: \n - "ACTC" - "Accepted
          Technical Validation"; \n - "RJCT" - "Rejected"'
      logSystem:
        description: Log System associated to the transaction
        type: string
        maxLength: 2
      centralLogPeriodIdentifier:
        description: Central log period identification
        type: string
        maxLength: 4
        pattern: ^[0-9]{1,4}$
        default: "1111"
      centralLogRecordNumber:
        description: Central log record number
        type: string
        maxLength: 8
        pattern: ^[0-9]{1,8}$
        default: "11111111"
      paymentOwner:
        description: Only present on success responses.
        properties:
          code:
            description: Code that allows the characterisation of a payment owner.
            type: string
            maxLength: 7
            pattern: ^[0-9]{1,8}$
            default: "1111111"
      fee:
        description: Only present on success responses.
        properties:
          code:
            description: Code of the Fee associated to a Payment Owner.
            type: string
            maxLength: 3
            pattern: ^[0-9]{1,3}$
            default: "111"
      tppMessages:
        $ref: '#/definitions/TppMessageArray'
        description: Messages to the TPP on operational issues.
    additionalProperties: false
    required:
    - transactionStatus
  TppMessage:
    required:
    - category
    - code
    description: Transports additional error information.
    properties:
      category:
        type: string
        default: ""
        description: Category of the error. Only "ERROR" or "WARNING" permitted.
      code:
        type: string
        default: ""
        description: Message error code.
      path:
        type: string
        default: ""
        description: Path of the element of the request message which provoked this
          error message.
      text:
        type: string
        maxLength: 512
        default: ""
        description: Additional explaining text.
    additionalProperties: false
  TppMessageArray:
    type: array
    description: Messages to the TPP on operational issues.
    items:
      $ref: '#/definitions/TppMessage'
      description: Transports additional error information.
    additionalProperties: false
  TransactionStatusType:
    description: |-
      ACTC : ACCEPTED TECHNICAL VALIDATION
      RJCT : REJECTED
    type: string
    enum:
    - ACTC
    - RJCT
    default: RJCT
    additionalProperties: false
parameters:
  payment-owner:
    name: payment-owner
    in: path
    description: Payment Owner code
    required: true
    type: string
    maxLength: 7
    pattern: ^[0-9]{0,7}$
    default: "1111111"
  fee:
    name: fee
    in: path
    description: Fee code
    required: true
    type: string
    maxLength: 3
    pattern: ^[0-9]{0,3}$
    default: "111"
  feeParameter:
    name: fee
    in: query
    description: Fee Code that must be indicated to request new occurrences.
    required: false
    type: string
    maxLength: 3
    pattern: ^[0-9]{0,3}$
    default: "111"
  operator:
    name: operator
    in: query
    description: 'Operator that indicates the list elements to be obtained. May be
      equal , lower or higher than the requested message fee. \n Possible operators:
      \n "equal"  ->  equal to or higher than the data requested in the request message
      \n "higher" ->  higher than the data requested in the request message \n "lower"
      ->    lower than the data requested in the request message'
    required: false
    type: string
    default: equal
    enum:
    - equal
    - higher
    - lower
  X-Message-ID:
    name: X-Message-ID
    in: header
    description: ID of the transaction as determined by the initiating party
    required: true
    type: string
    maxLength: 14
  Digest:
    name: Digest
    type: string
    required: true
    in: header
    description: Hash of the message body. Should be present when Request body exists
    default: ""
  Date:
    name: Date
    in: header
    description: Request date
    required: false
    type: string
    format: date-time
    pattern: yyyy-MM-dd'T'hh:MM:ss.SSS
  CreatePaymentOwnerFeeRequest:
    name: CreatePaymentOwnerFeeRequest
    in: body
    description: Create Payment Owner Fee Request
    required: true
    schema:
      $ref: '#/definitions/CreatePaymentOwnerFeeRequestResource'
  UpdatePaymentOwnerFeeRequest:
    name: UpdatePaymentOwnerFeeRequest
    in: body
    description: Update Payment Owner Fee Request
    required: true
    schema:
      $ref: '#/definitions/UpdatePaymentOwnerFeeRequestResource'
x-ibm-configuration:
  enforced: true
  testable: true
  phase: realized
securityDefinitions:
  x-ibm-client-id:
    type: apiKey
    description: ""
    in: header
    name: X-IBM-Client-Id
security:
- []
basePath: /
x-ibm-endpoints:
- endpointUrl: https://site1.sibsapimarket.com:8445/sibs-qly/apimarket-sb
  type:
  - production
  - development
- endpointUrl: https://site2.sibsapimarket.com:8445/sibs-qly/apimarket-sb
  type:
  - production
  - development
- endpointUrl: https://sandbox.qly.sibspayments.com
  type:
  - production
  - development
...