> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 59 - Check Assignor

> <p>Scopes:</p>
<b>api.ext api.cedente.consultar</b>

Through this endpoint, the partner can consult an already registered Assignor number.


## OpenAPI

````yaml get /api/Cedente
openapi: 3.0.1
info:
  title: BMPSPBExt
  description: '<p><strong>Build Number: </strong>#0.0</p>'
  version: v1
servers:
  - url: https://api.ext.dbs.moneyp.dev.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /api/Cedente:
    get:
      tags:
        - Cedente
      description: "<p>Scopes:</p>\r\n<b>api.ext api.cedente.consultar</b>"
      parameters:
        - name: Conta.Agencia
          in: query
          description: |-
            Número da agência bancária.*

            Observações:
            - O número da agência pode ter no máximo 4 caracteres.
          schema:
            type: string
            description: |-
              Número da agência bancária.*

              Observações:
              - O número da agência pode ter no máximo 4 caracteres.
        - name: Conta.AgenciaDigito
          in: query
          description: >-
            Dígito verificador da agência bancária.


            Observações:

            - O dígito verificador da agência bancária pode ter no máximo 1
            caracter.
          schema:
            type: string
            description: >-
              Dígito verificador da agência bancária.


              Observações:

              - O dígito verificador da agência bancária pode ter no máximo 1
              caracter.
        - name: Conta.Conta
          in: query
          description: >-
            Número da conta bancária.


            Observações:

            - O número da conta bancária pode ter no máximo 12 caracteres.

            - Para que seja possível localizar a conta, é necessário informar o
            'número da conta com dígito' (```contaPgto```) ou o 'número da
            conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

            - Caso o 'número da conta com dígito' (```contaPgto```) seja
            informado, não é necessário preencher os campos 'número da conta'
            (```conta```) e 'dígito verificador' (```contaDigito```).

            - Caso nenhum dos campos referentes ao número da conta seja
            informado, ocorrerá erro na requisição devido à falta de informação
            vital.
          schema:
            type: string
            description: >-
              Número da conta bancária.


              Observações:

              - O número da conta bancária pode ter no máximo 12 caracteres.

              - Para que seja possível localizar a conta, é necessário informar
              o 'número da conta com dígito' (```contaPgto```) ou o 'número da
              conta' (```conta```) e o 'dígito verificador' (```contaDigito```).

              - Caso o 'número da conta com dígito' (```contaPgto```) seja
              informado, não é necessário preencher os campos 'número da conta'
              (```conta```) e 'dígito verificador' (```contaDigito```).

              - Caso nenhum dos campos referentes ao número da conta seja
              informado, ocorrerá erro na requisição devido à falta de
              informação vital.
        - name: Conta.ContaDigito
          in: query
          description: >-
            Dígito verificador do número da conta bancária.


            Observações:

            - O dígito verificador do número da conta bancária pode ter no
            máximo 1 caracter.
          schema:
            type: string
            description: >-
              Dígito verificador do número da conta bancária.


              Observações:

              - O dígito verificador do número da conta bancária pode ter no
              máximo 1 caracter.
        - name: Conta.ContaPgto
          in: query
          description: >-
            Número da conta bancária seguido do dígito verificador.


            Observações:

            - O número da conta seguido do dígito verificador pode ter no máximo
            20 caracteres.
          schema:
            type: string
            description: >-
              Número da conta bancária seguido do dígito verificador.


              Observações:

              - O número da conta seguido do dígito verificador pode ter no
              máximo 20 caracteres.
        - name: Conta.TipoConta
          in: query
          description: |-
            Tipo da conta.*

            Valores:
            1 - Corrente
            2 - Poupanca
            3 - Pagamento
            4 - Salario
          schema:
            allOf:
              - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoConta'
            description: |-
              Tipo da conta.*

              Valores:
              1 - Corrente
              2 - Poupanca
              3 - Pagamento
              4 - Salario
        - name: Conta.ModeloConta
          in: query
          description: |-
            Modelo da conta.*

            Valores:
            1 - Movimento
            2 - Escrow
            3 - Vinculada
          schema:
            allOf:
              - $ref: '#/components/schemas/BMPSPB.Infra.Enums.ModeloConta'
            description: |-
              Modelo da conta.*

              Valores:
              1 - Movimento
              2 - Escrow
              3 - Vinculada
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BMPSPB.Domain.Messaging.API.Externa.Cedente.ConsultaCedenteResponse
        '400':
          description: Erro de negócio
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
components:
  schemas:
    BMPSPB.Infra.Enums.TipoConta:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.ModeloConta:
      enum:
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
    BMPSPB.Domain.Messaging.API.Externa.Cedente.ConsultaCedenteResponse:
      type: object
      properties:
        sucesso:
          type: boolean
        mensagem:
          type: string
          nullable: true
        codigo:
          type: string
          format: uuid
          nullable: true
        numero:
          type: integer
          format: int64
        carteiras:
          type: array
          items:
            $ref: >-
              #/components/schemas/BMPSPB.Domain.Messaging.API.Shared.CedenteCarteiraDto
          nullable: true
      additionalProperties: false
    BMPSPB.Domain.Messaging.API.Shared.CedenteCarteiraDto:
      type: object
      properties:
        codigo:
          type: string
          description: Codigo do cedente carteira.
          format: uuid
          nullable: true
        codigoCedente:
          type: string
          description: Codigo do cedente.
          format: uuid
          nullable: true
        codigoCarteira:
          type: string
          description: Codigo da carteira.
          format: uuid
          nullable: true
        numero:
          type: integer
          description: Número de identificação da Carteira.
          format: int64
        descricao:
          type: string
          description: Descrição da Carteira.
          nullable: true
        tipoJuros:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoJuros'
          description: |-
            Tipo de juros.*

             Valores:
            1 - CPF
            2 - CNPJ
            3 - TELEFONE
            6 - EMAIL
            8 - EVP
          nullable: true
        vlrJuros:
          type: number
          description: >-
            Valor ou percentual aplicado de juros, dependendo da natureza de
            juro informada.
          format: double
          nullable: true
        tipoMulta:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoMulta'
          description: |-
            Tipo de multa.*

             Valores:
            1 - Valor fixo
            2 - Percentual
            3 - Isenta
          nullable: true
        vlrMulta:
          type: number
          description: >-
            Valor ou percentual aplicado de multa, dependendo da natureza de
            multa informada.
          format: double
          nullable: true
        diasLimitePagamento:
          type: integer
          description: >-
            Número de dias de limite para pagamento após a data de vencimento do
            título, permitindo definir o período de tolerância para o pagamento.
          format: int32
          nullable: true
        especie:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.Especie'
          description: |-
            Espécie.*

             Valores:
            1 - CH Cheque
            2 - DM Duplicata Mercantil
            3 - DMI Duplicata Mercantil Indicação
            4 - DS Duplicata de Serviço
            5 - DSI Duplicata de Serviço Indicação
            6 - DR Duplicata Rural
            7 - LC Letra de Câmbio
            8 - NCC Nota de Crédito Comercial
            9 - NCE Nota de Crédito Exportação
            10 - NCI Nota de Crédito Industrial
            11 - NCR Nota de Crédito Rural
            12 - NP Nota Promissória
            13 - NPR Nota Promissória Rural
            14 - TM Triplicata Mercantil
            15 - TS Triplicata de Serviço
            16 - NS Nota de Seguro
            17 - RC Recibo
            18 - FAT Bloqueto
            19 - ND Nota de Débito
            20 - AP Apólice de Seguro
            21 - ME Mensalidade Escolar
            22 - PC Parcela de Consórcio
            23 - NF Nota Fiscal
            24 - DD Documento de Dívida
            25 - Cédula de Produto Rural
            26 - Warrant
            27 - Dívida Ativa de Estado
            28 - Dívida Ativa de Município
            29 - Dívida Ativa da União
            30 - Encargos condominiais
            31 - Cartão de Crédito
            32 - Boleto proposta
            99 - Outros
          nullable: true
        tipoPagamento:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoPagamento'
          description: |-
            Tipo de Pagamento.*

             Valores:
            1 - A vista
            2 - Vencimento determinado
            3 - Carnê
          nullable: true
        origemNossoNumero:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.OrigemNossoNumero'
          description: |-
            Origem nosso numero.*

             Valores:
            1 - BMP
            2 - Cliente
          nullable: true
        cnabHabilitado:
          type: boolean
          description: Indica se a carteira está habilitada para gerar arquivos CNAB.
          nullable: true
        codigoEmpresaCNAB:
          type: string
          description: >-
            Código da empresa no padrão CNAB, utilizado para identificá-la em
            arquivos no padrão CNAB.
          nullable: true
        codCartTit:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.Modalidade'
          description: |-
            Modalidade.*

             Valores:
            1 - Cobrança Simples
            2 - Cobrança Vinculada
            3 - Cobrança Caucionada
            4 - Cobrança Descontada
            5 - Cobrança Vendor
          nullable: true
        hibrido:
          type: boolean
          description: Indica se a carteira suporta uma modalidade híbrida de cobrança.
          nullable: true
        tipoDesconto:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoDesconto'
          description: |-
            Tipo de desconto.*

             Valores:
            0 - Isento
            1 - Valor fixo até a data informada
            2 - Percentual até a data informada
            3 - Valor por antecipação (dias corridos)
            4 - Valor por antecipação (dias úteis)
            5 - Percentual por antecipação (dias corridos)
            6 - Percentual por antecipação (dias úteis)
            7 - Cancelamento Desconto
          nullable: true
        valorDesconto1:
          type: number
          description: Valor ou percentual do 1º desconto.
          format: double
          nullable: true
        valorDesconto2:
          type: number
          description: Valor ou percentual do 2º desconto.
          format: double
          nullable: true
        valorDesconto3:
          type: number
          description: Valor ou percentual do 3º desconto.
          format: double
          nullable: true
        qtdDiasDesconto1:
          type: integer
          description: Quantidade de dias de antecipação para aplicação do 1º desconto.
          format: int32
          nullable: true
        qtdDiasDesconto2:
          type: integer
          description: Quantidade de dias de antecipação para aplicação do 2º desconto.
          format: int32
          nullable: true
        qtdDiasDesconto3:
          type: integer
          description: Quantidade de dias de antecipação para aplicação do 3º desconto.
          format: int32
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.TipoJuros:
      enum:
        - 1
        - 2
        - 3
        - 5
        - 6
        - 8
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.TipoMulta:
      enum:
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.Especie:
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - 16
        - 17
        - 18
        - 19
        - 20
        - 21
        - 22
        - 23
        - 24
        - 25
        - 26
        - 27
        - 28
        - 29
        - 30
        - 31
        - 32
        - 99
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.TipoPagamento:
      enum:
        - 1
        - 2
        - 3
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.OrigemNossoNumero:
      enum:
        - 1
        - 2
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.Modalidade:
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.TipoDesconto:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````