> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Get file batch status

> Returns the status of a batch submitted through the file channel (ANEXO VI, CNAB 750) and the result of each record of the remessa. The submitted content is not projected: the remessa carries the debtor's document and name.



## OpenAPI

````yaml /pt/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/arquivos/{id}
openapi: 3.1.0
info:
  contact:
    email: contact@lerian.studio
    name: Lerian Studio
    url: https://lerian.studio
  description: BR Code service for QR code generation and decoding (EMV QRCPS-MPM).
  license:
    name: Lerian Studio General License
  title: Lerian SPI — BR Code API
  version: 1.0.0
servers:
  - url: https://spi.sandbox.lerian.net
security: []
tags:
  - description: EMV BR Code payload generation, decoding, validation, info, and lookup.
    name: BRCode
  - description: >-
      Pix charges (Cob/CobV/LoteCobV): create, retrieve by TxID, list, cancel,
      reconcile, and resolve public payloads.
    name: Charges
  - description: >-
      Flow (mandatory order): create cob/cobv → generate QR/payload. A dynamic
      BR Code payload references a charge, so the cob/cobv charge MUST be
      created first; the payload links to it by txid/locator.
    name: charge
paths:
  /api/v1/brcode/arquivos/{id}:
    get:
      tags:
        - Charges
      summary: Get file batch status
      description: >-
        Returns the status of a batch submitted through the file channel (ANEXO
        VI, CNAB 750) and the result of each record of the remessa. The
        submitted content is not projected: the remessa carries the debtor's
        document and name.
      operationId: getFileBatch
      parameters:
        - description: Identificador do lote (UUID) devolvido pelo upload.
          in: path
          name: id
          required: true
          schema:
            description: Identificador do lote (UUID) devolvido pelo upload.
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileBatchDTO'
          description: OK
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Not Found
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Unprocessable Entity
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Internal Server Error
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    FileBatchDTO:
      additionalProperties: false
      properties:
        acceptedLines:
          description: Registros aceitos.
          format: int64
          type: integer
        createdAt:
          description: Momento do upload (RFC 3339).
          type: string
        filename:
          description: Nome do arquivo enviado.
          type: string
        id:
          description: Identificador do lote (UUID).
          format: uuid
          type: string
        lines:
          description: Resultado por registro, em ordem de arquivo.
          items:
            $ref: '#/components/schemas/FileBatchLineDTO'
          type: array
        processedAt:
          description: Momento em que o lote foi encerrado (RFC 3339).
          type: string
        recebedorDocument:
          description: CNPJ do recebedor declarado no Header do arquivo.
          type: string
        rejectedLines:
          description: Registros recusados.
          format: int64
          type: integer
        status:
          description: PROCESSING, PROCESSED ou REJECTED.
          examples:
            - PROCESSED
          type: string
        totalLines:
          description: Registros DETALHE que o arquivo continha.
          format: int64
          type: integer
      required:
        - id
        - filename
        - recebedorDocument
        - status
        - totalLines
        - acceptedLines
        - rejectedLines
        - createdAt
        - lines
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        correlationId:
          description: Request-scoped correlation identifier echoing X-Request-ID.
          examples:
            - req-7a3f9c2e
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
        upstream:
          $ref: '#/components/schemas/Upstream'
          description: >-
            RFC 9457 extension member: the error a proxied third-party provider
            reported. Absent unless the emitting service explicitly surfaced
            one.
      required:
        - correlationId
      type: object
    FileBatchLineDTO:
      additionalProperties: false
      properties:
        errorCode:
          description: Código oficial da recusa (aba CÓDIGOS DE ERRO), quando recusado.
          type: string
        errorDetail:
          description: Campo e regra da recusa. Nunca ecoa o valor recusado.
          type: string
        lineNumber:
          description: >-
            Ordem do registro na remessa (1-based, o Header é 1), a mesma que o
            retorno endereça. Linhas em branco são descartadas antes da
            numeração, então a ordem compacta e pode não coincidir com a posição
            absoluta no arquivo enviado.
          format: int64
          type: integer
        occurrence:
          description: >-
            Código de ocorrência solicitado (01 emissão, 02 cancelamento, 03
            alteração).
          examples:
            - '01'
          type: string
        resultId:
          description: Identificador gerado/afetado (idRec), quando aceito.
          type: string
        segment:
          description: Segmento do registro.
          examples:
            - REC
          type: string
        status:
          description: ACCEPTED ou REJECTED.
          examples:
            - ACCEPTED
          type: string
      required:
        - lineNumber
        - segment
        - occurrence
        - status
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    Upstream:
      additionalProperties: false
      properties:
        code:
          description: The upstream provider's own error code, verbatim.
          examples:
            - E4001
          type: string
        message:
          description: >-
            The upstream provider's own error message, verbatim (bounded, never
            its raw response body).
          examples:
            - account not found at provider
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````