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

# List immediate charges

> Lists immediate charges by start date, end date, cpf, cnpj, locationPresente, and status. Pix API v2.9 GET /cob.



## OpenAPI

````yaml en/openapi/v3-current/spi-brcode.yaml get /api/v1/brcode/cob
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/cob:
    get:
      tags:
        - Cob
      summary: List immediate charges
      description: >-
        Lists immediate charges by start date, end date, cpf, cnpj,
        locationPresente, and status. Pix API v2.9 GET /cob.
      operationId: listCob
      parameters:
        - description: Início do filtro de criação (RFC 3339).
          explode: false
          in: query
          name: inicio
          schema:
            description: Início do filtro de criação (RFC 3339).
            type: string
        - description: Fim do filtro de criação (RFC 3339).
          explode: false
          in: query
          name: fim
          schema:
            description: Fim do filtro de criação (RFC 3339).
            type: string
        - description: Filtro pelo CPF do devedor.
          explode: false
          in: query
          name: cpf
          schema:
            description: Filtro pelo CPF do devedor.
            pattern: ^\d{11}$
            type: string
        - description: Filtro pelo CNPJ do devedor.
          explode: false
          in: query
          name: cnpj
          schema:
            description: Filtro pelo CNPJ do devedor.
            pattern: ^[0-9A-Z]{14}$
            type: string
        - description: Filtro pela existência de location (true/false).
          explode: false
          in: query
          name: locationPresente
          schema:
            description: Filtro pela existência de location (true/false).
            type: string
        - description: Filtro pelo status do registro da cobrança.
          explode: false
          in: query
          name: status
          schema:
            description: Filtro pelo status do registro da cobrança.
            type: string
        - description: Página a ser retornada (0-based).
          explode: false
          in: query
          name: paginacao.paginaAtual
          schema:
            description: Página a ser retornada (0-based).
            format: int64
            minimum: 0
            type: integer
        - description: Itens por página (1..1000).
          explode: false
          in: query
          name: paginacao.itensPorPagina
          schema:
            description: Itens por página (1..1000).
            format: int64
            maximum: 1000
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CobsConsultadas'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
      security:
        - BearerAuth: []
