swagger: '2.0'
info:
  description: 'APIs serão utilizadas no envio de informações sobre pós negociação (Alocação de Renda Fixa Balcão)'
  version: '1.5'
  title: 'OTCFixedIncomeAllocation'
schemes:
  - https
basePath: /api/otc-fixed-income-allocation/v1
host: Caminho_backend
tags:
  - name: OTCIncomeTradeCaptured
  - name: OTCIncomeAllocation
  - name: OTCIncomeAllocationStatus
  - name: OTCIncomeAllocationAcceptanceOrRejection
  - name: OTCIncomeTradeCancellation
  - name: OTCIncomeTradeCancellationApproval

paths:
  /allocation:
    post:
      tags:
        - OTCIncomeAllocation
      summary: 'Provides information on the inclusion or exclusion of an allocation of businesses originating in the OTC (over-the-counter).'
      operationId: AllocationPost
      parameters: 
        - in: body
          name: AllocationReqPost
          description: ''
          schema:
            $ref: '#/definitions/AllocationReqPost'
      responses: 
        '201': 
          description: Created
        '400':
          description: Bad Request
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/errors'
        '500':
          description: Internal Error
  /allocation-approval:
    post:
      tags:
        - OTCIncomeAllocationAcceptanceOrRejection
      summary: 'Provides information about the approval or rejection of an over-the-counter (OTC) business allocation.'
      operationId: AllocationAcceptanceOrRejectionPost
      parameters: 
        - in: body
          name: AllocationAcceptanceOrRejectionReqPost
          description: ''
          schema:
            $ref: '#/definitions/AllocationAcceptanceOrRejectionReqPost'
      responses: 
        '201': 
          description: Created
        '400':
          description: Bad Request
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/errors'
        '500':
          description: Internal Error
  /allocation-status:
    get:
      tags:
        - OTCIncomeAllocationStatus
      summary: 'Provides information on the status of allocations originating at the OTC (counter).'
      operationId: AllocationStatusGet
      responses: 
        '200': 
          description: Ok
          schema:
            $ref: '#/definitions/AllocationStatusRspGet'
        '400':
          description: Bad Request
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/errors'
        '500':
          description: Internal Error
  /trade:
    get:
      tags:
        - OTCIncomeTradeCaptured
      summary: 'Provides information regarding the capture of business from operations originating from the OTC (over the counter).'
      operationId: TradeCapturedGet
      responses: 
        '200': 
          description: Ok
          schema:
            $ref: '#/definitions/TradeCapturedRspGet'
        '400':
          description: Bad Request
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/errors'
        '500':
          description: Internal Error
  /trade-cancellation:
    post:
      tags:
        - OTCIncomeTradeCancellation
      summary: 'Provides information about the over the counter (OTC) deal cancellation request.'
      operationId: TradeCancellationPost
      parameters: 
        - in: body
          name: OTCIncomeTradeCancellationReqPost
          description: ''
          schema:
            $ref: '#/definitions/OTCIncomeTradeCancellationReqPost'
      responses: 
        '201': 
          description: Created
        '400':
          description: Bad Request
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/errors'
        '500':
          description: Internal Error
  /trade-cancellation-approval:
    post:
      tags:
        - OTCIncomeTradeCancellationApproval
      summary: 'Provides information on the approval of the over-the-counter (OTC) deal cancellation.'
      operationId: TradeCancellationApprovalPost
      parameters: 
        - in: body
          name: OTCIncomeTradeCancellationReqPost
          description: ''
          schema:
            $ref: '#/definitions/OTCIncomeTradeCancellationApprovalReqPost'
      responses: 
        '201': 
          description: Created
        '400':
          description: Bad Request
        '422':
          description: Unprocessable Entity
          schema:
            $ref: '#/definitions/errors'
        '500':
          description: Internal Error
