openapi: 3.1.0
info:
  version: '3.0'
  title: EBACL STEP2 B2B REST API - DPWS
  description: DPWS RESTful API for interacting with STEP2 B2B services
  contact:
    name: EBA CLEARING
    url: https://www.ebaclearing.eu
  x-info-creation-date: '2026-06-15'
  x-info-release: v20261116
  x-info-oasis-version: 3.0.20
  x-info-customization: SWIFT
servers:
  - url: https://api.swiftnet.sipn.swift.com/ebacl-step2-b2b/v1
    description: Live Environment
  - url: https://api-test.swiftnet.sipn.swift.com/ebacl-step2-b2b-pilot/v1
    description: Test Environment
  - url: https://api.common.swiftnet.sipn.swift.com/ebacl-step2-b2b/v1
    description: Extended availability Live environment
  - url: https://api-pilot.common.swiftnet.sipn.swift.com/ebacl-step2-b2b-pilot/v1
    description: Extended availability Test environment
tags:
  - name: Commands
    description: Commands
  - name: LCR
    description: LCR
  - name: Liquidity Position
    description: Liquidity Position
  - name: Message Inquiry
    description: Message Inquiry
  - name: Participant Management
    description: Participant Management
  - name: Transaction Inquiry
    description: Transaction Inquiry
security:
  - oauthBearerToken: []