components:
  schemas:
    CobsConsultadas:
      additionalProperties: false
      properties:
        cobs:
          items:
            $ref: '#/components/schemas/CobCompleta'
          type:
            - array
            - 'null'
        parametros:
          $ref: '#/components/schemas/Parametros'
      required:
        - parametros
        - cobs
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          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
      type: object
    CobCompleta:
      additionalProperties: false
      properties:
        calendario:
          $ref: '#/components/schemas/CobCalendarioGerado'
        chave:
          description: Chave DICT do recebedor.
          maxLength: 77
          type: string
        devedor:
          $ref: '#/components/schemas/Pessoa'
        infoAdicionais:
          items:
            $ref: '#/components/schemas/InfoAdicional'
          type:
            - array
            - 'null'
        loc:
          $ref: '#/components/schemas/CobLocGerada'
        location:
          description: Localização do payload.
          maxLength: 77
          type: string
        pix:
          description: Pix recebidos vinculados à cobrança.
          items:
            $ref: '#/components/schemas/PixRecebido'
          type:
            - array
            - 'null'
        pixCopiaECola:
          description: Pix Copia e Cola (BR Code) correspondente à cobrança.
          maxLength: 512
          type: string
        revisao:
          description: Revisão da cobrança (inicia em 0).
          format: int64
          type: integer
        solicitacaoPagador:
          maxLength: 140
          type: string
        status:
          description: Status do registro da cobrança.
          enum:
            - ATIVA
            - CONCLUIDA
            - REMOVIDA_PELO_USUARIO_RECEBEDOR
            - REMOVIDA_PELO_PSP
          type: string
        txid:
          description: Identificador da transação.
          pattern: '[a-zA-Z0-9]{26,35}'
          type: string
        valor:
          $ref: '#/components/schemas/CobValor'
      required:
        - calendario
        - txid
        - revisao
        - loc
        - location
        - status
        - valor
        - chave
        - pixCopiaECola
      type: object
    Parametros:
      additionalProperties: false
      properties:
        fim:
          description: Fim do filtro (RFC 3339).
          type: string
        inicio:
          description: Início do filtro (RFC 3339).
          type: string
        paginacao:
          $ref: '#/components/schemas/Paginacao'
      required:
        - inicio
        - fim
        - paginacao
      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
    CobCalendarioGerado:
      additionalProperties: false
      properties:
        criacao:
          description: Data de criação da cobrança (RFC 3339).
          type: string
        expiracao:
          description: Tempo de vida da cobrança em segundos a partir de criacao.
          format: int64
          type: integer
      required:
        - criacao
        - expiracao
      type: object
    Pessoa:
      additionalProperties: false
      properties:
        cep:
          description: CEP do devedor.
          maxLength: 8
          type: string
        cidade:
          description: Cidade do devedor.
          maxLength: 200
          type: string
        cnpj:
          description: CNPJ do devedor (PJ). Mutuamente exclusivo com cpf.
          examples:
            - 12ABC34501DE35
          type: string
        cpf:
          description: CPF do devedor (PF). Mutuamente exclusivo com cnpj.
          examples:
            - '12345678901'
          type: string
        email:
          description: Email do devedor.
          type: string
        logradouro:
          description: Logradouro do devedor.
          maxLength: 200
          type: string
        nome:
          description: Nome do devedor.
          examples:
            - Fulano de Tal
          maxLength: 200
          type: string
        uf:
          description: UF do devedor.
          maxLength: 2
          type: string
      type: object
    InfoAdicional:
      additionalProperties: false
      properties:
        nome:
          description: Nome do campo.
          maxLength: 50
          type: string
        valor:
          description: Dados do campo.
          maxLength: 200
          type: string
      required:
        - nome
        - valor
      type: object
    CobLocGerada:
      additionalProperties: false
      properties:
        criacao:
          description: Data de criação da location (RFC 3339).
          type: string
        id:
          description: Id da location.
          format: int64
          type: integer
        location:
          description: Localização do payload.
          maxLength: 77
          type: string
        tipoCob:
          description: cob | cobv.
          enum:
            - cob
            - cobv
          type: string
      required:
        - id
        - tipoCob
        - criacao
      type: object
    PixRecebido:
      additionalProperties: false
      properties:
        endToEndId:
          pattern: '[a-zA-Z0-9]{32}'
          type: string
        horario:
          description: Horário do processamento do Pix (RFC 3339).
          type: string
        txid:
          pattern: '[a-zA-Z0-9]{1,35}'
          type: string
        valor:
          pattern: ^\d{1,10}\.\d{2}$
          type: string
      required:
        - endToEndId
        - valor
        - horario
      type: object
    CobValor:
      additionalProperties: false
      properties:
        modalidadeAlteracao:
          description: 0 = valor fixo (padrão); 1 = valor alterável pelo pagador.
          format: int64
          maximum: 1
          minimum: 0
          type: integer
        original:
          description: Valor original da cobrança (obrigatório na criação).
          examples:
            - '250.00'
          pattern: ^\d{1,10}\.\d{2}$
          type: string
        retirada:
          $ref: '#/components/schemas/Retirada'
          description: Estrutura opcional de recebimento de numerário (Pix Saque/Troco).
      type: object
    Paginacao:
      additionalProperties: false
      properties:
        itensPorPagina:
          description: Quantidade de registros na página.
          format: int64
          type: integer
        paginaAtual:
          description: Página recuperada (0-based).
          format: int64
          type: integer
        quantidadeDePaginas:
          description: Quantidade de páginas disponíveis.
          format: int64
          type: integer
        quantidadeTotalDeItens:
          description: Quantidade total de itens disponíveis.
          format: int64
          type: integer
      required:
        - paginaAtual
        - itensPorPagina
        - quantidadeDePaginas
        - quantidadeTotalDeItens
      type: object
    Retirada:
      additionalProperties: false
      properties:
        saque:
          $ref: '#/components/schemas/SaqueTroco'
          description: Informações de saque (Pix Saque).
        troco:
          $ref: '#/components/schemas/SaqueTroco'
          description: Informações de troco (Pix Troco).
      type: object
    SaqueTroco:
      additionalProperties: false
      properties:
        modalidadeAgente:
          description: AGTEC | AGTOT | AGPSS (saque) / AGTEC | AGTOT (troco).
          examples:
            - AGPSS
          type: string
        modalidadeAlteracao:
          description: 0 (padrão) ou 1.
          format: int64
          maximum: 1
          minimum: 0
          type: integer
        prestadorDoServicoDeSaque:
          description: ISPB do facilitador de serviço de saque.
          examples:
            - '12345678'
          pattern: ^[0-9A-Z]{8}$
          type: string
        valor:
          description: Valor do saque/troco.
          examples:
            - '5.00'
          pattern: ^\d{1,10}\.\d{2}$
          type: string
      required:
        - valor
        - modalidadeAgente
        - prestadorDoServicoDeSaque
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````