definitions:
  
  Transaction:
    type: object
    properties:
      transactionIdentification:
        type: string
        description: 'Transaction identification.'
        example: 
    required:
      - transactionIdentification

  ParticipantIdentification:
    type: object
    properties:
      participantIdentificationCode:
        type: string
        description: 'Participant identification. Unique and unambiguous identifier, as assigned to a financial institution using a proprietary identification scheme. The identification of the party must be informed in the standard below Role+PartyIdentification e.g 3-123456, where 3 means TP (Trading Participant).'
        example: 
      issuerCode:
        type: string
        description: 'Entity that assigns the identification. E.g iMercado. 
        Domain value

        56 - iMercado'
        example: 
      schemeName:
        type: string
        description: 'Identification type code.
        E.g. CÓDIGO PARTICIPANTE IMERCADO.

        Domain value

        47 -  CÓDIGO PARTICIPANTE IMERCADO'
        example: 
    required:
      - participantIdentificationCode
      - issuerCode
      - schemeName

  TradeCapturedInformation1:
    type: object
    properties:
      TechnicalInformation:
        $ref: '#/definitions/TechnicalInformation'
      ApplicationHeader: 
        $ref: '#/definitions/ApplicationHeader'
      identification:
        $ref: '#/definitions/Transaction10'
      participant:
        $ref: '#/definitions/ParticipantIdentification10'
      tradeLegDetails:
        $ref: '#/definitions/TradeLegInformation'
      allocationDetail:
        $ref: '#/definitions/AllocationInformation'
      repoDetail:
        $ref: '#/definitions/RepoInformation'
    required:
      - identification
      - participant
      - tradeLegDetails

  Transaction10:
    type: object
    properties:
        transactionIdentification:
          type: string
          maxLength: 35
          description: 'Transaction identification.'
          example: 
    required:
        - transactionIdentification
  
  ParticipantIdentification10:
    type: object
    properties:
        participantIdentificationCode:
          type: string
          maxLength: 35
          description: 'Participant identification. Unique and unambiguous identifier, as assigned to a financial institution using a proprietary identification scheme. The identification of the party must be informed in the standard below Role+PartyIdentification e.g 3-123456, where 3 means TP (Trading Participant).'
          example: 
        issuerCode:
          type: string
          maxLength: 35
          description: 'Entity that assigns the identification. E.g iMercado. 

          Domain value
          
          56 - iMercado'
          example: 
        schemeName:
          type: string
          maxLength: 45
          description: 'Identification type code. E.g. CÓDIGO PARTICIPANTE IMERCADO.
          
          Domain value
          
          47 -  CÓDIGO PARTICIPANTE IMERCADO'
          example: 
    required:
        - participantIdentificationCode
        - issuerCode
        - schemeName
        
  TradeLegInformation1:
    type: object
    properties:
      tradeDate:
        type: string
        format: date
        description: 'Provides the trade date.'
        example: 20200116
      tradeIdentificationCode:
        type: string
        description: 'Trade identification.'
        example: 847839384000003
      ballastCode:
        type: string
        description: 'Ballast code. Unique identifier to inform that the SELIC asset has a ballast.'
        example: 
      sideDescription:
        type: string
        description: 'Coded list to specify the side of the trade.
        Domain value
        - BUYI 
        - SELL'
        example: 
      backOfficeTransactionIdentification:
        type: string
        description: 'Back Office transaction identification.'
        example: 
    required:
      - tradeDate
      - tradeIdentificationCode
      - sideDescription

  AllocationInformation2:
    type: object
    properties:
      finalAllocationIndicator:
        type: boolean
        description: 'Indicates the end of the allocation process.'
        example: 
      allocationRequestTypeCode:
        type: integer
        enum: [1,2]
        description: 'Type of allocation request.

        Domain Values

        1-  Inclusion
        2 - Exclusion '
        example: 
    required:
      - finalAllocationIndicator
      - allocationRequestTypeCode

  AllocationInformation3:
    type: object
    properties:
      selicAccountIdentification:
        type: string
        description: 'Number account identification. Selic Account used by the Custodians to deposit public bonds.'
        example: 
      tradeQuantity:
        type: number
        description: 'Trade  quantity.'
        example: 
      subAccountFundIdentification:
        type: string
        description: 'Sub account fund dentification.'
        example: 
      selicControlNumber:
        type: integer
        minimum: -2147483648
        maximum: 2147483647
        description: 'Informs the control number for contracts with settlement in the SELIC.'
        example: 
    required:
      - selicAccountIdentification
      - tradeQuantity

  Transaction2:
    type: object
    properties:
      transactionIdentification:
        type: string
        description: 'Transaction identification.'
        example: 
      executingPartyTransactionIdentification:
        type: string
        description: 'Transaction identification made by a participant in reference to a previous transaction.'
        example: 
    required:
      - transactionIdentification
      - executingPartyTransactionIdentification

  SecurityIdentification4:
    type: object
    properties:
      tickerSymbol:
        type: string
        description: 'Ticker that identifies a stock traded on a stock exchange. The Ticker Symbol is a short and convenient way of identifying a stock.'
        example: 
    required:
      - tickerSymbol

  TradeLegInformation3:
    type: object
    properties:
      tradeDate:
        type: string
        format: date
        description: 'Provides the trade date.'
        example: 20200116
      settlementDate:
        type: string
        format: date
        description: 'Provides settlement date.'
        example: 20200116
      tradeIdentificationCode:
        type: string
        description: 'Trade identification.'
        example: 847839384000003
      sideDescription:
        type: string
        description: 'Coded list to specify the side of the trade.
        Domain value
        - BUYI 
        - SELL'
        example: 
    required:
      - tradeDate
      - tradeIdentificationCode
      - sideDescription

  AllocationInformation9:
    type: object
    properties:
      investorFinalDocumentIdentification:
        type: string
        description: 'Provides the identification of the final investors document.'
        example: 
      allocatedtQuantity:
        type: number
        description: 'Specifies the trade quantity allocated.  '
        example: 
    required:
      - investorFinalDocumentIdentification
      - allocatedtQuantity

  AllocationInformation10:
    type: object
    properties:
      selicCode:
        type: string
        description: 'Code that identifies the title in SELIC (Special System of Clearance and Custody). The SELIC is the central depository of securities issued by the Treasury and the Central Bank of Braziland under that condition, processes the issue, redemption, payment of interest and custody of securities.'
        example: 
      subAccountFundIdentification:
        type: string
        description: 'Sub account fund dentification.'
        example: 
      finalInvestorDetails:
        type: array
        items:
          $ref: '#/definitions/AllocationInformation9'
    required:
      - selicCode

  StatusInformation:
    type: object
    properties:
      affirmationStatusCode:
        type: string
        enum: ["AFFI","NAFI"]
        description: 'Provides information on acceptance or rejection of the transaction. 
        Domain valid

        AFFI Aceito
        NAFI Rejeitado'
        example: 
    required:
      - affirmationStatusCode

  TradeLegInformation4:
    type: object
    properties:
      tradeDate:
        type: string
        format: date
        description: 'Provides the trade date.'
        example: 20200116
      settlementDate:
        type: string
        format: date
        description: 'Provides settlement date.'
        example: 20200116
      tradeIdentificationCode:
        type: string
        description: 'Trade identification.'
        example: 847839384000003
    required:
      - tradeDate
      - tradeIdentificationCode

  Transaction3:
    type: object
    properties:
      transactionIdentification:
        type: string
        description: 'Transaction identification.'
        example: 
      executingPartyTransactionIdentification:
        type: string
        description: 'Transaction identification made by a participant in reference to a previous transaction.'
        example: 
    required:
      - executingPartyTransactionIdentification

  TradeLegInformation5:
    type: object
    properties:
      tradeDate:
        type: string
        format: date
        description: 'Provides the trade date.'
        example: 20200116
      tradeIdentificationCode:
        type: string
        description: 'Trade identification.'
        example: 847839384000003
    required:
      - tradeDate
      - tradeIdentificationCode

  errors:
    type: object
    properties:
        errors:
            type: array
            items:
                $ref: '#/definitions/Error'
  Error:
    type: object
    properties:
      code:
          type: string
          description: 'Business error code.'
          example: 
      title:
          type: string
          description: 'Brief business error message'
          example: 
      detail:
          type: string
          description: 'Complementary information regarding business error'
          example: 
    required:
      - code
      - title

  AllocationReqPost:
    type: object
    properties:
      data:
        type: object
        properties:
              TechnicalInformation:
                $ref: '#/definitions/TechnicalInformation'
              ApplicationHeader: 
                $ref: '#/definitions/ApplicationHeader'
              identification:
                $ref: '#/definitions/Transaction'
              participant:
                $ref: '#/definitions/ParticipantIdentification'
              tradeLegDetails:
                $ref: '#/definitions/TradeLegInformation1'
              allocationInformation:
                $ref: '#/definitions/AllocationInformation2'
              allocationDetails:
                type: array
                items:
                  $ref: '#/definitions/AllocationInformation3'
  AllocationAcceptanceOrRejectionReqPost:
    type: object
    properties:
      data:
        type: object
        properties:
              TechnicalInformation:
                $ref: '#/definitions/TechnicalInformation'
              ApplicationHeader: 
                $ref: '#/definitions/ApplicationHeader'
              identification:
                $ref: '#/definitions/Transaction2'
              participant:
                $ref: '#/definitions/ParticipantIdentification'
              custodian:
                $ref: '#/definitions/ParticipantIdentification'
              securityIdentification:
                $ref: '#/definitions/SecurityIdentification4'
              tradeLegDetails:
                $ref: '#/definitions/TradeLegInformation3'
              allocationDetails:
                type: array
                items:
                  $ref: '#/definitions/AllocationInformation10'
              allocationRequestStatus:
                $ref: '#/definitions/StatusInformation'
  SecurityIdentification1:
    type: object
    properties:
      tickerSymbol:
          type: string
          description: 'Ticker that identifies a stock traded on a stock exchange. The Ticker Symbol is a short and convenient way of identifying a stock.'
          example: 
      ballastCode:
          type: string
          description: 'Ballast code. Unique identifier to inform that the SELIC asset has a ballast.'
          example: 
    required:
      - tickerSymbol

  SecurityIdentification2:
    type: object
    properties:
      isinIdentification:
          type: string
          description: 'International Securities Identification Number (ISIN). A numbering system designed by the United Nations International Organisation for Standardisation (ISO). The ISIN is composed of a 2-character prefix representing the country of issue, followed by the national security number (if one exists), and a check digit. Each country has a national numbering agency that assigns ISIN numbers for securities in that country.'
          example: 
      tickerSymbol:
          type: string
          description: 'Ticker that identifies a stock traded on a stock exchange. The Ticker Symbol is a short and convenient way of identifying a stock.'
          example: 
      selicCode:
          type: string
          description: 'Code that identifies the title in SELIC (Special System of Clearance and Custody). The SELIC is the central depository of securities issued by the Treasury and the Central Bank of Braziland under that condition, processes the issue, redemption, payment of interest and custody of securities.'
          example: 
      maturityDate:
          type: string
          format: date
          description: 'Date of instrument expiration.'
          example: 
    required:
      - tickerSymbol

  TradeLegInformation2:
    type: object
    properties:
      tradeDate:
          type: string
          format: date
          description: 'Provides the trade date.'
          example: 20200116
      settlementDate:
          type: string
          format: date
          description: 'Provides settlement date.'
          example: 20200116
      tradeIdentificationCode:
          type: string
          description: 'Trade identification.'
          example: 847839384000003
      sideDescription:
          type: string
          description: 'Coded list to specify the side of the trade.

          Domain value
          - BUYI 
          - SELL'
          example: 
      unitValue:
          type: number
          description: 'Unit issue value.'
          example: 
      dealPrice:
          type: number
          description: 'Deal price. Amount of money for which goods or services are offered, sold, or bought.'
          example: 
      tradeRatePercentage:
          type: number
          description: 'Provides the trade rate. Value is expressed as a rate. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%.'
          example: 
      tradeQuantity:
          type: number
          description: 'Trade  quantity.'
          example: 
      originalQuantity:
          type: number
          description: 'Original quantity.'
          example: 
      backOfficeTransactionIdentification:
          type: string
          description: 'Back Office transaction identification.'
          example: 
    required:
      - tradeDate
      - tradeIdentificationCode
      - sideDescription

  ParticipantIdentification2:
    type: object
    properties:
        participantIdentificationCode:
          type: string
          description: 'Participant identification. Unique and unambiguous identifier, as assigned to a financial institution using a proprietary identification scheme. The identification of the party must be informed in the standard below Role+PartyIdentification e.g 3-123456, where 3 means TP (Trading Participant).'
          example: 
        issuerCode:
          type: string
          description: 'Entity that assigns the identification. E.g iMercado. 

          Domain value

          56 - iMercado'
          example: 
        schemeName:
          type: string
          description: 'Identification type code. E.g. CÓDIGO PARTICIPANTE IMERCADO.

          Domain value
          47 -  CÓDIGO PARTICIPANTE IMERCADO'
          example: 
    required:
        - participantIdentificationCode
        - issuerCode
        - schemeName

  AllocationInformation1:
    type: object
    properties:
      offeringPartyIdentification:
          type: string
          description: 'Provides details about the offering party identification.'
          example: 
      participant:
        $ref: '#/definitions/ParticipantIdentification2'
  AllocationInformation4:
    type: object
    properties:
      tradeLegStatusCode:
          type: integer
          enum: [1,2,3,4,5,6,7,8,9,10]
          description: 'Provides a  status of trade.

          Domain value

          1 - Novo
          2 - Pendente Alocação
          3 - Pendente Confirmação
          4 - Pendente Alocação Contraparte
          5 - Pendente Confirmação Contraparte
          6 - Pendente Intermediação
          7 - Alocação completa
          8 - Cancelado
          9 - Cancelado no sistema de negociação
          10- Expirado'
          example: 
      finalAllocationStatus:
          type: integer
          enum: [1,2,3,4,5,6,7]
          maximum: 1
          description: 'Informs the status of the finalization of the allocation process.
          Domain value

          1 - Confirmado
          2 - Confirmado Fora da Grade
          3 - Não Confirmado
          4 - Intermediação Parcialmente Confirmado
          5 - Intermediação Totalmente Confirmado
          6 - Intermediação Parcialmente Confirmado Fora da Grade
          7 - Intermediação Totalmente Confirmado Fora da Grade'
          example: 
      offeringCounterPartyIdentification:
          type: string
          description: 'Provides identification about the offering counter party.'
          example: 
      counterPartyIdentification:
        $ref: '#/definitions/ParticipantIdentification2'
    required:
      - tradeLegStatusCode
      - finalAllocationStatus

  AllocationInformation6:
    type: object
    properties:
        selicAccountIdentification:
          type: string
          description: 'Number account identification. Selic Account used by the Custodians to deposit public bonds.'
          example: 
        allocatedtQuantity:
          type: number
          description: 'Specifies the trade quantity allocated.  '
          example: 
    required:
        - selicAccountIdentification
        - allocatedtQuantity

  AllocationInformation7:
    type: object
    properties:
        accountName:
          type: string
          description: 'Provides accounts name.'
          example: 
        otcSecurityAccountType:
          type: integer
          enum: [1,2,3,4,5,6,7]
          description: 'Identifies the Account Type in which the trade is allocated OTC.

          Domain value 

          1 - SELIC
          2 - SELIC Intermediação
          3 - NoMe
          4 - NoMe Tipo 1
          5 - NoMe Tipo 2
          6 - NoMe Intermediação
          7 - NoMe Conta Própria'
          example: 
        custodianShortName:
          type: string
          description: 'Provides short name of custodian.'
          example: 
        custodian:
          $ref: '#/definitions/ParticipantIdentification2'
        otcCustodian:
          $ref: '#/definitions/ParticipantIdentification2'
  AllocationInformation8:
    type: object
    properties:
        selicControlNumber:
          type: integer
          minimum: -2147483648
          maximum: 2147483647
          description: 'Informs the control number for contracts with settlement in the SELIC.'
          example: 
        brokerDealerSelicControlNumber:
          type: integer
          minimum: -2147483648
          maximum: 2147483647
          description: 'Informs the control number for contracts with settlement in the SELIC for broker dealer operations.'
          example: 
        createdCommandQuantity:
          type: number
          description: 'Provides the quantity of the contract in the created command.'
          example: 
        recordStatusCode:
          type: string
          enum: [1,2,3,4,5,6]
          description: 'Provides a  status of record.

          Domain value

          1 - Pendente Confirmação Custodiante
          2 - Pendente Confirmação Contraparte Custodiante
          3 - Rejeitado pelo Custodiante
          4 - Rejeitado pela Contraparte Custodiante
          5 - Confirmado pelo Custodiante
          6 - Disponível para Registro'
          example: 
        counterPartyAccountIdentification:
          type: string
          description: 'Provides identification about counter party account.'
          example: 
    required:
        - createdCommandQuantity
        - recordStatusCode

  AllocationInformation5:
    type: object
    properties:
      subAccountFundIdentification:
          type: string
          description: 'Sub account fund dentification.'
          example: 
      commonAllocationDetail:
        $ref: '#/definitions/AllocationInformation6'
      privilegedAllocationDetail:
        $ref: '#/definitions/AllocationInformation7'
      recordDetails:
        type: array
        items:
          $ref: '#/definitions/AllocationInformation8'
      finalInvestorDetails:
        type: array
        items:
          $ref: '#/definitions/AllocationInformation9'
    required:
      - subAccountFundIdentification

  RepoInformation:
    type: object
    properties:
        repoTypeCode:
          type: string
          enum: ['01','02','03','04','05','06','07','08']
          description: 'Provides the type of Repo.

          Domain value:
          
          01 - 1054 - Compra com PU de Retorno Definido (Retorno no Selic)
          02 - 1057 - Compra com PU em Aberto (Retorno no Selic)
          03 - 1044 - Compra com Livre Movimentação (Retorno no Selic)
          04 - 1047 - Compra com Livre Movimentação e PU em Aberto (Retorno no Selic)
          05 - 1054 - Compra com PU de Retorno Definido (Retorno na BMF - Ativos)
          06 - 1044 - Compra com Livre Movimentação (Retorno na BMF - Ativos)
          07 - 1054 - Compra com PU de Retorno Definido (Retorno na Central)
          08 - 1044 - Compra com Livre Movimentação (Retorno na Central)'
          example: 
        unilateralTypeCode:
          type: integer
          enum: [1,2,3,4]
          description: 'Type of unilateral right to claim the repurchase / resale commitment in Selic.

          Domain value:
          
          1 - Nenhuma das partes
          2 - Qualquer das partes
          3 - Somente cessionário
          4 - Somente cedente'
          example: 
        settlementRepoStartDate:
          type: string
          format: date
          description: 'Date from which a repurchase / resale repo can be settled at Selic.'
          example: 
        operationReturnDate:
          type: string
          format: date
          description: 'Date of the return operation.'
          example: 
        unitReturnPrice:
          type: number
          description: 'Preço unitário de um título válido para a operação de retorno.'
          example: 
        financialReturnValue:
          type: number
          description: 'Financial value of a return operation.'
          example: 
  Link:
    type: object
    properties:
      self:
          type: string
          description: 'Current page link'
          example: 
      first:
          type: string
          description: 'First page link'
          example: 
      prev:
          type: string
          description: 'Next page link'
          example: 
      next:
          type: string
          description: 'Next page link'
          example: 
      last:
          type: string
          description: 'Last page link'
          example: 
    required:
      - self

  AllocationStatusRspGet:
    type: object
    properties:
      data:
        type: object
        properties:
              allocationStatusInformations:
                type: array
                items:
                  $ref: '#/definitions/AllocationStatusInformation'
      links:
        $ref: '#/definitions/Link'
    required:
      - links
      
  AllocationStatusInformation:
    type: object
    properties:
      TechnicalInformation:
        $ref: '#/definitions/TechnicalInformation'
      ApplicationHeader: 
        $ref: '#/definitions/ApplicationHeader'
      identification:
        $ref: '#/definitions/Transaction20'
      participant:
        $ref: '#/definitions/ParticipantIdentification10'
      custodian:
        $ref: '#/definitions/ParticipantIdentification10'
      financialInstrumentAttributeInformation:
        $ref: '#/definitions/SecurityIdentification1'
      underlyingSecurityIdentification:
        $ref: '#/definitions/SecurityIdentification2'
      tradeLegDetail:
        $ref: '#/definitions/TradeLegInformation2'
      allocationParticipantIdentification:
        $ref: '#/definitions/AllocationInformation1'
      allocationInformation:
        $ref: '#/definitions/AllocationInformation4'
      allocationDetails:
        type: array
        items:
          $ref: '#/definitions/AllocationInformation5'
      repoDetail:
        $ref: '#/definitions/RepoInformation'
    required:
      - identification
      - tradeLegDetail      
  
  Transaction20:
    type: object
    properties:
        transactionIdentification:
          type: string
          maxLength: 35
          description: 'Transaction identification.'
          example: 
        executingPartyTransactionIdentification:
          type: string
          maxLength: 35
          description: 'Transaction identification made by a participant in reference to a previous transaction.'
          example: 
    required:
        - transactionIdentification
        - executingPartyTransactionIdentification
        
  SecurityIdentification:
    type: object
    properties:
        isinIdentification:
          type: string
          description: 'International Securities Identification Number (ISIN). A numbering system designed by the United Nations International Organisation for Standardisation (ISO). The ISIN is composed of a 2-character prefix representing the country of issue, followed by the national security number (if one exists), and a check digit. Each country has a national numbering agency that assigns ISIN numbers for securities in that country.'
          example: 
        tickerSymbol:
          type: string
          description: 'Ticker that identifies a stock traded on a stock exchange. The Ticker Symbol is a short and convenient way of identifying a stock.'
          example: 
        selicCode:
          type: string
          description: 'Code that identifies the title in SELIC (Special System of Clearance and Custody). The SELIC is the central depository of securities issued by the Treasury and the Central Bank of Braziland under that condition, processes the issue, redemption, payment of interest and custody of securities.'
          example: 
        maturityDate:
          type: string
          format: date
          description: 'Date of instrument expiration.'
          example: 
        ballastCode:
          type: string
          description: 'Ballast code. Unique identifier to inform that the SELIC asset has a ballast.'
          example: 
    required:
        - tickerSymbol
        - selicCode

  TradeLegInformation:
    type: object
    properties:
      tradeIdentificationCode:
          type: string
          description: 'Trade identification.'
          example: 847839384000003
      tradeDate:
          type: string
          format: date
          description: 'Provides the trade date.'
          example: 20200116
      settlementDate:
          type: string
          format: date
          description: 'Provides settlement date.'
          example: 20200116
      sideDescription:
          type: string
          description: 'Coded list to specify the side of the trade.
          Domain value
          - BUYI 
          - SELL'
          example: 
      tradeQuantity:
          type: number
          description: 'Trade  quantity.'
          example: 
      dealPrice:
          type: number
          description: 'Deal price. Amount of money for which goods or services are offered, sold, or bought.'
          example: 
      grossAmount:
          type: number
          description: 'Deal price. Amount of money for which goods or services are offered, sold, or bought.'
          example: 
      tradeRatePercentage:
          type: number
          description: 'Provides the trade rate. Value is expressed as a rate. Rate expressed as a percentage, that is, in hundredths, for example, 0.7 is 7/10 of a percent, and 7.0 is 7%.'
          example: 
      backOfficeTransactionIdentification:
          type: string
          description: 'Back Office transaction identification.'
          example: 
      underlyingSecurityIdentification:
        $ref: '#/definitions/SecurityIdentification'
    required:
      - tradeIdentificationCode
      - tradeDate
      - settlementDate
      - sideDescription
      - tradeQuantity
      - dealPrice

  AllocationInformation:
    type: object
    properties:
      selicAccountIdentification:
          type: string
          description: 'Number account identification. Selic Account used by the Custodians to deposit public bonds.'
          example: 
      finalAllocationIndicator:
          type: boolean
          description: 'Indicates the end of the allocation process.'
          example: 
      subAccountFundIdentification:
          type: string
          description: 'Sub account fund dentification.'
          example: 
  
  TechnicalInformation:
      type: object
      properties:
       SeqNum:
        type: integer
        format: int64
        description: Sequence Number. This attribute is only sent by B3. long
        example: 
       PossDupFlag:
        type: boolean
        description: Indicates that the message may have already been sent. If PossDupFlag = "true", indicates that it is possible to be a resend, otherwise PossDupFlag = "false" represents the original submission. YesNoIndicator
        example: 
       OnBehalfOfCompId:
        type: string
        minLength: 1
        maxLength: 20
        description: Provides the FIX session name where the message was received. This field is filled only when B3 sends to the Participant.
        example: 
       DeliverToCompId:
        type: string
        minLength: 1
        maxLength: 20
        description: Provides the FIX session name where the message should be delivered, in which this information was received from an earlier message of the same business stream. This field is filled out by the Participant.
        example: 
       GatewayName:
        type: string
        minLength: 1
        maxLength: 20
        description: Provides the name of the gateway where the FIX session is hosted. This field is filled in by B3 and the participant.
        example:  
  ApplicationHeader:
      type: object
      properties:
       BusinessMessageIdentifier:
        type: string
        minLength: 1
        maxLength: 35
        description: Identification of Business Message Identifier. Unique identifier of the message given by the participant or by B3. 
        example: 
       MessageDefinitionIdentifier:
        type: string
        minLength: 1
        maxLength: 35
        description: Contains the MessageIdentifier that defines the BusinessMessage. It must contain a MessageIdentifier published on the ISO 20022 website.
        example: 'camt.001.001.03'
       CreationDate:
        type: string
        format: datetime
        description: Date and time when this Business Message (header) was created.Note Times must be normalized, using the "Z" annotation. This field must be filled according to the UTC format. ISONormalisedDateTime YYYY-MM-DDThh:mm:ss.0Z
        example:  '2012-07-18T13:40:23.0Z'
       From:
        type: object
        properties:
         OrganisationIdentification:
          type: object
          properties:
            Identification:
              type: object
              properties:
               OrganisationIdentification:
                type: object
                properties:
                  Other:
                    type: array
                    items:
                     type: object
                     properties:
                       Identification:
                        type: string
                        minLength: 1
                        maxLength: 35
                        description: Identification assigned by an institution.
                        example: 
                       SchemeName:
                        type: object
                        properties:
                         Proprietary:
                          type: string
                          minLength: 1
                          maxLength: 35
                          description: Name of the identification scheme, in a free text form.
                          example: 
                       Issuer:
                        type: string
                        minLength: 1
                        maxLength: 35
                        description: Entity that assigns the identification.
                        example: 
       To:
        type: object
        properties:
          OrganisationIdentification:
           type: object
           properties:
            Identification:
             type: object
             properties:
               OrganisationIdentification:
                type: object
                properties:
                  Other:
                   type: array
                   items:
                      type: object
                      properties:
                        Identification:
                          type: string
                          minLength: 1
                          maxLength: 35
                          description: Identification assigned by an institution.
                          example: 
                        SchemeName:
                          type: object
                          properties:
                            Proprietary:
                             type: string
                             minLength: 1
                             maxLength: 35
                             description: Name of the identification scheme, in a free text form.
                             example: 
                        Issuer:
                          type: string
                          minLength: 1
                          maxLength: 35
                          description: Entity that assigns the identification.
                          example: 
       Related:
        type: object
        properties:
          BusinessMessageIdentifier:
            type: string
            minLength: 1
            maxLength: 35
            description: Identification of Business Message Identifier. Unique identifier of the message given by the participant or by B3. 
            example: 
          MessageDefinitionIdentifier:
            type: string
            minLength: 1
            maxLength: 35
            description: Contains the MessageIdentifier that defines the BusinessMessage. It must contain a MessageIdentifier published on the ISO 20022 website.
            example: 'camt.001.001.03'
          CreationDate:
           type: string
           format: datetime
           description: Date and time when this Business Message (header) was created.Note Times must be normalized, using the "Z" annotation. This field must be filled according to the UTC format. ISONormalisedDateTime  YYYY-MM-DDThh:mm:ss.0Z
           example:  '2012-07-18T13:40:23.0Z'
          From:
           type: object
           properties:
             OrganisationIdentification:
              type: object
              properties:
                Identification:
                  type: object
                  properties:
                   OrganisationIdentification:
                    type: object
                    properties:
                      Other:
                        type: array
                        items:
                         type: object
                         properties:
                           Identification:
                            type: string
                            minLength: 1
                            maxLength: 35
                            description: Identification assigned by an institution.
                            example: 
                           SchemeName:
                            type: object
                            properties:
                             Proprietary:
                              type: string
                              minLength: 1
                              maxLength: 35
                              description: Name of the identification scheme, in a free text form.
                              example: 
                           Issuer:
                            type: string
                            minLength: 1
                            maxLength: 35
                            description: Entity that assigns the identification.
                            example: 
          To:
            type: object
            properties:
              OrganisationIdentification:
               type: object
               properties:
                Identification:
                 type: object
                 properties:
                   OrganisationIdentification:
                    type: object
                    properties:
                      Other:
                       type: array
                       items:
                          type: object
                          properties:
                            Identification:
                              type: string
                              minLength: 1
                              maxLength: 35
                              description: Identification assigned by an institution.
                              example: 
                            SchemeName:
                              type: object
                              properties:
                                Proprietary:
                                 type: string
                                 minLength: 1
                                 maxLength: 35
                                 description: Name of the identification scheme, in a free text form.
                                 example: 
                            Issuer:
                              type: string
                              minLength: 1
                              maxLength: 35
                              description: Entity that assigns the identification.
                              example:  
  
  TradeCapturedRspGet:
    type: object
    properties:
      data:
        type: object
        properties:
          tradeCapturedInformations:
            type: array
            items:
              $ref: '#/definitions/TradeCapturedInformation1'
      links:
        $ref: '#/definitions/Link'
    required:
      - links
      
        
  OTCIncomeTradeCancellationReqPost:
    type: object
    properties:
      data:
        type: object
        properties:
              TechnicalInformation:
                $ref: '#/definitions/TechnicalInformation'
              ApplicationHeader: 
                $ref: '#/definitions/ApplicationHeader'
              identification:
                $ref: '#/definitions/Transaction'
              participant:
                $ref: '#/definitions/ParticipantIdentification'
              custodian:
                $ref: '#/definitions/ParticipantIdentification'
              securityIdentification:
                $ref: '#/definitions/SecurityIdentification4'
              tradeLegDetails:
                $ref: '#/definitions/TradeLegInformation4'
  
  OTCIncomeTradeCancellationApprovalReqPost:
    type: object
    properties:
      data:
        type: object
        properties:
              TechnicalInformation:
                $ref: '#/definitions/TechnicalInformation'
              ApplicationHeader: 
                $ref: '#/definitions/ApplicationHeader'
              identification:
                $ref: '#/definitions/Transaction3'
              participant:
                $ref: '#/definitions/ParticipantIdentification'
              securityIdentification:
                $ref: '#/definitions/SecurityIdentification4'
              tradeLegDetails:
                $ref: '#/definitions/TradeLegInformation5'
              tradeApprovalStatus:
                $ref: '#/definitions/StatusInformation'