openapi: 3.0.1
info:
  title: TCAP Filantropia
  description: "antiga web service URL: https://svp.hml.bradescoseguros.com.br\nnova URL: https://10.205.104.107:8443"
  version: v1
servers:
  - url: https://parceiros.bradescoseguros.com.br/tcap-filantropia/v1
paths:
  /produtos-ativos:
    get:
      tags:
        - Cliente
        - Planos
      summary: Consultar Produtos Ativos
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-planos-service-rest-consultarprodutosativos
      parameters:
        - name: documentoCessionario
          in: query
          description: cpf/cnpj do cessionario
          required: true
          schema:
            type: string
        - name: codigoParceriaCliente
          in: query
          description: codigo de parceria do cliente
          required: true
          schema:
            type: number
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /produtos-canal:
    get:
      tags:
        - Propostas
      summary: Consultar Produtos Canal
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-proposta-consultarprodutoscanal
      parameters:
        - name: midia
          in: query
          description: Canal de acesso
          required: true
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /plano:
    get:
      tags:
        - Propostas
      summary: Consultar Plano
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-proposta-consultarplano
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de \ncapitalização"
          required: true
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /valores-plano:
    get:
      tags:
        - Propostas
      summary: Consultar Valores Plano
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-proposta-consultarvaloresplano
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de\n capitalização"
          required: true
          schema:
            type: string
        - name: vlrMax
          in: query
          description: "Valor máximo de parcela do\n plano de capitalização"
          required: true
          schema:
            type: number
        - name: vlrMin
          in: query
          description: "Valor mínimo de parcela do\n plano de capitalização"
          required: true
          schema:
            type: number
        - name: vlrMult
          in: query
          description: "Valor múltiplo multiplicador\n sobre o valor de parcela do\n plano de capitalização."
          required: true
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /listar-planos-compativeis:
    get:
      tags:
        - Propostas
      summary: Listar Planos Compativeis
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-proposta-listarplanoscompativeis
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: numeroDoc
          in: query
          description: Número cpf/cnpj
          required: true
          schema:
            type: string
        - name: agencia
          in: query
          description: Código da agência
          required: true
          schema:
            type: number
        - name: conta
          in: query
          description: Número da conta corrente
          required: true
          schema:
            type: number
        - name: formaPgto
          in: query
          description: "Código da forma de \npagamento do título"
          required: true
          schema:
            type: number
        - name: modalidade
          in: query
          description: Código da modalidade
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /validar-documento:
    get:
      tags:
        - Aquisicao
      summary: Validar CPF
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-aquisicao-validarcpf
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: documento
          in: query
          description: "Número do CPF/CNPJ do \nSubscritor"
          required: true
          schema:
            type: string
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /forma-pagamento-produto-aquisicao:
    get:
      tags:
        - Aquisicao
      summary: Consultar Forma de Pagamento Produto Aquisicao
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-aquisicao-consultarformapagamentoprodutoaquisicao
      parameters:
        - name: midia
          in: query
          description: Código do Canal
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de\ncapitalização"
          required: true
          schema:
            type: number
        - name: modalidade
          in: query
          description: Código da modalidade
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  '/midia/{midia}/modalidade/{modalidade}/numPlano/{plano}/entidadeFilantropia':
    get:
      tags:
        - Planos
      summary: Busca Entidade Filantropia
      description: Azure (GET) -> Backend (GET)
      operationId: get-v2-tcap-planos-service-rest-midia-1-modalidade-1-numplano-1235-entidadef
      parameters:
        - name: midia
          in: path
          description: Código do canal
          required: true
          schema:
            type: number
        - name: modalidade
          in: path
          description: Código da Modalidade
          required: true
          schema:
            type: number
        - name: plano
          in: path
          description: Número do Plano
          required: true
          schema:
            type: number
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  '/midia/{midia}/numPlano/{plano}/quantidadeSorteios':
    get:
      tags:
        - Planos
      summary: Quantidade de Sorteios
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-planos-service-rest-midia-1-numplano-1-quantidadesorteios
      parameters:
        - name: midia
          in: path
          description: Código do canal
          required: true
          schema:
            type: number
        - name: plano
          in: path
          description: Número do Plano
          required: true
          schema:
            type: number
        - name: modalidade
          in: query
          description: Código da Modalidade
          required: true
          schema:
            type: integer
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /Informacao-plano-aquisicao:
    get:
      tags:
        - Aquisicao
      summary: Consultar Informacao Plano Aquisição
      description: Azure (GET) -> Backend (POST)
      operationId: post-tcap-aquisicao-consultarinfomacaoplanoaquisicao
      parameters:
        - name: midia
          in: query
          description: Código do Canal
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de\ncapitalização"
          required: true
          schema:
            type: number
        - name: vlrParcelaTitulo
          in: query
          description: Valor da Parcela do título
          required: true
          schema:
            type: number
        - name: modalidade
          in: query
          description: Código da modalidade
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: hml
          in: header
          schema:
            type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /probabilidade-tipo-sorteio-plano:
    get:
      tags:
        - Sorteios
      summary: Consultar Probabilidade Tipo Sorteio Plano
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-sorteios-consultarprobabilidadetiposorteioplano
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de\nCapitalização"
          required: true
          schema:
            type: number
        - name: modalidade
          in: query
          description: Código da Modalidade
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /cotas-capitalizacao-produto:
    get:
      tags:
        - Sorteios
      summary: Consultar Cotas Capitalizacao Produto
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-sorteios-consultarcotascapitalizacaoproduto
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: Número do Plano
          required: true
          schema:
            type: number
        - name: modalidade
          in: query
          description: Código da Modalidade
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /consultar-nome-titular-subscritor:
    get:
      tags:
        - Cliente
      summary: Consultar Nome Titular Subscritor
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-cliente-consultarnometitularsubscritor
      parameters:
        - name: midia
          in: query
          description: Canal de acesso
          required: true
          schema:
            type: number
        - name: documentoSubscritor
          in: query
          description: CPF/CNPJ do subscritor
          required: true
          schema:
            type: string
        - name: modalidade
          in: query
          description: Código da modalidade
          schema:
            type: number
        - name: documentoTitular
          in: query
          description: CPF/CNPJ do titular
          schema:
            type: string
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /tabela-resgate:
    get:
      tags:
        - Resgates
      summary: Consultar Tabela Resgate
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-resgates-consultartabelaresgate
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: Número do Plano
          required: true
          schema:
            type: number
        - name: vlrParcelaTitulo
          in: query
          description: Valor da parcelo do título
          required: true
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /probabilidade-contemplacao-resgate:
    get:
      tags:
        - Resgates
      summary: Obter Probabilidade Contemplacao Resgate
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-resgates-obterprobabilidadecontemplacaoresgate
      parameters:
        - name: plano
          in: query
          description: Número do Plano
          required: true
          schema:
            type: number
        - name: vlrParcela
          in: query
          description: "Valor da parcela \nobs: Em caso de \npreenchimento com zeros o \nsistema calcula o valor da \nparcela, e se preencher com \nvalor da parcela maior que \nzero, o sistema acata o valor \nenviado do próprio plano "
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /cancelamento-proposta-agendada:
    put:
      tags:
        - Propostas
      summary: Efetivar Cancelamento Proposta Agendada
      description: "Azure (PUT) -> Backend (POST)\nalterado para put pois DELETE não pode conter um corpo de requisição."
      operationId: post-v2-tcap-proposta-efetivarcancelamentopropostaagendada
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                midia: '22'
                tpBusca: '1'
                numPlano: '0141'
                numAquisicao: '0077889506'
            example:
              midia: '22'
              tpBusca: '1'
              numPlano: '0141'
              numAquisicao: '0077889506'
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /alteracao-proposta-agendada:
    put:
      tags:
        - Propostas
      summary: Efetivar Alteracao Proposta Agendada
      description: Azure (PUT) -> Backend (POST)
      operationId: post-v2-tcap-proposta-efetivaralteracaopropostaagendada
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                midia: '066'
                numPlano: '1118'
                numAquisicao: '137'
                dataPrimeiraParcela: 27.10.2020
                dataDemaisParcelas: '27'
            example:
              midia: '066'
              numPlano: '1118'
              numAquisicao: '137'
              dataPrimeiraParcela: 27.10.2020
              dataDemaisParcelas: '27'
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /certificado:
    get:
      tags:
        - Titulos
      summary: Consultar Certificado
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-titulos-consultarcertificado
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de \ncapitalização"
          required: true
          schema:
            type: number
        - name: aquisicao
          in: query
          description: "Número da proposta de \naquisição do título"
          required: true
          schema:
            type: number
        - name: serie
          in: query
          description: Número da Série de Títulos
          required: true
          schema:
            type: number
        - name: titulo
          in: query
          description: Número do título
          required: true
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /consultar-detalhe-titulo:
    get:
      tags:
        - Titulos
      summary: Consultar Detalhe Titulo
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-titulos-consultardetalhetitulo
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de \ncapitalização"
          required: true
          schema:
            type: number
        - name: aquisicao
          in: query
          description: "Número da proposta de \naquisição do título"
          required: true
          schema:
            type: number
        - name: seriePlano
          in: query
          description: Número da Série do título
          required: true
          schema:
            type: number
        - name: titulo
          in: query
          description: Número do título
          required: true
          schema:
            type: number
        - name: tpBusca
          in: query
          description: Tipo de busca - mover fixo zeros
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /listar-titulos:
    get:
      tags:
        - Titulos
      summary: Listar Titulos
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-titulos-listartitulos
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: sentido
          in: query
          description: "Sentido da Paginação \nI - Inicial \nP - Primeira \nS - Seguinte \nA - Anterior \nU - Última"
          required: true
          schema:
            enum:
              - I
              - P
              - S
              - A
              - U
            type: string
        - name: limit
          in: query
          description: "Número máximo de ocorrências \nna busca. Limite: 800 \nocorrências. "
          required: true
          schema:
            type: integer
        - name: agencia
          in: query
          description: "Agência conectada para\nconsulta (sem dígito)"
          required: true
          schema:
            type: number
        - name: conta
          in: query
          description: "Conta conectada para corrente\n(sem dígito)"
          required: true
          schema:
            type: number
        - name: tpTitularidade
          in: query
          description: Tipo de titularidade da conta
          required: true
          schema:
            type: number
        - name: tpBusca
          in: query
          description: "Tipo de Busca \n1 - ATIVA \n2 - INATIVA \n3 - TODAS (ATIVAS E \nINATIVAS)"
          required: true
          schema:
            enum:
              - 1
              - 2
              - 3
            type: integer
        - name: tpPgto
          in: query
          description: "Tipo de Pagamento \n0 - Todos \n1 - PM \n2 - PU \n3 – PP"
          required: true
          schema:
            enum:
              - 0
              - 1
              - 2
              - 3
            type: integer
        - name: tpVisualizacao
          in: query
          description: "Tipo de Visualização \n0 - Todos \n1 - SÓ ADQUIRIDOS NO\nCANAL"
          required: true
          schema:
            enum:
              - 0
              - 1
            type: integer
        - name: vigenciaInicio
          in: query
          description: "Primeira Data de início de vigência \npara paginação"
          required: true
          schema:
            type: string
        - name: planoInicio
          in: query
          description: "Primeiro Número do plano para \npaginação"
          required: true
          schema:
            type: number
        - name: aquisicaoInicio
          in: query
          description: "Primeiro Número de Proposta para \npaginação"
          required: true
          schema:
            type: number
        - name: vigenciaFim
          in: query
          description: Último Número do plano para paginação
          required: true
          schema:
            type: string
        - name: planoFim
          in: query
          description: Último Número do plano para paginação
          required: true
          schema:
            type: number
        - name: aquisicaoFim
          in: query
          description: Último Número de Proposta para paginação
          required: true
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /extrato-consolidado:
    get:
      tags:
        - Titulos
      summary: Listar Extrato Consolidado
      description: Azure (GET) -> Backend (POST)
      operationId: post-tcap-titulos-listarextratoconsolidado
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: sentido
          in: query
          description: "Sentido da paginação \nI - Inicial \nP - Primeira \nS - Seguinte \nA - Anterior \nU – Última"
          required: true
          schema:
            enum:
              - I
              - P
              - S
              - A
              - U
            type: string
        - name: agencia
          in: query
          description: "Agência conectada para \nconsulta"
          required: true
          schema:
            type: number
        - name: conta
          in: query
          description: Conta conectada para corrente
          required: true
          schema:
            type: number
        - name: tpConta
          in: query
          description: Tipo de titularidade da conta
          required: true
          schema:
            type: number
        - name: tpPgto
          in: query
          description: "Periodicidade de pagamento 0 -\nTodos \n1 - PM \n2 - PU \n3 - PP"
          required: true
          schema:
            enum:
              - 0
              - 1
              - 2
              - 3
            type: integer
        - name: tpVisualizacao
          in: query
          description: "Tipo de visualização \n0 - Todos \n1 - SÓ ADQUIRIDOS NO \nCANAL"
          required: true
          schema:
            enum:
              - 0
              - 1
            type: integer
        - name: tpBusca
          in: query
          description: "Tipo de pesquisa \n0 - Extrato consolidado \n1 - Acompanhamento \nfinanceiro por conta corrente\n2 - Acompanhamento \nfinanceiro \npor cnpj"
          required: true
          schema:
            enum:
              - 0
              - 1
              - 2
            type: integer
        - name: limit
          in: query
          description: Número máximo de ocorrências
          required: true
          schema:
            type: integer
        - name: vigenciaInicio
          in: query
          description: "Primeira Data de início de \nvigência para paginação"
          required: true
          schema:
            type: string
        - name: planoInicio
          in: query
          description: "Primeiro Número do plano para \npaginação"
          required: true
          schema:
            type: number
        - name: aquisicaoInicio
          in: query
          description: "Primeiro Número de Proposta \npara paginação"
          required: true
          schema:
            type: number
        - name: vigenciaFim
          in: query
          description: "Última Data de início de \nvigência para paginação"
          required: true
          schema:
            type: string
        - name: planoFim
          in: query
          description: "Último Número do plano para \npaginação"
          required: true
          schema:
            type: number
        - name: aquisicaoFim
          in: query
          description: " Último Número de Proposta \npara paginação"
          required: true
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '500':
          description: Successful response
          content:
            application/json: { }
  /titulos-capitalizacao:
    get:
      tags:
        - Titulos
      summary: Listar Titulos Capitalizacao
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-titulos-listartituloscapitalizacao
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: sentido
          in: query
          description: "Sentido da paginação \nI - Inicial \nP - Primeira \nS - Seguinte \nA - Anterior \nU - Última"
          required: true
          schema:
            enum:
              - I
              - P
              - S
              - A
              - U
            type: string
        - name: serieInicio
          in: query
          description: "Primeiro Número de Série para \npaginação – mover fixos zeros"
          required: true
          schema:
            type: number
        - name: tituloInicio
          in: query
          description: "Primeiro Número de título para \npaginação– mover fixos zeros"
          required: true
          schema:
            type: number
        - name: serieFim
          in: query
          description: "Último Número de Série para \npaginação – mover fixos zeros"
          required: true
          schema:
            type: number
        - name: tituloFim
          in: query
          description: "Último Número de título para \npaginação – mover fixos zeros"
          required: true
          schema:
            type: number
        - name: limit
          in: query
          description: "Quantidade máxima de\nocorrências"
          required: true
          schema:
            type: integer
        - name: plano
          in: query
          description: "Número do plano de \ncapitalização"
          required: true
          schema:
            type: number
        - name: aquisicao
          in: query
          description: "Número da proposta de \naquisição do título "
          required: true
          schema:
            type: number
        - name: mesAno
          in: query
          description: "Mês / ano solicitado para o\nacompanhamento"
          required: true
          schema:
            type: string
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /combo-titulos-capitalizacao:
    post:
      tags:
        - Titulos
      summary: Combo Títulos Capitalização
      description: Azure (POST) -> Backend (POST)
      operationId: post-tcap-titulos-combotituloscapitalizacao
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                qtdOcorrencias: 200
                tpBusca: 1
                numPlano: 1435
                numAquisicao: 13
                midia: 35
            example:
              qtdOcorrencias: 200
              tpBusca: 1
              numPlano: 1435
              numAquisicao: 13
              midia: 35
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /listar-combinacoes:
    get:
      tags:
        - Sorteios
      summary: Listar Combinacoes
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-sorteios-listarcombinacoes
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: agencia
          in: query
          description: Agência do Titular
          required: true
          schema:
            type: number
        - name: conta
          in: query
          description: Conta do Titular
          required: true
          schema:
            type: number
        - name: tpTitular
          in: query
          description: Tipo de titularidade da conta
          required: true
          schema:
            type: number
        - name: tpPagamento
          in: query
          description: "TIPO DE PAGTO\n0 - Todos\n1 - PM\n2 - PU\n3 - PP"
          required: true
          schema:
            enum:
              - 0
              - 1
              - 2
              - 3
            type: integer
        - name: qtdOcorrencias
          in: query
          description: "Quantidade máxima de\n ocorrências"
          required: true
          schema:
            type: integer
        - name: tpVisualizacao
          in: query
          description: "Tipo de visualização\n1 - Todos\n2 - SÓ ADQUIRIDOS NO\nCANAL"
          required: true
          schema:
            enum:
              - 1
              - 2
            type: integer
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /combinacoes:
    get:
      tags:
        - Sorteios
      summary: Consultar Combinações
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-sorteios-consultarcombinacoes
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: limit
          in: query
          description: "Quantidade máxima de \nocorrências"
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de \ncapitalização"
          required: true
          schema:
            type: number
        - name: aquisicao
          in: query
          description: "Número da proposta de \naquisição do título"
          required: true
          schema:
            type: number
        - name: serieCaptz
          in: query
          description: Número da Série do título
          required: true
          schema:
            type: number
        - name: titulos
          in: query
          description: Número do título
          required: true
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /listar-resultados:
    get:
      tags:
        - Sorteios
      summary: Listar Resultados
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-sorteios-listarresultados
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: agencia
          in: query
          description: "Agência conectada para \nconsulta"
          required: true
          schema:
            type: number
        - name: conta
          in: query
          description: "Conta conectada para \ncorrente"
          required: true
          schema:
            type: number
        - name: tpTitular
          in: query
          description: Número do título
          required: true
          schema:
            type: number
        - name: tpPgto
          in: query
          description: "Periodicidade \nde pagamento \n0 - TODOS \n1 - PM \n2 - PU \n3 - PP"
          required: true
          schema:
            enum:
              - 0
              - 1
              - 2
              - 3
            type: integer
        - name: mesSorteio
          in: query
          description: "Mês do sorteio para \npesquisa"
          required: true
          schema:
            type: integer
        - name: anoSorteio
          in: query
          description: "Ano do sorteio para \npesquisa"
          required: true
          schema:
            type: integer
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /resultados:
    get:
      tags:
        - Sorteios
      summary: Consultar Resultados
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-sorteios-consultarresultados
      parameters:
        - name: susep
          in: query
          description: "Número do Processo SUSEP\nde capitalização"
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de\ncapitalização"
          required: true
          schema:
            type: number
        - name: mesSorteio
          in: query
          description: Mês do sorteio para pesquisa
          required: true
          schema:
            type: number
        - name: anoSorteio
          in: query
          description: Ano do sorteio para pesquisa
          required: true
          schema:
            type: number
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /premios-sorteio:
    get:
      tags:
        - Sorteios
      summary: Listar Premios Sorteio
      description: Azure (GET) -> Backend (POST)
      operationId: post-tcap-sorteios-listarpremiossorteio
      parameters:
        - name: midia
          in: query
          description: Canal de Acesso
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número do plano de \nCapitalização"
          required: true
          schema:
            type: number
        - name: vlrParcelaTitulo
          in: query
          description: Valor da parcela do Título
          required: true
          schema:
            type: number
        - name: modalidade
          in: query
          description: Código da Modalidade
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /obter-premios-instantaneos:
    get:
      tags:
        - Sorteios
      summary: Obter Premios Instantaneos
      description: Azure (GET) -> Backend (POST)
      operationId: post-v2-tcap-sorteios-obterpremiosinstantaneos
      parameters:
        - name: midia
          in: query
          description: Código do Canal
          required: true
          schema:
            type: number
        - name: plano
          in: query
          description: "Número plano \nCapitalização"
          required: true
          schema:
            type: number
        - name: serie
          in: query
          description: "Número série \nCapitalização"
          required: true
          schema:
            type: number
        - name: numSorteInstataneo
          in: query
          description: "Número sorte \ninstantâneo "
          required: true
          schema:
            type: number
        - name: vlrParcela
          in: query
          description: "Valor da parcela do \nTítulo"
          required: true
          schema:
            type: number
        - name: tpBusca
          in: query
          description: "Tipo de busca: \n1 -> PLANO, SERIE E \nNRO SORTE \n2 -> ATENDIMENTO"
          required: true
          schema:
            enum:
              - 1
              - 2
            type: integer
        - name: modalidade
          in: query
          description: Código da Modalidade
          schema:
            type: number
        - name: atendimento
          in: query
          description: Número do Atendimento
          schema:
            type: number
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /cancelar-solicitacao-resgate:
    put:
      tags:
        - Resgates
      summary: Cancelar Solicitacao Resgate
      description: "Azure (PUT) -> Backend (POST)\nalterado para put (não pode ser delete devido a regra rfc7231)"
      operationId: post-v2-tcap-resgates-cancelarsolicitacaoresgate
      parameters:
        - name: token
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              example:
                midia: '1'
                codModalidade: '1'
                tpBusca: '1'
                numResgate: '202000000000000131'
            example:
              midia: '1'
              codModalidade: '1'
              tpBusca: '1'
              numResgate: '202000000000000131'
      responses:
        '200':
          description: Successful response
          content:
            application/json: { }
  /Auth:
    get:
      summary: Auth
      operationId: buscatoken
      parameters:
        - name: grant_type
          in: header
          description: ''
          schema:
            type: string
        - name: client_id
          in: header
          schema:
            type: string
        - name: scope
          in: header
          schema:
            type: string
        - name: token
          in: header
          schema:
            type: string
      responses:
        '200':
          description: 
components:
  securitySchemes:
    apiKeyHeader:
      type: apiKey
      name: Ocp-Apim-Subscription-Key
      in: header
    apiKeyQuery:
      type: apiKey
      name: subscription-key
      in: query
security:
  - apiKeyHeader: [ ]
  - apiKeyQuery: [ ]
tags:
  - name: Propostas
  - name: Aquisicao
  - name: Cliente
  - name: Planos
  - name: Resgates
  - name: Sorteios
  - name: Titulos