> ## 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.

# 32 - CNAB 240

> <p>Scopes:</p>
<b>api.ext api.cnab.240</b>

Through this endpoint, the partner can check for the existence of a return file of the imported files.


## OpenAPI

````yaml get /api/CNAB/240
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/CNAB/240:
    get:
      tags:
        - CNAB
      summary: Lista arquivos de retorno no padrão CNAB 240 de uma conta específica.
      description: "<p>Scopes:</p>\r\n<b>api.ext api.cnab.240</b>"
      parameters:
        - name: TipoRetorno
          in: query
          description: |-
            Tipo retorno.

            Valores:
            -1 - Todos
            2 - Remessa
            3 - Diário
          schema:
            allOf:
              - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoRetorno'
            description: |-
              Tipo retorno.

              Valores:
              -1 - Todos
              2 - Remessa
              3 - Diário
        - 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
        - name: DtInicio
          in: query
          description: Data de início do período de consulta.
          schema:
            type: string
            description: Data de início do período de consulta.
            format: date-time
        - name: DtFim
          in: query
          description: Data final do período de consulta.
          schema:
            type: string
            description: Data final do período de consulta.
            format: date-time
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/BMPSPB.Domain.Messaging.API.Shared.CNAB.RetornoArquivoCNAB240Response
        '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.TipoRetorno:
      enum:
        - 0
        - 1
        - -1
      type: integer
      description: ''
      format: int32
    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.Shared.CNAB.RetornoArquivoCNAB240Response:
      type: object
      properties:
        codigo:
          type: string
          description: Código UUID identificador do registro do arquivo.
          format: uuid
        dtInclusao:
          type: string
          description: Data de inclusão do registro.
          format: date-time
        nome:
          type: string
          description: Nome do arquivo.
          nullable: true
        nroVersaoLayout:
          type: string
          description: >-
            Número que identifica a versão do layout CNAB 240 utilizada no
            arquivo.
          nullable: true
        tipoRetorno:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.TipoRetorno'
          description: |-
            Situação.

            Valores:
            -1 - Todos
            0 - Remessa
            1 - Diário
        situacao:
          allOf:
            - $ref: '#/components/schemas/BMPSPB.Infra.Enums.SituacaoArquivo'
          description: |-
            Situação.

            Valores:
            0 - Pendente
            1 - Gerado
      additionalProperties: false
    BMPSPB.Infra.Enums.SituacaoArquivo:
      enum:
        - 0
        - 1
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````