paths:
  /listParticipants/{senderBIC}:
    post:
      tags:
        - Participant Management
      operationId: listParticipants
      summary: It allows the Participant to inquire the Direct Participants list.
      description: |-
        The listParticipants request allows participants to inquire the Direct Participants list.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListParticipantsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    BICCode: TESTIT88
                    name: Merrill Lynch
                    initParticipantValidity: '2025-06-12'
                    endParticipantValidity: '2025-04-23'
                    status: ENB
                    batchProcessingMode: false
                    NLOUserGroup: false
                    network: SWF
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListParticipantsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    participants:
                      - BICCode: TESTIT88
                        name: Merrill Lynch
                        initValidity: '2025-06-12'
                        endValidity: '2025-04-23'
                        ROnlyDate: '2025-02-03'
                        status: ENB
                        settlementBIC: IPSDID21XXX
                        newBIC: BICDPA23
                        newRole: true
                      - BICCode: TESTIT88
                        name: ExampleBank02
                        initValidity: '2025-04-23'
                        endValidity: '2025-02-03'
                        ROnlyDate: '2025-06-12'
                        status: DIS
                        settlementBIC: TESBIC99XXX
                        newBIC: BICDPA23
                        newRole: true
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /participantDetails/{senderBIC}:
    post:
      tags:
        - Participant Management
      operationId: participantDetails
      summary: It allows the Participant to retrieve the details of a Direct Participant.
      description: |-
        The participantDetails request allows participants to inquire the details of a Direct Participant.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ParticipantDetailsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  participantRef:
                    BICCode: TESTIT88
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParticipantDetailsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    participant:
                      BICCode: TESTIT88
                      name: Merrill Lynch
                      initParticipantValidity: '2025-06-12'
                      endParticipantValidity: '2025-04-23'
                      currentStatus: ENB
                      ROnlyDate: '2025-02-03'
                      settlementBIC: IPSDID21XXX
                      parModHistory:
                        - initParameterValidity: '2025-06-12'
                          endParameterValidity: '2025-04-23'
                          BICName: ExampleBank01
                          settlementBIC: TESBIC11XXX
                          debitProductsAllowed: COR
                          admissionProfile: CAD
                          maxReceivingFileSize: 1000
                          technicalBIC: false
                          ICMUserGroup: false
                        - initParameterValidity: '2025-06-12'
                          endParameterValidity: '2025-04-23'
                          BICName: Merrill Lynch
                          settlementBIC: IPSDID21XXX
                          debitProductsAllowed: COR2
                          admissionProfile: CAD
                          maxReceivingFileSize: 3000
                          CAIUserGroup: false
                          NLOUserGroup: false
                      detailsHistory:
                        - BICCode: BICDPA23
                          newDPBICCode: DPBICA88
                          name: Merrill Lynch
                          initParticipantValidity: '2025-04-23'
                          endParticipantValidity: '2025-02-03'
                          ROnlyDate: '2025-06-12'
                          status: RON
                          initParameterValidity: '2025-04-23'
                          endParameterValidity: '2025-02-03'
                          DPSettlementBIC: IPSDID21XXX
                          admissionProfile: CAD
                          settlementFile: 1
                          deliverDebitsImm: false
                          defaultThresholdValue: 10000.01
                          extendedPSR: false
                          routingInfoChanged: false
                          maxReceivingFileSize: 1000
                          ICMUserGroup: false
                          technicalBIC: false
                          activeOutputNetwork: PRI
                          priNetworkIdentification: cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
                          secNetworkIdentification: PRIMARY
                          priReceivingNetIdentification: SECONDARY
                          secReceivingNetIdentification: cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
                          priSendingNetIdentification: PRIMARY
                          secSendingNetIdentification: SECONDARY
                          debitProductsAllowed: COR2
                          T2RTGSAuthorisedAccountUserAAUForAS-D: TESBIC11XXX
                          T2RTGSAuthorisedAccountUserAAUForAS-E: TESBIC99XXX
                          T2RTGSDedicatedCashAccountDCAForAS-D: '11123422244678888888887677800000005'
                          T2RTGSDedicatedCashAccountDCAForAS-E: '11123433344671111188887677800000023'
                        - BICCode: BICDPA23
                          newDPBICCode: DPBICA88
                          name: ExampleBank02
                          newRole: false
                          initParticipantValidity: '2025-04-23'
                          endParticipantValidity: '2025-02-03'
                          ROnlyDate: '2025-06-12'
                          status: ENB
                          initParameterValidity: '2025-04-23'
                          endParameterValidity: '2025-02-03'
                          DPSettlementBIC: TESBIC11XXX
                          admissionProfile: CAD
                          settlementFile: 3
                          MSRRequired: false
                          defaultThresholdValue: 9999999.12
                          swiftNetOutputFileCompression: false
                          maxReceivingFileSize: 99999999
                          CAIUserGroup: false
                          batchProcessingMode: false
                          activeOutputNetwork: PRI
                          priNetworkIdentification: PRIMARY
                          secNetworkIdentification: SECONDARY
                          priReceivingNetIdentification: cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
                          secReceivingNetIdentification: PRIMARY
                          priSendingNetIdentification: SECONDARY
                          secSendingNetIdentification: cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
                          debitProductsAllowed: COR1
                          T2RTGSAuthorisedAccountUserAAUForAS-D: TESBIC99XXX
                          T2RTGSAuthorisedAccountUserAAUForAS-E: IPSDID21XXX
                          T2RTGSDedicatedCashAccountDCAForAS-D: '11123422244678888888887677800000005'
                          T2RTGSDedicatedCashAccountDCAForAS-E: '11123433344671111188887677800000023'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listReachableBICs/{senderBIC}:
    post:
      tags:
        - Participant Management
      operationId: listReachableBICs
      summary: It allows the Participant to inquire the Reachable BICs list.
      description: |-
        The listReachableBICs request allows participants to inquire the Reachable BICs list.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListReachableBICsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    BICCode: IPSDID21XXX
                    name: Merrill Lynch
                    initParticipantValidity: '2025-06-12'
                    endParticipantValidity: '2025-04-23'
                    status: ENB
                    DPBICCode: TESTIT88
                    ICMUserGroup: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReachableBICsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    indParticipants:
                      - BICCode: IPSDID21XXX
                        name: Merrill Lynch
                        initValidity: '2025-06-12'
                        endValidity: '2025-04-23'
                        ROnlyDate: '2025-02-03'
                        status: ENB
                        newBIC: TESBIC11XXX
                        newRole: true
                        DPBICCode: TESTIT88
                      - BICCode: IPSDID21XXX
                        name: ExampleBank02
                        initValidity: '2025-04-23'
                        endValidity: '2025-02-03'
                        ROnlyDate: '2025-06-12'
                        status: DIS
                        newBIC: TESBIC11XXX
                        newRole: true
                        DPBICCode: DPBICA88
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /RBDetails/{senderBIC}:
    post:
      tags:
        - Participant Management
      operationId: RBDetails
      summary: It allows the Participant to retrieve the details of a Reachable BIC.
      description: |-
        The RBDetails request allows participants to inquire the details of Reachable BICs.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RBDetailsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  indParticipantRef:
                    BICCode: IPSDID21XXX
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RBDetailsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    indParticipant:
                      BICCode: IPSDID21XXX
                      name: Merrill Lynch
                      initParticipantValidity: '2025-06-12'
                      endParticipantValidity: '2025-04-23'
                      DPBICCode: TESTIT88
                      ROnlyDate: '2025-02-03'
                      currentStatus: ENB
                      parModHistory:
                        - initParameterValidity: '2025-06-12'
                          endParameterValidity: '2025-04-23'
                          BICName: ExampleBank01
                          DPBICCode: BICDPA23
                          status: RON
                          debitProductsAllowed: COR
                          admissionProfile: CAD
                          NLOUserGroup: false
                        - initParameterValidity: '2025-06-12'
                          endParameterValidity: '2025-04-23'
                          BICName: Merrill Lynch
                          DPBICCode: TESTIT88
                          status: ENB
                          debitProductsAllowed: COR2
                          admissionProfile: CAD
                          NLOUserGroup: false
                      detailsHistory:
                        - BICCode: TESBIC11XXX
                          newBICCode: TESBIC99XXX
                          name: Merrill Lynch
                          initParticipantValidity: '2025-04-23'
                          endParticipantValidity: '2025-02-03'
                          ROnlyDate: '2025-06-12'
                          status: ENB
                          initParameterValidity: '2025-04-23'
                          endParameterValidity: '2025-02-03'
                          DPBICCode: TESTIT88
                          admissionProfile: CAD
                          routingInfoChanged: false
                          ICMUserGroup: false
                          debitProductsAllowed: COR2
                        - BICCode: TESBIC11XXX
                          newBICCode: TESBIC99XXX
                          name: ExampleBank02
                          initParticipantValidity: '2025-04-23'
                          endParticipantValidity: '2025-02-03'
                          ROnlyDate: '2025-06-12'
                          status: DIS
                          initParameterValidity: '2025-04-23'
                          endParameterValidity: '2025-02-03'
                          DPBICCode: DPBICA88
                          admissionProfile: CAD
                          routingInfoChanged: false
                          ICMUserGroup: false
                          debitProductsAllowed: COR1
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listBPORelationships/{senderBIC}:
    post:
      tags:
        - Participant Management
      operationId: listBPORelationships
      summary: It allows the Participant to enquire the list of its BPO relationships.
      description: |-
        The listBPORelationships request allows a participant to inquire the list of its BPO relationships.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBPORelationshipsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    counterpartBICCode: TESTIT88
                    counterpartName: Merrill Lynch
                    activationDateFrom: '2025-06-12'
                    activationDateTo: '2025-04-23'
                    removalDateFrom: '2025-02-03'
                    removalDateTo: '2025-06-12'
                    requestorUser: APIUSER1
                    authorizerUser: APIUSER2
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBPORelationshipsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    endOfList: true
                    relationships:
                      - counterpartBICCode: TESTIT88
                        counterpartName: Merrill Lynch
                        activationDate: '2025-06-12'
                        removalDate: '2025-04-23'
                        requestorUser: APIUSER1
                        authorizerUser: APIUSER2
                      - counterpartBICCode: DPBICA88
                        counterpartName: ExampleBank02
                        activationDate: '2025-06-12'
                        removalDate: '2025-04-23'
                        requestorUser: APIUSER1
                        authorizerUser: APIUSER2
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /insertBPORelationship/{senderBIC}:
    put:
      tags:
        - Participant Management
      operationId: insertBPORelationship
      summary: It allows the Participant to insert a new BPO relationship.
      description: The insertBPORelationship request allows participants to insert a new BPO Relationship.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsertBPORelationshipRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  relationship:
                    counterpartBIC: TESTIT88
                    activationDate: '2025-06-12'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsertBPORelationshipResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /removeBPORelationship/{senderBIC}:
    put:
      tags:
        - Participant Management
      operationId: removeBPORelationship
      summary: 'It allows the Participant to remove a BPO relationship. '
      description: The removeBPORelationship request allows participants to remove a BPO Relationship.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveBPORelationshipRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  relationship:
                    counterpartBIC: TESTIT88
                    removalDate: '2025-06-12'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveBPORelationshipResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /changeStatusReachableBIC/{senderBIC}:
    put:
      tags:
        - Participant Management
      operationId: changeStatusReachableBIC
      summary: It allows the Participant to set its Reachable BICs in R-Only or Remove status or to revoke a previously set R-Only status.
      description: |-
        The changeStatusReachableBIC request allows the participant to change the status of its RBs to RON or DIS or to amend/revoke a previously inserted R-Only operation.
        This function is managed under BCWS dual control and it generates an "R-Only RB" or “Remove RB” operation logged as “TO BE AUTHORIZED”.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeStatusReachableBICRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  changeStatusRB:
                    RBBICCode: IPSDID21XXX
                    newStatus: ENB
                    rOnlyDate: '2025-06-12'
                    effectiveDate: '2025-04-23'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChangeStatusReachableBICResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    operationRef: REF0123456789111
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /insertReachableBIC/{senderBIC}:
    put:
      tags:
        - Participant Management
      operationId: insertReachableBIC
      summary: It allows the Participant to insert a new Reachable BIC.
      description: |-
        The insertReachableBIC request allows the participant to insert a new RB in B2B Routing Table.
        This function is managed under BCWS dual control and it generates an “Insert RB” operation logged as “TO BE AUTHORIZED”.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InsertReachableBICRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  RBBICCode: IPSDID21XXX
                  initParticipantValidity: '2025-06-12'
                  endParticipantValidity: '2025-04-23'
                  parameters:
                    name: Merrill Lynch
                    admissionProfile: CAD
                    CAIUserGroup: true
                    sameBankingGroupAsDP: false
                    productsAllowed: COR
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsertReachableBICResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    operationRef: REF0123456789111
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /updateDirectParticipant/{senderBIC}:
    put:
      tags:
        - Participant Management
      operationId: updateDirectParticipant
      summary: It allows the Participant to update its DP BIC.
      description: |-
        The updateDirectParticipant request allows the participant to update its own DP in B2B Routing Table.
        This function is managed under BCWS dual control and it generates an “Update DP” operation logged as “TO BE AUTHORIZED”.
        If no change is made to any parameters (besides the effective date), the request for update will be rejeceted (ErrorCode XA31)
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDirectParticipantRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  effectiveDate: '2025-06-12'
                  parameters:
                    name: Merrill Lynch
                    admissionProfile: CAD
                    defaultThresholdValue: 10000.01
                    settlementFiles: 1
                    extendedPSR: false
                    maxReceivingFileSize: 1000
                    CAIUserGroup: false
                    technicalBIC: false
                    priNetworkIdentification: SWF
                    secNetworkIdentification: EAS
                    priReceivingNetIdentification: cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
                    secReceivingNetIdentification: PRIMARY
                    priSendingNetIdentification: SECONDARY
                    secSendingNetIdentification: cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
                    T2RTGSAuthorisedAccountUserAAUForAS-D: IPSDID21XXX
                    T2RTGSAuthorisedAccountUserAAUForAS-E: TESBIC11XXX
                    T2RTGSDedicatedCashAccountDCAForAS-D: '11123422244678888888887677800000005'
                    T2RTGSDedicatedCashAccountDCAForAS-E: '11123433344671111188887677800000023'
                    productList: COR
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDirectParticipantResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    operationRef: REF0123456789111
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /updateReachableBIC/{senderBIC}:
    put:
      tags:
        - Participant Management
      operationId: updateReachableBIC
      summary: It allows the Participant to update its Reachable BICs.
      description: |-
        The updateReachableBIC request allows the participant to update its RBs in B2B Routing Table.
        This function is managed under BCWS dual control and it generates an "Update RB” operation logged as “TO BE AUTHORIZED”.
        If no change is made to any parameters (besides the effective date), the request for update will be rejeceted (ErrorCode XA31)
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReachableBICRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  RBBICCode: IPSDID21XXX
                  effectiveDate: '2025-06-12'
                  parameters:
                    name: Merrill Lynch
                    admissionProfile: CAD
                    sameBankingGroupAsDP: false
                    productList: COR
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateReachableBICResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    operationRef: REF0123456789111
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /rejectParticipantOperation/{senderBIC}:
    put:
      tags:
        - Participant Management
      operationId: rejectParticipantOperation
      summary: It allows the Participant to reject an operation previously issued via API.
      description: The rejectParticipantOperation request allows the participant to reject a specific change operation submitted and not yet authorized.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RejectParticipantOperationRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  operationRef: REF0123456789111
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RejectParticipantOperationResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    operationRef: REF0123456789111
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listOperations/{senderBIC}:
    post:
      tags:
        - Participant Management
      operationId: listOperations
      summary: It allows the Participant to enquire the list of its routing operations.
      description: The listOperations request allows the participant to retrieve participant's routing table operations, based on a customized search criteria.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListOperationsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    DPRBOperation: DIR
                    DPBICCode: TESTIT88
                    RBBICCode: IPSDID21XXX
                    operationType: INS
                    effectiveDate: '2025-06-12'
                    operationStatus: RJS
                    requestDate: '2025-04-23'
                    confirmDate: '2025-02-03'
                    authRejectDate: '2025-06-12'
                    userIssuer: APIUSER1
                    confirmer: APIUSER2
                    userAuthReject: APIUSER3
                    operationRef: REF0123456789111
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOperationsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    operations:
                      - DPRBOperation: DIR
                        DPBICCode: TESTIT88
                        RBBICCode: IPSDID21XXX
                        operationType: INS
                        operationStatus: RJS
                        effectiveDate: '2025-06-12'
                        requestDateTime: '2024-11-08T14:29:00.012345'
                        confirmDateTime: '9999-12-31T12:55:45.000001'
                        authRejectDateTime: '2019-06-21T23:20:50.000001'
                        userIssuer: APIUSER1
                        confirmer: APIUSER2
                        userAuthReject: APIUSER3
                        operationRef: REF0123456789111
                        critical: true
                      - DPRBOperation: DIR
                        DPBICCode: DPBICA88
                        RBBICCode: TESBIC99XXX
                        operationType: UPD
                        operationStatus: AUT
                        effectiveDate: '2025-02-03'
                        requestDateTime: '9999-12-31T12:55:45.000001'
                        confirmDateTime: '2019-06-21T23:20:50.000001'
                        authRejectDateTime: '2024-11-08T14:29:00.012345'
                        userIssuer: APIUSER2
                        confirmer: APIUSER3
                        userAuthReject: APIUSER1
                        operationRef: REF0123456789123
                        critical: true
                    endOfList: true
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /operationDetails/{senderBIC}:
    post:
      tags:
        - Participant Management
      operationId: operationsDetails
      summary: It allows the Participant to retrieve the details of one of its operations.
      description: The operationDetails request allows the participant to inquire details of specific routing table operations.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OperationDetailsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  operationRef: REF0123456789111
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationDetailsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    operationDetails:
                      DPRBOperation: DIR
                      operationType: INS
                      operationStatus: RJS
                      effectiveDate: '2025-06-12'
                      requestDateTime: '2024-11-08T14:29:00.012345'
                      confirmDateTime: '9999-12-31T12:55:45.000001'
                      authRejectDateTime: '2019-06-21T23:20:50.000001'
                      userIssuer: APIUSER1
                      confirmer: APIUSER2
                      userAuthReject: APIUSER3
                      operationRef: REF0123456789111
                      critical: true
                      directParticipant:
                        name: Merrill Lynch
                        admissionProfile: CAD
                        defaultThresholdValue: 10000.01
                        settlementFiles: 1
                        MSRRequired: false
                        maxReceivingFileSize: 1000
                        batchProcessingMode: false
                        swiftNetOutputFileCompression: false
                        priNetworkIdentification: SWF
                        secNetworkIdentification: EAS
                        priReceivingNetIdentification: cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
                        secReceivingNetIdentification: PRIMARY
                        priSendingNetIdentification: SECONDARY
                        SecSendingNetIdentification: cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
                        T2RTGSAuthorisedAccountUserAAUForAS-D: IPSDID21XXX
                        T2RTGSAuthorisedAccountUserAAUForAS-E: TESBIC11XXX
                        T2RTGSDedicatedCashAccountDCAForAS-D: '11123422244678888888887677800000005'
                        T2RTGSDedicatedCashAccountDCAForAS-E: '11123433344671111188887677800000023'
                        productsAllowed: COR
                      reachableBIC:
                        RBBICCode: TESBIC99XXX
                        oldDPBICCode: TESTIT88
                        newDPBICCode: BICDPA23
                        name: ExampleBank01
                        admissionProfile: DEB
                        CAIUserGroup: false
                        productsAllowed: COR1
                        endValidityDate: '2025-04-23'
                      insertBRT:
                        counterpartBIC: DPBICA88
                      removeBRT:
                        counterpartBIC: TESTIT88
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listDefaultThresholds/{senderBIC}:
    post:
      tags:
        - Liquidity Position
      operationId: listDefaultThresholds
      summary: It allows the Participant to enquire the Default Thresholds list.
      description: |-
        The listDefaultThresholds request allows a participant to inquire its Default Thresholds list.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDefaultThresholdsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    counterpartyBIC: TESTIT88
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDefaultThresholdsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    endOfList: true
                    defaultThresholds:
                      - counterpartyBIC: TESTIT88
                        thresholdAmount: 10000.01
                        lastUserUpdate: '2024-11-08T14:29:00.012345'
                      - counterpartyBIC: DPBICA88
                        thresholdAmount: 9999999.12
                        lastUserUpdate: '2019-06-21T23:20:50.000001'
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /updateDefaultThreshold/{senderBIC}:
    put:
      tags:
        - Liquidity Position
      operationId: updateDefaultThreshold
      summary: It allows the Participant to update a specific Default Threshold.
      description: |-
        The updateDefaultThreshold request allows a participant to update a specific Default Threshold.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDefaultThresholdRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  defaultThreshold:
                    counterpartyBIC: TESTIT88
                    thresholdAmount: 10000.01
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDefaultThresholdResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /debitPositionCGS/{senderBIC}:
    post:
      tags:
        - Liquidity Position
      operationId: debitPositionCGS
      summary: 'It allows the Participant to inquire its debit position against a specific Counterparty BIC configured for settling in CGS. '
      description: |-
        The debitPositionCGS request allows a participant to retrieve its debit position to be settled in CGS against the System or a specific Counterparty BIC configured to settle in CGS.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
        NOTE: LCRs in CANCELLED, REVOKED and REJECTED status are not counted for neither sender nor for receiver counterpart.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DebitPositionCGSRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    interbankSettlementDate: '2025-06-12'
                    lac: '01'
                    counterpartyBIC: TESTIT88
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DebitPositionCGSResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    header:
                      interbankSettlementDate: '2025-06-12'
                      lac: '01'
                      DPBICCode: TESTIT88
                      totalPosition: 10000.01
                    debtorPosition:
                      - counterpartyBIC: BICDPA23
                        tresholdAmount: 1234567.99
                        sumAmountDebitReceived: 9999999.12
                        sumAmountReturnRefundReceived: 10000.01
                        sumAmountReversalSent: 1234567.99
                        totalDebitPosition: 9999999.12
                        sumAmountDebitSent: 10000.01
                        sumAmountReturnRefundSent: 1234567.99
                        sumAmountReversalReceived: 9999999.12
                        totalCreditPosition: 10000.01
                        totalPosition: 1234567.99
                      - counterpartyBIC: TESTIT88
                        tresholdAmount: 10000.01
                        sumAmountDebitReceived: 1234567.99
                        sumAmountReturnRefundReceived: 9999999.12
                        sumAmountReversalSent: 10000.01
                        totalDebitPosition: 1234567.99
                        sumAmountDebitSent: 9999999.12
                        sumAmountReturnRefundSent: 10000.01
                        sumAmountReversalReceived: 1234567.99
                        totalCreditPosition: 9999999.12
                        totalPosition: 10000.01
                    endOfList: true
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listLiquidityPosition/{senderBIC}:
    post:
      tags:
        - Liquidity Position
      operationId: listLiquidityPosition
      summary: It allows the Participant to inquire its Real-Time liquidity position against its Reachable BICs.
      description: |-
        The listLiquidityPosition request allows a Participant as Sending Direct Participant to retrieve its Real-Time liquidity positions against its Reachable BICs.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
        For API requests performed on future dates or on current date but before the settlement completion has occurred, following fields are set equal to “0” (which corresponds to “NA” displayed in the equivalent function on DPWS):
        • directDebitReceived
        • returnRefundReceived
        • reversalSent
        • RBOwesDP
        • netPosition
        NOTE: LCRs in CANCELLED, REVOKED and REJECTED status are not counted for neither sender nor for receiver counterpart.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListLiquidityPositionRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    settlementDate: '2025-06-12'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLiquidityPositionResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    liquidityPosition:
                      - RBBICCode: IPSDID21XXX
                        directDebitSent: 10000.01
                        returnRefundSent: 1234567.99
                        reversalReceived: 9999999.12
                        DPOwesRB: 10000.01
                        directDebitReceived: 1234567.99
                        returnRefundReceived: 9999999.12
                        reversalSent: 10000.01
                        RBOwesDP: 1234567.99
                        netPosition: 9999999.12
                      - RBBICCode: TESBIC99XXX
                        directDebitSent: 1234567.99
                        returnRefundSent: 9999999.12
                        reversalReceived: 10000.01
                        DPOwesRB: 1234567.99
                        directDebitReceived: 9999999.12
                        returnRefundReceived: 10000.01
                        reversalSent: 1234567.99
                        RBOwesDP: 9999999.12
                        netPosition: 10000.01
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listTransactions/{senderBIC}:
    post:
      tags:
        - Transaction Inquiry
      operationId: listTransactions
      summary: It allows to inquire the Transactions sent or received by the Participant.
      description: |-
        The listTransactions request allows a participant to inquire its transactions (either sent or received).
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTransactionsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    fileType: IDF
                    PACSMessageType: Pacs.003
                    lac: '01'
                    instructingAgent: TESTIT88
                    instructedAgent: BICDPA23
                    transactionStatus: STG
                    bulkReference: TESTBULKREF135000000000000000000123
                    transactionRefId: TESTTRANSEF135000000000000000000123
                    creditorAgent: TESBIC22XXX
                    debtorAgent: TESBIC33XXX
                    processingBusinessDate: '2025-06-12'
                    IDFReference: TESTFILEREF01234
                    DVFReference: COREFILEREF01234
                    LCRReference: LCRREF1111111111
                    debitProduct: CAI
                    interbankSettlementDate: '2025-04-23'
                    sequenceType: RCUR
                    creditorId: CREDITORSEF135000000000000000000123
                    mandateId: TESTTRANSEF135000000000000000000123
                    transactionType: RET
                    originalTransactionId: TRX2026000001
                    settlementDate: '2025-02-03'
                    originalSettlementDate: '2025-06-12'
                    originalAmount: 10000.01
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransactionsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    endOfList: true
                    transactions:
                      - transactionType: RET
                        processingBsnDate: '2025-06-12'
                        lac: '01'
                        transactionId: TESTTRANSEF135000000000000000000123
                        instructingBIC: TESTIT88
                        instructedBIC: BICDPA23
                        bulkReference: TESTBULKREF135000000000000000000123
                        transactionStatus: STG
                        interbankSettlementAmount: 10000.01
                        interbankSettlementDate: '2025-04-23'
                        fileType: IDF
                        creditorOutBulkReference: TESTBULKREF135000000000000000999999
                        debitorOutBulkReference: TESTBULKREF135123400000000000000567
                        creditorBankBIC: TESBIC22XXX
                        debtorBankBIC: TESBIC33XXX
                      - transactionType: RFS
                        processingBsnDate: '2025-06-12'
                        lac: '10'
                        transactionId: TRX2026000002
                        instructingBIC: TESTIT88
                        instructedBIC: BICDPA23
                        bulkReference: TESTBULKREF135000000000000000999999
                        transactionStatus: NTF
                        interbankSettlementAmount: 9999999.12
                        interbankSettlementDate: '2025-04-23'
                        fileType: DNF
                        creditorOutBulkReference: TESTBULKREF135123400000000000000567
                        debitorOutBulkReference: TESTBULKREF135000000000000000000123
                        creditorBankBIC: TESBIC22XXX
                        debtorBankBIC: TESBIC33XXX
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /transactionDetails/{senderBIC}:
    post:
      tags:
        - Transaction Inquiry
      operationId: transactions
      summary: It allows to get the details of a specific transaction sent or received by the Participant.
      description: |-
        The transactionDetails request allows a participant to get the details of a specific transaction (sent or received).
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransactionDetailsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  transactionRef:
                    transactionType: RET
                    interbankSettlementDate: '2025-06-12'
                    transactionId: TESTTRANSEF135000000000000000000123
                    fileType: IDF
                    creditorBankBIC: TESBIC22XXX
                    debtorBankBIC: TESBIC33XXX
                    lac: '01'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionDetailsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    DMessage:
                      fileType: IDF
                      timestampLastUpdate: '2024-11-08T14:29:00.012345'
                      DPSendingBIC: TESTIT88
                      DPReceivingBIC: BICDPA23
                      creditorBankBIC: TESBIC22XXX
                      debtorBankBIC: TESBIC33XXX
                      mandateId: TESTTRANSEF135000000000000000000123
                      creditorId: CREDITORSEF135000000000000000000123
                      interbankSettlementAmount: 10000.01
                      transactionReferenceId: TESTTRANSEF135000000000000000000123
                      interbankSettlementDate: '2025-06-12'
                      repCollectionDate: '2025-04-23'
                      processingBusinessDate: '2025-02-03'
                      notificationDate: '2025-06-12'
                      transactionStatus: STG
                      sequenceType: RCUR
                      lac: '01'
                      debitProduct: CAI
                      fileReference: TESTFILEREF01234
                      routingType: DIR
                      DNFBulkReference: TESTBULKREF135000000000000000000123
                      originalFileReference: COREFILEREF01234
                      bulkReference: TESTBULKREF135000000000000000999999
                      settlementInstReference: B2BTFILEREF01234
                      bulkType: Pacs.003
                      debitMandateFlowIndicator: Y
                      DVFReference: TESTFILEREF01234
                      debtorRSFReference: TESTBULKREF135123400000000000000567
                      DVFBulkReference: TESTBULKREF135000000000000000000123
                      creditorRSFReference: TESTBULKREF135000000000000000999999
                      LCRReference: LCRREF1111111111
                      endToEndId: END2ENDNSEF135000000000000000000123
                    RMessage:
                      fileType: DVF
                      timestampLastUpdate: '9999-12-31T12:55:45.000001'
                      DPSendingBIC: DPBICA88
                      DPReceivingBIC: TESTIT88
                      creditorBankBIC: TESBIC99XXX
                      debtorBankBIC: TESBIC22XXX
                      interbankSettlementAmount: 1234567.99
                      transactionReferenceId: TRX2026000001
                      settlementDate: '2025-04-23'
                      transactionType: RET
                      processingBusinessDate: '2025-02-03'
                      transactionStatus: VAL
                      lac: '02'
                      debitProduct: COR1
                      fileReference: COREFILEREF01234
                      routingType: IND
                      settlementInstReference: B2BTFILEREF01234
                      originalCreditorBank: BICDPA23
                      bulkType: Pacs.004
                      originalBusinessDate: '2025-06-12'
                      bulkReference: TESTBULKREF135123400000000000000567
                      originalTransactionReference: TRX2026000002
                      DVFReference: TESTFILEREF01234
                      originalBulkReference: TESTBULKREF135000000000000000000123
                      reasonCode: DUPL
                      originalFileReference: COREFILEREF01234
                      LCRReference: LCRREF1111111222
                      originalEndToEndId: END2ENDCORF135000000000000000000111
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listBulks/{senderBIC}:
    post:
      tags:
        - Transaction Inquiry
      operationId: listBulks
      summary: It allows to inquire the bulks contained in a file sent or received by the Participant.
      description: |-
        The listBulks request allows participants to inquire the bulks contained in a file for which they are sender or receiver.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListBulksRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    fileType: IDF
                    messageType: Pacs.003
                    fileReference: TESTFILEREF01234
                    bulkStatus: ACCP
                    bulkReference: TESTBULKREF135000000000000000000123
                    date: '2025-06-12'
                    dateType: Business Date
                    lac: '01'
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListBulksResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    endOfList: true
                    bulks:
                      - messageType: Pacs.003
                        senderReceiverBIC: TESTIT88
                        fileReference: TESTFILEREF01234
                        bulkReference: TESTBULKREF135000000000000000000123
                        date: '2025-06-12'
                        lac: '01'
                        bulkStatus: ACCP
                        reasonCode: A01
                        dateTime: '2024-11-08T14:29:00.012345'
                        fileType: IDF
                        offset: AAaa88ss2345fggGGDDaaaHH
                      - messageType: Camt.056
                        senderReceiverBIC: DPBICA88
                        fileReference: B2BTFILEREF01234
                        bulkReference: TESTBULKREF135123400000000000000567
                        date: '2025-02-03'
                        lac: '10'
                        bulkStatus: RJCT
                        reasonCode: R10
                        dateTime: '2019-06-21T23:20:50.000001'
                        fileType: RSF
                        offset: AAaa11ss2345fgg1122aaaLM
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /bulkDetails/{senderBIC}:
    post:
      tags:
        - Transaction Inquiry
      operationId: bulks
      summary: It allows to get the details of a specific bulk contained in a file sent or received by the Participant.
      description: |-
        The bulkDetails request allows participants to get the details of a specific bulk contained in a file for which they are sender or receiver.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDetailsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  bulkRef:
                    fileType: IDF
                    messageType: Pacs.003
                    fileReference: TESTFILEREF01234
                    bulkReference: TESTBULKREF135000000000000000000123
                    dateType: Budiness Date
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkDetailsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    bulk:
                      messageType: Pacs.003
                      bulkReference: TESTBULKREF135000000000000000000123
                      fileReference: TESTFILEREF01234
                      bulkStatus: ACCP
                      settlementDate: '2025-06-12'
                      bulkReasonCode: A01
                      fileType: IDF
                      originalBulk: TESTBULKREF135000000000000000999999
                      totNumTransactionsContained: 1000
                      totAmountTransactionsContained: 10000.01
                      totTransactionValid: 10000
                      totAmountTransactionValid: 1234567.99
                      totTransactionRejected: 99999999
                      totAmountTransactionRejected: 9999999.12
                      bulkCurrency: EUR
                      BICInstructing: TESTIT88
                      businessDate: '2025-04-23'
                      BICInstructed: BICDPA23
                      calendarDate: '2025-02-03'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listFiles/{senderBIC}:
    post:
      tags:
        - Transaction Inquiry
      operationId: listFiles
      summary: It allows to inquire the list of files sent or received by the Participant.
      description: |-
        The listFiles request allows participants to inquire the files for which they are sender or receiver.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListFilesRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    fileType: IDF
                    dateTimeFrom: '2024-11-08T14:29:00.012345'
                    dateTimeTo: '9999-12-31T12:55:45.000001'
                    dateType: Business Date
                    fileReference: TESTFILEREF01234
                    lac: '01'
                    originalFileRef: COREFILEREF01234
                    fileStatus: TSD
                    reasonCode: A01
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListFilesResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    endOfList: true
                    files:
                      - fileType: IDF
                        fileReference: TESTFILEREF01234
                        lac: '01'
                        dateTime: '2024-11-08T14:29:00.012345'
                        date: '2025-06-12'
                        fileStatus: TSD
                        reasonCode: A01
                        originalFileRef: COREFILEREF01234
                        networkFileName: S202SDDTESTITMM_F800AAA.I
                        network: SWF
                        numBulks: 1000
                        numTransactions: 10000
                        numMessages: 99999999
                      - fileType: RSF
                        fileReference: TESTFILEREF01234
                        lac: '10'
                        dateTime: '2019-06-21T23:20:50.000001'
                        date: '2025-02-03'
                        fileStatus: VAL
                        reasonCode: R10
                        originalFileRef: COREFILEREF01234
                        networkFileName: S202B2BTESTITMM_F999AAA.I
                        network: EBX
                        numBulks: 10000
                        numTransactions: 99999999
                        numMessages: 1000
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /fileDetails/{senderBIC}:
    post:
      tags:
        - Transaction Inquiry
      operationId: files
      summary: It allows to get the details of a specific file sent or received by the Participant.
      description: |-
        The fileDetails request allows participants to get the details of a specific file for which they are sender of receiver.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileDetailsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  fileRef:
                    fileType: IDF
                    fileStatus: TSD
                    fileReference: TESTFILEREF01234
                    dateTime: '2024-11-08T14:29:00.012345'
                    networkFileName: S202SDDTESTITMM_F800AAA.I
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileDetailsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    fileDNF:
                      fileType: IDF
                      receiverBIC: TESTIT88
                      businessDate: '2025-06-12'
                      calendarDate: '2025-04-23'
                      fileReference: TESTFILEREF01234
                      dateTime: '2024-11-08T14:29:00.012345'
                      networkFileName: S202SDDTESTITMM_F800AAA.I
                      network: SWF
                      fileStatus: TSD
                      lastStatusUpdated: '9999-12-31T12:55:45.000001'
                      totNumBulks: 1000
                      numDebitsContained: 10000
                      valDebitsContained: 10000.01
                      numReturnsContained: 99999999
                      valReturnsContained: 1234567.99
                      numPCRContained: 1000
                      valPCRContained: 9999999.12
                      numReversalContained: 10000
                      valReversalContained: 10000.01
                      numRejectsContained: 99999999
                      valRejectsContained: 1234567.99
                    fileDRR:
                      fileType: DVF
                      receiverBIC: BICDPA23
                      businessDate: '2025-02-03'
                      calendarDate: '2025-06-12'
                      fileReference: COREFILEREF01234
                      dateTime: '2019-06-21T23:20:50.000001'
                      networkFileName: S202CORTESTITMM_F111ABC.I
                      network: EAS
                      fileStatus: ERR
                      lastStatusUpdated: '2024-11-08T14:29:00.012345'
                    fileDVF:
                      fileType: RSF
                      receiverBIC: DPBICA88
                      businessDate: '2025-04-23'
                      calendarDate: '2025-02-03'
                      fileReference: B2BTFILEREF01234
                      dateTime: '9999-12-31T12:55:45.000001'
                      networkFileName: S202B2BTESTITMM_F999AAA.I
                      network: EBX
                      fileStatus: VAL
                      reasonCode: A01
                      lastStatusUpdated: '2019-06-21T23:20:50.000001'
                      IDFFileRefeference: TESTFILEREF01234
                      IDFNetworkFileName: S202SDDTESTITMM_F800AAA.I
                      numBulksAccepted: 1000
                      numBulksRejected: 10000
                      numDebitsAccepted: 99999999
                      valDebitsAccepted: 9999999.12
                      numDebitsRejected: 1000
                      valDebitsRejected: 10000.01
                      numReturnsAccepted: 10000
                      valReturnsAccepted: 1234567.99
                      numReturnsRejected: 99999999
                      valReturnsRejected: 9999999.12
                      numPCRAccepted: 1000
                      valPCRAccepted: 10000.01
                      numPCRRejected: 10000
                      valPCRRejected: 1234567.99
                      numReversalAccepted: 99999999
                      valReversalAccepted: 9999999.12
                      numReversalRejected: 1000
                      valReversalRejected: 10000.01
                      numRejectsAccepted: 10000
                      valRejectsAccepted: 1234567.99
                      numRejectsRejected: 99999999
                      valRejectsRejected: 9999999.12
                    fileIDF:
                      fileType: IDF
                      senderBIC: TESTIT88
                      businessDate: '2025-06-12'
                      calendarDate: '2025-04-23'
                      fileReference: COREFILEREF01234
                      dateTime: '2024-11-08T14:29:00.012345'
                      networkFileName: S202CORTESTITMM_F111ABC.I
                      network: SWF
                      fileStatus: TSD
                      reasonCode: R01
                      processingTime: '9999-12-31T12:55:45.000001'
                      DVFFileReference: B2BTFILEREF01234
                      DVFNetworkFileName: S202B2BTESTITMM_F999AAA.I
                      numBulksContained: 1000
                      numBulksRejected: 10000
                      numDebitsContained: 99999999
                      valDebitsContained: 10000.01
                      numDebitsRejected: 1000
                      valDebitsRejected: 1234567.99
                      numReturnsContained: 10000
                      valReturnsContained: 9999999.12
                      numReturnsRejected: 99999999
                      valReturnsRejected: 10000.01
                      numPCRContained: 1000
                      valPCRContained: 1234567.99
                      numPCRRejected: 10000
                      valPCRRejected: 9999999.12
                      numReversalContained: 99999999
                      valReversalContained: 10000.01
                      numReversalRejected: 1000
                      valReversalRejected: 1234567.99
                      numRejectsContained: 10000
                      valRejectsContained: 9999999.12
                      numRejectsRejected: 99999999
                      valRejectsRejected: 10000.01
                    fileMSR:
                      fileType: DVF
                      receiverBIC: BICDPA23
                      businessDate: '2025-02-03'
                      calendarDate: '2025-06-12'
                      fileReference: TESTFILEREF01234
                      dateTime: '2019-06-21T23:20:50.000001'
                      networkFileName: S202SDDTESTITMM_F800AAA.I
                      network: EAS
                      fileStatus: ERR
                      lastStatusUpdated: '2024-11-08T14:29:00.012345'
                    filePSR:
                      fileType: RSF
                      receiverBIC: DPBICA88
                      businessDate: '2025-04-23'
                      calendarDate: '2025-02-03'
                      lac: '01'
                      fileReference: COREFILEREF01234
                      dateTime: '9999-12-31T12:55:45.000001'
                      networkFileName: S202CORTESTITMM_F111ABC.I
                      network: EBX
                      fileStatus: VAL
                      lastStatusUpdated: '2019-06-21T23:20:50.000001'
                    fileRSF:
                      fileType: IDF
                      receiverBIC: TESTIT88
                      businessDate: '2025-06-12'
                      calendarDate: '2025-04-23'
                      lac: '02'
                      fileReference: B2BTFILEREF01234
                      dateTime: '2024-11-08T14:29:00.012345'
                      networkFileName: S202B2BTESTITMM_F999AAA.I
                      network: SWF
                      fileStatus: TSD
                      lastStatusUpdated: '9999-12-31T12:55:45.000001'
                      totNumBulks: 1000
                      numDebitsSettled: 10000
                      valDebitsSettled: 1234567.99
                      numDebitsCancelled: 99999999
                      valDebitsCancelled: 9999999.12
                      numReturnsSettled: 1000
                      valReturnsSettled: 10000.01
                      numReturnsCancelled: 10000
                      valReturnsCancelled: 1234567.99
                      numReversalSettled: 99999999
                      valReversalSettled: 9999999.12
                      numReversalCancelled: 1000
                      valReversalCancelled: 10000.01
                    fileRTF:
                      fileType: DVF
                      receiverBIC: BICDPA23
                      businessDate: '2025-02-03'
                      calendarDate: '2025-06-12'
                      fileReference: TESTFILEREF01234
                      dateTime: '2019-06-21T23:20:50.000001'
                      networkFileName: S202SDDTESTITMM_F800AAA.I
                      network: EAS
                      fileStatus: ERR
                      lastStatusUpdated: '2024-11-08T14:29:00.012345'
                    fileIGF:
                      fileType: RSF
                      senderBIC: DPBICA88
                      businessDate: '2025-04-23'
                      calendarDate: '2025-02-03'
                      IGFFileRef: COREFILEREF01234
                      dateTime: '9999-12-31T12:55:45.000001'
                      IGFNetworkFileName: S202CORTESTITMM_F111ABC.I
                      network: EBX
                      fileStatus: VAL
                      reasonCode: R10
                      processingTime: '2019-06-21T23:20:50.000001'
                      OGFFileRef: B2BTFILEREF01234
                      OGFNetworkFileName: S202B2BTESTITMM_F999AAA.I
                      numGetAccountValidated: 10000
                      numGetAccountRejected: 99999999
                      numGetTransactionValidated: 1000
                      numGetTransactionRejected: 10000
                    fileOGF:
                      fileType: IDF
                      receiverBIC: TESTIT88
                      businessDate: '2025-06-12'
                      calendarDate: '2025-04-23'
                      OGFFileRef: TESTFILEREF01234
                      dateTime: '2024-11-08T14:29:00.012345'
                      OGFNetworkFileName: S202SDDTESTITMM_F800AAA.I
                      network: SWF
                      fileStatus: TSD
                      reasonCode: A01
                      lastStatusUpdated: '9999-12-31T12:55:45.000001'
                      IGFFileRef: COREFILEREF01234
                      IGFNetworkFileName: S202CORTESTITMM_F111ABC.I
                      numGetAccountValidated: 99999999
                      numGetAccountRejected: 1000
                      numGetTransactionValidated: 10000
                      numGetTransactionRejected: 99999999
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /originalXML/{senderBIC}:
    post:
      tags:
        - Transaction Inquiry
      operationId: originalXML
      summary: It allows to ask for the creation of the original xml of the message (valid only for the transactions processed in bulk processing mode).
      description: |-
        The originalXML request allows participants to ask for the recreation of the original xml of the message (valid only for the transactions processed in bulk processing mode).
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OriginalXMLRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  transactionRef:
                    transactionType: RET
                    interbankSettlementDate: '2025-06-12'
                    transactionId: TESTTRANSEF135000000000000000000123
                    fileType: IDF
                    creditorBankBIC: TESBIC22XXX
                    debtorBankBIC: TESBIC33XXX
                    lac: '01'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OriginalXMLResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    originalXml: <originalXml>......</originalXml>
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listMessages/{senderBIC}:
    post:
      tags:
        - Message Inquiry
      operationId: listMessages
      summary: It allows Participants to enquire the list of messages for which they are sender or receiver
      description: |-
        The listMessages request allows a participant to retrieve the list of its messages (sent or received).
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListMessagesRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    fileType: IDF
                    messageType: Camt.003
                    senderReceiverBIC: TESTIT88
                    dateTimeFrom: '2024-11-08T14:29:00.012345'
                    dateTimeTo: '9999-12-31T12:55:45.000001'
                    messageRef: MSGREF0000011111
                    originalMessageRef: CORREF0000011234
                    messageStatus: VAL
                    reasonCode: GMRC
                    IGFFileRef: TESTFILEREF01234
                    OGFFileRef: COREFILEREF01234
                    network: SWF
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMessagesResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    endOfList: true
                    senderReceiverBIC: TESTIT88
                    messages:
                      - messageType: Camt.003
                        messageRef: MSGREF0000011111
                        dateTime: '2024-11-08T14:29:00.012345'
                        lastStatusUpdate: '9999-12-31T12:55:45.000001'
                        messageStatus: VAL
                        reasonCode: GMRC
                        originalMessageRef: CORREF0000011234
                        network: SWF
                        IGFFileRef: TESTFILEREF01234
                        OGFFileRef: COREFILEREF01234
                      - messageType: Camt.005
                        messageRef: MSGREF0000011111
                        dateTime: '2024-11-08T14:29:00.012345'
                        lastStatusUpdate: '9999-12-31T12:55:45.000001'
                        messageStatus: ERR
                        reasonCode: EX99
                        originalMessageRef: CORREF0000011234
                        network: EBX
                        IGFFileRef: TESTFILEREF01234
                        OGFFileRef: COREFILEREF01234
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /messageDetails/{senderBIC}:
    post:
      tags:
        - Message Inquiry
      operationId: messageDetails
      summary: It allows Participants to enquire the details of a single message for which they are sender or receiver
      description: |-
        The messageDetails request allows participants to get the details of a specific message (sent or received).
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageDetailsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  message:
                    messageType: Camt.003
                    messageStatus: VAL
                    messageRef: MSGREF0000011111
                    dateTime: '2024-11-08T14:29:00.012345'
                    senderReceiverBIC: TESTIT88
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageDetailsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    messageDetails:
                      messageType: Camt.003
                      messageStatus: VAL
                      messageRef: MSGREF0000011111
                      dateTime: '2024-11-08T14:29:00.012345'
                      validationDateTime: '9999-12-31T12:55:45.000001'
                      lastStatusUpdate: '2019-06-21T23:20:50.000001'
                      senderReceiverBIC: TESTIT88
                      IGFFileRef: TESTFILEREF01234
                      OGFFileRef: COREFILEREF01234
                      network: SWF
                      counter: 1000
                      getAccountDetails:
                        settlementBIC: IPSDID21XXX
                      returnAccountDetails:
                        settlementBIC: TESBIC11XXX
                        position: 1000
                        positionTimestamp: '2024-11-08T14:29:00.012345'
                      returnAccountQueryResponseError:
                        reasonCode: GMRC
                      getTransaction:
                        referenceLCR: B2BTFILEREF01234
                      returnTransaction:
                        instructingSettlementBIC: TESBIC99XXX
                        instructingDPBIC: BICDPA23
                        instructedSettlementBIC: IPSDID21XXX
                        instructedDPBIC: DPBICA88
                        lcrStatusUpdate:
                          - lcrStatus: WTG
                            lastStatusUpdate: '9999-12-31T12:55:45.000001'
                          - lcrStatus: RJCT
                            lastStatusUpdate: '2024-11-08T14:29:00.012345'
                        totalLCRNumber: 10000
                        totalLCRAmount: 10000.01
                      returnTransactionQueryResponseError:
                        reasonCode: EX01
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /retransmitOutFiles/{senderBIC}:
    post:
      tags:
        - Commands
      operationId: retransmitOutFiles
      summary: It allows to ask for the resending of a single file for which the Participant was the receiver.
      description: |-
        The retransmitOutFiles request allows a participant to ask for the resending of a single file in  ERR (error) – TSD (transmitted) – TSG (transmitting) status and for which such participant was the receiver.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetransmitOutFilesRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  fileRef:
                    fileType: IDF
                    networkFileName: S202SDDTESTITMM_F800AAA.I
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetransmitOutFilesResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    commandRef: F010190208113908
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /resendAll/{senderBIC}:
    post:
      tags:
        - Commands
      operationId: resendAll
      summary: It allows the Participant to ask the comprehensive re-transmission of output files for which the Participant was the receiver.
      description: |-
        The resendAll request allows a participant to ask the comprehensive re-transmission of all the output files in TSG (transmitting) or ERR (error) status and for which such participant was the receiver.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResendAllRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  resendCriteria:
                    fileType: IDF
                    dateFrom: '2025-06-12'
                    dateTo: '2025-04-23'
                    fileReference: TESTFILEREF01234
                    lac: '01'
                    originalFileRef: COREFILEREF01234
                    fileStatus: TSD
                    reasonCode: A01
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResendAllResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    commandRef: F010190208113908
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /retransmitOutMessages/{senderBIC}:
    post:
      tags:
        - Commands
      operationId: retransmitOutMessages
      summary: It allows to ask for the resending of a single file message which the Participant is the receiver.
      description: |-
        The retransmitOutMessages allows participants to ask for the resending of a single message in ERR (error) – TSD (transmitted) – TSG (transmitting) status and for which the Participant is the receiver.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetransmitOutMessagesRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  message:
                    messageType: Camt.003
                    messageRef: MSGREF0000011111
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetransmitOutMessagesResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    commandRef: F010190208113908
                    counter: 1000
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /bulkCancellation/{senderBIC}:
    put:
      tags:
        - Commands
      operationId: bulkCancellation
      summary: It allows the Participant to ask the cancellation of a bulk processed in Bulk Processing mode before the settlement takes place.
      description: |-
        The bulkCancellation request allows a participant to ask the cancellation of a bulk processed in Bulk Processing mode, before the settlement of the included DD collections takes place. Only pacs.003 (DD bulk messages) not yet settled can be cancelled.  The bulk cancellation request can be carried out  only if the following conditions are met:
        - None of the transactions in the bulk is either settled or cancelled at settlement; and
        - At least one of the transactions in the bulk is either validated or notified to the counterpart.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCancellationRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  bulkRef:
                    fileReference: TESTFILEREF01234
                    bulkReference: TESTBULKREF135000000000000000000123
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkCancellationResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    commandRef: F010190208113908
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /batchCancellation/{senderBIC}:
    put:
      tags:
        - Commands
      operationId: batchCancellation
      summary: 'It allows the Participant to ask the cancellation of a bulk processed in Batch Processing mode before the settlement takes place. '
      description: |-
        The batchCancellation request allows participants to ask the cancellation of a bulk processed in Batch Processing mode before the settlement takes place. Only batches concerning pacs.003 (DD bulk messages) not yet settled can be cancelled. The cancellation of a Batch can be carried out only in the case the batch to be cancelled has not been yet notified to the counterpart. The cancellation of a Batch cannot be executed in  case the Batch to be cancelled has been completely or partially cancelled/rejected by a camt.056 or pacs.002.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate
            (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed”
            (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchCancellationRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  bulkRef:
                    fileReference: TESTFILEREF01234
                    bulkReference: TESTBULKREF135000000000000000000123
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchCancellationResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    commandRef: F010190208113908
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /thirdPoleReportRequest/{senderBIC}:
    post:
      tags:
        - Commands
      operationId: thirdPoleReportRequest
      summary: It allows to ask for the creation of the Third Pole Reconciliation report.
      description: |-
        The thirdPoleReportRequest allows participants to ask for the creation of the Third Pole Reconciliation report.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ThirdPoleReportRequestRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  reportCriteria:
                    processCycle: '01'
                    bulkType: Pacs.003
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThirdPoleReportRequestResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listThirdPoleReport/{senderBIC}:
    post:
      tags:
        - Commands
      operationId: listThirdPoleReport
      summary: It allows to ask for the list of the Third Pole Reconciliation report generated after the “ThirdPoleReportRequest” API.
      description: |-
        The listThirdPoleReport allows participants to ask for the list of the Third Pole Reconciliation report generated after the “thirdPoleReportRequest” API.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListThirdPoleReportRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    reportRef: UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN
                    creationDateTimeFrom: '2024-11-08T14:29:00.012345'
                    creationDateTimeTo: '9999-12-31T12:55:45.000001'
                    reportStatus: WTG
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListThirdPoleReportResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    reports:
                      - reportRef: UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN
                        creationDateTime: '2024-11-08T14:29:00.012345'
                        reportType: BRE
                        reportStatus: WTG
                      - reportRef: UUUUUUUU_YYDDD_12345678901234567890123456789012999_NNN
                        creationDateTime: '2019-06-21T23:20:50.000001'
                        reportType: BRE
                        reportStatus: NTF
                    endOfList: true
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /thirdPoleReportReceivingRequest/{senderBIC}:
    post:
      tags:
        - Commands
      operationId: thirdPoleReportReceivingRequest
      summary: It allows to ask for the receiving of the Third Pole Reconciliation report generated after the “ThirdPoleReportRequest” API.
      description: |-
        The thirdPoleReportReceivingRequest allows participants to ask for the receiving of the Third Pole Reconciliation report generated after the “thirdPoleReportRequest” API.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ThirdPoleReportReceivingRequestRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  reportRef: UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThirdPoleReportReceivingRequestResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    report:
                      reportRef: UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN
                      creationDateTime: '2024-11-08T14:29:00.012345'
                      reportType: BRE
                      reportStatus: WTG
                      data: U3dhZ2dlciByb2Nrcw
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listCommands/{senderBIC}:
    post:
      tags:
        - Commands
      operationId: listCommands
      summary: It allows the Participant to inquiry for the list of Commands that were submitted by the Participant.
      description: |-
        The listCommands request allows a participant to inquire for the status of its commands.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListCommandsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    commandType: F01
                    commandStatus: '001'
                    requestDateTimeFrom: '2024-11-08T14:29:00.012345'
                    requestDateTimeTo: '9999-12-31T12:55:45.000001'
                    authRejectDateTimeFrom: '2019-06-21T23:20:50.000001'
                    authRejectDateTimeTo: '2024-11-08T14:29:00.012345'
                    userIssuer: APIUSER1
                    userAuthReject: APIUSER2
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCommandsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    commands:
                      - commandType: F01
                        commandStatus: '001'
                        requestDateTime: '2024-11-08T14:29:00.012345'
                        authRejectDateTime: '9999-12-31T12:55:45.000001'
                        userIssuer: APIUSER1
                        userAuthReject: APIUSER2
                        commandRef: F010190208113908
                      - commandType: F03
                        commandStatus: '003'
                        requestDateTime: '2024-11-08T14:29:00.012345'
                        authRejectDateTime: '9999-12-31T12:55:45.000001'
                        userIssuer: APIUSER1
                        userAuthReject: APIUSER2
                        commandRef: F123456789012345
                    endOfList: true
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /commandDetail/{senderBIC}:
    post:
      tags:
        - Commands
      operationId: commandDetails
      summary: It allows the Participant to inquiry for the status of a single command submitted by the Participant.
      description: |-
        The commandDetail request allows participants to inquire the details of a specific command submitted by participants linked to their same BIC.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommandDetailRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  commandRef: F010190208113908
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommandDetailResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    retransmitOutFiles:
                      commandRef: F010190208113908
                      commandType: F01
                      commandStatus: '001'
                      requestDateTime: '2024-11-08T14:29:00.012345'
                      authRejectDateTime: '9999-12-31T12:55:45.000001'
                      userIssuer: APIUSER1
                      userAuthReject: APIUSER2
                      fileType: IDF
                      networkFileName: S202SDDTESTITMM_F800AAA.I
                      settlementDate: '2025-06-12'
                      dateTime: '2019-06-21T23:20:50.000001'
                    resendAll:
                      commandRef: F011390508223918
                      commandType: F02
                      commandStatus: '002'
                      requestDateTime: '2024-11-08T14:29:00.012345'
                      authRejectDateTime: '9999-12-31T12:55:45.000001'
                      userIssuer: APIUSER3
                      userAuthReject: APIUSER1
                      fileType: DVF
                      dateTime: '2019-06-21T23:20:50.000001'
                    bulkCancellation:
                      commandRef: F123456789012345
                      commandType: F03
                      commandStatus: '003'
                      requestDateTime: '2024-11-08T14:29:00.012345'
                      authRejectDateTime: '9999-12-31T12:55:45.000001'
                      userIssuer: APIUSER2
                      userAuthReject: APIUSER3
                      cancellationRef: SDDSDDDITA22018534SCTSCTDITA2201853
                    batchCancellation:
                      commandRef: F010190208113908
                      commandType: F01
                      commandStatus: '001'
                      requestDateTime: '2019-06-21T23:20:50.000001'
                      authRejectDateTime: '2024-11-08T14:29:00.012345'
                      userIssuer: APIUSER1
                      userAuthReject: APIUSER2
                      cancellationRef: SDDCORDITA22018534SCTSCTDITA2201111
                    retransmitOutMessage:
                      commandRef: F011390508223918
                      commandType: F02
                      commandStatus: '002'
                      requestDateTime: '9999-12-31T12:55:45.000001'
                      authRejectDateTime: '2019-06-21T23:20:50.000001'
                      userIssuer: APIUSER3
                      userAuthReject: APIUSER1
                      messageType: Camt.003
                      messageRef: MSGREF0000011111
                      dateTime: '2024-11-08T14:29:00.012345'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listAlerts/{senderBIC}:
    post:
      tags:
        - Commands
      operationId: listAlerts
      summary: It allows the Participant to inquiry the list of alerts produced by the System for its BIC.
      description: |-
        The listAlerts request allows participants to browse the list of alerts produced by the System for their BIC.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAlertsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    dateTimeFrom: '2024-11-08T14:29:00.012345'
                    dateTimeTo: '9999-12-31T12:55:45.000001'
                    eventDescription: INDIRECT PARTICIPANT INPART001 IS NOT PRESENT
                    issuer: APIUSER1
                    authorizer: APIUSER2
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAlertsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    alerts:
                      - dateTime: '2024-11-08T14:29:00.012345'
                        eventType: WRN
                        eventDescription: INDIRECT PARTICIPANT INPART001 IS NOT PRESENT
                        issuer: APIUSER1
                        authorizer: APIUSER2
                      - dateTime: '2019-06-21T23:20:50.000001'
                        eventType: ERR
                        eventDescription: SAMPLE EVENT DESCRIPTION
                        issuer: APIUSER1
                        authorizer: APIUSER2
                    endOfList: true
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /listLCR/{senderBIC}:
    post:
      tags:
        - LCR
      operationId: listLCR
      summary: 'It allows to enquire the list of the LCRs generated for the Participant by B2B Service.  '
      description: |-
        The listLCR request allows STEP2 Direct Participants to inquire LCRs for their BIC.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListLCRRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    instructingDPBIC: TESTIT88
                    instructedDPBIC: BICDPA23
                    instgSttlmBIC: IPSDID21XXX
                    instdSttlmBIC: TESBIC11XXX
                    settlementDateFrom: '2025-06-12'
                    settlementDateTo: '2025-04-23'
                    dateTimeFrom: '2024-11-08T14:29:00.012345'
                    dateTimeTo: '9999-12-31T12:55:45.000001'
                    referenceLCR: TESTFILEREF01234
                    bulkType: pacs.003
                    lac: '01'
                    lcrStatus: WTG
                  offset: AAaa88ss2345fggGGDDaaaHH
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLCRResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    endOfList: true
                    LCRs:
                      - instructingDPBIC: TESTIT88
                        instructedDPBIC: BICDPA23
                        instgSttlmBIC: IPSDID21XXX
                        instdSttlmBIC: TESBIC11XXX
                        settlementDate: '2025-06-12'
                        businessDateTime: '2024-11-08T14:29:00.012345'
                        bulkType: pacs.003
                        referenceLCR: TESTFILEREF01234
                        lac: '01'
                        lcrStatus: WTG
                        originalBulkReferenceId: TESTBULKREF135000000000000000000123
                        originalInputFileReferenceId: COREFILEREF01234
                        amount: 10000.01
                        creationDateTime: '9999-12-31T12:55:45.000001'
                        dbrCrdFlag: C
                      - instructingDPBIC: TESTIT88
                        instructedDPBIC: BICDPA23
                        instgSttlmBIC: IPSDID21XXX
                        instdSttlmBIC: TESBIC11XXX
                        settlementDate: '2025-02-03'
                        businessDateTime: '2024-11-08T14:29:00.012345'
                        bulkType: pacs.007
                        referenceLCR: TESTFILEREF01234
                        lac: '10'
                        lcrStatus: RJCT
                        originalBulkReferenceId: TESTBULKREF135123400000000000000567
                        originalInputFileReferenceId: COREFILEREF01234
                        amount: 9999999.12
                        creationDateTime: '9999-12-31T12:55:45.000001'
                        dbrCrdFlag: C
                    offset: AAaa88ss2345fggGGDDaaaHH
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
  /lcrDetails/{senderBIC}:
    post:
      tags:
        - LCR
      operationId: lcrDetails
      summary: It allows the Participant to retrieve details for a specific LCR.
      description: |-
        The lcrDetails request allows STEP2 Direct Participant to retrieve details of a specific LCR for their BIC.
        If no record is found for the set criteria of the request, the HTTP Code 204 is returned with the Response.
      parameters:
        - name: senderBIC
          description: |-
            The BIC sending the request

             **Validation Rule(s)** It must be equal to the BIC of the DP certificate (errorCode XA02)
            Sending DP must not have status “Disabled” or “Changed” (errorCode PY01)
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/SenderBIC'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LcrDetailsRequest'
            examples:
              OK:
                value:
                  dateTime: '2019-06-21T23:20:50.000001'
                  searchCriteria:
                    settlementDate: '2025-06-12'
                    referenceLCR: TESTFILEREF01234
                    lac: '01'
                    lcrStatus: WTG
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LcrDetailsResponse'
              examples:
                OK:
                  value:
                    dateTime: '2019-06-21T23:20:50.000001'
                    LCRDetails:
                      referenceLCR: TESTFILEREF01234
                      settlementDate: '2025-06-12'
                      origBulkMsgId: TESTBULKREF135000000000000000000123
                      origInputFile: COREFILEREF01234
                      bulkType: pacs.003
                      instructingDPBIC: TESTIT88
                      instructedDPBIC: BICDPA23
                      instgSttlmBIC: IPSDID21XXX
                      instdSttlmBIC: TESBIC11XXX
                      credPartyBIC: DPBICA88
                      debPartyBIC: TESTIT88
                      cgsLacInput: '01'
                      cgsLacOutput: '02'
                      amount: 10000.01
                      numTransactions: 1000
                      lcrStatus: WTG
                      s2LcrCreationTimestamp: '2024-11-08T14:29:00.012345'
                      cgsLcrStatusUpdate: '9999-12-31T12:55:45.000001'
                      dbrCrdFlag: C
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '204':
          description: No Content
          $ref: '#/components/responses/ErrorResponse_204'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ErrorResponse'
                  - $ref: '#/components/schemas/Errors'
          headers:
            X-Request-ID:
              $ref: '#/components/headers/X-Request-ID'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/ErrorResponse_401'
        '403':
          description: Forbidden
          $ref: '#/components/responses/ErrorResponse_403'
        '404':
          description: Not Found
          $ref: '#/components/responses/ErrorResponse_404'
        '429':
          description: Too many requests
          $ref: '#/components/responses/ErrorResponse_429'
        '500':
          description: Internal Server Error
          $ref: '#/components/responses/ErrorResponse_500'
components:
  securitySchemes:
    oauthBearerToken:
      description: |
        The access token obtained as a result of OAuth 2.0 flows. SWIFT supports two OAuth grant types depending on the API service.
        * JWT-Bearer grant type [RFC 7523](https://tools.ietf.org/html/rfc7523)
        * Password grant type

        This API uses JWT-Bearer grant type.

        Please visit [SWIFT OAuth Token API](https://developer.swift.com/swift-oauth-token-api) page for more information and examples on how to generate an OAuth token.

        In this declaration only the basic security element to transport the bearer token of an OAuth2 process is declared.
      type: http
      scheme: bearer
      bearerFormat: opaque OAuth 2.0
  parameters: {}
  headers:
    X-Request-ID:
      description: Specify an unique end to end tracking request ID. The element will be populated by the SWIFT API gateway
      schema:
        type: string
  schemas:
    ActiveOutputNetwork:
      description: Active Network.
      type: string
      enum:
        - PRI
        - SEC
      examples:
        - PRI
    AdmissionProfile:
      description: Admission Profile.
      type: string
      enum:
        - DEB
        - CAD
      examples:
        - CAD
    Alerts:
      type: object
      properties:
        dateTime:
          description: The Date and Time of command triggering the event
          $ref: '#/components/schemas/DateTime'
        eventType:
          description: The type of event
          $ref: '#/components/schemas/EventType'
        eventDescription:
          description: The description of the event
          $ref: '#/components/schemas/EventDescription'
        issuer:
          description: The UserID of the user that has issued the command triggering the event
          $ref: '#/components/schemas/UserId'
        authorizer:
          description: The UserID of the user that has authorized or rejected the command triggering the event
          $ref: '#/components/schemas/UserId'
      required:
        - dateTime
        - eventType
        - eventDescription
        - issuer
        - authorizer
    Amount:
      description: Position Amount
      type: number
      format: double
      minimum: 0
      maximum: 999999999999999.99
      examples:
        - 1000
    BatchCancellationRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        bulkRef:
          $ref: '#/components/schemas/BulkRef1'
      required:
        - dateTime
        - bulkRef
    BatchCancellationResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        commandRef:
          description: The command reference
          $ref: '#/components/schemas/CommandRef'
      required:
        - dateTime
        - commandRef
    BIC11:
      description: The Generic BIC of participant.
      type: string
      pattern: '[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3}){0,1}'
      examples:
        - TESBIC22XXX
    BIC11Only:
      description: BIC11 Only
      type: string
      pattern: '[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3})'
      examples:
        - IPSDID21XXX
    Bic11Only:
      type: string
      pattern: '[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]{3,3})'
      minLength: 11
      maxLength: 11
      examples:
        - IPSDID21XXX
    BIC8:
      description: The BIC of direct participant.
      type: string
      pattern: '[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}'
      examples:
        - TESTIT88
    Bulk:
      type: object
      properties:
        messageType:
          description: The bulk type
          $ref: '#/components/schemas/MessageType'
        bulkReference:
          description: The bulk reference
          $ref: '#/components/schemas/BulkReference'
        fileReference:
          description: The reference of file where this bulk was included
          $ref: '#/components/schemas/FileReference'
        bulkStatus:
          description: The status of bulk
          $ref: '#/components/schemas/BulkStatus'
        settlementDate:
          description: The settlement date of the bulk
          $ref: '#/components/schemas/Date'
        bulkReasonCode:
          description: The reason code of bulk
          $ref: '#/components/schemas/ReasonCode'
        fileType:
          description: The file type
          $ref: '#/components/schemas/FileType'
        originalBulk:
          description: |-
            The original bulk reference
            Present only in case of pacs.002 message
          $ref: '#/components/schemas/BulkReference'
        totNumTransactionsContained:
          description: The total number of transactions contained in the bulk
          $ref: '#/components/schemas/StandardInteger'
        totAmountTransactionsContained:
          description: The total amount of transactions contained in the bulk
          $ref: '#/components/schemas/StandardAmount'
        totTransactionValid:
          description: The total number of valid transactions contained in the bulk
          $ref: '#/components/schemas/StandardInteger'
        totAmountTransactionValid:
          description: The total amount of valid transactions contained in the bulk
          $ref: '#/components/schemas/StandardAmount'
        totTransactionRejected:
          description: The total number of rejected transactions contained in the bulk
          $ref: '#/components/schemas/StandardInteger'
        totAmountTransactionRejected:
          description: The total amount of rejected transactions contained in the bulk
          $ref: '#/components/schemas/StandardAmount'
        bulkCurrency:
          description: The currency of bulk
          $ref: '#/components/schemas/Currency'
        BICInstructing:
          description: The instructing BIC
          $ref: '#/components/schemas/BIC8'
        businessDate:
          description: The business date
          $ref: '#/components/schemas/Date'
        BICInstructed:
          description: |-
            The instructed BIC
            Present only in case of camt.056 or pacs.007 messages
          $ref: '#/components/schemas/BIC8'
        calendarDate:
          description: The Calendar Date
          $ref: '#/components/schemas/Date'
      required:
        - messageType
        - bulkReference
        - fileReference
        - bulkStatus
        - settlementDate
        - bulkReasonCode
        - fileType
        - totNumTransactionsContained
        - totAmountTransactionsContained
        - totTransactionValid
        - totAmountTransactionValid
        - totTransactionRejected
        - totAmountTransactionRejected
        - bulkCurrency
        - BICInstructing
        - businessDate
        - calendarDate
    BulkCancellation:
      type: object
      properties:
        commandRef:
          description: The reference of the command
          $ref: '#/components/schemas/CommandRef'
        commandType:
          description: The type of command (F02 for Bulk Cancellation)
          $ref: '#/components/schemas/CommandType'
        commandStatus:
          description: The status of the command
          $ref: '#/components/schemas/CommandStatus'
        requestDateTime:
          description: The date and time in which the command has been issued
          $ref: '#/components/schemas/DateTime'
        authRejectDateTime:
          description: The date and time in which the command has been executed or rejected
          $ref: '#/components/schemas/DateTime'
        userIssuer:
          description: The UserID of the user that has issued the command
          $ref: '#/components/schemas/UserId'
        userAuthReject:
          description: The UserID of the user that has authorized or rejected the command
          $ref: '#/components/schemas/UserId'
        cancellationRef:
          description: The reference of cancellation
          $ref: '#/components/schemas/CancellationRef'
      required:
        - commandRef
        - commandType
        - commandStatus
        - requestDateTime
        - userIssuer
        - cancellationRef
    BulkCancellationRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        bulkRef:
          $ref: '#/components/schemas/BulkRef1'
      required:
        - dateTime
        - bulkRef
    BulkCancellationResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        commandRef:
          description: The command reference
          $ref: '#/components/schemas/CommandRef'
      required:
        - dateTime
        - commandRef
    BulkDetailsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        bulkRef:
          $ref: '#/components/schemas/BulkRef'
      required:
        - dateTime
        - bulkRef
    BulkDetailsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        bulk:
          $ref: '#/components/schemas/Bulk'
      required:
        - dateTime
    BulkRef:
      type: object
      properties:
        fileType:
          description: |-
            The file type

             **Validation Rule(s)** It can be set with one of the valuesconfigured in the system
            (errorCode SC01)
            “DRR”, “MSR”, “PSR” or “RTF” values cannot be used
            (errorCode XA07)
          $ref: '#/components/schemas/FileType'
        messageType:
          description: The transaction type
          $ref: '#/components/schemas/MessageType'
        fileReference:
          description: |-
            The file reference

             **Validation Rule(s)** It can be set with one of the values configured in the system
            (errorCode SC01)
            If fileType is equal to “IDF”, this field must be populated with “DD.Message” or “R.Message”
            (errorCode XA07)
          $ref: '#/components/schemas/FileReference'
        bulkReference:
          description: The bulk reference
          $ref: '#/components/schemas/BulkReference'
        dateType:
          description: The relevant Business, Calendar or Settlement Date
          $ref: '#/components/schemas/DateType'
      required:
        - bulkReference
    BulkRef1:
      type: object
      properties:
        fileReference:
          description: The file reference
          $ref: '#/components/schemas/FileReference'
        bulkReference:
          description: The bulk reference of the bulk to be cancelled
          $ref: '#/components/schemas/BulkReference'
      required:
        - fileReference
        - bulkReference
    BulkReference:
      description: The bulk reference of the file.
      type: string
      pattern: ([A-Za-z0-9]|[+|\?|/|\-|:|\(|\)|\.|,|']){1,35}
      examples:
        - TESTBULKREF135000000000000000000123
    Bulks:
      type: object
      properties:
        messageType:
          description: The bulk type
          $ref: '#/components/schemas/MessageType'
        senderReceiverBIC:
          description: The DP BIC of the receiver/sender
          $ref: '#/components/schemas/BIC8'
        fileReference:
          description: The reference of the file
          $ref: '#/components/schemas/FileReference'
        bulkReference:
          description: The reference of the bulk
          $ref: '#/components/schemas/BulkReference'
        date:
          description: The date of the bulk
          $ref: '#/components/schemas/Date'
        lac:
          description: The relevant LAC
          $ref: '#/components/schemas/Lac'
        bulkStatus:
          description: The status of the bulk
          $ref: '#/components/schemas/BulkStatus'
        reasonCode:
          description: The validation reason code associated to the the bulk
          $ref: '#/components/schemas/ReasonCode'
        dateTime:
          description: The business date and time when the bulk was received/sent by the Central System
          $ref: '#/components/schemas/DateTime'
        fileType:
          description: The file type
          $ref: '#/components/schemas/FileType'
        offset:
          description: The offset is used in order to manage the pagination. Present in case  endOfList is set as “false”
          $ref: '#/components/schemas/Offset'
      required:
        - messageType
        - senderReceiverBIC
        - fileReference
        - bulkReference
        - date
        - bulkStatus
        - reasonCode
        - dateTime
        - fileType
    BulkStatus:
      description: The status of Bulk.
      type: string
      enum:
        - PART
        - ACCP
        - RJCT
      examples:
        - ACCP
    BulkType:
      description: Bulk Type.
      type: string
      enum:
        - Pacs.003
        - Pacs.002
        - Pacs.004
        - Camt.056
        - Pacs.007
        - Pacs.2S2
      examples:
        - Pacs.003
    BulkType2:
      type: string
      enum:
        - pacs.003
        - pacs.004
        - pacs.007
      examples:
        - pacs.003
    CancellationRef:
      description: Reference for bulk and batch cancellation.
      type: string
      pattern: '[A-Z0-9]{35,35}'
      examples:
        - SDDSDDDITA22018534SCTSCTDITA2201853
    ChangeStatusRB:
      type: object
      properties:
        RBBICCode:
          description: |-
            The RB BIC for which the status must be changed

             **Validation Rule(s)** The BIC must be in status "Enabled" or "R-Only" in Routing Table
            (errorCode PY01)
            The BIC must be recorded in routing table as Reachable BIC of the sender BIC
            (errorCode PY01)
          $ref: '#/components/schemas/Bic11Only'
        newStatus:
          description: |-
            The new status for the participant

             **Validation Rule(s)** It must be set as
            - “DIS” if the RB has "ENB" or “RON” status and
            1. the RB is going to become disabled [no end validity date has been previously set]
            2. the RB has an end date already set in the future and the user wishes to postpone or bring it forward (i.e. "Amend Remove")
            - “RON” if the RB has “ENB” (enabled) status and:
            1. the RB is going to become R-only  [no R-Only date has been previously set]
            2. the RB has an R-Only date already set in the future and the user wishes to postpone or bring it forward (i.e. "Amend R-Only")
            - "ENB" if the RB has “ENB” (enabled) status, an R-Only or a End date already set in the future and the user wishes to cancel the previous R-Only/Remove operation and keep the BIC in ENB status (i.e. “Revoke R-Only"/”Revoke Remove” – effectiveDate must be set to 9999-12-31).
            (errorCode PY01)
          $ref: '#/components/schemas/ParticipantStatus1'
        rOnlyDate:
          description: |-
            The date set for R-Only

             **Validation Rule(s)** This field can be used only if newStatus is set to RON or ENB
            (errorCodeXA13)

            If different than 9999-12-31, it can correspond to an R-Only operation or an Amend R-Only operation according to the configuration of the involved BIC.

            Amend R-Only when postponing the R-Only date is not subject to warehousing constraints.
            R-Only date cannot be brought forward during warehousing period
            (errorCode DT01)

            For R-Only operation (not Amend), it must be a future date calculated as follows:
            -if the calculated first available effective date taking into consideration only warehousing constraints falls on Monday, the first available “effective date” will be the Tuesday of the 3rd week;
            -if the calculated first available effective date taking into consideration only warehousing constraints falls between Tuesday and Sunday, the first available “effective date” will be Tuesday of the 4th week.
            (error code DT01)

            If set equal to 9999-12-31, this operation is handled as "Revoke R-Only".  This operation is not subject to warehousing constraints.
            Date equal to  9999-12-31 can be used only if newStatus is set equal to ENB
            (errorCode XA13)
          $ref: '#/components/schemas/Date'
        effectiveDate:
          description: |-
            The effective date set for the removal

             **Validation Rule(s)** This field can be used only if newStatus is set to:
            - DIS
            - ENB
            (errorCodeXA13)
            The first available effective date must be set as follows:
            - the effective date must be equal to one of the effective date stored within "Change Dates Calendar" functionality
            - the business date when the operation is confirmed, must precede or must be equal to "Submission Date" relevant to the chosen “Effective Date”
            - the effective date must be equal to 9999-12-31 if the operation corresponds to a “Revoke R-Only"/“Revoke Remove” (newStatus must be set to ENB”)
            (error code DT01)
          $ref: '#/components/schemas/Date'
      required:
        - RBBICCode
        - newStatus
    ChangeStatusReachableBICRequest:
      type: object
      properties:
        dateTime:
          description: The Date and Time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        changeStatusRB:
          $ref: '#/components/schemas/ChangeStatusRB'
      required:
        - dateTime
        - changeStatusRB
    ChangeStatusReachableBICResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        operationRef:
          description: The reference assigned by the system to the "Change Status (Remove or R-Only)" operation, logged in the system in TBA status
          $ref: '#/components/schemas/OperationRef'
      required:
        - dateTime
        - operationRef
    CommandDetailRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        commandRef:
          description: The command reference
          $ref: '#/components/schemas/CommandRef'
      required:
        - dateTime
        - commandRef
    CommandDetailResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        retransmitOutFiles:
          $ref: '#/components/schemas/RetransmitOutFiles'
        resendAll:
          $ref: '#/components/schemas/ResendAll'
        bulkCancellation:
          $ref: '#/components/schemas/BulkCancellation'
        batchCancellation:
          $ref: '#/components/schemas/BulkCancellation'
        retransmitOutMessage:
          description: The type of command (F05 for Retransmit Out Message)
          $ref: '#/components/schemas/RetransmitOutMessage'
      required:
        - dateTime
    CommandRef:
      description: Command reference.
      type: string
      maxLength: 16
      examples:
        - F010190208113908
    Commands:
      type: object
      properties:
        commandType:
          description: |-
            The type of command. Possible values:
            F01 Retransmit Out Files
            F02 Bulk Cancellation
            F03 Batch Cancellation
            F04 Resend All
            F05 Retransmit Out Messages
          $ref: '#/components/schemas/CommandType'
        commandStatus:
          description: The status of the command
          $ref: '#/components/schemas/CommandStatus'
        requestDateTime:
          description: The date and time in which the command has been issued
          $ref: '#/components/schemas/DateTime'
        authRejectDateTime:
          description: The date and time in which the command has been executed or rejected
          $ref: '#/components/schemas/DateTime'
        userIssuer:
          description: The UserID of the user that has issued the command
          $ref: '#/components/schemas/UserId'
        userAuthReject:
          description: The UserID of the user that has authorized or rejected the command
          $ref: '#/components/schemas/UserId'
        commandRef:
          description: The reference of the command
          $ref: '#/components/schemas/CommandRef'
      required:
        - commandType
        - commandStatus
        - requestDateTime
        - userIssuer
        - commandRef
    CommandStatus:
      description: Command status.
      type: string
      enum:
        - '001'
        - '002'
        - '003'
      examples:
        - '001'
    CommandType:
      description: Command type.
      type: string
      enum:
        - F01
        - F02
        - F03
        - F04
        - F05
      examples:
        - F01
    CreditorId:
      description: Creditor reference.
      type: string
      pattern: ([A-Za-z0-9]|[+|\?|/|\-|:|\(|\)|\.|,|']){1,35}
      examples:
        - CREDITORSEF135000000000000000000123
    Currency:
      description: Currency.
      type: string
      maxLength: 3
      examples:
        - EUR
    Cycle:
      description: The cycle of service.
      type: string
      pattern: '[0-9]{2,2}'
      examples:
        - '01'
    DataType:
      type: string
      enum:
        - Business Date
        - Calendar Date
        - Settlement Date
      examples:
        - Business Date
    Date:
      description: Standard ISO Date.
      type: string
      pattern: '[0-9]{4,4}\-[0-9]{2,2}\-[0-9]{2,2}'
      examples:
        - '2025-06-12'
    DateTime:
      description: Standard ISO Date-Time.
      type: string
      pattern: '[0-9]{4,4}\-[0-9]{2,2}\-[0-9]{2,2}[T][0-9]{2,2}:[0-9]{2,2}:[0-9]{2,2}(\.[0-9]{1,6}){0,1}'
      examples:
        - '2019-06-21T23:20:50.000001'
    DateType:
      type: string
      examples:
        - Budiness Date
    DateType1:
      type: string
      enum:
        - Business Date
        - Calendar Date
      examples:
        - Business Date
    DebitPositionCGSRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria5'
        offset:
          description: |-
            The pointer returned in the previous API Response, useful to obtain the next group of records satisfying the same filtering criteria.

             **Validation Rule(s)** It can be filled only with the same value as the offset field of the previous API Response returned to the previous API Request with the same filtering criteria (it must be empty for the first API Request)
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - searchCriteria
    DebitPositionCGSResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        header:
          $ref: '#/components/schemas/Header'
        debtorPosition:
          type: array
          items:
            $ref: '#/components/schemas/DebtorPosition'
        endOfList:
          description: |-
            The flag is used to show if the list is complete or not
            true= The list is complete
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        offset:
          description: It indicates if there are more records satisfying the searching criteria; to get them, the offset value must be copied in the offset field of a new API Request that must also contain the same filtering criteria than the current one
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - header
        - debtorPosition
        - endOfList
    DebitProduct:
      type: string
      enum:
        - CAI
        - NLO
        - ICM
      examples:
        - CAI
    DebtorPosition:
      type: object
      properties:
        counterpartyBIC:
          description: The BIC of the counterparty
          $ref: '#/components/schemas/BIC8'
        tresholdAmount:
          description: The threshold amount against its counterparties
          $ref: '#/components/schemas/StandardAmount'
        sumAmountDebitReceived:
          description: Sum of Amount of Direct Debits received by the counterparty from this DP
          $ref: '#/components/schemas/StandardAmount'
        sumAmountReturnRefundReceived:
          description: Sum of Amount of Returns/Refunds received by the counterparty from this DP
          $ref: '#/components/schemas/StandardAmount'
        sumAmountReversalSent:
          description: Sum of Amount of Reversal sent to the counterparty by this DP
          $ref: '#/components/schemas/StandardAmount'
        totalDebitPosition:
          description: Total Debit Position against this counterparty
          $ref: '#/components/schemas/StandardAmount'
        sumAmountDebitSent:
          description: |-
            Sum of Amount of Direct Debits sent to the counterparty from this DP.
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        sumAmountReturnRefundSent:
          description: |-
            Sum of Amount of Returns/Refunds sent by the counterparty to this DP
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        sumAmountReversalReceived:
          description: |-
            Sum of Amount of Reversal received by the counterparty to this DP
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        totalCreditPosition:
          description: |-
            Total Credit position against this counterparty
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        totalPosition:
          description: Total Position computed as Total Credit Position minus of Total Debit Position (It could be negative)
          $ref: '#/components/schemas/StandardAmount'
      required:
        - counterpartyBIC
        - tresholdAmount
        - sumAmountDebitReceived
        - sumAmountReturnRefundReceived
        - sumAmountReversalSent
        - totalDebitPosition
        - sumAmountDebitSent
        - sumAmountReturnRefundSent
        - sumAmountReversalReceived
        - totalCreditPosition
        - totalPosition
    DedicatedCashAccount:
      description: DCA number
      type: string
      maxLength: 35
      examples:
        - '11123422244678888888887677800000005'
    DefaultThreshold:
      type: object
      properties:
        counterpartyBIC:
          description: |-
            The credit party BIC

             **Validation Rule(s)** It must be a credit party BIC of the sender BIC
            (errorCode XA07)
          $ref: '#/components/schemas/BIC8'
        thresholdAmount:
          description: |-
            The new threshold amount

             **Validation Rule(s)** Only decimal notation is allowed
            (errorCode XA05)
          $ref: '#/components/schemas/StandardAmount'
      required:
        - counterpartyBIC
        - thresholdAmount
    DefaultThresholds:
      type: object
      properties:
        counterpartyBIC:
          description: The BIC of the creditor party
          $ref: '#/components/schemas/BIC8'
        thresholdAmount:
          description: The threshold amount
          $ref: '#/components/schemas/StandardAmount'
        lastUserUpdate:
          description: The date and time of the last update
          $ref: '#/components/schemas/DateTime'
      required:
        - counterpartyBIC
        - thresholdAmount
        - lastUserUpdate
    DetailsHistory:
      type: object
      properties:
        name:
          description: The name of the DP
          $ref: '#/components/schemas/ParticipantName'
        BICCode:
          description: The BIC of the DP
          $ref: '#/components/schemas/BIC8'
        newDPBICCode:
          description: The new BIC of the DP, following a “Change BIC” operation
          $ref: '#/components/schemas/BIC8'
        newRole:
          description: |-
            The new role of the DP
            true= Role changed
            false= Role unchanged
          $ref: '#/components/schemas/GenericBoolean'
        initParticipantValidity:
          description: The first date starting from which the DP is active
          $ref: '#/components/schemas/Date'
        endParticipantValidity:
          description: The last date until which this DP is active
          $ref: '#/components/schemas/Date'
        ROnlyDate:
          description: The date starting from which the DP is updated as R-Only
          $ref: '#/components/schemas/Date'
        status:
          description: The status of the DP
          $ref: '#/components/schemas/ParticipantStatus'
        initParameterValidity:
          description: The first date starting from which the set of parameters is valid
          $ref: '#/components/schemas/Date'
        endParameterValidity:
          description: The last date until this set of parameters is valid
          $ref: '#/components/schemas/Date'
        DPSettlementBIC:
          description: The BIC by which this DP is known to the External Settlement Mechanism
          $ref: '#/components/schemas/Bic11Only'
        admissionProfile:
          description: |-
            The admission profile
            Possible values are:
            DEB = Debtor
            CAD = Creditor and Debtor
          $ref: '#/components/schemas/AdmissionProfile'
        settlementFile:
          description: The number of settlement files the DP is configured to receive
          $ref: '#/components/schemas/SettlementFile'
        deliverDebitsImm:
          description: |-
            The DP is configured to receive the debits immediately
            true= Deliver debits immediately
            false= No deliver debits immediately
            Set to true
          $ref: '#/components/schemas/GenericBoolean'
        MSRRequired:
          description: |-
            The DP is configured to receive an MSR
            true= MSR enabled
            false= MSR not enabled
          $ref: '#/components/schemas/GenericBoolean'
        defaultThresholdValue:
          description: The Default Threshold Value between the DP and each other enabled DP
          $ref: '#/components/schemas/StandardAmount'
        extendedPSR:
          description: |-
            The DP require to receive the liquidity information in the extended PSR file
            true= PSR enabled
            false= PSR not enabled
          $ref: '#/components/schemas/GenericBoolean'
        swiftNetOutputFileCompression:
          description: |-
            The DP is allowed to send/receive compressed files
            true= Compression enabled
            false= Compression not enabled
          $ref: '#/components/schemas/GenericBoolean'
        routingInfoChanged:
          description: |-
            The flag used to show if this DP was subject to a Routing Change operation
            true= Routing changed
            false= No routing changed
          $ref: '#/components/schemas/GenericBoolean'
        maxReceivingFileSize:
          description: The maximum number of bytes that a DP will accept for the size of each file received from STEP2 CS
          $ref: '#/components/schemas/StandardInteger'
        CAIUserGroup:
          description: |-
            Whether the DP adheres to CAI User Group
            true= CAI enabled
            false= CAI not enabled
          $ref: '#/components/schemas/GenericBoolean'
        ICMUserGroup:
          description: |-
            Whether the DP is configured for ICM
            true= configured for ICM
            false= not configured for ICM
          $ref: '#/components/schemas/GenericBoolean'
        batchProcessingMode:
          description: |-
            The DP adheres to Batch Processing Option
            true= Batch processing mode enabled
            false= Batch processing mode not enabled
          $ref: '#/components/schemas/GenericBoolean'
        technicalBIC:
          description: |-
            The technical BIC indicator
            true= Technical BIC
            false=No technical BIC
          $ref: '#/components/schemas/GenericBoolean'
        activeOutputNetwork:
          description: The currently active output network where the output files are sent by STEP2 to DP
          $ref: '#/components/schemas/ActiveOutputNetwork'
        priNetworkIdentification:
          description: The primary network through which the DP connects to STEP2
          $ref: '#/components/schemas/NetworkIdentification'
        secNetworkIdentification:
          description: The type of network used by the DP as “Secondary Network”
          $ref: '#/components/schemas/NetworkIdentification'
        priReceivingNetIdentification:
          description: The identifier by which the DP is known on the primary network when receiving files from STEP2 CS
          $ref: '#/components/schemas/NetworkIdentification'
        secReceivingNetIdentification:
          description: The identifier by which the DP is known on the secondary network, when receiving files from STEP2 CS
          $ref: '#/components/schemas/NetworkIdentification'
        priSendingNetIdentification:
          description: The identifier by which this DP is known on the primary network when sending files to STEP2 CS
          $ref: '#/components/schemas/NetworkIdentification'
        secSendingNetIdentification:
          description: The identifier by which the DP is known on the secondary network, when sending files from STEP2 CS
          $ref: '#/components/schemas/NetworkIdentification'
        debitProductsAllowed:
          description: The debit products allowed
          $ref: '#/components/schemas/ProductsAllowedString'
        T2RTGSAuthorisedAccountUserAAUForAS-D:
          description: Contain the BIC11 of the T2-RTGS DCA for settlement of STEP2 transactions. It must be declared at TARGET Level as Authorized Account User BIC of the T2-RTGS DCA used for AS-D
          $ref: '#/components/schemas/Bic11Only'
        T2RTGSAuthorisedAccountUserAAUForAS-E:
          description: The BIC11 of the T2-RTGS Dedicated Cash Account (DCA) for remuneration process.
          $ref: '#/components/schemas/Bic11Only'
        T2RTGSDedicatedCashAccountDCAForAS-D:
          description: T2-RTGS Dedicated Cash Account (DCA) used by a Participant for funding/defunding CGS position (with Ancillary System AS-D). It is the Account registered with STEP2 Settlement Bank Account Group (as registered in T2 CRDM Registration form).
          $ref: '#/components/schemas/DedicatedCashAccount'
        T2RTGSDedicatedCashAccountDCAForAS-E:
          description: T2-RTGS Dedicated Cash Account (DCA) used by a Participant for remuneration process (with Ancillary System AS-E).
          $ref: '#/components/schemas/DedicatedCashAccount'
      required:
        - T2RTGSAuthorisedAccountUserAAUForAS-D
        - T2RTGSDedicatedCashAccountDCAForAS-D
    DetailsHistory1:
      type: object
      properties:
        name:
          description: The name of the RB
          $ref: '#/components/schemas/ParticipantName'
        BICCode:
          description: The BIC of the RB
          $ref: '#/components/schemas/Bic11Only'
        newBICCode:
          description: The new BIC of the RB, following a “Change BIC” operation
          $ref: '#/components/schemas/Bic11Only'
        newRole:
          description: |-
            The new role of the RB
            true= Role changed
            false= Role unchanged
          $ref: '#/components/schemas/GenericBoolean'
        initParticipantValidity:
          description: The first date starting from which the RB is active
          $ref: '#/components/schemas/Date'
        endParticipantValidity:
          description: The last date until the RB is active
          $ref: '#/components/schemas/Date'
        ROnlyDate:
          description: The date starting from which the DP is updated as R-Only
          $ref: '#/components/schemas/Date'
        status:
          description: The current status of the RB
          $ref: '#/components/schemas/ParticipantStatus'
        initParameterValidity:
          description: The first date starting from which the set of parameters is valid
          $ref: '#/components/schemas/Date'
        endParameterValidity:
          description: The last date until this set of parameters is valid
          $ref: '#/components/schemas/Date'
        DPBICCode:
          description: The BIC of the DP
          $ref: '#/components/schemas/BIC8'
        admissionProfile:
          description: |-
            The admission profile.
            Possible values are:
            DEB = Debtor
            CAD = Creditor and Debtor
          $ref: '#/components/schemas/AdmissionProfile'
        routingInfoChanged:
          description: |-
            The flag used to show if this RB was subject to a Routing Change operation
            true= Role changed
            false= Role unchanged
          $ref: '#/components/schemas/GenericBoolean'
        CAIUserGroup:
          description: |-
            Whether the RB adheres to CAI
            true= CAI user group
            false= No CAI user group
          $ref: '#/components/schemas/GenericBoolean'
        ICMUserGroup:
          description: |-
            Whether the RB is configured for ICM
            true= configured for ICM
            false= not configured for ICM
          $ref: '#/components/schemas/GenericBoolean'
        debitProductsAllowed:
          description: The debit products allowed
          $ref: '#/components/schemas/ProductsAllowedString'
        sameBankingGroupAsDP:
          description: |-
            RB part of the same banking group as its DP
            true= RB part of the same banking group as its DP
            false= RB not part of the same banking group as its DP
          $ref: '#/components/schemas/GenericBoolean'
      required:
        - ICMUserGroup
    DirectParticipant:
      type: object
      properties:
        name:
          description: The name of the participant
          $ref: '#/components/schemas/ParticipantName'
        admissionProfile:
          description: The admission profile
          $ref: '#/components/schemas/AdmissionProfile'
        defaultThresholdValue:
          description: The default threshold value
          $ref: '#/components/schemas/StandardAmount'
        settlementFiles:
          description: The value set for settlement files
          $ref: '#/components/schemas/SettlementFile'
        MSRRequired:
          description: The value set for Receiving MSR parameter
          $ref: '#/components/schemas/GenericBoolean'
        extendedPSR:
          description: The value set for receiving Extended PSR  parameter
          $ref: '#/components/schemas/GenericBoolean'
        maxReceivingFileSize:
          description: The value set for Max Receiving File Size parameter
          $ref: '#/components/schemas/StandardInteger'
        batchProcessingMode:
          description: The value et for Batch Processing Mode parameter
          $ref: '#/components/schemas/GenericBoolean'
        CAIUserGroup:
          description: The value set for CAI adherence
          $ref: '#/components/schemas/GenericBoolean'
        swiftNetOutputFileCompression:
          description: The value set for Swiftnet Output File Compression parameter
          $ref: '#/components/schemas/GenericBoolean'
        technicalBIC:
          description: The value set for Technical BIC configuration
          $ref: '#/components/schemas/GenericBoolean'
        priNetworkIdentification:
          description: The primary network through which the DP connects to STEP2
          $ref: '#/components/schemas/NetworkIdentification1'
        secNetworkIdentification:
          description: The secondary network through which the DP connects to STEP2
          $ref: '#/components/schemas/NetworkIdentification1'
        priReceivingNetIdentification:
          description: The identifier by which the DP is known on the primary network when receiving files from STEP2 CS
          $ref: '#/components/schemas/NetworkIdentificationSendingReceiving'
        secReceivingNetIdentification:
          description: The identifier by which the DP is known on the secondary network, when receiving files from STEP2 CS
          $ref: '#/components/schemas/NetworkIdentificationSendingReceiving'
        priSendingNetIdentification:
          description: The identifier by which this DP is known on the primary network when sending files to STEP2 CS
          $ref: '#/components/schemas/NetworkIdentificationSendingReceiving'
        SecSendingNetIdentification:
          description: The identifier by which the DP is known on the secondary network, when sending files from STEP2 CS
          $ref: '#/components/schemas/NetworkIdentificationSendingReceiving'
        T2RTGSAuthorisedAccountUserAAUForAS-D:
          description: The BIC11 of the T2-RTGS DCA for settlement of STEP2 transactions. It must be declared at TARGET Level as Authorized Account User BIC of the T2-RTGS DCA used for AS-D.
          $ref: '#/components/schemas/Bic11Only'
        T2RTGSAuthorisedAccountUserAAUForAS-E:
          description: The BIC11 of the T2-RTGS Dedicated Cash Account (DCA) for remuneration process.
          $ref: '#/components/schemas/Bic11Only'
        T2RTGSDedicatedCashAccountDCAForAS-D:
          description: T2-RTGS Dedicated Cash Account (DCA) used by a Participant for funding/defunding CGS position (with Ancillary System AS-D). It is the Account registered with STEP2 Settlement Bank Account Group (as registered in T2 CRDM Registration form).
          $ref: '#/components/schemas/DedicatedCashAccount'
        T2RTGSDedicatedCashAccountDCAForAS-E:
          description: T2-RTGS Dedicated Cash Account (DCA) used by a Participant for remuneration process (with Ancillary System AS-E).
          $ref: '#/components/schemas/DedicatedCashAccount'
        productsAllowed:
          description: The identifiers of the products configured for the DP
          $ref: '#/components/schemas/ProductsAllowedString'
      required:
        - T2RTGSAuthorisedAccountUserAAUForAS-D
        - T2RTGSDedicatedCashAccountDCAForAS-D
    DMessage:
      type: object
      properties:
        fileType:
          description: The file type
          $ref: '#/components/schemas/FileTypeList'
        timestampLastUpdate:
          description: The timestamp of last update
          $ref: '#/components/schemas/DateTime'
        DPSendingBIC:
          description: The DP sending BIC
          $ref: '#/components/schemas/BIC8'
        DPReceivingBIC:
          description: The DP receiving BIC
          $ref: '#/components/schemas/BIC8'
        creditorBankBIC:
          description: The financial institution that receives the transaction from either the account owner or authorized party and processes the instructions
          $ref: '#/components/schemas/BIC11'
        debtorBankBIC:
          description: The financial institution that receives the transaction instruction on behalf of the account owner or other nominated party and applies the transaction to the account
          $ref: '#/components/schemas/BIC11'
        mandateId:
          description: The mandate ID of the debit mandate.
          $ref: '#/components/schemas/MandateId'
        creditorId:
          description: The Creditor ID of the debit creditor
          $ref: '#/components/schemas/CreditorId'
        interbankSettlementAmount:
          description: The quantity of cash that will be transferred for the individual Direct Debit between the instructing and instructed agent in the settlement instruction.
          $ref: '#/components/schemas/StandardAmount'
        transactionReferenceId:
          description: A reference assigned by the credit party to unambiguously identify the transaction instruction
          $ref: '#/components/schemas/TransactionId'
        interbankSettlementDate:
          description: Interbank settlement date of the transaction. Date in which the transaction status is changed to Settled (STD)
          $ref: '#/components/schemas/Date'
        repCollectionDate:
          description: The due date of the collection
          $ref: '#/components/schemas/Date'
        processingBusinessDate:
          description: STEP2 Processing business date of the debit
          $ref: '#/components/schemas/Date'
        notificationDate:
          description: The business date in which this DD will be notified to the debtor PSP
          $ref: '#/components/schemas/Date'
        transactionStatus:
          description: The status of transaction
          $ref: '#/components/schemas/TransactionStatus'
        sequenceType:
          description: The type of direct debit
          $ref: '#/components/schemas/Sequence'
        lac:
          description: |-
            The LAC received from the CGS when the transaction closed its life-cycle
            Not available for rejected transactions
          $ref: '#/components/schemas/Lac'
        debitProduct:
          description: The debit product
          $ref: '#/components/schemas/DebitProduct'
        fileReference:
          description: The reference of file
          $ref: '#/components/schemas/FileReference'
        routingType:
          description: The routing applied by the STEP2 central system to deliver this transaction
          $ref: '#/components/schemas/RoutingType'
        DNFBulkReference:
          description: The bulk reference of the DNF file, which included this transaction
          $ref: '#/components/schemas/BulkReference'
        originalFileReference:
          description: The original file reference, which included this transaction
          $ref: '#/components/schemas/FileReference'
        bulkReference:
          description: The reference of the bulk, which included this transaction
          $ref: '#/components/schemas/BulkReference'
        settlementInstReference:
          description: The reference of the settlement instruction used to settle this transaction instruction; this field will be non-empty if the Transaction Status field is “Settling”, “Settled”, “Cancelled” or “Waiting for Resubmission”
          $ref: '#/components/schemas/FileReference'
        bulkType:
          description: The type of bulk
          $ref: '#/components/schemas/BulkType'
        debitMandateFlowIndicator:
          description: Whether this debit has a DMF
          $ref: '#/components/schemas/FlowIndicator'
        DVFReference:
          description: The relevant DVF file reference related to this transaction
          $ref: '#/components/schemas/FileReference'
        debtorRSFReference:
          description: The relevant debtor RSF reference of this transaction
          $ref: '#/components/schemas/BulkReference'
        DVFBulkReference:
          description: The bulk reference of the DVF file
          $ref: '#/components/schemas/BulkReference'
        creditorRSFReference:
          description: The relevant creditor RSF reference of this transaction.
          $ref: '#/components/schemas/BulkReference'
        LCRReference:
          description: The reference of the LCR which included this transaction
          $ref: '#/components/schemas/LcrReference'
        endToEndId:
          description: 'The end to end identifier: it is always returned as “collapsed”'
          $ref: '#/components/schemas/EndToEnd'
      required:
        - fileType
        - timestampLastUpdate
        - DPSendingBIC
        - DPReceivingBIC
        - creditorBankBIC
        - debtorBankBIC
        - mandateId
        - creditorId
        - interbankSettlementAmount
        - transactionReferenceId
        - interbankSettlementDate
        - repCollectionDate
        - processingBusinessDate
        - notificationDate
        - transactionStatus
        - fileReference
        - routingType
        - originalFileReference
        - bulkReference
        - settlementInstReference
        - bulkType
        - debitMandateFlowIndicator
        - DVFReference
        - DVFBulkReference
        - endToEndId
    DPRBOperation:
      description: Whether the operation is referred to a DP or an RB
      type: string
      enum:
        - DIR
        - IND
      examples:
        - DIR
    EndOfList:
      description: End of list indicator.
      type: boolean
      examples:
        - true
    EndToEnd:
      description: Transaction reference.
      type: string
      maxLength: 35
      examples:
        - END2ENDNSEF135000000000000000000123
    ErrorCode:
      description: Error code.
      type: string
      pattern: '[A-Za-z0-9]{4,4}'
      examples:
        - AX01
    ErrorCodeDescription:
      description: Message.
      type: string
      maxLength: 255
      examples:
        - Transaction rejected
    ErrorResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        errorCode:
          description: The relevant error code
          $ref: '#/components/schemas/ErrorCode'
        errorCodeDescription:
          description: The description of the error
          $ref: '#/components/schemas/ErrorCodeDescription'
        requestId:
          description: The univocal reference per senderBIC and date assigned by the system to the API request
          $ref: '#/components/schemas/RequestId'
      required:
        - dateTime
        - errorCode
        - errorCodeDescription
    EventDescription:
      description: Event description.
      type: string
      maxLength: 150
      examples:
        - INDIRECT PARTICIPANT INPART001 IS NOT PRESENT
    EventType:
      description: Event type.
      type: string
      enum:
        - SEC
        - FTL
        - ERR
        - WRN
        - NOR
      examples:
        - WRN
    FileDetailsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        fileRef:
          $ref: '#/components/schemas/FileRef'
      required:
        - dateTime
        - fileRef
    FileDetailsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        fileDNF:
          description: The information related to the Debit Notification File
          $ref: '#/components/schemas/FileDNF'
        fileDRR:
          description: The information related to the Daily Reconciliation Report
          $ref: '#/components/schemas/FileDRR'
        fileDVF:
          description: The information related to the Direct Debit Validation File
          $ref: '#/components/schemas/FileDVF'
        fileIDF:
          description: The information related to the Input Direct Debit File
          $ref: '#/components/schemas/FileIDF'
        fileMSR:
          description: The information related to the Monthly Statistical Report
          $ref: '#/components/schemas/FileDRR'
        filePSR:
          description: The information related to the Pre-Settlement Report File
          $ref: '#/components/schemas/FilePSR'
        fileRSF:
          description: The information related to the Results of Settlement File
          $ref: '#/components/schemas/FileRSF'
        fileRTF:
          description: The information related to the Routing Table File
          $ref: '#/components/schemas/FileDRR'
        fileIGF:
          description: The information related to Input Get File
          $ref: '#/components/schemas/FileIGF'
        fileOGF:
          $ref: '#/components/schemas/FileOGF'
      required:
        - dateTime
    FileDNF:
      type: object
      properties:
        fileType:
          description: The file type
          $ref: '#/components/schemas/FileType1'
        receiverBIC:
          description: The BIC of the receiving DP
          $ref: '#/components/schemas/BIC8'
        businessDate:
          description: The business date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        calendarDate:
          description: The calendar date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        fileReference:
          description: The reference of file
          $ref: '#/components/schemas/FileReference'
        dateTime:
          description: The Date and Time of the creation of the file
          $ref: '#/components/schemas/DateTime'
        networkFileName:
          description: The network file name of the file
          $ref: '#/components/schemas/NetworkFileName'
        network:
          description: The network from which the file is received or sent
          $ref: '#/components/schemas/Network1'
        fileStatus:
          description: The status of the file
          $ref: '#/components/schemas/FileStatus'
        lastStatusUpdated:
          description: The last status update date and time
          $ref: '#/components/schemas/DateTime'
        totNumBulks:
          description: The total number of bulk contained
          $ref: '#/components/schemas/StandardInteger'
        numDebitsContained:
          description: The number of Debits contained
          $ref: '#/components/schemas/StandardInteger'
        valDebitsContained:
          description: The value of Debits contained
          $ref: '#/components/schemas/StandardAmount'
        numReturnsContained:
          description: The number of Returns contained
          $ref: '#/components/schemas/StandardInteger'
        valReturnsContained:
          description: The value of Returns contained
          $ref: '#/components/schemas/StandardAmount'
        numPCRContained:
          description: The number of PCR contained
          $ref: '#/components/schemas/StandardInteger'
        valPCRContained:
          description: The value of PCR contained
          $ref: '#/components/schemas/StandardAmount'
        numReversalContained:
          description: The number of Reversal contained
          $ref: '#/components/schemas/StandardInteger'
        valReversalContained:
          description: The value of Reversal contained
          $ref: '#/components/schemas/StandardAmount'
        numRejectsContained:
          description: The number of Rejects contained
          $ref: '#/components/schemas/StandardInteger'
        valRejectsContained:
          description: The value of Rejects contained
          $ref: '#/components/schemas/StandardAmount'
      required:
        - fileType
        - receiverBIC
        - businessDate
        - calendarDate
        - fileReference
        - dateTime
        - networkFileName
        - network
        - fileStatus
        - lastStatusUpdated
        - totNumBulks
        - numDebitsContained
        - valDebitsContained
        - numReturnsContained
        - valReturnsContained
        - numPCRContained
        - valPCRContained
        - numReversalContained
        - valReversalContained
        - numRejectsContained
        - valRejectsContained
    FileDRR:
      type: object
      properties:
        fileType:
          description: The type of file
          $ref: '#/components/schemas/FileType1'
        receiverBIC:
          description: The BIC of the receiving DP
          $ref: '#/components/schemas/BIC8'
        businessDate:
          description: The business date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        calendarDate:
          description: The calendar date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        fileReference:
          description: The reference of file
          $ref: '#/components/schemas/FileReference'
        dateTime:
          description: The Date and Time of the creation of the file
          $ref: '#/components/schemas/DateTime'
        networkFileName:
          description: The network file name of the file
          $ref: '#/components/schemas/NetworkFileName'
        network:
          description: The network from which the file is received
          $ref: '#/components/schemas/Network1'
        fileStatus:
          description: The file status
          $ref: '#/components/schemas/FileStatus'
        lastStatusUpdated:
          description: The last status update date and time
          $ref: '#/components/schemas/DateTime'
      required:
        - fileType
        - receiverBIC
        - businessDate
        - calendarDate
        - fileReference
        - dateTime
        - networkFileName
        - network
        - fileStatus
        - lastStatusUpdated
    FileDVF:
      type: object
      properties:
        fileType:
          description: The file type
          $ref: '#/components/schemas/FileType1'
        receiverBIC:
          description: The BIC of the receiving DP
          $ref: '#/components/schemas/BIC8'
        businessDate:
          description: The business date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        calendarDate:
          description: The calendar date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        fileReference:
          description: The reference of file
          $ref: '#/components/schemas/FileReference'
        dateTime:
          description: The Date and Time of the reception of the file
          $ref: '#/components/schemas/DateTime'
        networkFileName:
          description: The network file name of the file
          $ref: '#/components/schemas/NetworkFileName'
        network:
          description: The network from which the file is sent
          $ref: '#/components/schemas/Network1'
        fileStatus:
          description: The file status
          $ref: '#/components/schemas/FileStatus'
        reasonCode:
          description: The validation reason code associated to the file
          $ref: '#/components/schemas/ReasonCode'
        lastStatusUpdated:
          description: The last status update date and time
          $ref: '#/components/schemas/DateTime'
        IDFFileRefeference:
          description: The File Reference of the IDF
          $ref: '#/components/schemas/FileReference'
        IDFNetworkFileName:
          description: The network file name of the IDF
          $ref: '#/components/schemas/NetworkFileName'
        numBulksAccepted:
          description: The number of bulk accepted
          $ref: '#/components/schemas/StandardInteger'
        numBulksRejected:
          description: The number of bulk rejected
          $ref: '#/components/schemas/StandardInteger'
        numDebitsAccepted:
          description: The number of Debits accepted
          $ref: '#/components/schemas/StandardInteger'
        valDebitsAccepted:
          description: The value of Debits accepted
          $ref: '#/components/schemas/StandardAmount'
        numDebitsRejected:
          description: The number of Debits rejected
          $ref: '#/components/schemas/StandardInteger'
        valDebitsRejected:
          description: The value of Debits rejected
          $ref: '#/components/schemas/StandardAmount'
        numReturnsAccepted:
          description: The number of Returns accepted
          $ref: '#/components/schemas/StandardInteger'
        valReturnsAccepted:
          description: The value of Returns accepted
          $ref: '#/components/schemas/StandardAmount'
        numReturnsRejected:
          description: The number of Returns rejected
          $ref: '#/components/schemas/StandardInteger'
        valReturnsRejected:
          description: The value of Returns rejected
          $ref: '#/components/schemas/StandardAmount'
        numPCRAccepted:
          description: The number of PCR accepted
          $ref: '#/components/schemas/StandardInteger'
        valPCRAccepted:
          description: The value of PCR accepted
          $ref: '#/components/schemas/StandardAmount'
        numPCRRejected:
          description: The number of PCR rejected
          $ref: '#/components/schemas/StandardInteger'
        valPCRRejected:
          description: The value of PCR rejected
          $ref: '#/components/schemas/StandardAmount'
        numReversalAccepted:
          description: The number of Reversal accepted
          $ref: '#/components/schemas/StandardInteger'
        valReversalAccepted:
          description: The value of Reversal accepted
          $ref: '#/components/schemas/StandardAmount'
        numReversalRejected:
          description: The number Reversal rejected
          $ref: '#/components/schemas/StandardInteger'
        valReversalRejected:
          description: The value of Reversal rejected
          $ref: '#/components/schemas/StandardAmount'
        numRejectsAccepted:
          description: The number of Rejects validated
          $ref: '#/components/schemas/StandardInteger'
        valRejectsAccepted:
          description: The value of Rejects accepted
          $ref: '#/components/schemas/StandardAmount'
        numRejectsRejected:
          description: The number of Rejects rejected
          $ref: '#/components/schemas/StandardInteger'
        valRejectsRejected:
          description: The value of Rejects rejected
          $ref: '#/components/schemas/StandardAmount'
      required:
        - fileType
        - receiverBIC
        - businessDate
        - calendarDate
        - fileReference
        - dateTime
        - networkFileName
        - network
        - fileStatus
        - reasonCode
        - lastStatusUpdated
        - IDFFileRefeference
        - IDFNetworkFileName
        - numBulksAccepted
        - numBulksRejected
        - numDebitsAccepted
        - valDebitsAccepted
        - numDebitsRejected
        - valDebitsRejected
        - numReturnsAccepted
        - valReturnsAccepted
        - numReturnsRejected
        - valReturnsRejected
        - numPCRAccepted
        - valPCRAccepted
        - numPCRRejected
        - valPCRRejected
        - numReversalAccepted
        - valReversalAccepted
        - numReversalRejected
        - valReversalRejected
        - numRejectsAccepted
        - valRejectsAccepted
        - numRejectsRejected
        - valRejectsRejected
    FileIDF:
      type: object
      properties:
        fileType:
          description: The type of file
          $ref: '#/components/schemas/FileType1'
        senderBIC:
          description: The BIC of the sending DP
          $ref: '#/components/schemas/BIC8'
        businessDate:
          description: The business date when the file was received by the Central System
          $ref: '#/components/schemas/Date'
        calendarDate:
          description: The calendar date when the file was received by the Central System
          $ref: '#/components/schemas/Date'
        fileReference:
          description: |-
            The reference of file
            Not present in case of IDF rejected with error code “R10”
          $ref: '#/components/schemas/FileReference'
        dateTime:
          description: The Date and Time of the reception of the file
          $ref: '#/components/schemas/DateTime'
        networkFileName:
          description: The network file name of the file
          $ref: '#/components/schemas/NetworkFileName'
        network:
          description: The network from which the file is received or sent
          $ref: '#/components/schemas/Network1'
        fileStatus:
          description: The file status
          $ref: '#/components/schemas/FileStatus'
        reasonCode:
          description: The validation reason code
          $ref: '#/components/schemas/ReasonCode'
        processingTime:
          description: The validation reason code The date and time at which the file was processed
          $ref: '#/components/schemas/DateTime'
        DVFFileReference:
          description: The file reference of the DVF
          $ref: '#/components/schemas/FileReference'
        DVFNetworkFileName:
          description: The network file name of the DVF
          $ref: '#/components/schemas/NetworkFileName'
        numBulksContained:
          description: The number of bulk validated
          $ref: '#/components/schemas/StandardInteger'
        numBulksRejected:
          description: The number of bulk rejected
          $ref: '#/components/schemas/StandardInteger'
        numDebitsContained:
          description: The number of Debits Contained
          $ref: '#/components/schemas/StandardInteger'
        valDebitsContained:
          description: The value of Debits Contained
          $ref: '#/components/schemas/StandardAmount'
        numDebitsRejected:
          description: The number of Debits rejected
          $ref: '#/components/schemas/StandardInteger'
        valDebitsRejected:
          description: The value of Debits rejected
          $ref: '#/components/schemas/StandardAmount'
        numReturnsContained:
          description: The number of Returns contained
          $ref: '#/components/schemas/StandardInteger'
        valReturnsContained:
          description: The value of Returns validated
          $ref: '#/components/schemas/StandardAmount'
        numReturnsRejected:
          description: The number of Returns rejected
          $ref: '#/components/schemas/StandardInteger'
        valReturnsRejected:
          description: The value of Returns rejected
          $ref: '#/components/schemas/StandardAmount'
        numPCRContained:
          description: The number of PCR contained
          $ref: '#/components/schemas/StandardInteger'
        valPCRContained:
          description: The value of PCR contained
          $ref: '#/components/schemas/StandardAmount'
        numPCRRejected:
          description: The number of PCR rejected
          $ref: '#/components/schemas/StandardInteger'
        valPCRRejected:
          description: The value of PCR rejected
          $ref: '#/components/schemas/StandardAmount'
        numReversalContained:
          description: The number of Reversal contained
          $ref: '#/components/schemas/StandardInteger'
        valReversalContained:
          description: The value of Reversal contained
          $ref: '#/components/schemas/StandardAmount'
        numReversalRejected:
          description: The number Reversal rejected
          $ref: '#/components/schemas/StandardInteger'
        valReversalRejected:
          description: The value of Reversal rejected
          $ref: '#/components/schemas/StandardAmount'
        numRejectsContained:
          description: The number of Rejects contained
          $ref: '#/components/schemas/StandardInteger'
        valRejectsContained:
          description: The value of Rejects contained
          $ref: '#/components/schemas/StandardAmount'
        numRejectsRejected:
          description: The number Rejects rejected
          $ref: '#/components/schemas/StandardInteger'
        valRejectsRejected:
          description: The value of Rejects rejected
          $ref: '#/components/schemas/StandardAmount'
      required:
        - fileType
        - senderBIC
        - businessDate
        - calendarDate
        - dateTime
        - networkFileName
        - network
        - fileStatus
        - reasonCode
        - processingTime
        - DVFFileReference
        - DVFNetworkFileName
        - numBulksContained
        - numBulksRejected
        - numDebitsContained
        - valDebitsContained
        - numDebitsRejected
        - valDebitsRejected
        - numReturnsContained
        - valReturnsContained
        - numReturnsRejected
        - valReturnsRejected
        - numPCRContained
        - valPCRContained
        - numPCRRejected
        - valPCRRejected
        - numReversalContained
        - valReversalContained
        - numReversalRejected
        - valReversalRejected
        - numRejectsContained
        - valRejectsContained
        - numRejectsRejected
        - valRejectsRejected
    FileIGF:
      type: object
      properties:
        fileType:
          description: The relevant file type - set to IGF
          $ref: '#/components/schemas/FileType1'
        senderBIC:
          description: The BIC of the DP sending the file
          $ref: '#/components/schemas/BIC8'
        businessDate:
          description: The business date of file’s processing
          $ref: '#/components/schemas/Date'
        calendarDate:
          description: The calendar date of file’s processing
          $ref: '#/components/schemas/Date'
        IGFFileRef:
          description: The DP-generated Sender’s File Reference for this file
          $ref: '#/components/schemas/FileReference'
        dateTime:
          description: The date & time when the file was received by STEP2 Central System
          $ref: '#/components/schemas/DateTime'
        IGFNetworkFileName:
          description: The name of this file as it crossed the network
          $ref: '#/components/schemas/NetworkFileName'
        network:
          description: The Network from which the file IGF is received by STEP2
          $ref: '#/components/schemas/Network1'
        fileStatus:
          description: |-
            The Status of the IGF. Possible values are:
            RCV  - Received;  the file was received from the network;
            VAL  - Accepted: the file has been validated and at least one transaction was accepted; or
            RJT – Rejected: the file was entirely rejected.
          $ref: '#/components/schemas/FileStatus'
        reasonCode:
          description: The Reason Code associated to file, resulting from the validation process
          $ref: '#/components/schemas/ReasonCode'
        processingTime:
          description: The date and time at which the file was processed
          $ref: '#/components/schemas/DateTime'
        OGFFileRef:
          description: The File Reference of the related OGF for this file
          $ref: '#/components/schemas/FileReference'
        OGFNetworkFileName:
          description: The name of the related OGF of this file as it crossed the network
          $ref: '#/components/schemas/NetworkFileName'
        numGetAccountValidated:
          description: The total number of Get Account validated in this file
          $ref: '#/components/schemas/StandardInteger'
        numGetAccountRejected:
          description: The total number of Get Account rejected in this file
          $ref: '#/components/schemas/StandardInteger'
        numGetTransactionValidated:
          description: The total number of Get Transaction validated in this file
          $ref: '#/components/schemas/StandardInteger'
        numGetTransactionRejected:
          description: The total number of Get Transaction rejected in this file
          $ref: '#/components/schemas/StandardInteger'
      required:
        - fileType
        - senderBIC
        - businessDate
        - calendarDate
        - IGFFileRef
        - dateTime
        - IGFNetworkFileName
        - network
        - fileStatus
        - reasonCode
        - processingTime
        - OGFFileRef
        - OGFNetworkFileName
    FileOGF:
      type: object
      properties:
        fileType:
          description: The relevant file type - set to OGF
          $ref: '#/components/schemas/FileType1'
        receiverBIC:
          description: The BIC of the DP receiving this file
          $ref: '#/components/schemas/BIC8'
        businessDate:
          description: The Business Date related to File’s generation
          $ref: '#/components/schemas/Date'
        calendarDate:
          description: The Calendar Date related to File’s generation
          $ref: '#/components/schemas/Date'
        OGFFileRef:
          description: The reference of the file generated by STEP2
          $ref: '#/components/schemas/FileReference'
        dateTime:
          description: The date & time when the file was sent by STEP2 Central System
          $ref: '#/components/schemas/DateTime'
        OGFNetworkFileName:
          description: The name of this file as it crossed the network
          $ref: '#/components/schemas/NetworkFileName'
        network:
          description: The network through which the file is sent to the DP by STEP2
          $ref: '#/components/schemas/Network1'
        fileStatus:
          description: |-
            The Status of the File. Possible values are:
            TSG - Transmitting: the  file has been created and not yet sent, or it’s in the process of being transmitted
            TSD – Transmitted: the file has been sent; or
            ERR - Error:  the file has not been positively sent;
            RNS – Retransmitted: the file has been retransmitted
          $ref: '#/components/schemas/FileStatus'
        reasonCode:
          description: The Reason code of the file resulting from the validation process
          $ref: '#/components/schemas/ReasonCode'
        lastStatusUpdated:
          description: The last update of the status of the file
          $ref: '#/components/schemas/DateTime'
        IGFFileRef:
          description: The reference of the IGF file related to this OGF
          $ref: '#/components/schemas/FileReference'
        IGFNetworkFileName:
          description: The network file name of IGF file related to this OGF
          $ref: '#/components/schemas/NetworkFileName'
        numGetAccountValidated:
          description: The total number of Get Account validated in this file
          $ref: '#/components/schemas/StandardInteger'
        numGetAccountRejected:
          description: The total number of Get Account rejected in this file
          $ref: '#/components/schemas/StandardInteger'
        numGetTransactionValidated:
          description: The total number of Get Transaction validated in this file
          $ref: '#/components/schemas/StandardInteger'
        numGetTransactionRejected:
          description: The total number of Get Transaction rejected in this file
          $ref: '#/components/schemas/StandardInteger'
      required:
        - fileType
        - receiverBIC
        - businessDate
        - calendarDate
        - OGFFileRef
        - dateTime
        - OGFNetworkFileName
        - network
        - fileStatus
        - reasonCode
        - lastStatusUpdated
        - IGFNetworkFileName
    FilePSR:
      type: object
      properties:
        fileType:
          description: The type of file
          $ref: '#/components/schemas/FileType1'
        receiverBIC:
          description: The BIC of the receiving DP
          $ref: '#/components/schemas/BIC8'
        businessDate:
          description: The business date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        calendarDate:
          description: The calendar date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        lac:
          description: The LAC to which the file is related
          $ref: '#/components/schemas/Lac'
        fileReference:
          description: The reference of file
          $ref: '#/components/schemas/FileReference'
        dateTime:
          description: The Date and Time of the creation of the file
          $ref: '#/components/schemas/DateTime'
        networkFileName:
          description: The network file name of the file
          $ref: '#/components/schemas/NetworkFileName'
        network:
          description: The network from which the file is received or sent
          $ref: '#/components/schemas/Network1'
        fileStatus:
          description: The file status
          $ref: '#/components/schemas/FileStatus'
        lastStatusUpdated:
          description: The last status update date and time
          $ref: '#/components/schemas/DateTime'
      required:
        - fileType
        - receiverBIC
        - businessDate
        - calendarDate
        - fileReference
        - dateTime
        - networkFileName
        - network
        - fileStatus
        - lastStatusUpdated
    FileRef:
      type: object
      properties:
        fileType:
          description: |-
            The file type

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/FileType1'
        fileStatus:
          description: |-
            The status of the file

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/FileStatus'
        fileReference:
          description: The file reference
          $ref: '#/components/schemas/FileReference'
        dateTime:
          description: The date and time of the creation/reception of the file
          $ref: '#/components/schemas/DateTime'
        networkFileName:
          description: The network file name
          $ref: '#/components/schemas/NetworkFileName'
      required:
        - fileReference
        - networkFileName
    FileRef1:
      type: object
      properties:
        fileType:
          description: |-
            The type of the file to be retransmitted

             **Validation Rule(s)** It can be set only with a configured value in the system
            (errorCode SC01)
            The values “IDF” and "IGF" cannot be used
            (error Code XA07)
          $ref: '#/components/schemas/FileType1'
        networkFileName:
          description: The network file name of the file to be retransmitted
          $ref: '#/components/schemas/NetworkFileName'
      required:
        - fileType
        - networkFileName
    FileReference:
      description: Sender's File Reference for the file. Generated by the sending DP for ICFs and by the STEP2 central system for all others files.
      type: string
      pattern: '[0-9A-Z]{16,16}'
      examples:
        - TESTFILEREF01234
    FileRSF:
      type: object
      properties:
        fileType:
          description: The type of file
          $ref: '#/components/schemas/FileType1'
        receiverBIC:
          description: The BIC of the receiving DP
          $ref: '#/components/schemas/BIC8'
        businessDate:
          description: The business date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        calendarDate:
          description: The calendar date when the file was sent by the Central System
          $ref: '#/components/schemas/Date'
        lac:
          description: The LAC to which the file is related
          $ref: '#/components/schemas/Lac'
        fileReference:
          description: The reference of file
          $ref: '#/components/schemas/FileReference'
        dateTime:
          description: The Date and Time of the creation of the file
          $ref: '#/components/schemas/DateTime'
        networkFileName:
          description: The network file name of the file
          $ref: '#/components/schemas/NetworkFileName'
        network:
          description: The network from which the file is received or sent
          $ref: '#/components/schemas/Network1'
        fileStatus:
          description: The status of the file.
          $ref: '#/components/schemas/FileStatus'
        lastStatusUpdated:
          description: The last status update date and time
          $ref: '#/components/schemas/DateTime'
        totNumBulks:
          description: The number of bulk contained
          $ref: '#/components/schemas/StandardInteger'
        numDebitsSettled:
          description: The number of Debits settled
          $ref: '#/components/schemas/StandardInteger'
        valDebitsSettled:
          description: The value of Debits settled
          $ref: '#/components/schemas/StandardAmount'
        numDebitsCancelled:
          description: The number of Debits cancelled
          $ref: '#/components/schemas/StandardInteger'
        valDebitsCancelled:
          description: The value of Debits cancelled
          $ref: '#/components/schemas/StandardAmount'
        numReturnsSettled:
          description: The number of Returns settled
          $ref: '#/components/schemas/StandardInteger'
        valReturnsSettled:
          description: The value of Returns settled
          $ref: '#/components/schemas/StandardAmount'
        numReturnsCancelled:
          description: The number of Returns cancelled
          $ref: '#/components/schemas/StandardInteger'
        valReturnsCancelled:
          description: The value of Returns cancelled
          $ref: '#/components/schemas/StandardAmount'
        numReversalSettled:
          description: The number of Reversal settled
          $ref: '#/components/schemas/StandardInteger'
        valReversalSettled:
          description: The value of Reversal settled
          $ref: '#/components/schemas/StandardAmount'
        numReversalCancelled:
          description: The number of Reversal cancelled
          $ref: '#/components/schemas/StandardInteger'
        valReversalCancelled:
          description: The value of Reversal cancelled
          $ref: '#/components/schemas/StandardAmount'
      required:
        - fileType
        - receiverBIC
        - businessDate
        - calendarDate
        - fileReference
        - dateTime
        - networkFileName
        - network
        - fileStatus
        - lastStatusUpdated
        - totNumBulks
        - numDebitsSettled
        - valDebitsSettled
        - numDebitsCancelled
        - valDebitsCancelled
        - numReturnsSettled
        - valReturnsSettled
        - numReturnsCancelled
        - valReturnsCancelled
        - numReversalSettled
        - valReversalSettled
        - numReversalCancelled
        - valReversalCancelled
    Files:
      type: object
      properties:
        fileType:
          description: The file type
          $ref: '#/components/schemas/FileType1'
        fileReference:
          description: The reference of the file
          $ref: '#/components/schemas/FileReference'
        lac:
          description: |-
            The relevant LAC
            Available for “RSF”, “PSR” Output files only, if the DP is configured for settling in CGS
          $ref: '#/components/schemas/Lac'
        dateTime:
          description: The date time in which the file was created/received by the CS
          $ref: '#/components/schemas/DateTime'
        date:
          description: The business or calendar date  when the file was sent/received by the Central System
          $ref: '#/components/schemas/Date'
        fileStatus:
          description: The status of the file
          $ref: '#/components/schemas/FileStatus'
        reasonCode:
          description: The reason code associated to the file
          $ref: '#/components/schemas/ReasonCode'
        originalFileRef:
          description: |-
            The original file reference
            This criterion is only relevant for “IDF”/"IGF" and “DVF”/"OGF" files.
            If the retrieved fileType is equal to “IDF”/"IGF" this field contains the relevant “DVF”/"OGF" file reference to which this file relates.
            If the retrieved fileType is equal to “DVF”/"OGF" this field contains the Sender’s File Reference of the “IDF”/"IGF" to which this file relates.
          $ref: '#/components/schemas/FileReference'
        networkFileName:
          description: The network file name
          $ref: '#/components/schemas/NetworkFileName'
        network:
          description: The network from which the file is received or sent
          $ref: '#/components/schemas/Network1'
        numBulks:
          description: The number of bulks included in the file
          $ref: '#/components/schemas/StandardInteger'
        numTransactions:
          description: The number of transactions included in the file
          $ref: '#/components/schemas/StandardInteger'
        numMessages:
          description: The number of messages included in the file. Applicable only to IGF and OGF
          $ref: '#/components/schemas/StandardInteger'
      required:
        - fileType
        - dateTime
        - date
        - fileStatus
        - networkFileName
        - network
    FileStatus:
      description: Status of the file.
      type: string
      enum:
        - VAL
        - RJT
        - RCV
        - DEF
        - TSD
        - TSG
        - ERR
        - RNS
      examples:
        - TSD
    FileType:
      description: The type of File.
      type: string
      enum:
        - IDF
        - DVF
        - DNF
        - RSF
        - DRR
        - MSR
        - PSR
        - RTF
      examples:
        - IDF
    FileType1:
      description: The type of File.
      type: string
      enum:
        - IDF
        - DVF
        - DNF
        - RSF
        - DRR
        - MSR
        - PSR
        - RTF
        - IGF
        - OGF
      examples:
        - IDF
    FileTypeList:
      description: The type of File.
      type: string
      enum:
        - IDF
        - DVF
        - DNF
        - RSF
      examples:
        - IDF
    FlowIndicator:
      description: Flow Indicator.
      type: string
      enum:
        - N
        - Y
      examples:
        - Y
    GenericBoolean:
      description: True or False indicator.
      type: boolean
      examples:
        - true
    GetAccountDetails:
      type: object
      properties:
        settlementBIC:
          description: The settlement BIC for which the position is enquired
          $ref: '#/components/schemas/BIC11Only'
      required:
        - settlementBIC
    GetMessageReasonCode:
      description: Get Message Reason Code
      type: string
      maxLength: 4
      examples:
        - GMRC
    GetMessageRef:
      description: Message reference
      type: string
      examples:
        - MSGREF0000011111
    GetMessageStatus:
      description: Get Message Status
      type: string
      enum:
        - VAL
        - RJS
        - RCV
        - TSD
        - TSG
        - ERR
      examples:
        - VAL
    GetMessageType:
      description: Get Message Type
      type: string
      enum:
        - Camt.003
        - Camt.004
        - Camt.005
        - Camt.006
      examples:
        - Camt.003
    GetTransaction:
      type: object
      properties:
        referenceLCR:
          description: The reference of the relevant LCR
          $ref: '#/components/schemas/FileReference'
    Header:
      type: object
      properties:
        interbankSettlementDate:
          description: The Interbank Settlement Date to which the information are related
          $ref: '#/components/schemas/Date'
        lac:
          description: |-
            The Liquidity Adjustment checkpoint to which the information are related
            Not available for LCRs that have not yet closed their life-cycle
          $ref: '#/components/schemas/Lac'
        DPBICCode:
          description: The Debit party BIC
          $ref: '#/components/schemas/BIC8'
        totalPosition:
          description: 'The total amount position against the system to be settled in CGS (It could be negative: if negative it will have the minus sign before the amount)'
          $ref: '#/components/schemas/StandardAmount'
      required:
        - interbankSettlementDate
        - DPBICCode
        - totalPosition
    IndParticipant:
      type: object
      properties:
        name:
          description: The name of the RB
          $ref: '#/components/schemas/ParticipantName'
        BICCode:
          description: The BIC of the RB
          $ref: '#/components/schemas/Bic11Only'
        initParticipantValidity:
          description: The first date starting from which the RB is active
          $ref: '#/components/schemas/Date'
        endParticipantValidity:
          description: The last date until which this RB is active
          $ref: '#/components/schemas/Date'
        DPBICCode:
          description: The BIC of the RB
          $ref: '#/components/schemas/BIC8'
        ROnlyDate:
          description: The date starting from which the RB is updated as R-Only
          $ref: '#/components/schemas/Date'
        currentStatus:
          description: The current status of the RB
          $ref: '#/components/schemas/ParticipantStatus'
        parModHistory:
          type: array
          items:
            $ref: '#/components/schemas/ParModHistory1'
        detailsHistory:
          type: array
          items:
            $ref: '#/components/schemas/DetailsHistory1'
      required:
        - BICCode
        - name
        - initParticipantValidity
        - endParticipantValidity
        - DPBICCode
        - ROnlyDate
        - currentStatus
    IndParticipantRef:
      type: object
      properties:
        BICCode:
          description: |-
            The enquired RB

             **Validation Rule(s)** It must correspond to an RB linked to the senderBIC
            (errorCode PY01)
          $ref: '#/components/schemas/Bic11Only'
      required:
        - BICCode
    IndParticipants:
      type: object
      properties:
        name:
          description: The name of the RB
          $ref: '#/components/schemas/ParticipantName'
        BICCode:
          description: The BIC of the RB
          $ref: '#/components/schemas/Bic11Only'
        initValidity:
          description: The Initial validity date of the RB
          $ref: '#/components/schemas/Date'
        endValidity:
          description: The end validity date of the RB
          $ref: '#/components/schemas/Date'
        ROnlyDate:
          description: The date starting from which the RB is updated as R-Only
          $ref: '#/components/schemas/Date'
        status:
          description: The status of the RB
          $ref: '#/components/schemas/ParticipantStatus'
        newBIC:
          description: The new BIC of the RB, following a “Change BIC” operation
          $ref: '#/components/schemas/Bic11Only'
        newRole:
          description: |-
            Whether the RB changed role after a "Change Role" provisioning action. Possible values:
            true= Role changed
            false= Role unchanged
          $ref: '#/components/schemas/GenericBoolean'
        DPBICCode:
          description: The BIC of the DP
          $ref: '#/components/schemas/BIC8'
      required:
        - BICCode
        - name
        - initValidity
        - endValidity
        - ROnlyDate
        - status
        - newRole
        - DPBICCode
    InsertBPORelationshipRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        relationship:
          $ref: '#/components/schemas/Relationship'
      required:
        - dateTime
        - relationship
    InsertBPORelationshipResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
      required:
        - dateTime
    InsertBRT:
      type: object
      properties:
        counterpartBIC:
          description: The inserted counterpart BIC
          $ref: '#/components/schemas/BIC8'
    InsertReachableBICRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        RBBICCode:
          description: The Reachable BIC to be inserted
          $ref: '#/components/schemas/Bic11Only'
        initParticipantValidity:
          description: |-
            The initial validity date for the RB

             **Validation Rule(s)** The first available Init Validity Date  must be set as follows:
            - the effective date (initial validity date) must be equal to one of the effective date stored within "Change Dates Calendar" functionality
            - the business date when the operation is confirmed, must precede or must be equal to "Submission Date" relevant to the chosen “Effective Date”
            (errorCode DT01)
          $ref: '#/components/schemas/Date'
        endParticipantValidity:
          description: |-
            The end validity date for the RB

             **Validation Rule(s)** It must be equal to the fixed value ‘9999-12-31’ (errorCode DT01)
          $ref: '#/components/schemas/Date'
        parameters:
          $ref: '#/components/schemas/Parameters'
      required:
        - dateTime
        - RBBICCode
        - initParticipantValidity
        - endParticipantValidity
        - parameters
    InsertReachableBICResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        operationRef:
          description: The reference assigned by the system to the "Insert" operation, logged in the system in TBA status
          $ref: '#/components/schemas/OperationReference'
      required:
        - dateTime
        - operationRef
    Lac:
      description: The LAC in which the relevant LCR was generated
      type: string
      pattern: '[0-9]{1,2}'
      examples:
        - '01'
    LargeInteger:
      description: Standard Integer.
      type: integer
      format: int64
      examples:
        - 1000
    LCRDetails:
      type: object
      properties:
        referenceLCR:
          description: The LCR reference
          $ref: '#/components/schemas/FileReference'
        settlementDate:
          description: The LCR settlement date
          $ref: '#/components/schemas/Date'
        origBulkMsgId:
          description: The “Bulk Message Id” of the IDF input file that includes the transactions leading to the creation of the LCR
          $ref: '#/components/schemas/BulkReference'
        origInputFile:
          description: The original IDF file reference
          $ref: '#/components/schemas/FileReference'
        bulkType:
          description: The Bulk Type to which the LCR refers
          $ref: '#/components/schemas/BulkType2'
        instructingDPBIC:
          description: The Instructing Agent BIC
          $ref: '#/components/schemas/BIC8'
        instructedDPBIC:
          description: The Instructed Agent BIC
          $ref: '#/components/schemas/BIC8'
        instgSttlmBIC:
          description: The Settlement BIC configured for the Instructing Agent
          $ref: '#/components/schemas/Bic11Only'
        instdSttlmBIC:
          description: The Settlement BIC configured for the Instructed Agent
          $ref: '#/components/schemas/Bic11Only'
        credPartyBIC:
          description: |-
            The Credit Party BIC
            This field corresponds to:
            -the Instructed Agent of the original instructions for Pacs.007;
            -the Instructing Agent of the original instructions for Pacs.003 and Pacs.004.
          $ref: '#/components/schemas/BIC8'
        debPartyBIC:
          description: |-
            The Debit Party BIC
            This field corresponds to:
            -the Instructing Agent of the original instructions for Pacs.007;
            -the Instructed Agent of the original instructions for Pacs.003 and Pacs.004
          $ref: '#/components/schemas/BIC8'
        cgsLacInput:
          description: The LAC running on CGS when the LCR has been retrieved by CGS
          $ref: '#/components/schemas/Lac'
        cgsLacOutput:
          description: The LAC running on CGS when the LCR has closed its life-cycle
          $ref: '#/components/schemas/Lac'
        amount:
          description: The amount managed in the relevant LCR
          $ref: '#/components/schemas/StandardAmount'
        numTransactions:
          description: The number of transactions included in the relevant LCR
          $ref: '#/components/schemas/StandardInteger'
        lcrStatus:
          description: LCR status
          $ref: '#/components/schemas/LcrStatus'
        s2LcrCreationTimestamp:
          description: The timestamp when the STEP2 Service created the LCR
          $ref: '#/components/schemas/DateTime'
        cgsLcrStatusUpdate:
          description: The timestamp of the last LCR’s status update
          $ref: '#/components/schemas/DateTime'
        dbrCrdFlag:
          description: |-
            Whether the LCR results in a debit or credit position
            C=Credit
            D=Debit
          $ref: '#/components/schemas/Sign'
      required:
        - referenceLCR
        - settlementDate
        - origBulkMsgId
        - origInputFile
        - bulkType
        - instructingDPBIC
        - instructedDPBIC
        - credPartyBIC
        - debPartyBIC
        - amount
        - numTransactions
        - lcrStatus
        - s2LcrCreationTimestamp
        - cgsLcrStatusUpdate
        - dbrCrdFlag
    LcrDetailsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria15'
      required:
        - dateTime
        - searchCriteria
    LcrDetailsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        LCRDetails:
          $ref: '#/components/schemas/LCRDetails'
      required:
        - dateTime
        - LCRDetails
    LcrReference:
      description: LCR Reference
      type: string
      maxLength: 16
      examples:
        - LCRREF1111111111
    LCRs:
      type: object
      properties:
        instructingDPBIC:
          description: The Instructing Agent BIC
          $ref: '#/components/schemas/BIC8'
        instructedDPBIC:
          description: The Instructed Agent BIC
          $ref: '#/components/schemas/BIC8'
        instgSttlmBIC:
          description: |-
            The Settlement BIC configured for the Instructing Agent.
            Available only after LCRs have been sent to the CGS
          $ref: '#/components/schemas/Bic11Only'
        instdSttlmBIC:
          description: |-
            The Settlement BIC configured for the Instructed Agent.
            Available only after LCRs have been sent to the CGS
          $ref: '#/components/schemas/Bic11Only'
        settlementDate:
          description: The LCR settlement date
          $ref: '#/components/schemas/Date'
        businessDateTime:
          description: Business date and time at which the LCR has closed its life-cycle
          $ref: '#/components/schemas/DateTime'
        bulkType:
          description: The bulk type to which the LCR relates.
          $ref: '#/components/schemas/BulkType2'
        referenceLCR:
          description: The LCR reference
          $ref: '#/components/schemas/FileReference'
        lac:
          description: The LAC in which the relevant LCR closed its life cycle
          $ref: '#/components/schemas/Lac'
        lcrStatus:
          description: The status of the LCR
          $ref: '#/components/schemas/LcrStatus'
        originalBulkReferenceId:
          description: The reference Id of the original bulk
          $ref: '#/components/schemas/BulkReference'
        originalInputFileReferenceId:
          description: The reference Id of the original input file
          $ref: '#/components/schemas/FileReference'
        amount:
          description: The amount managed in the LCR
          $ref: '#/components/schemas/StandardAmount'
        creationDateTime:
          description: The date and time of the API response creation
          $ref: '#/components/schemas/DateTime'
        dbrCrdFlag:
          description: |-
            Whether the LCR results in a debit or credit position
            C=Credit
            D=Debit
          $ref: '#/components/schemas/Sign'
      required:
        - instructingDPBIC
        - instructedDPBIC
        - settlementDate
        - bulkType
        - referenceLCR
        - lcrStatus
        - originalBulkReferenceId
        - originalInputFileReferenceId
        - amount
        - creationDateTime
        - dbrCrdFlag
    LcrStatus:
      type: string
      enum:
        - WTG
        - STTLD
        - TRD
        - CNLD
        - RVKD
        - RJCT
        - RJCS
        - QUED
      examples:
        - WTG
    LcrStatusUpdate:
      type: object
      properties:
        lcrStatus:
          description: The status of the LCR for which the enquiry is requested
          $ref: '#/components/schemas/LcrStatus'
        lastStatusUpdate:
          description: The date&time at which the LCR for which the enquiry is requested acquired the status set in lcrStatus field
          $ref: '#/components/schemas/DateTime'
    LiquidityPosition:
      type: object
      properties:
        RBBICCode:
          description: The BIC of the Reachable BIC
          $ref: '#/components/schemas/Bic11Only'
        directDebitSent:
          description: |-
            The value of DDs sent by the DP on behalf of its RBs and settled on the specific settlement date.
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        returnRefundSent:
          description: |-
            The value of Returns/Refunds sent by the DP on behalf of its RBs and settled on the specific settlement date.
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        reversalReceived:
          description: |-
            The value of Reversal received from the DP on behalf of its RBs and settled on the specific settlement date.
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        DPOwesRB:
          description: The amount that the DP owes to the RB for the current settlement date
          $ref: '#/components/schemas/StandardAmount'
        directDebitReceived:
          description: |-
            The value of DDs received from the DP on behalf of its RBs and settled on the specific settlement date.
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        returnRefundReceived:
          description: |-
            The value of Returns/Refunds received from the DP on behalf of its RBs and settled on the specific settlement date.
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        reversalSent:
          description: |-
            The value of Reversal sent by the DP on behalf of its RBs and settled on the specific settlement date.
            LCRs in status
            - Waiting;
            - Transmitted:
            - Queued:
            - Rejected-due-to SWITCH
            are not counted
          $ref: '#/components/schemas/StandardAmount'
        RBOwesDP:
          description: The amount that the RBs owe to the DP for the current settlement date
          $ref: '#/components/schemas/StandardAmount'
        netPosition:
          description: 'The net position of the Direct Participant vs. all Reachable BICs: Then the value of “DP Owes RBs” minus “RBs Owe DP”. (It could be negative)'
          $ref: '#/components/schemas/StandardAmount'
      required:
        - RBBICCode
        - directDebitSent
        - returnRefundSent
        - reversalReceived
        - DPOwesRB
        - directDebitReceived
        - returnRefundReceived
        - reversalSent
        - RBOwesDP
        - netPosition
    ListAlertsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria13'
        offset:
          description: |-
            Indicator used to manage pagination

             **Validation Rule(s)** If used, it must correspond to the value provided in the previous listAlerts Response
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
    ListAlertsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        alerts:
          type: array
          items:
            $ref: '#/components/schemas/Alerts'
        endOfList:
          description: |-
            Whether the list is complete or not. Possible values:
            true= the list is complete
            false=the list is not complete
          $ref: '#/components/schemas/EndOfList'
        offset:
          description: Provided if endOfList is set to false. It must be used in the subsequent listAlerts Request to retrieve the next portion of the list
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
    ListBPORelationshipsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria2'
        offset:
          description: |-
            The pointer returned in the previous API Response, useful to obtain the next group of records satisfying the same filtering criteria.

             **Validation Rule(s)** It can be filled only with the same value as the offset field of the previous API Response returned to the previous API Request with the same filtering criteria (it must be empty for the first API Request)
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
    ListBPORelationshipsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API response creation
          $ref: '#/components/schemas/DateTime'
        endOfList:
          description: |-
            The flag used to show if the list is complete or not
            true= The list is completed
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        relationships:
          type: array
          items:
            $ref: '#/components/schemas/Relationships'
        offset:
          description: It indicates if there are more records satisfying the searching criteria; to get them, the offset value must be copied in the offset field of a new API Request that must also contain the same filtering criteria than the current one
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
    ListBulksRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria8'
        offset:
          description: The offset is used in order to manage the pagination. If used, it has to contain the same value of the offset present in the previous “listBulks – Positive Response Body”
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - searchCriteria
    ListBulksResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        endOfList:
          description: |-
            The flag is used to show if the list is complete or not
            true= The list is complete
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        bulks:
          type: array
          items:
            $ref: '#/components/schemas/Bulks'
      required:
        - dateTime
        - endOfList
    ListCommandsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria12'
        offset:
          description: |-
            The offset returned in the previous API Response, useful to obtain the next group of records satisfying the same filtering criteria.

             **Validation Rule(s)** It can be filled only with the same value as the offset field of the previous API Response returned to the previous API Request with the same filtering criteria (it must be empty for the first API Request)
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
    ListCommandsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API response creation
          $ref: '#/components/schemas/DateTime'
        commands:
          type: array
          items:
            $ref: '#/components/schemas/Commands'
        endOfList:
          description: |-
            The flag used to show if the list is complete or not
            true= The list is completed
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        offset:
          description: It indicates if there are more records satisfying the searching criteria; to get them, the offset value must be copied in the offset field of a new API Request that must also contain the same filtering criteria than the current one
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
    ListDefaultThresholdsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria4'
        offset:
          description: |-
            The pointer returned in the previous API Response, useful to obtain the next group of records satisfying the same filtering criteria.

             **Validation Rule(s)** It can be filled only with the same value as the offset field of the previous API Response returned to the previous API Request with the same filtering criteria (it must be empty for the first API Request)
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
    ListDefaultThresholdsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API response creation
          $ref: '#/components/schemas/DateTime'
        endOfList:
          description: |-
            The flag is used to show if the list is complete or not
            true= The list is completed
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        defaultThresholds:
          type: array
          items:
            $ref: '#/components/schemas/DefaultThresholds'
        offset:
          description: It indicates if there are more records satisfying the searching criteria; to get them, the offset value must be copied in the offset field of a new API Request that must also contain the same filtering criteria than the current one
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
    ListFilesRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria9'
        offset:
          description: |-
            The offset is used in order to manage the pagination

             **Validation Rule(s)** If used, it has to contain the same value of the offset present in the previous “listFiles - Positive Response Body”
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - searchCriteria
    ListFilesResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        endOfList:
          description: |-
            The flag used to show if the list is complete or not
            true= The list is complete
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        files:
          type: array
          items:
            $ref: '#/components/schemas/Files'
        offset:
          description: The offset is used in order to manage the pagination. Present in case  endOfList is set as “false”
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
    ListLCRRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria14'
        offset:
          description: |-
            The offset is used in order to manage the pagination.

             **Validation Rule(s)** If used, it has to contain the same value of the offset present in the previous “listLCR– Positive Response Body”
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - searchCriteria
    ListLCRResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        endOfList:
          description: |-
            Flag field used to inform if the last element (record) of the list has been reached:
            true= the record list is completed
            false= the record list is partial
          $ref: '#/components/schemas/EndOfList'
        LCRs:
          type: array
          items:
            $ref: '#/components/schemas/LCRs'
        offset:
          description: The offset points to a set of records. It must be used in the request to retrieve the next portion of records (when the endOfList is false)
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
        - LCRs
    ListLiquidityPositionRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria6'
      required:
        - dateTime
        - searchCriteria
    ListLiquidityPositionResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        liquidityPosition:
          type: array
          items:
            $ref: '#/components/schemas/LiquidityPosition'
      required:
        - dateTime
        - liquidityPosition
    ListMessagesRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria10'
        offset:
          description: |-
            The offset is used in order to manage the pagination

             **Validation Rule(s)** If used, it has to contain the same value of the offset present in the previous “listMessages - Positive Response Body”
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - searchCriteria
    ListMessagesResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        endOfList:
          description: |-
            The flag used to show if the list is complete or not
            true= The list is complete
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        senderReceiverBIC:
          description: The BIC sending/receiving the message
          $ref: '#/components/schemas/BIC8'
        messages:
          type: array
          items:
            $ref: '#/components/schemas/Messages'
        offset:
          description: The offset is used in order to manage the pagination. Present in case  endOfList is set to “false”
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
        - senderReceiverBIC
        - messages
    ListOperationsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          description: Set of fields for search criteria
          $ref: '#/components/schemas/SearchCriteria3'
        offset:
          description: |-
            The pointer returned in the previous API Response, useful to obtain the next group of records satisfying the same filtering criteria.

             **Validation Rule(s)** It can be filled only with the same value as the offset field of the previous API Response returned to the previous API Request with the same filtering criteria (it must be empty for the first API Request)
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
    ListOperationsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        operations:
          type: array
          items:
            $ref: '#/components/schemas/Operations'
        endOfList:
          description: |-
            The flag used to show if the list is complete or not
            true= The list is completed
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        offset:
          description: It indicates if there are more records satisfying the searching criteria; to get them, the offset value must be copied in the offset field of a new API Request that must also contain the same filtering criteria than the current one
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
    ListParticipantsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria'
      required:
        - dateTime
    ListParticipantsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        participants:
          description: The information related to the DP
          type: array
          items:
            $ref: '#/components/schemas/Participants'
      required:
        - dateTime
    ListReachableBICsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria1'
      required:
        - dateTime
    ListReachableBICsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        indParticipants:
          type: array
          items:
            $ref: '#/components/schemas/IndParticipants'
      required:
        - dateTime
    ListThirdPoleReportRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria11'
        offset:
          description: |-
            The pointer returned in the previous API Response, useful to obtain the next group of records satisfying the same filtering criteria.

             **Validation Rule(s)** It can be filled only with the same value as the offset field of the previous API Response returned to the previous API Request with the same filtering criteria (it must be empty for the first API Request)
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
    ListThirdPoleReportResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        reports:
          type: array
          items:
            $ref: '#/components/schemas/Reports'
        endOfList:
          description: |-
            The flag used to show if the list is complete or not
            true= The list is completed
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        offset:
          description: It indicates if there are more records satisfying the searching criteria; to get them, the offset value must be copied in the offset field of a new API Request that must also contain the same filtering criteria than the current one
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
    ListTransactionsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        searchCriteria:
          $ref: '#/components/schemas/SearchCriteria7'
        offset:
          description: |-
            The offset is used in order to manage the pagination.

             **Validation Rule(s)** If used, it has to contain the same value of the offset present in the previous “listTransactions - Positive Response Body”
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - searchCriteria
    ListTransactionsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        endOfList:
          description: |-
            The flag is used to show if the list is complete or not
            true= The list is completed
            false= The list is partial
          $ref: '#/components/schemas/EndOfList'
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/Transactions'
        offset:
          description: The offset is used in order to manage the pagination. Present in case  endOfList is set as “false”
          $ref: '#/components/schemas/Offset'
      required:
        - dateTime
        - endOfList
    MandateId:
      description: Mandate reference.
      type: string
      pattern: ([A-Za-z0-9]|[+|\?|/|\-|:|\(|\)|\.|,|']){1,35}
      examples:
        - TESTTRANSEF135000000000000000000123
    Message:
      type: object
      properties:
        messageType:
          description: |-
            The message type

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/GetMessageType'
        messageStatus:
          description: |-
            The status of the message.
            The field is set only for single messages sent via SWIFTNet. If the relevant file references are populated, this field is set to blank.
            Possible values are:
            • VAL – Validated:  validated transactions; applicable to camt.003 and camt.005
            • RJS – Rejected by CS: rejected by STEP2; applicable to camt.003 and camt.005
            • TSD – Transmitted:  the output message is sent to the sender BIC; applicable to camt.004 and camt.006;
            • TSG – Transmitting: the message has been created and not yet sent, or it’s in the process of being transmitted; applicable to camt.004 and camt.006;
            • ERR – Error: the output message sending failed

             **Validation Rule(s)** If set, it must be set with one of the values configured in the system and applicable to the relevant message type
            (errorCode SC01)
            It can be set only for messages for which network is set to Swiftnet
            (errorCode SC01)
          $ref: '#/components/schemas/GetMessageStatus'
        messageRef:
          description: The message reference
          $ref: '#/components/schemas/GetMessageRef'
        dateTime:
          description: The date and time of the sending/reception of the relevant message
          $ref: '#/components/schemas/DateTime'
        senderReceiverBIC:
          description: The BIC of the relevant DP
          $ref: '#/components/schemas/BIC8'
      required:
        - messageType
        - messageRef
        - dateTime
        - senderReceiverBIC
    Message1:
      type: object
      properties:
        messageType:
          description: |-
            The type of the message to be retransmitted

             **Validation Rule(s)** It can be set only with a configured value in the system
            (errorCode SC01)
            The values Camt.003 and Camt.005 cannot be used
            (error Code XA07)
          $ref: '#/components/schemas/GetMessageType'
        messageRef:
          description: The reference ID of the message to be retransmitted
          $ref: '#/components/schemas/GetMessageRef'
      required:
        - messageType
        - messageRef
    MessageDetails:
      type: object
      properties:
        messageType:
          description: The message type
          $ref: '#/components/schemas/GetMessageType'
        messageStatus:
          description: |-
            The status of the message.
            The field is set only for single messages sent via Swiftnet.
            Possible values are:
            • VAL – Validated:  validated transactions; applicable to camt.003 and camt.005
            • RJS – Rejected by CS: rejected by STEP2; applicable to camt.003 and camt.005.
            • TSD – Transmitted:  the output message is sent to the sender BIC; applicable to camt.004 and camt.006;
            • TSG – Transmitting: the message has been created and not yet sent, or it’s in the process of being transmitted; applicable to camt.004 and camt.006;
            • ERR – Error: the output message sending failed; applicable to camt.004 and camt.006
          $ref: '#/components/schemas/GetMessageStatus'
        messageRef:
          description: The message reference
          $ref: '#/components/schemas/GetMessageRef'
        dateTime:
          description: The date and time of the sending/reception of the relevant message
          $ref: '#/components/schemas/DateTime'
        validationDateTime:
          description: |-
            The time at which the input message is validated
            Applicable to Camt.003 and Camt.005
          $ref: '#/components/schemas/DateTime'
        lastStatusUpdate:
          description: The timestamp of the message’s last status update. Not available to Camt.003 and Camt.005
          $ref: '#/components/schemas/DateTime'
        senderReceiverBIC:
          description: The sender/receiver DP BIC
          $ref: '#/components/schemas/BIC8'
        IGFFileRef:
          description: |-
            The reference of the related IGF file.
            Applicable only for messages exchanged via EBICS or SIANet. If the reference is set, no message status is available
          $ref: '#/components/schemas/FileReference'
        OGFFileRef:
          description: |-
            The reference of the related OGF file.
            Applicable only for messages exchanged via EBICS or SIANet. If the reference is set, no message status is available.
          $ref: '#/components/schemas/FileReference'
        network:
          description: |-
            The network through which the message is sent or received
            Possible values:
            SWF, "Swiftnet single request type"
            SWA, "Swiftnet multiple request type"
            EAS, "SIANet"
            EBX, "EBICS Network"
            SWS, "SWIFTNet S&F Single Request Type"
            SWM, "SWIFTNet S&F Multiple Request Type"
          $ref: '#/components/schemas/Network1'
        counter:
          description: |-
            The counter of the retransmissions requested for the message.
            Set for camt.004 and camt.006
            Possible values: 0 to 5
          $ref: '#/components/schemas/StandardInteger'
        getAccountDetails:
          description: This section is present if messageType is equal to Camt.003
          $ref: '#/components/schemas/GetAccountDetails'
        returnAccountDetails:
          description: This section is present if messageType is equal to Camt.004 (positive validation)
          $ref: '#/components/schemas/ReturnAccountDetails'
        returnAccountQueryResponseError:
          description: This section is present if messageType is equal to Camt.004 (negative validation)
          $ref: '#/components/schemas/ReturnAccountQueryResponseError'
        getTransaction:
          description: This section is present if messageType is equal to Camt.005
          $ref: '#/components/schemas/GetTransaction'
        returnTransaction:
          description: This section is present if messageType is equal to Camt.006 (positive validation)
          $ref: '#/components/schemas/ReturnTransaction'
        returnTransactionQueryResponseError:
          description: This section is present if messageType is equal to Camt.006 (negative validation)
          $ref: '#/components/schemas/ReturnAccountQueryResponseError'
      required:
        - messageType
        - messageRef
        - dateTime
        - senderReceiverBIC
        - network
    MessageDetailsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        message:
          $ref: '#/components/schemas/Message'
      required:
        - dateTime
        - message
    MessageDetailsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        messageDetails:
          description: This section reports the general information related to the message
          $ref: '#/components/schemas/MessageDetails'
      required:
        - dateTime
        - messageDetails
    Messages:
      type: object
      properties:
        messageType:
          description: The message type
          $ref: '#/components/schemas/GetMessageType'
        messageRef:
          description: The reference of the message
          $ref: '#/components/schemas/GetMessageRef'
        dateTime:
          description: The date and time when the message was sent/received by the Central System
          $ref: '#/components/schemas/DateTime'
        lastStatusUpdate:
          description: The timestamp of the last status update. Not available to Camt.003 and Camt.005
          $ref: '#/components/schemas/DateTime'
        messageStatus:
          description: The status of the message
          $ref: '#/components/schemas/GetMessageStatus'
        reasonCode:
          description: The reason code associated to the message
          $ref: '#/components/schemas/GetMessageReasonCode'
        originalMessageRef:
          description: The original message reference. Applicable to camt.004 and camt.006
          $ref: '#/components/schemas/GetMessageRef'
        network:
          description: The network from which the message is received or sent
          $ref: '#/components/schemas/Network2'
        IGFFileRef:
          description: |-
            The reference of the relevant IGF
            Applicable only to messages sent via SIANet or EBICS
          $ref: '#/components/schemas/FileReference'
        OGFFileRef:
          description: |-
            The reference of the relevant OGF
            Applicable only to messages sent via SIANet or EBICS
          $ref: '#/components/schemas/FileReference'
      required:
        - messageType
        - messageRef
        - dateTime
        - reasonCode
        - network
    MessageType:
      description: The type of message.
      type: string
      enum:
        - DD.Message
        - R.Message
        - Camt.056
        - Pacs.002
        - Pacs.003
        - Pacs.004
        - Pacs.007
        - Pacs.2S2
      examples:
        - Pacs.003
    Network:
      description: Network from which the file is received or sent.
      type: string
      enum:
        - EAS
        - EBX
        - SWF
        - SWA
        - SWS
        - SWM
      pattern: '[A-Za-z0-9]{3,3}'
      examples:
        - SWF
    Network1:
      description: Network from which the file is received or sent.
      type: string
      pattern: '[A-Za-z0-9]{3,3}'
      examples:
        - SWF
    Network2:
      description: Network from which the file is received or sent.
      type: string
      enum:
        - SWF
        - SWA
        - EAS
        - EBX
        - SWS
        - SMW
      pattern: '[A-Za-z0-9]{3,3}'
      examples:
        - SWF
    NetworkFileName:
      description: Network file name of the file.
      type: string
      pattern: ^\S{15,30}\.[A-Z]{1,1}
      examples:
        - S202SDDTESTITMM_F800AAA.I
    NetworkIdentification:
      description: Identification network.
      type: string
      maxLength: 100
      examples:
        - cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
    NetworkIdentification1:
      description: Network identification.
      type: string
      enum:
        - EAS
        - EBX
        - SWF
        - SWA
      maxLength: 3
      examples:
        - SWF
    NetworkIdentification2:
      description: Network identification.
      type: string
      enum:
        - EAS
        - EBX
        - SWF
        - SWA
        - SWS
        - SWM
      maxLength: 3
      examples:
        - SWF
    NetworkIdentificationSendingReceiving:
      description: Ntetwork identification for sending/receiving.
      type: string
      maxLength: 100
      examples:
        - cn=bank01,cn=sag2,cn=memb,o=itsimitt,o=swift
    Offset:
      description: Offset is used in lists that support pagination.
      type: string
      examples:
        - AAaa88ss2345fggGGDDaaaHH
    OperationDetails:
      type: object
      properties:
        DPRBOperation:
          description: Whether the operation refers to a Direct Participant or a Reachable BIC
          $ref: '#/components/schemas/DPRBOperation'
        operationType:
          description: |-
            The operation type. Possible values:
            INS for “Insert”
            REM for “Remove”
            UPD for  “Update”
            RON for "R-Only"
            BRI for “Insert BRT”
            BRR for “Remove BRT”
            MOD for “Amend Change”
            REV for “Revoke Change”
            CDP for “RB Change DP”
          $ref: '#/components/schemas/OperationType'
        operationStatus:
          description: |-
            The operation status. Possible values:
            AUT for “Authorized”
            EXE for “Executed”
            REJ for  “Rejected by User”
            RJS for “Rejected by System”
            TBA for “To Be Authorized”
            TBC for "Submitted"
          $ref: '#/components/schemas/OperationStatus'
        effectiveDate:
          description: The effective date of the requested operation
          $ref: '#/components/schemas/Date'
        requestDateTime:
          description: The date and time of the issuing of the operation
          $ref: '#/components/schemas/DateTime'
        confirmDateTime:
          description: |-
            The date and time of the confirmation by Participant User.
            Applicable only in case of “Critical” operation
          $ref: '#/components/schemas/DateTime'
        authRejectDateTime:
          description: The date and time of the authorization/rejection of the operation
          $ref: '#/components/schemas/DateTime'
        userIssuer:
          description: The user Id of the user who issued the operation
          $ref: '#/components/schemas/UserId'
        confirmer:
          description: |-
            The user Id of the user who confirmed the operation.
            Applicable only in case of “Critical” operation
          $ref: '#/components/schemas/UserId'
        userAuthReject:
          description: The user Id of the user who authorized/rejected the operation
          $ref: '#/components/schemas/UserId'
        operationRef:
          description: The reference of the operation
          $ref: '#/components/schemas/OperationReference'
        critical:
          description: |-
            Whether the operation is critical or not. Possible values:
            true=critical
            false=non-critical
          $ref: '#/components/schemas/GenericBoolean'
        directParticipant:
          description: This section is present if operationType is equal to UPD for DP
          $ref: '#/components/schemas/DirectParticipant'
        reachableBIC:
          description: |-
            The following details are present for INS - REM - UPD RB - RON - MOD - REV - CDP.
            In case of Amend Change/Revoke Change the fields report the new value set with the operation
          $ref: '#/components/schemas/ReachableBIC'
        insertBRT:
          description: The section is present if the operationType is equal to BRI
          $ref: '#/components/schemas/InsertBRT'
        removeBRT:
          description: The section is present if the operationType is equal to BRR
          $ref: '#/components/schemas/InsertBRT'
      required:
        - DPRBOperation
        - operationType
        - operationStatus
        - effectiveDate
        - requestDateTime
        - userIssuer
        - operationRef
        - critical
    OperationDetailsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        operationRef:
          description: The operation reference
          $ref: '#/components/schemas/OperationReference'
      required:
        - dateTime
        - operationRef
    OperationDetailsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        operationDetails:
          $ref: '#/components/schemas/OperationDetails'
      required:
        - dateTime
    OperationRef:
      description: The reference of the operation
      type: string
      maxLength: 16
      examples:
        - REF0123456789111
    OperationReference:
      description: The reference of the operation
      type: string
      maxLength: 16
      examples:
        - REF0123456789111
    Operations:
      type: object
      properties:
        DPRBOperation:
          description: Whether the operation refers to a Direct participant or a Reachable BIC
          $ref: '#/components/schemas/DPRBOperation'
        DPBICCode:
          description: The DP BIC to which the operation refers. It must correspond to the senderBIC
          $ref: '#/components/schemas/BIC8'
        RBBICCode:
          description: The RB BIC to which the operation refers. It must correspond to the a Reachable BIC of the senderBIC
          $ref: '#/components/schemas/Bic11Only'
        operationType:
          description: |-
            The operation type. Possible values:
            INS for “Insert”
            REM for “Remove”
            UPD for  “Update”
            RON for "R-Only"
            BRI for “Insert BRT”
            BRR for “Remove BRT”
            MOD for “Amend Change”
            REV for “Revoke Change”
            CDP for “RB Change DP”
          $ref: '#/components/schemas/OperationType'
        operationStatus:
          description: |-
            The operation status. Possible values:
            AUT for “Authorized”
            EXE for “Executed”
            REJ for  “Rejected by User”
            RJS for “Rejected by System”
            TBA for “To Be Authorized”
            TBC for "Submitted"
          $ref: '#/components/schemas/OperationStatus'
        effectiveDate:
          description: The effective date of the operation
          $ref: '#/components/schemas/Date'
        requestDateTime:
          description: The DateTime when the operation was requested
          $ref: '#/components/schemas/DateTime'
        confirmDateTime:
          description: |-
            The date and time of the confirmation by Participant User.
            Applicable only in case of “Critical” operation
          $ref: '#/components/schemas/DateTime'
        authRejectDateTime:
          description: The DateTime when the operation was authorized/rejected
          $ref: '#/components/schemas/DateTime'
        userIssuer:
          description: The user Id of the user who issued the operation
          $ref: '#/components/schemas/UserId'
        confirmer:
          description: |-
            The user Id of the user who confirmed the operation.
            Applicable only in case of “Critical” operation
          $ref: '#/components/schemas/UserId'
        userAuthReject:
          description: The user Id of the user who authorized/rejected the operation
          $ref: '#/components/schemas/UserId'
        operationRef:
          description: The operation reference
          $ref: '#/components/schemas/OperationReference'
        critical:
          description: |-
            Whether the operation is critical
            true= critical operation
            false=non-critical operation
          $ref: '#/components/schemas/GenericBoolean'
      required:
        - DPRBOperation
        - operationType
        - operationStatus
        - effectiveDate
        - requestDateTime
        - userIssuer
        - operationRef
        - critical
    OperationStatus:
      description: The status of the operation
      type: string
      enum:
        - AUT
        - EXE
        - REJ
        - RJS
        - TBA
        - TBC
      maxLength: 3
      examples:
        - RJS
    OperationType:
      description: The type of operation
      type: string
      enum:
        - INS
        - REM
        - UPD
        - RON
        - BRI
        - BRR
        - MOD
        - REV
        - CDP
      maxLength: 3
      examples:
        - INS
    OriginalXml:
      description: OriginalXml.
      type: string
      format: xml
      examples:
        - <originalXml>......</originalXml>
    OriginalXMLRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API request creation
          $ref: '#/components/schemas/DateTime'
        transactionRef:
          $ref: '#/components/schemas/TransactionRef1'
      required:
        - dateTime
        - transactionRef
    OriginalXMLResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        originalXml:
          description: The OriginalXml
          $ref: '#/components/schemas/OriginalXml'
      required:
        - dateTime
        - originalXml
    Parameters:
      type: object
      properties:
        name:
          description: The name of the RB
          $ref: '#/components/schemas/ParticipantName'
        admissionProfile:
          description: |-
            The admission profile

             **Validation Rule(s)** it can only be set as
            - DEB; or
            - CAD
            (errorCode SC01)
          $ref: '#/components/schemas/AdmissionProfile'
        CAIUserGroup:
          description: |-
            The DP adheres to CAI User Group
            true= CAI enabled
            false= CAI not enabled

             **Validation Rule(s)** it can only be set as
            - true; or
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        sameBankingGroupAsDP:
          description: |-
            RB part of the same banking group as its DP
            true= RB part of the same banking group as its DP
            false= RB not part of the same banking group as its DP

             **Validation Rule(s)** it can only be set as
            - true; or
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        productsAllowed:
          description: |-
            The list of the products configured for the Reachable BIC

             **Validation Rule(s)** It must correspond to products configured in the system for the relevant service (COR or B2B),i.e.:
            - COR (COR+1 blank space)
            - ICMC
            - NLGO
            - B2B (B2B+1 blank space)
            (errorCode SC01)
            For COR Service, "COR " product is mandatory
            (errorCode SC01)
            For B2B Service, "B2B " product is mandatory
            (errorCode SC01)
            Values must be 4-characters long and must be followed by a semicolon (;)
            (errorCode SC01)
          $ref: '#/components/schemas/ProductsAllowedString'
      required:
        - name
        - admissionProfile
        - CAIUserGroup
        - sameBankingGroupAsDP
        - productsAllowed
    Parameters1:
      type: object
      properties:
        name:
          description: The name of the participant
          $ref: '#/components/schemas/ParticipantName'
        admissionProfile:
          description: |-
            The admission profile of the participant

             **Validation Rule(s)** Possible values:
            - DEB
            - CAD
            (errorCode SC01)
          $ref: '#/components/schemas/AdmissionProfile'
        defaultThresholdValue:
          description: |-
            The Default Threshold Value between the DP and each other enabled DP.

             **Validation Rule(s)** Only decimal notation is allowed
            (errorCode XA05)
          $ref: '#/components/schemas/StandardAmount'
        settlementFiles:
          description: |-
            The number of settlement files (DNF) the Direct Participant is configured to receive

             **Validation Rule(s)** It must be set with one of the configured values
            (errorCode SC01)
          $ref: '#/components/schemas/SettlementFile'
        MSRRequired:
          description: |-
            The DP is configured to receive an MSR
            true= configured
            false= not configured

             **Validation Rule(s)** it can only be set as
            - true; or
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        extendedPSR:
          description: |-
            The DP is configured to receive the liquidity information in the extended PSR file
            true= configured
            false= not configured

             **Validation Rule(s)** it can only be set as
            - true; or
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        maxReceivingFileSize:
          description: |-
            The maximum number of bytes that a DP will accept for the size of each file received from STEP2 CS

             **Validation Rule(s)** The value must be in the range included between the default values set in the system for the Minimum file size and the Maximum file size.
            (errorCode XA15)
          $ref: '#/components/schemas/StandardInteger'
        batchProcessingMode:
          description: |-
            The DP is configured for Batch Processing Option
            true= configured
            false= not configured

             **Validation Rule(s)** it can only be set as
            - true; or
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        CAIUserGroup:
          description: |-
            The DP adheres to CAI User Group
            true= CAI enabled
            false= CAI not enabled

             **Validation Rule(s)** it can only be set as
            - true; or
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        swiftNetOutputFileCompression:
          description: |-
            The DP is allowed to send/receive compressed files
            true= Compression enabled
            false= Compression not enabled

             **Validation Rule(s)** it can only be set as
            - true; or
            - false
            (errorCode SC01)
            It can be set to "true" only if active output is configured with Swiftnet
            (errorCode XA07)
          $ref: '#/components/schemas/GenericBoolean'
        technicalBIC:
          description: |-
            Technical BIC indicator
            true= Technical BIC
            false=No technical BIC

             **Validation Rule(s)** it can only be set as
            - true; or
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        priNetworkIdentification:
          description: |-
            The primary network through which the DP connects to STEP2

             **Validation Rule(s)** It can contain:
            -  “EAS” for SIANet,
            - “EBX” for EBICS;
            - “SWF” for SWIFTNet single request;
            - “SWA” for SWIFTNet multiple request
            - "SWS" for SWIFTNet S&F Single Request
            - "SWM" for SWIFTNet S&F Multiple Request
            (errorCode SC01)
          $ref: '#/components/schemas/NetworkIdentification2'
        secNetworkIdentification:
          description: |-
            The secondary network through which the DP connects to STEP2

             **Validation Rule(s)** It can contain:
            -  “EAS” for SIANet,
            - “EBX” for EBICS;
            - “SWF” for SWIFTNet single request;
            - “SWA” for SWIFTNet multiple request
            - "SWS" for SWIFTNet S&F Single Request
            - "SWM" for SWIFTNet S&F Multiple Request
            (errorCode SC01)
          $ref: '#/components/schemas/NetworkIdentification2'
        priReceivingNetIdentification:
          description: The identifier by which the DP is known on the primary network when receiving files from STEP2 CS
          $ref: '#/components/schemas/NetworkIdentificationSendingReceiving'
        secReceivingNetIdentification:
          description: The identifier by which the DP is known on the secondary network, when receiving files from STEP2 CS
          $ref: '#/components/schemas/NetworkIdentificationSendingReceiving'
        priSendingNetIdentification:
          description: The identifier by which this DP is known on the primary network when sending files to STEP2 CS
          $ref: '#/components/schemas/NetworkIdentificationSendingReceiving'
        secSendingNetIdentification:
          description: The identifier by which the DP is known on the secondary network, when sending files from STEP2 CS
          $ref: '#/components/schemas/NetworkIdentificationSendingReceiving'
        T2RTGSAuthorisedAccountUserAAUForAS-D:
          description: |-
            The BIC11 of the T2-RTGS DCA for settlement of STEP2 transactions. It must be declared at TARGET Level as Authorized Account User BIC of the T2-RTGS DCA used for AS-D

             **Validation Rule(s)** Format checks only (errorCode SC01)
          $ref: '#/components/schemas/Bic11Only'
        T2RTGSAuthorisedAccountUserAAUForAS-E:
          description: |-
            The BIC11 of the T2-RTGS Dedicated Cash Account (DCA) for remuneration process

             **Validation Rule(s)** It must be set only if different from the one used for "T2RTGSAuthorisedAccountUserAAUForAS-D"
            (errorCode XA04)
          $ref: '#/components/schemas/Bic11Only'
        T2RTGSDedicatedCashAccountDCAForAS-D:
          description: |-
            T2-RTGS Dedicated Cash Account (DCA) used by a Participant for funding/defunding CGS position (with Ancillary System AS-D). It is the Account registered with STEP2 Settlement Bank Account Group (as registered in T2 CRDM Registration form)

             **Validation Rule(s)** Format checks only (errorCode SC01)
          $ref: '#/components/schemas/DedicatedCashAccount'
        T2RTGSDedicatedCashAccountDCAForAS-E:
          description: |-
            The T2-RTGS Dedicated Cash Account (DCA) used by a Participant for remuneration process (with Ancillary System AS-E)

             **Validation Rule(s)** It must be set only if different by "T2RTGSDedicatedCashAccountDCAForAS-D"
            (errorCode XA04)
          $ref: '#/components/schemas/DedicatedCashAccount'
        productList:
          description: |-
            The list of configured products for participants

             **Validation Rule(s)** It must be products configured in the system for the relevant service, i.e.:
            - COR (COR+1 blank space)
            - ICMC
            - NLGO
            - B2B (B2B+1 blank space)
            (errorCode SC01)
             "COR " product is mandatory for CORE service
            (errorCode SC01)
            "B2B " product is mandatory for B2B Service
            (errorCode SC01)
          $ref: '#/components/schemas/ProductsAllowedString'
      required:
        - T2RTGSAuthorisedAccountUserAAUForAS-D
        - T2RTGSDedicatedCashAccountDCAForAS-D
    Parameters2:
      type: object
      properties:
        name:
          description: The name of the RB
          $ref: '#/components/schemas/ParticipantName'
        admissionProfile:
          description: |-
            The admission profile

             **Validation Rule(s)** Possible values:
            - DEB
            - CAD
            (errorCode SC01)
          $ref: '#/components/schemas/AdmissionProfile'
        CAIUserGroup:
          description: |-
            The DP adheres to CAI User Group
            true= CAI enabled
            false= CAI not enabled

             **Validation Rule(s)** Possible values:
            - true
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        sameBankingGroupAsDP:
          description: |-
            RB part of the same banking group as its DP
            true= RB part of the same banking group as its DP
            false= RB not part of the same banking group as its DP

             **Validation Rule(s)** Possible values:
            - true
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        productList:
          description: |-
            The list of products configured for the Reachable BIC

             **Validation Rule(s)** It must be products configured in the system for the relevant service, i.e.:
            - COR (COR+1 blank space)
            - ICMC
            - NLGO
            - B2B (B2B+1 blank space)
            (errorCode SC01)
            COR  product is mandatory in the CORE service
            (errorCode SC01)
            "B2B " product is mandatory for B2B Service
            (errorCode SC01)
          $ref: '#/components/schemas/ProductsAllowedString'
    ParModHistory:
      type: object
      properties:
        initParameterValidity:
          description: The first date starting from which the parameter is valid
          $ref: '#/components/schemas/Date'
        endParameterValidity:
          description: The last date until which the parameter is valid
          $ref: '#/components/schemas/Date'
        BICName:
          description: The name of the DP
          $ref: '#/components/schemas/ParticipantName'
        settlementBIC:
          description: The BIC by which this DP is known to the External Settlement Mechanism
          $ref: '#/components/schemas/Bic11Only'
        debitProductsAllowed:
          description: The debit products allowed
          $ref: '#/components/schemas/ProductsAllowedString'
        admissionProfile:
          description: |-
            The admission profile.
            Possible values are:
            DEB = Debtor
            CAD = Creditor and Debtor
          $ref: '#/components/schemas/AdmissionProfile'
        maxReceivingFileSize:
          description: The maximum receiving file size
          $ref: '#/components/schemas/LargeInteger'
        CAIUserGroup:
          description: |-
            Whether the DP adheres to CAI
            true= CAI user group
            false= No CAI user group
          $ref: '#/components/schemas/GenericBoolean'
        technicalBIC:
          description: |-
            Technical BIC indicator
            true= Technical BIC
            false=No technical BIC
          $ref: '#/components/schemas/GenericBoolean'
        NLOUserGroup:
          description: |-
            Whether the DP is configured for NLO
            true= configured for NLO
            false= not configured for NLO
          $ref: '#/components/schemas/GenericBoolean'
        ICMUserGroup:
          description: |-
            Whether the DP is configured for ICM
            true= configured for ICM
            false= not configured for ICM
          $ref: '#/components/schemas/GenericBoolean'
    ParModHistory1:
      type: object
      properties:
        initParameterValidity:
          description: The first date starting from which the set of parameters is valid
          $ref: '#/components/schemas/Date'
        endParameterValidity:
          description: The last date until this set of parameters is valid
          $ref: '#/components/schemas/Date'
        BICName:
          description: The name of the RB
          $ref: '#/components/schemas/ParticipantName'
        DPBICCode:
          description: The BIC of the RB
          $ref: '#/components/schemas/BIC8'
        status:
          description: The current status of the RB
          $ref: '#/components/schemas/ParticipantStatus'
        debitProductsAllowed:
          description: The debit products allowed
          $ref: '#/components/schemas/ProductsAllowedString'
        admissionProfile:
          description: |-
            The admission profile.
            Possible values are:
            DEB = Debtor
            CAD = Creditor and Debtor
          $ref: '#/components/schemas/AdmissionProfile'
        CAIUserGroup:
          description: |-
            Whether the RB adheres to CAI
            true= CAI user group
            false= No CAI user group
          $ref: '#/components/schemas/GenericBoolean'
        NLOUserGroup:
          description: |-
            Whether the RB is configured for NLO
            true= configured for NLO
            false= not configured for NLO
          $ref: '#/components/schemas/GenericBoolean'
        ICMUserGroup:
          description: |-
            Whether the RB is configured for ICM
            true= configured for ICM
            false= not configured for ICM
          $ref: '#/components/schemas/GenericBoolean'
    Participant:
      type: object
      properties:
        name:
          description: The name of the participant
          $ref: '#/components/schemas/ParticipantName'
        BICCode:
          description: The BIC of the DP
          $ref: '#/components/schemas/BIC8'
        initParticipantValidity:
          description: The initial validity date of the DP
          $ref: '#/components/schemas/Date'
        endParticipantValidity:
          description: The end validity date of the DP
          $ref: '#/components/schemas/Date'
        currentStatus:
          description: The current status of the DP
          $ref: '#/components/schemas/ParticipantStatus'
        ROnlyDate:
          description: The date starting from which the DP is updated as R-Only
          $ref: '#/components/schemas/Date'
        settlementBIC:
          description: The BIC by which this DP is known to the External Settlement Mechanism
          $ref: '#/components/schemas/Bic11Only'
        parModHistory:
          description: The section is visible only when participant enquires details of its BIC
          type: array
          items:
            $ref: '#/components/schemas/ParModHistory'
        detailsHistory:
          description: The section is visible only when participant enquires details of its BIC
          type: array
          items:
            $ref: '#/components/schemas/DetailsHistory'
      required:
        - BICCode
        - name
        - initParticipantValidity
        - endParticipantValidity
        - currentStatus
        - ROnlyDate
        - settlementBIC
    ParticipantDetailsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API request creation
          $ref: '#/components/schemas/DateTime'
        participantRef:
          $ref: '#/components/schemas/ParticipantRef'
      required:
        - dateTime
        - participantRef
    ParticipantDetailsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        participant:
          $ref: '#/components/schemas/Participant'
      required:
        - dateTime
    ParticipantName:
      description: Name of Participant.
      type: string
      pattern: (^\S+.*){1,50}
      examples:
        - Merrill Lynch
    ParticipantRef:
      type: object
      properties:
        BICCode:
          description: The enquired DP
          $ref: '#/components/schemas/BIC8'
      required:
        - BICCode
    Participants:
      type: object
      properties:
        name:
          description: The name of the DP requested
          $ref: '#/components/schemas/ParticipantName'
        BICCode:
          description: The BIC of the DP requested
          $ref: '#/components/schemas/BIC8'
        initValidity:
          description: The Initial validity date of the DP
          $ref: '#/components/schemas/Date'
        endValidity:
          description: The end validity date of the DP
          $ref: '#/components/schemas/Date'
        ROnlyDate:
          description: The date starting from which the Participant is updated as R-Only
          $ref: '#/components/schemas/Date'
        status:
          description: The status of the DP
          $ref: '#/components/schemas/ParticipantStatus'
        settlementBIC:
          description: The BIC by which this DP is known to the External Settlement Mechanism
          $ref: '#/components/schemas/Bic11Only'
        newBIC:
          description: The new BIC of the DP, following a “Change BIC” operation
          $ref: '#/components/schemas/BIC8'
        newRole:
          description: |-
            Whether the DP changed role after a "Change Role" provisioning action
            true= Role changed
            false= Role unchanged
          $ref: '#/components/schemas/GenericBoolean'
      required:
        - BICCode
        - name
        - initValidity
        - endValidity
        - ROnlyDate
        - status
        - settlementBIC
        - newRole
    ParticipantStatus:
      description: Status of participant.
      type: string
      enum:
        - ENB
        - DIS
        - SUS
        - RON
        - CHG
      examples:
        - ENB
    ParticipantStatus1:
      description: Status of participant.
      type: string
      enum:
        - RON
        - DIS
        - ENB
      examples:
        - ENB
    Product:
      description: Product.
      type: string
      maxLength: 4
      examples:
        - COR1
    ProductsAllowedString:
      description: Products Allowed.
      type: string
      maxLength: 200
      examples:
        - COR
    RBDetailsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API request creation
          $ref: '#/components/schemas/DateTime'
        indParticipantRef:
          $ref: '#/components/schemas/IndParticipantRef'
      required:
        - dateTime
        - indParticipantRef
    RBDetailsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        indParticipant:
          $ref: '#/components/schemas/IndParticipant'
      required:
        - dateTime
    ReachableBIC:
      type: object
      properties:
        name:
          description: The name of the participant
          $ref: '#/components/schemas/ParticipantName'
        RBBICCode:
          description: The RB to which the operation refers
          $ref: '#/components/schemas/Bic11Only'
        oldDPBICCode:
          description: |-
            The DP under which the RB is configured at the time of the operation.
            The field will be available only in case of CDP operation.
          $ref: '#/components/schemas/BIC8'
        newDPBICCode:
          description: |-
            The DP under which the RB will be configured with the “RB Change DP” operation.
            The field will be available only in case of CDP operation.
          $ref: '#/components/schemas/BIC8'
        admissionProfile:
          description: The value for admission profile
          $ref: '#/components/schemas/AdmissionProfile'
        CAIUserGroup:
          description: The value for CAI adherence
          $ref: '#/components/schemas/GenericBoolean'
        sameBankingGroupAsDP:
          description: The value for Same Banking Group adherence
          $ref: '#/components/schemas/GenericBoolean'
        productsAllowed:
          description: The products configured for the RB
          $ref: '#/components/schemas/ProductsAllowedString'
        endValidityDate:
          description: |-
            The end validity date assigned by the system in case of “R-Only” operations for RB.
            The field will be available only in case of RON operation and if the field DPRBOperation=IND
          $ref: '#/components/schemas/Date'
    ReasonCode:
      description: Error code associated to the file.
      type: string
      pattern: '[A-Z]{1,1}[0-9]{2,2}'
      examples:
        - A01
    ReasonCodeTransaction:
      description: Error code associated to the transaction.
      type: string
      maxLength: 4
      examples:
        - DUPL
    RejectParticipantOperationRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        operationRef:
          description: |-
            The reference of the operation to be rejected

             **Validation Rule(s)** The operation must not be authorized yet
            (errorCode XA07)
          $ref: '#/components/schemas/OperationReference'
      required:
        - dateTime
        - operationRef
    RejectParticipantOperationResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        operationRef:
          description: The reference of the operation rejected with the API request (this operation is logged in the system in REJ status)
          $ref: '#/components/schemas/OperationReference'
      required:
        - dateTime
        - operationRef
    Relationship:
      type: object
      properties:
        counterpartBIC:
          description: |-
            The BIC code of the counterpart

             **Validation Rule(s)** The counterpart BIC code must be present in the Routing Table and must have the BPO option equal to “YES”
            (errorCode XA07)
          $ref: '#/components/schemas/BIC8'
        activationDate:
          description: |-
            The activation date of the BPO relationship

             **Validation Rule(s)** It must be equal to the next business date
            (errorCode DT01)
          $ref: '#/components/schemas/Date'
      required:
        - counterpartBIC
        - activationDate
    Relationship1:
      type: object
      properties:
        counterpartBIC:
          description: |-
            The counterpart BIC code to be removed

             **Validation Rule(s)** It must be a counterpart of the senderBIC
            (errorCode XA07)
          $ref: '#/components/schemas/BIC8'
        removalDate:
          description: |-
            The effective date of the removal

             **Validation Rule(s)** It must be set according to warehousing constraints
            (errorCode DT01)
          $ref: '#/components/schemas/Date'
      required:
        - counterpartBIC
        - removalDate
    Relationships:
      type: object
      properties:
        counterpartBICCode:
          description: The BIC code of the counterpart
          $ref: '#/components/schemas/BIC8'
        counterpartName:
          description: The name of the counterpart
          $ref: '#/components/schemas/ParticipantName'
        activationDate:
          description: The activation date of the BPO relationship
          $ref: '#/components/schemas/Date'
        removalDate:
          description: The removal date of the BPO relationship
          $ref: '#/components/schemas/Date'
        requestorUser:
          description: The requestor user
          $ref: '#/components/schemas/UserId'
        authorizerUser:
          description: The authorizer user
          $ref: '#/components/schemas/UserId'
      required:
        - counterpartBICCode
        - counterpartName
        - activationDate
        - requestorUser
    RemoveBPORelationshipRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        relationship:
          $ref: '#/components/schemas/Relationship1'
      required:
        - dateTime
        - relationship
    RemoveBPORelationshipResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
      required:
        - dateTime
    Report:
      type: object
      properties:
        reportRef:
          description: The reference of the report
          $ref: '#/components/schemas/ReportRef'
        creationDateTime:
          description: The creation date and time of the report
          $ref: '#/components/schemas/DateTime'
        reportType:
          description: The report type
          $ref: '#/components/schemas/ReportType'
        reportStatus:
          description: The report status
          $ref: '#/components/schemas/ReportStatus'
        data:
          description: The data included in the report
          $ref: '#/components/schemas/ReportData'
      required:
        - reportRef
        - creationDateTime
        - reportType
        - reportStatus
        - data
    ReportCriteria:
      type: object
      properties:
        processCycle:
          description: |-
            The process cycle

             **Validation Rule(s)** It can be set only with a configured value in the system
            (errorCode SC01)
          $ref: '#/components/schemas/Cycle'
        bulkType:
          description: |-
            The bulk type

             **Validation Rule(s)** It can be set only with a configured value in the system
            (errorCode SC01)
          $ref: '#/components/schemas/MessageType'
    ReportData:
      description: Report data.
      type: string
      format: binary
      examples:
        - U3dhZ2dlciByb2Nrcw
    ReportRef:
      description: Report reference.
      type: string
      maxLength: 54
      examples:
        - UUUUUUUU_YYDDD_12345678901234567890123456789012345_NNN
    Reports:
      type: object
      properties:
        reportRef:
          description: The reference of the report
          $ref: '#/components/schemas/ReportRef'
        creationDateTime:
          description: The creation Date and Time
          $ref: '#/components/schemas/DateTime'
        reportType:
          description: The type of report
          $ref: '#/components/schemas/ReportType'
        reportStatus:
          description: The status of the report
          $ref: '#/components/schemas/ReportStatus'
      required:
        - reportRef
        - creationDateTime
        - reportType
        - reportStatus
    ReportStatus:
      description: Status of report.
      type: string
      enum:
        - WTG
        - RDY
        - NTF
      examples:
        - WTG
    ReportType:
      description: Type of report.
      type: string
      enum:
        - BRE
      examples:
        - BRE
    RequestId:
      description: Request Identification.
      type: string
      maxLength: 36
      examples:
        - '20180501183030100000'
    ResendAll:
      type: object
      properties:
        commandRef:
          description: The reference of the command
          $ref: '#/components/schemas/CommandRef'
        commandType:
          description: The type of command (F04 for Resend All)
          $ref: '#/components/schemas/CommandType'
        commandStatus:
          description: The status of the command
          $ref: '#/components/schemas/CommandStatus'
        requestDateTime:
          description: The date and time in which the command has been issued
          $ref: '#/components/schemas/DateTime'
        authRejectDateTime:
          description: The date and time in which the command has been executed or rejected
          $ref: '#/components/schemas/DateTime'
        userIssuer:
          description: The UserID of the user that has issued the command
          $ref: '#/components/schemas/UserId'
        userAuthReject:
          description: The UserID of the user that has authorized or rejected the command
          $ref: '#/components/schemas/UserId'
        fileType:
          description: The type of file
          $ref: '#/components/schemas/FileType1'
        dateTime:
          description: The date and time of the last command’s update
          $ref: '#/components/schemas/DateTime'
      required:
        - commandRef
        - commandType
        - commandStatus
        - requestDateTime
        - userIssuer
        - fileType
        - dateTime
    ResendAllRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        resendCriteria:
          $ref: '#/components/schemas/ResendCriteria'
      required:
        - dateTime
        - resendCriteria
    ResendAllResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        commandRef:
          description: The command reference
          $ref: '#/components/schemas/CommandRef'
      required:
        - dateTime
        - commandRef
    ResendCriteria:
      type: object
      properties:
        fileType:
          description: |-
            The file type

             **Validation Rule(s)** It can be set only with a configured value in the system
            (errorCode SC01)
            “IDF” and "IGF" values cannot be used
            (errorCode XA07)
          $ref: '#/components/schemas/FileType1'
        dateFrom:
          description: |-
            The oldest date for which the files are requested

             **Validation Rule(s)** It cannot be lesser two days to the current calendar date
            (errorCode DT01)
          $ref: '#/components/schemas/Date'
        dateTo:
          description: The maximum date for which the files are requested
          $ref: '#/components/schemas/Date'
        fileReference:
          description: The file reference
          $ref: '#/components/schemas/FileReference'
        lac:
          description: |-
            The LAC to which the file refers

             **Validation Rule(s)** It can be set only with a configured value in the system
            (errorCode SC01)
            It can be used only if “file type” is equal to “RSF” and “PSR”
            (errorCode XA07)
          $ref: '#/components/schemas/Lac'
        originalFileRef:
          description: The original file reference
          $ref: '#/components/schemas/FileReference'
        fileStatus:
          description: |-
            The status of file

             **Validation Rule(s)** Only TSG and ERR values can be used
            (errorCode SC01)
          $ref: '#/components/schemas/FileStatus'
        reasonCode:
          description: The validation reason code of the file
          $ref: '#/components/schemas/ReasonCode'
      required:
        - fileType
        - dateFrom
        - dateTo
        - fileStatus
    RetransmitOutFiles:
      type: object
      properties:
        commandRef:
          description: The reference of the command
          $ref: '#/components/schemas/CommandRef'
        commandType:
          description: The type of command (F01 for Retransmit Out Files)
          $ref: '#/components/schemas/CommandType'
        commandStatus:
          description: The status of the command
          $ref: '#/components/schemas/CommandStatus'
        requestDateTime:
          description: The date and time in which the command has been issued
          $ref: '#/components/schemas/DateTime'
        authRejectDateTime:
          description: The date and time in which the command has been executed or rejected
          $ref: '#/components/schemas/DateTime'
        userIssuer:
          description: The UserID of the user that has issued the command
          $ref: '#/components/schemas/UserId'
        userAuthReject:
          description: The UserID of the user that has authorized or rejected the command
          $ref: '#/components/schemas/UserId'
        fileType:
          description: The type of file
          $ref: '#/components/schemas/FileType1'
        networkFileName:
          description: The network file name of file
          $ref: '#/components/schemas/NetworkFileName'
        settlementDate:
          description: The settlement date of file
          $ref: '#/components/schemas/Date'
        dateTime:
          description: The date and time of the last command’s update
          $ref: '#/components/schemas/DateTime'
      required:
        - commandRef
        - commandType
        - commandStatus
        - requestDateTime
        - userIssuer
        - fileType
        - networkFileName
        - settlementDate
        - dateTime
    RetransmitOutFilesRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        fileRef:
          $ref: '#/components/schemas/FileRef1'
      required:
        - dateTime
        - fileRef
    RetransmitOutFilesResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        commandRef:
          description: The command reference
          $ref: '#/components/schemas/CommandRef'
      required:
        - dateTime
        - commandRef
    RetransmitOutMessage:
      type: object
      properties:
        commandRef:
          description: The relevant command reference
          $ref: '#/components/schemas/CommandRef'
        commandType:
          description: The relevant command type
          $ref: '#/components/schemas/CommandType'
        commandStatus:
          description: The relevant command status
          $ref: '#/components/schemas/CommandStatus'
        requestDateTime:
          description: The date and time when the command was requested
          $ref: '#/components/schemas/DateTime'
        authRejectDateTime:
          description: The date and time when the command was authorized or rejected
          $ref: '#/components/schemas/DateTime'
        userIssuer:
          description: The UserID of the Supervisor that has requested the command
          $ref: '#/components/schemas/UserId'
        userAuthReject:
          description: The UserID of the Supervisor that has authorized or rejected the command
          $ref: '#/components/schemas/UserId'
        messageType:
          description: The type of message to be retransmitted
          $ref: '#/components/schemas/GetMessageType'
        messageRef:
          description: The message reference
          $ref: '#/components/schemas/GetMessageRef'
        dateTime:
          description: The date and time of the last command’s update
          $ref: '#/components/schemas/DateTime'
      required:
        - commandRef
        - commandType
        - commandStatus
        - requestDateTime
        - userIssuer
        - messageType
        - messageRef
        - dateTime
    RetransmitOutMessagesRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        message:
          $ref: '#/components/schemas/Message1'
      required:
        - dateTime
        - message
    RetransmitOutMessagesResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        commandRef:
          description: The command reference
          $ref: '#/components/schemas/CommandRef'
        counter:
          description: |-
            The counter of the retransmission requested for the message.
            Possible values: 0 to 5
          $ref: '#/components/schemas/StandardInteger'
      required:
        - dateTime
        - commandRef
        - counter
    ReturnAccountDetails:
      type: object
      properties:
        settlementBIC:
          description: The settlement BIC for which the position is enquired
          $ref: '#/components/schemas/BIC11Only'
        position:
          description: The position retrieved at the relevant positionTimestamp
          $ref: '#/components/schemas/Amount'
        positionTimestamp:
          description: The timestamp at which the position is retrieved
          $ref: '#/components/schemas/DateTime'
      required:
        - settlementBIC
        - position
        - positionTimestamp
    ReturnAccountQueryResponseError:
      type: object
      properties:
        reasonCode:
          description: The Reason Code of the message
          $ref: '#/components/schemas/GetMessageReasonCode'
      required:
        - reasonCode
    ReturnTransaction:
      type: object
      properties:
        instructingSettlementBIC:
          description: The settlement BIC of the Instructing DP BIC
          $ref: '#/components/schemas/BIC11Only'
        instructingDPBIC:
          description: The DP sending the LCR for which the enquiry is requested
          $ref: '#/components/schemas/BIC8'
        instructedSettlementBIC:
          description: The settlement BIC of the Instructed DP BIC
          $ref: '#/components/schemas/BIC11Only'
        instructedDPBIC:
          description: The Instructed DP of the LCR for which the enquiry is requested
          $ref: '#/components/schemas/BIC8'
        lcrStatusUpdate:
          description: This section is repeated as many times as the status of relevant LCR has changed
          type: array
          items:
            $ref: '#/components/schemas/LcrStatusUpdate'
        totalLCRNumber:
          description: The total number of debit queued LCRs listed in the relevant camt.006
          $ref: '#/components/schemas/StandardInteger'
        totalLCRAmount:
          description: The total amount of debit queued LCRs listed in the relevant camt.006
          $ref: '#/components/schemas/StandardAmount'
    RMessage:
      type: object
      properties:
        fileType:
          description: The type of file
          $ref: '#/components/schemas/FileTypeList'
        timestampLastUpdate:
          description: The timestamp of last update
          $ref: '#/components/schemas/DateTime'
        DPSendingBIC:
          description: The DP sending BIC
          $ref: '#/components/schemas/BIC8'
        DPReceivingBIC:
          description: The DP receiving BIC
          $ref: '#/components/schemas/BIC8'
        creditorBankBIC:
          description: The financial institution that receives the transaction from either the account owner or authorized party and processes the instructions
          $ref: '#/components/schemas/BIC11'
        debtorBankBIC:
          description: The financial institution that receives the transaction instruction on behalf of the account owner or other nominated party and applies the transaction to the account
          $ref: '#/components/schemas/BIC11'
        interbankSettlementAmount:
          description: The quantity of cash that will be transferred for the individual R-message between the instructing and instructed agent in the settlement instruction.
          $ref: '#/components/schemas/StandardAmount'
        transactionReferenceId:
          description: A reference assigned by the credit party to unambiguously identify the transaction instruction
          $ref: '#/components/schemas/TransactionId'
        settlementDate:
          description: Target date on which funds cease to be available to the agent that owes the funds and on which funds become available to the agent to which funds are due
          $ref: '#/components/schemas/Date'
        transactionType:
          description: 'Whether this instruction refers to request for cancellation, reject by bank, refund/return, and reversals. The possible values are: PCR, RJB, RET, REF, RFS and, REV'
          $ref: '#/components/schemas/TransactionType'
        processingBusinessDate:
          description: STEP2 Processing business date of the R-message
          $ref: '#/components/schemas/Date'
        transactionStatus:
          description: The status of transaction
          $ref: '#/components/schemas/TransactionStatus'
        lac:
          description: |-
            The LAC received from the CGS when the transaction closed its life-cycle
            Not available for rejected transactions
          $ref: '#/components/schemas/Lac'
        debitProduct:
          description: The debit product
          $ref: '#/components/schemas/Product'
        fileReference:
          description: The reference of file
          $ref: '#/components/schemas/FileReference'
        routingType:
          description: The routing applied by the STEP2 central system to deliver this transaction
          $ref: '#/components/schemas/RoutingType'
        settlementInstReference:
          description: The reference of the settlement instruction used to settle this transaction instruction; this field will be non-empty if the Transaction Status field is “Settling”, “Settled”, “Cancelled” or “Waiting for Resubmission”
          $ref: '#/components/schemas/FileReference'
        originalCreditorBank:
          description: The original creditor PSP
          $ref: '#/components/schemas/BIC8'
        bulkType:
          description: The type of bulk
          $ref: '#/components/schemas/BulkType'
        originalBusinessDate:
          description: The Original Interbank Settlement Date reported in the R-message
          $ref: '#/components/schemas/Date'
        bulkReference:
          description: The reference of the bulk, which included this transaction
          $ref: '#/components/schemas/BulkReference'
        originalTransactionReference:
          description: The original transaction instruction reference
          $ref: '#/components/schemas/TransactionId'
        DVFReference:
          description: The relevant DVF file reference related to this transaction
          $ref: '#/components/schemas/FileReference'
        originalBulkReference:
          description: The original bulk reference of the IDF file
          $ref: '#/components/schemas/BulkReference'
        reasonCode:
          description: The reason code of this transaction, present only if the transaction has been rejected
          $ref: '#/components/schemas/ReasonCodeTransaction'
        originalFileReference:
          description: The original file reference, which included this transaction
          $ref: '#/components/schemas/FileReference'
        LCRReference:
          description: The reference of the LCR which included this transaction
          $ref: '#/components/schemas/LcrReference'
        originalEndToEndId:
          description: 'The original end to end identifier: it is always returned as “collapsed”'
          $ref: '#/components/schemas/EndToEnd'
      required:
        - fileType
        - timestampLastUpdate
        - DPSendingBIC
        - DPReceivingBIC
        - creditorBankBIC
        - debtorBankBIC
        - interbankSettlementAmount
        - transactionReferenceId
        - settlementDate
        - transactionType
        - processingBusinessDate
        - transactionStatus
        - fileReference
        - routingType
        - settlementInstReference
        - originalCreditorBank
        - bulkType
        - originalBusinessDate
        - bulkReference
        - DVFReference
        - originalBulkReference
        - originalFileReference
        - originalEndToEndId
    RoutingType:
      description: Routing Type.
      type: string
      enum:
        - DIR
        - IND
      examples:
        - DIR
    SearchCriteria:
      type: object
      properties:
        name:
          description: The name of the relevant DP
          $ref: '#/components/schemas/ParticipantName'
        BICCode:
          description: The BIC of the relevant DP
          $ref: '#/components/schemas/BIC8'
        initParticipantValidity:
          description: The Initial validity date of the DP
          $ref: '#/components/schemas/Date'
        endParticipantValidity:
          description: The end validity date of the DP
          $ref: '#/components/schemas/Date'
        status:
          description: |-
            The status of the DP

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/ParticipantStatus'
        CAIUserGroup:
          description: |-
            Whether the DP is configured for CAI

             **Validation Rule(s)** Possible values:
            true=configured for CAI
            false=not configured for CAI
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        batchProcessingMode:
          description: |-
            Whether the DP is configured for Batch Processing Option

             **Validation Rule(s)** Possible values:
            true=configured for BPO
            false=not configured for BPO
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        technicalBIC:
          description: |-
            Whether the DP is a technical BIC

             **Validation Rule(s)** Possible values:
            true=Technical BIC
            false=no Technical BIC
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        NLOUserGroup:
          description: |-
            Whether the DP is configured for NLO

             **Validation Rule(s)** Possible values:
            true=configured for NLO
            false=not configured for NLO
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        ICMUserGroup:
          description: |-
            Whether the DP is configured for ICM

             **Validation Rule(s)** Possible values:
            true=configured for ICM
            false=not configured for ICM
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        network:
          description: |-
            The network channel used by the DP

             **Validation Rule(s)** It can be set only with a configured value in the system
            (errorCode SC01)
          $ref: '#/components/schemas/Network'
    SearchCriteria1:
      type: object
      properties:
        name:
          description: The name of the relevant RB
          $ref: '#/components/schemas/ParticipantName'
        BICCode:
          description: The BIC of the relevant RB
          $ref: '#/components/schemas/Bic11Only'
        initParticipantValidity:
          description: The Initial validity date of the RB
          $ref: '#/components/schemas/Date'
        endParticipantValidity:
          description: The end validity date of the RB
          $ref: '#/components/schemas/Date'
        status:
          description: |-
            The status of the RB

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/ParticipantStatus'
        DPBICCode:
          description: The BIC of the DP linked to the RB
          $ref: '#/components/schemas/BIC8'
        NLOUserGroup:
          description: |-
            Whether the RB is configured for NLO

             **Validation Rule(s)** Possible values:
            true= configured for NLO
            false= not configured for NLO
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        ICMUserGroup:
          description: |-
            Whether the RB is configured for ICM

             **Validation Rule(s)** Possible values:
            true= configured for ICM
            false= not configured for ICM
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
        CAIUserGroup:
          description: |-
            Whether the RB is configured for CAI

             **Validation Rule(s)** Possible values:
            true= configured for CAI
            false= not configured for CAI
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
    SearchCriteria10:
      type: object
      properties:
        fileType:
          description: |-
            The file type in which the relevant message is sent/received.

             **Validation Rule(s)** Mandatory for messages sent via file
            (errorCode SC01)
            Only "IGF" and "OGF" values can be used
            (errorCode SC01)
          $ref: '#/components/schemas/FileType1'
        messageType:
          description: |-
            The relevant message type

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/GetMessageType'
        senderReceiverBIC:
          description: |-
            The BIC sending/receiving the message

             **Validation Rule(s)** If set, it must correspond to the BIC of the senderBIC
            (errorCode PY01)
          $ref: '#/components/schemas/BIC8'
        dateTimeFrom:
          description: |-
            The start date and time of the relevant search timespan

             **Validation Rule(s)** It must be previous or equal to the current date and time (errorCode DT01)
          $ref: '#/components/schemas/DateTime'
        dateTimeTo:
          description: |-
            The end date of the relevant search timespan

             **Validation Rule(s)** It must be greater than or equal to the dateTimeFrom  (errorCode DT01)
          $ref: '#/components/schemas/DateTime'
        messageRef:
          description: The reference ID of the message
          $ref: '#/components/schemas/GetMessageRef'
        originalMessageRef:
          description: |-
            The original message reference

             **Validation Rule(s)** The original message reference. Applicable only to:
            • Camt.004
            • Camt.006
            (errorCode XA07)
          $ref: '#/components/schemas/GetMessageRef'
        messageStatus:
          description: |-
            The status of the relevant message.
            Possible values:
            • RCV – Received: received messages; applicable to camt.003 and camt.005
            • VAL – Validated:  validate messages; applicable to camt.003 and camt.005
            • RJS – Rejected by CS: rejected by STEP2; applicable to camt.003 and camt.005. Messages in RJS status can be retrieved starting from both IGF and OGF.
            • TSD – Transmitted:  the output message is sent to the sender BIC; applicable to camt.004 and camt.006;
            • TSG – Transmitting: the message has been created and not yet sent, or it’s in the process of being transmitted; applicable to camt.004 and camt.006;
            • ERR – Error: the output message sending failed

             **Validation Rule(s)** If filled in, it must be set with one of the values configured in the system and applicable to the relevant message type
            (errorCode SC01)
            The field is available only for messages sent/received via Swiftnet
            (errorCode SC01)
          $ref: '#/components/schemas/GetMessageStatus'
        reasonCode:
          description: The validation reason code associated to the message
          $ref: '#/components/schemas/GetMessageReasonCode'
        IGFFileRef:
          description: |-
            The reference of the relevant IGF
            Applicable only for messages sent into files via SIANet or EBICS
          $ref: '#/components/schemas/FileReference'
        OGFFileRef:
          description: |-
            The reference of the relevant OGF
            Applicable only for messages sent into files via SIANet or EBICS
          $ref: '#/components/schemas/FileReference'
        network:
          description: |-
            The network through which the message is received

             **Validation Rule(s)** If filled in, it must be set with one of the values configured in the system
            Possible values:
            SWF, "Swiftnet single request type"
            SWA, "Swiftnet multiple request type"
            EAS, "SIANet"
            EBX, "EBICS Network"
            SWS, "SWIFTNet S&F Single Request Type"
            SWM, "SWIFTNet S&F Multiple Request Type"
            (errorCode SC01)
          $ref: '#/components/schemas/Network2'
      required:
        - messageType
        - senderReceiverBIC
    SearchCriteria11:
      type: object
      properties:
        reportRef:
          description: The reference of report
          $ref: '#/components/schemas/ReportRef'
        creationDateTimeFrom:
          description: The creation Date and Time - From
          $ref: '#/components/schemas/DateTime'
        creationDateTimeTo:
          description: The creation Date and Time - To
          $ref: '#/components/schemas/DateTime'
        reportStatus:
          description: |-
            The status of report

             **Validation Rule(s)** It can be set only with a configured value in the system
            (errorCode SC01)
          $ref: '#/components/schemas/ReportStatus'
    SearchCriteria12:
      type: object
      properties:
        commandType:
          description: |-
            The type of command

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/CommandType'
        commandStatus:
          description: |-
            The status of the command

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/CommandStatus'
        requestDateTimeFrom:
          description: The date and time in which the command has been issued - From
          $ref: '#/components/schemas/DateTime'
        requestDateTimeTo:
          description: The date and time in which the command has been issued - To
          $ref: '#/components/schemas/DateTime'
        authRejectDateTimeFrom:
          description: The date and time in which the command has been executed or rejected - From
          $ref: '#/components/schemas/DateTime'
        authRejectDateTimeTo:
          description: The date and time in which the command has been executed or rejected - To
          $ref: '#/components/schemas/DateTime'
        userIssuer:
          description: The UserID of the user that has issued the command
          $ref: '#/components/schemas/UserId'
        userAuthReject:
          description: The UserID of the user that has authorized or rejected the command
          $ref: '#/components/schemas/UserId'
    SearchCriteria13:
      type: object
      properties:
        dateTimeFrom:
          description: The Date and Time of the event - From
          $ref: '#/components/schemas/DateTime'
        dateTimeTo:
          description: The Date and Time of the event - To
          $ref: '#/components/schemas/DateTime'
        eventDescription:
          description: The description of the event
          $ref: '#/components/schemas/EventDescription'
        issuer:
          description: The UserID of the user that has issued the command triggering the event
          $ref: '#/components/schemas/UserId'
        authorizer:
          description: The UserID of the user that has authorized or rejected the command triggering the event
          $ref: '#/components/schemas/UserId'
    SearchCriteria14:
      type: object
      properties:
        instructingDPBIC:
          description: |-
            The Instructing Agent BIC

             **Validation Rule(s)** Must be present if the Instructed Agent BIC has not been set (errorCode XA04).
            Either the Instructing Agent or the Instructed Agent must be set with the DP BIC configured for the User (errorCode XA07).
          $ref: '#/components/schemas/BIC8'
        instructedDPBIC:
          description: |-
            The Instructed Agent BIC

             **Validation Rule(s)** Must be present if the Instructing Agent BIC has not been set (errorCode XA04).
            Either the Instructing Agent or the Instructed Agent must be set with the DP BIC configured for the User (errorCode XA07).
          $ref: '#/components/schemas/BIC8'
        instgSttlmBIC:
          description: The Settlement BIC configured for the Instructing Agent
          $ref: '#/components/schemas/Bic11Only'
        instdSttlmBIC:
          description: The Settlement BIC configured for the Instructed Agent
          $ref: '#/components/schemas/Bic11Only'
        settlementDateFrom:
          description: |-
            The LCR settlement date
            The lowest value of date and time range for searching LCRs.
            It corresponds to the date when the LCR closed its life-cycle

             **Validation Rule(s)** Maximum range allowed five target days (errorCode DT01)
          $ref: '#/components/schemas/Date'
        settlementDateTo:
          description: |-
            The LCR settlement date
            The highest value of date and time range for searching LCRs.
            It corresponds to the date when the LCR closed its life-cycle

             **Validation Rule(s)** Maximum range allowed five target days (errorCode DT01)
          $ref: '#/components/schemas/Date'
        dateTimeFrom:
          description: |-
            The lowest value of date and time range for searching LCRs
            It corresponds to the date and time when the LCR closed its life-cycle

             **Validation Rule(s)** Maximum range allowed five target days (errorCode DT01)
          $ref: '#/components/schemas/DateTime'
        dateTimeTo:
          description: |-
            The highest value of date and time range for searching LCRs
            It corresponds to the date and time when the LCR closed its life-cycle

             **Validation Rule(s)** Maximum range allowed five target days (errorCode DT01)
          $ref: '#/components/schemas/DateTime'
        referenceLCR:
          description: The LCR reference
          $ref: '#/components/schemas/FileReference'
        bulkType:
          description: |-
            The bulk type to which the LCR relates

             **Validation Rule(s)** Possible values are:
            - pacs.003
            - pacs.004
            - pacs.007
            (errorCode XA07)
          $ref: '#/components/schemas/BulkType2'
        lac:
          description: |-
            The LAC in which the relevant LCR closed its life-cycle

             **Validation Rule(s)** It must be a valid LAC
            (errorCode SC01)
          $ref: '#/components/schemas/Lac'
        lcrStatus:
          description: |-
            The status of the LCR

             **Validation Rule(s)** It must be a valid code
            (errorCode SC01)
          $ref: '#/components/schemas/LcrStatus'
      required:
        - settlementDateFrom
        - settlementDateTo
    SearchCriteria15:
      type: object
      properties:
        settlementDate:
          description: The LCR settlement date
          $ref: '#/components/schemas/Date'
        referenceLCR:
          description: The LCR reference
          $ref: '#/components/schemas/FileReference'
        lac:
          description: |-
            The LAC in which the relevant LCR has closed its life-cycle

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/Lac'
        lcrStatus:
          description: |-
            The status of the  LCR

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/LcrStatus'
      required:
        - referenceLCR
    SearchCriteria2:
      type: object
      properties:
        counterpartBICCode:
          description: The BIC code of the counterpart
          $ref: '#/components/schemas/BIC8'
        counterpartName:
          description: The name of the counterpart
          $ref: '#/components/schemas/ParticipantName'
        activationDateFrom:
          description: The date from which the BPO relationship is valid
          $ref: '#/components/schemas/Date'
        activationDateTo:
          description: The date to which the BPO relationship is valid
          $ref: '#/components/schemas/Date'
        removalDateFrom:
          description: The date from which the BPO relationship is removed
          $ref: '#/components/schemas/Date'
        removalDateTo:
          description: The date to which the BPO relationship is removed
          $ref: '#/components/schemas/Date'
        requestorUser:
          description: The requestor user
          $ref: '#/components/schemas/UserId'
        authorizerUser:
          description: The authorizer user
          $ref: '#/components/schemas/UserId'
    SearchCriteria3:
      type: object
      properties:
        DPRBOperation:
          description: |-
            Whether the operation refers to a Direct Participant or a Reachable BIC

             **Validation Rule(s)** Possible values:
            - DIR, if the command is referred to DP
            - IND, if the command is referred to an RB
            (errorCode SC01)
          $ref: '#/components/schemas/DPRBOperation'
        DPBICCode:
          description: |-
            The DP related to the operation

             **Validation Rule(s)** It must correspond to the senderBIC
            (errorCode PY01)
          $ref: '#/components/schemas/BIC8'
        RBBICCode:
          description: |-
            The Reachable BIC related to the operation

             **Validation Rule(s)** It must correspond to an RB listed in routing table under the senderBIC
            (errorCode PY01)
          $ref: '#/components/schemas/Bic11Only'
        operationType:
          description: |-
            The operation type:
            INS for “Insert”
            REM for “Remove”
            UPD for “Update”
            RON for "R-Only"
            BRI for “Insert BRT”
            BRR for “Remove BRT”
            MOD for “Amend Change”
            REV for “Revoke Change”
            CDP for “RB Change DP”

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/OperationType'
        effectiveDate:
          description: The effective date of the operation.
          $ref: '#/components/schemas/Date'
        operationStatus:
          description: |-
            The operation status. Possible values:
            AUT for “Authorized”
            EXE for “Executed”
            REJ for  “Rejected by User”
            RJS for “Rejected by System”
            TBA for “To Be Authorized”
            TBC for "Submitted"

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/OperationStatus'
        requestDate:
          description: The date of the request
          $ref: '#/components/schemas/Date'
        confirmDate:
          description: |-
            The date of the confirmation by Participant User.
            Applicable only in case of “Critical” operation
          $ref: '#/components/schemas/Date'
        authRejectDate:
          description: The date of the authorization/rejection
          $ref: '#/components/schemas/Date'
        userIssuer:
          description: The user Id of the user who issued the operation
          $ref: '#/components/schemas/UserId'
        confirmer:
          description: |-
            The user Id of the user who confirmed the operation.
            Applicable only in case of “Critical” operation
          $ref: '#/components/schemas/UserId'
        userAuthReject:
          description: The user Id of the user who authorized/rejected the operation
          $ref: '#/components/schemas/UserId'
        operationRef:
          description: The operation reference
          $ref: '#/components/schemas/OperationReference'
        critical:
          description: |-
            Whether the operation is critical
            true= critical operation
            false=non-critical operation

             **Validation Rule(s)** It must be set as
            - true; or
            - false
            (errorCode SC01)
          $ref: '#/components/schemas/GenericBoolean'
    SearchCriteria4:
      type: object
      properties:
        counterpartyBIC:
          description: The BIC of the credit party
          $ref: '#/components/schemas/BIC8'
    SearchCriteria5:
      type: object
      properties:
        interbankSettlementDate:
          description: The relevant interbank settlement date
          $ref: '#/components/schemas/Date'
        lac:
          description: The relevant LAC
          $ref: '#/components/schemas/Lac'
        counterpartyBIC:
          description: The BIC of the counterparty (Credit BIC)
          $ref: '#/components/schemas/BIC8'
      required:
        - interbankSettlementDate
    SearchCriteria6:
      type: object
      properties:
        settlementDate:
          description: |-
            The relevant settlement date

             **Validation Rule(s)** It can be filled only with the current or future date (errorCode DT01)
          $ref: '#/components/schemas/Date'
      required:
        - settlementDate
    SearchCriteria7:
      type: object
      properties:
        fileType:
          description: |-
            The file type which included this transaction

             **Validation Rule(s)** It must be set with one of the configured values
            (errorCode SC01)
             “DRR”, “MSR”, “PSR” or “RTF” values cannot be used
            (ErrorCode XA07)
          $ref: '#/components/schemas/FileTypeList'
        PACSMessageType:
          description: |-
            The type of transaction to be enquired

             **Validation Rule(s)** It must be set with one of the configured values
            (errorCode SC01)
            If the “file type” is equal to “IDF”, it must be valorized with “DD.Message” or “R.Message”
            (errorCode XA07)
            If the “file type” is equal to “DVF”, it must be valorized with “Pacs.2S2”
            (errorCode XA07)
          $ref: '#/components/schemas/MessageType'
        lac:
          description: |-
            The LAC to which transaction is related
            It corresponds to the LAC when the transaction closed its life-cycle. Not available for rejected transactions.

             **Validation Rule(s)** It must be set with one of the configured values
            (errorCode SC01)
          $ref: '#/components/schemas/Lac'
        instructingAgent:
          description: |-
            The clearing agent that sends the (file of) transaction instructions

             **Validation Rule(s)** It cannot be used at the same time as Instructed Agent (below)
            (errorCode XA07)
            It can be used if the file type is equal to “DNF”,  “DVF” or “RSF”
            (errorCode XA07)
          $ref: '#/components/schemas/BIC8'
        instructedAgent:
          description: |-
            The clearing agent that receives the (file of) transaction instructions

             **Validation Rule(s)** It cannot be used at the same time as Instructing Agent (above)
            (errorCode XA07)
            It can be used if the file type is equal to “IDF”
            (errorCode XA07)
          $ref: '#/components/schemas/BIC8'
        transactionStatus:
          description: |-
            The status of transaction to be enquired

             **Validation Rule(s)** It must be set with one of the configured values
            (errorCode SC01)
          $ref: '#/components/schemas/TransactionStatus'
        bulkReference:
          description: The reference of the bulk which included this transaction
          $ref: '#/components/schemas/BulkReference'
        transactionRefId:
          description: The reference assigned to the transaction instruction
          $ref: '#/components/schemas/TransactionId'
        creditorAgent:
          description: Financial institution that receives the transaction from either the account owner or authorized party and processes the instructions
          $ref: '#/components/schemas/BIC11'
        debtorAgent:
          description: The financial institution that receives the transaction instruction on behalf of the account owner or other nominated party and applies the transaction to the account
          $ref: '#/components/schemas/BIC11'
        processingBusinessDate:
          description: |-
            The STEP2 business date opened when the transaction was processed

             **Validation Rule(s)** It must be lesser or equal to the current calendar date and timestamp (ErrorCode DT01)
          $ref: '#/components/schemas/Date'
        IDFReference:
          description: The reference identifier of the IDF file, which included this transaction
          $ref: '#/components/schemas/FileReference'
        DVFReference:
          description: The relevant DVF file reference related to this transaction
          $ref: '#/components/schemas/FileReference'
        LCRReference:
          description: The reference of the LCR related to this transaction
          $ref: '#/components/schemas/LcrReference'
        debitProduct:
          description: |-
            The debit product.

             **Validation Rule(s)** It must be set with one of the configured values
            (errorCode SC01)
          $ref: '#/components/schemas/DebitProduct'
        interbankSettlementDate:
          description: The Target date when funds cease to be available to the agent who owes the funds and when funds become available to the agent whom funds are due to
          $ref: '#/components/schemas/Date'
        sequenceType:
          description: The type of direct debit
          $ref: '#/components/schemas/Sequence'
        creditorId:
          description: The Creditor ID of the debit creditor
          $ref: '#/components/schemas/CreditorId'
        mandateId:
          description: The mandate ID of the debit mandate.
          $ref: '#/components/schemas/MandateId'
        transactionType:
          description: |-
            The type of transaction

             **Validation Rule(s)** It must be set with one of the configured values
            (errorCode SC01)
            It cannot be present if “PACSMessageType” field is equal to “DD.Message”
          $ref: '#/components/schemas/TransactionType'
        originalTransactionId:
          description: The original reference of the transaction (only for Payment Cancellation Request, Payment Status, Return or Reversal transactions)
          $ref: '#/components/schemas/TransactionId'
        settlementDate:
          description: The settlement date
          $ref: '#/components/schemas/Date'
        originalSettlementDate:
          description: The original settlement date when the original transaction was settled (only for Payment Cancellation Request, Payment Status, Return or Reversal)
          $ref: '#/components/schemas/Date'
        originalAmount:
          description: |-
            The original amount only for (Payment Cancellation Request, Payment Status, Return or Reversal)

             **Validation Rule(s)** Only decimal notation is allowed
            (errorCode XA05)
          $ref: '#/components/schemas/StandardAmount'
      required:
        - fileType
        - interbankSettlementDate
    SearchCriteria8:
      type: object
      properties:
        fileType:
          description: |-
            The type of file

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
             “DRR”, “MSR”, “PSR” or “RTF” values cannot be used
            (errorCode XA07)
          $ref: '#/components/schemas/FileTypeList'
        messageType:
          description: |-
            The type of message

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
            Mandatory in case fileType is equal to “IDF” (errorCode XA04)
            If fileType is equal to “IDF” this field must be populated with “DD.Message” or “R.Message” (errorCode XA07)
          $ref: '#/components/schemas/MessageType'
        fileReference:
          description: The reference of the file
          $ref: '#/components/schemas/FileReference'
        bulkStatus:
          description: |-
            The status of the bulk

             **Validation Rule(s)** It can be used only if the File Type is equal to “IDF” (errorCode XA07)
            It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/BulkStatus'
        bulkReference:
          description: The reference of the bulk
          $ref: '#/components/schemas/BulkReference'
        date:
          description: The date of STEP2 CS of the bulk header
          $ref: '#/components/schemas/Date'
        dateType:
          description: |-
            The type of date  of STEP2 CS of the bulk header

             **Validation Rule(s)** The allowed values are:
            - Business Date
            - Calendar Date
            - Settlement Date
            ErrorCode SC01
          $ref: '#/components/schemas/DataType'
        lac:
          description: |-
            The LAC to which this bulk is related
            Only available for bulks included in Output files generated for Participants configured for settling in CGS

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
            It cannot be used if “file type” is equal to “IDF” or “DVF” (errorCode XA07)
          $ref: '#/components/schemas/Lac'
      required:
        - fileType
        - dateType
    SearchCriteria9:
      type: object
      properties:
        fileType:
          description: The type of file
          $ref: '#/components/schemas/FileType1'
        dateTimeFrom:
          description: |-
            The oldest date and time of the reception or sending of the files by the system

             **Validation Rule(s)** It must be previous or equal to the current date and time (errorCode DT01)
          $ref: '#/components/schemas/DateTime'
        dateTimeTo:
          description: |-
            The maximum date for which the files are requested

             **Validation Rule(s)** It must be greater than or equal to the dateTimeFrom  (errorCode DT01)
          $ref: '#/components/schemas/DateTime'
        dateType:
          description: |-
            The date type of the file

             **Validation Rule(s)** The possible values are:
            - Business Date
            - Calendar Date
            ErrorCode SC01
          $ref: '#/components/schemas/DateType1'
        fileReference:
          description: The reference of file
          $ref: '#/components/schemas/FileReference'
        lac:
          description: |-
            The LAC to which file is related
            Only available for Output files generated for Participants configured to settle in CGS

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
            It can be used only if “fileType” is equal to “RSF” and “PSR”
            (errorCode XA07)
          $ref: '#/components/schemas/Lac'
        originalFileRef:
          description: |-
            The original file reference
            This criterion is only relevant for “IDF” and “DVF” files.
            If the fileType criterion is set to “IDF” this field can be used to search the “DVF” file reference to which this file relates.
            If the fileType criterion is set to “DVF” this field can be used to search the Sender’s File Reference of the “IDF” to which this file relates.
          $ref: '#/components/schemas/FileReference'
        fileStatus:
          description: |-
            The status of the file

             **Validation Rule(s)** It must be set with one of the values configured in the system
            (errorCode SC01)
          $ref: '#/components/schemas/FileStatus'
        reasonCode:
          description: The validation reason code associated to the file
          $ref: '#/components/schemas/ReasonCode'
      required:
        - fileType
        - dateType
    SenderBIC:
      description: BIC searching.
      type: string
      pattern: '[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}'
      examples:
        - BICCOR1X
    Sequence:
      description: Sequence Type.
      type: string
      maxLength: 4
      examples:
        - RCUR
    SettlementFile:
      description: Number of file.
      type: integer
      minimum: 1
      maximum: 3
      examples:
        - 1
    Sign:
      type: string
      enum:
        - C
        - D
      examples:
        - C
    StandardAmount:
      description: Standard Amount.
      type: number
      format: double
      maximum: 999999999999999.99
      examples:
        - 10000.01
    StandardInteger:
      description: Standard Integer.
      type: integer
      format: int32
      examples:
        - 1000
    ThirdPoleReportReceivingRequestRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        reportRef:
          description: The reference of the report
          $ref: '#/components/schemas/ReportRef'
      required:
        - dateTime
        - reportRef
    ThirdPoleReportReceivingRequestResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API response creation
          $ref: '#/components/schemas/DateTime'
        report:
          $ref: '#/components/schemas/Report'
      required:
        - dateTime
    ThirdPoleReportRequestRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        reportCriteria:
          $ref: '#/components/schemas/ReportCriteria'
      required:
        - dateTime
        - reportCriteria
    ThirdPoleReportRequestResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
      required:
        - dateTime
    TransactionDetailsRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API request creation
          $ref: '#/components/schemas/DateTime'
        transactionRef:
          $ref: '#/components/schemas/TransactionRef'
      required:
        - dateTime
        - transactionRef
    TransactionDetailsResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        DMessage:
          $ref: '#/components/schemas/DMessage'
        RMessage:
          description: The information related to the R-message
          $ref: '#/components/schemas/RMessage'
      required:
        - dateTime
    TransactionId:
      description: Transaction reference.
      type: string
      pattern: ([A-Za-z0-9]|[+|\?|/|\-|:|\(|\)|\.|,|']){1,35}
      examples:
        - TESTTRANSEF135000000000000000000123
    TransactionRef:
      type: object
      properties:
        transactionType:
          description: |-
            The type of transaction to be enquired

             **Validation Rule(s)** It must be set only with one of the configured values on the system
            (errorCode SC01)
            If the file type is equal to “IDF” or “DNF”’ it must be set as “DDM”, “PCR”, “RET”, “REF”, “RJB”, “RFS” or “REV”
            (errorCode XA07)
             If the file type is equal to “RSF” it must be set as “DDM”, “PCR”, “RET”, “REF” or “REV”
            (errorCode XA07)
            If the file type is equal to “DVF” it must be set as “S22’
            (errorCode XA07)
          $ref: '#/components/schemas/TransactionType'
        interbankSettlementDate:
          description: |-
            The Interbank settlement date of the transaction

             **Validation Rule(s)** It must be set only with one of the configured values on the system
            (errorCode SC01)
          $ref: '#/components/schemas/Date'
        transactionId:
          description: The reference assigned  to the transaction instruction
          $ref: '#/components/schemas/TransactionId'
        fileType:
          description: |-
            The type of file

             **Validation Rule(s)** “DRR”, “MSR”, “PSR” or “RTF” values cannot be used
            (errorCode XA07)
          $ref: '#/components/schemas/FileTypeList'
        creditorBankBIC:
          description: |-
            The BIC of the Creditor PSP

             **Validation Rule(s)** Mandatory if transactionType is equal to “DDM”, PCR” or "REV”
            (errorCode XA04)
          $ref: '#/components/schemas/BIC11'
        debtorBankBIC:
          description: |-
            The BIC of the Debtor PSP

             **Validation Rule(s)** Mandatory if transactionType is equal to “RET”, “REF”, “RJB” or "RSF”
            (errorCode XA04)
          $ref: '#/components/schemas/BIC11'
        lac:
          description: |-
            The LAC to which transaction is related
            It corresponds to the LAC when the transaction closed its life-cycle. Not available for rejected transactions.

             **Validation Rule(s)** It must be set with one of the configured values
            (errorCode SC01)
          $ref: '#/components/schemas/Lac'
      required:
        - transactionId
    TransactionRef1:
      type: object
      properties:
        transactionType:
          description: |-
            It must be set with one of the configured values on the system
            (errorCode SC01)
            If the file type is equal to “IDF” or “DNF”’ it must be valorized with “DDM”, “PCR”, “RET”, “REF”, “RJB”, “RFS” or “REV”
             If the file type is equal to “RSF” it must be valorized with “DDM”, “PCR”, “RET”, “REF” or “REV”
            If the file type is equal to “DVF” it must be valorized with “S22"
          $ref: '#/components/schemas/TransactionType'
        interbankSettlementDate:
          $ref: '#/components/schemas/Date'
        transactionId:
          $ref: '#/components/schemas/TransactionId'
        fileType:
          description: |-
            It must be set with one of the configured values on the system
            (errorCode SC01)
            Cannot be used “DRR”, “MSR”, “PSR” or “RTF”
            (errorCode XA07)
            Mandatory if Transaction Type is equal to “DDM”, PCR” or REV”
            (errorCode XA07)
            Mandatory if Transaction Type is equal to “RET”, “REF”, “RJB” or RSF”
            (errorCode XA07)
          $ref: '#/components/schemas/FileTypeList'
        creditorBankBIC:
          description: The creditor bank BIC
          $ref: '#/components/schemas/BIC11'
        debtorBankBIC:
          description: The debtor bank BIC
          $ref: '#/components/schemas/BIC11'
        lac:
          description: |-
            The LAC running when the transaction was settled or processed.
            It can be retrieved transaction in status STD or CNL

             **Validation Rule(s)** It must be set with one of the LAC values provided by the system
            (errorCode SC01)
          $ref: '#/components/schemas/Lac'
      required:
        - transactionId
    Transactions:
      type: object
      properties:
        transactionType:
          description: The type of transaction to be enquired
          $ref: '#/components/schemas/TransactionType'
        processingBsnDate:
          description: The STEP2 business date opened when the transaction was processed
          $ref: '#/components/schemas/Date'
        lac:
          description: |-
            The LAC received from the CGS when the transaction closed its life-cycle.
            Not available for rejected transactions
          $ref: '#/components/schemas/Lac'
        transactionId:
          description: The reference assigned to the transaction
          $ref: '#/components/schemas/TransactionId'
        instructingBIC:
          description: The clearing agent that prepares the (file of) transaction instructions and forwards it to the next party in the transaction chain
          $ref: '#/components/schemas/BIC8'
        instructedBIC:
          description: The clearing agent that receives the (file of) transaction instructions
          $ref: '#/components/schemas/BIC8'
        bulkReference:
          description: The bulk reference, which included this transaction
          $ref: '#/components/schemas/BulkReference'
        transactionStatus:
          description: The status of transaction to be enquired
          $ref: '#/components/schemas/TransactionStatus'
        interbankSettlementAmount:
          description: The amount of the searched payment instructions
          $ref: '#/components/schemas/StandardAmount'
        interbankSettlementDate:
          description: The Target date when funds cease to be available to the agent who owes the funds and when funds become available to the agent whom funds are due to
          $ref: '#/components/schemas/Date'
        fileType:
          description: The type of file to be enquired
          $ref: '#/components/schemas/FileTypeList'
        creditorOutBulkReference:
          description: The creditor out bulk reference present if the file type is equal to RSF
          $ref: '#/components/schemas/BulkReference'
        debitorOutBulkReference:
          description: The debtor out bulk reference present if the file type is equal to RSF
          $ref: '#/components/schemas/BulkReference'
        creditorBankBIC:
          description: The financial institution that receives the transaction from either the account owner or authorized party and processes the instructions
          $ref: '#/components/schemas/BIC11'
        debtorBankBIC:
          description: The financial institution that receives the transaction instruction on behalf of the account owner or other nominated party and applies the transaction to the account
          $ref: '#/components/schemas/BIC11'
      required:
        - transactionType
        - processingBsnDate
        - transactionId
        - instructingBIC
        - instructedBIC
        - bulkReference
        - transactionStatus
        - interbankSettlementAmount
        - interbankSettlementDate
        - fileType
        - creditorBankBIC
        - debtorBankBIC
    TransactionStatus:
      description: Status of the transaction.
      type: string
      enum:
        - VAL
        - NTF
        - STG
        - STD
        - CNL
        - CNN
        - PCR
        - RJB
        - RFS
        - RVF
        - RET
        - RFA
        - RFU
      examples:
        - STG
    TransactionType:
      description: Transaction Type.
      type: string
      enum:
        - PCR
        - RET
        - REF
        - RJB
        - RFS
        - REV
        - S22
        - DDM
      examples:
        - RET
    UpdateDefaultThresholdRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        defaultThreshold:
          $ref: '#/components/schemas/DefaultThreshold'
      required:
        - dateTime
        - defaultThreshold
    UpdateDefaultThresholdResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
      required:
        - dateTime
    UpdateDirectParticipantRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API request creation
          $ref: '#/components/schemas/DateTime'
        effectiveDate:
          description: |-
            The effective date of the change

             **Validation Rule(s)** For critical parameters, the first available effective date must be set as follows:
            - the effective date must be equal to one of the effective date stored within "Change Dates Calendar" functionality
            - the business date when the operation is confirmed, must precede or must be equal to "Submission Date" relevant to the chosen “Effective Date”
            For Non-Critical parameters, the first available effective date corresponds to the first available TARGET day according to warehousing constraints set for the parameter, if any.
            (error code DT01)
            Another configuration with the same effective date is already existing
            (errorCode XA22)
          $ref: '#/components/schemas/Date'
        parameters:
          $ref: '#/components/schemas/Parameters1'
      required:
        - dateTime
        - effectiveDate
        - parameters
    UpdateDirectParticipantResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        operationRef:
          description: The reference assigned by the system to the "Update" operation
          $ref: '#/components/schemas/OperationReference'
      required:
        - dateTime
        - operationRef
    UpdateReachableBICRequest:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Request creation
          $ref: '#/components/schemas/DateTime'
        RBBICCode:
          description: |-
            The Reachable BIC to be updated

             **Validation Rule(s)** It must be a Reachable BIC of the senderBIC
            (errorCode PY01)
          $ref: '#/components/schemas/Bic11Only'
        effectiveDate:
          description: |-
            The effective date of the change

             **Validation Rule(s)** For critical parameters, the first available effective date must be set as follows:
            - the effective date must be equal to one of the effective date stored within "Change Dates Calendar" functionality
            - the business date when the operation is confirmed, must precede or must be equal to "Submission Date" relevant to the chosen “Effective Date”
            For Non-Critical parameters, the first available effective date corresponds to the first available TARGET day according to warehousing constraints set for the parameter, if any.
            (error code DT01)
            Another configuration with the same effective date is already existing
            (errorCode XA22)
          $ref: '#/components/schemas/Date'
        parameters:
          $ref: '#/components/schemas/Parameters2'
      required:
        - dateTime
        - RBBICCode
        - effectiveDate
        - parameters
    UpdateReachableBICResponse:
      type: object
      properties:
        dateTime:
          description: The date and time of the API Response creation
          $ref: '#/components/schemas/DateTime'
        operationRef:
          description: The reference of the "Update" operation requested via API
          $ref: '#/components/schemas/OperationReference'
      required:
        - dateTime
        - operationRef
    UserId:
      description: User.
      type: string
      pattern: (\S+.*){8,8}
      examples:
        - APIUSER1
    Errors:
      description: Container to return multiple ErrorMessage object. Collection of error can be useful when API needs to return multiple errors, for example validation errors. When the response code conveys application-specific functional semantics and consumer can parse machine-readable error code, this block can be useful. The error response must contain at least one error object.
      type: array
      items:
        $ref: '#/components/schemas/ErrorMessage'
    ErrorMessage:
      description: Custom error schema to support detailed error message.
      type: object
      additionalProperties: false
      required:
        - code
        - severity
        - text
      properties:
        severity:
          description: Specifies the severity of the error.
          type: string
          enum:
            - Fatal
            - Transient
            - Logic
        code:
          description: Specifies the custom error code as defined by the service provider.
          type: string
          minLength: 3
          maxLength: 70
        text:
          description: Specifies the detail error message identifying the cause of the error.
          type: string
          minLength: 1
          maxLength: 255
        user_message:
          description: A human-readable text describing the error.
          type: string
          minLength: 1
          maxLength: 255
        more_info:
          description: Specifies an URL to find more information about the error.
          type: string
          format: uri
  responses:
    ErrorResponse_204:
      description: No Content
      content:
        text/plain:
          schema:
            type: string
            examples:
              - TSTBICXX204
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
    ErrorResponse_401:
      description: Unauthorized
      content:
        text/plain:
          schema:
            type: string
            examples:
              - TSTBICXX401
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
    ErrorResponse_403:
      description: Forbidden
      content:
        text/plain:
          schema:
            type: string
            examples:
              - TSTBICXX403
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
    ErrorResponse_404:
      description: Not Found
      content:
        text/plain:
          schema:
            type: string
            examples:
              - TSTBICXX404
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
    ErrorResponse_429:
      description: Too many requests
      content:
        text/plain:
          schema:
            type: string
            examples:
              - TSTBICXX429
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'
    ErrorResponse_500:
      description: Internal Server Error
      content:
        text/plain:
          schema:
            type: string
            examples:
              - TSTBICXX500
      headers:
        X-Request-ID:
          $ref: '#/components/headers/X-Request-ID'