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

# Listar os QR codes Pix do PSP

> Lista os QR codes Pix que o PSP criou, filtrados por tipo e por uma janela de registro (≤90 dias). Retorna os blocos estático e dinâmico-imediato; QR codes compostos / cobv / recorrência estão fora do escopo deste contexto e não são projetados.



## OpenAPI

````yaml pt/openapi/v3-current/pix.yaml GET /v1/qrcodes/list
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - API Completa
  description: >
    API completa para o sistema de pagamentos instantaneos PIX brasileiro,
    incluindo

    operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes,
    transacoes e

    limites de transacao.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/qrcodes/list:
    get:
      tags:
        - QR Codes API
      summary: Listar os QR codes Pix do PSP
      description: >-
        Lista os QR codes Pix que o PSP criou, filtrados por tipo e por uma
        janela de registro (≤90 dias). Retorna os blocos estático e
        dinâmico-imediato; QR codes compostos / cobv / recorrência estão fora do
        escopo deste contexto e não são projetados.
      parameters:
        - description: >-
            filtro tpQRCode (11=estático, 12=dinâmico imediato, 13=cobv,
            14-17=composto).
          explode: false
          in: query
          name: qrCodeType
          schema:
            description: >-
              filtro tpQRCode (11=estático, 12=dinâmico imediato, 13=cobv,
              14-17=composto).
            format: int64
            type: integer
        - description: Início da janela (dtHrInicial; aaaa-mm-ddTHH:mm:ss.sssZ).
          explode: false
          in: query
          name: startDateTime
          schema:
            description: Início da janela (dtHrInicial; aaaa-mm-ddTHH:mm:ss.sssZ).
            type: string
        - description: >-
            Fim da janela (dtHrFinal; aaaa-mm-ddTHH:mm:ss.sssZ; ≤90d a partir do
            início).
          explode: false
          in: query
          name: endDateTime
          schema:
            description: >-
              Fim da janela (dtHrFinal; aaaa-mm-ddTHH:mm:ss.sssZ; ≤90d a partir
              do início).
            type: string
        - description: Número da página (pagina; padrão 1).
          explode: false
          in: query
          name: page
          schema:
            description: Número da página (pagina; padrão 1).
            format: int64
            type: integer
        - description: Tamanho da página (tamanhoPagina; padrão 50, máx. 100).
          explode: false
          in: query
          name: pageSize
          schema:
            description: Tamanho da página (tamanhoPagina; padrão 50, máx. 100).
            format: int64
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQRResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
components:
  schemas:
    ListQRResponse:
      additionalProperties: false
      properties:
        consultedAt:
          description: O carimbo de data/hora da consulta ao upstream (upstream timestamp).
          type: string
        dynamicQrCodes:
          description: Os QR codes dinâmico-imediato (qrCodeDinamico).
          items:
            $ref: '#/components/schemas/ListedDynamicQRResponse'
          type: array
          nullable: true
        staticQrCodes:
          description: Os QR codes estáticos (qrCodeEstatico).
          items:
            $ref: '#/components/schemas/ListedStaticQRResponse'
          type: array
          nullable: true
      required:
        - consultedAt
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, escopado ao
            serviço emissor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: Uma explicação legível específica desta ocorrência do problema.
          type: string
        errors:
          description: Lista opcional de detalhes individuais de erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          format: uri
          type: string
        status:
          description: Código de status HTTP
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível do tipo de problema. Este valor não deve
            mudar entre ocorrências do erro.
          type: string
        type:
          default: about:blank
          description: Uma referência URI para a documentação legível do erro.
          format: uri
          type: string
      type: object
    ListedDynamicQRResponse:
      additionalProperties: false
      properties:
        amount:
          description: Valor original em reais (valorOriginal).
          format: double
          type: number
        categoryCode:
          description: Código de categoria do recebedor (codigoCategoria).
          type: string
        city:
          description: Cidade do recebedor (cidade).
          type: string
        conciliationId:
          description: Id de conciliação (idConciliacaoRecebedor).
          type: string
        description:
          description: Entradas de dados adicionais (dadosAdicionais).
          items:
            $ref: '#/components/schemas/AdditionalDataBody'
          type: array
          nullable: true
        documentId:
          description: O GUID da cobrança no upstream (idDocumento).
          type: string
        expirationTime:
          description: Expiração do QR em segundos (expiracaoQR).
          format: int64
          type: integer
        format:
          description: formato do upstream (0=imagem, 1=payload, 2=ambos).
          format: int64
          type: integer
        key:
          description: A chave Pix do recebedor.
          type: string
        payloadUrl:
          description: URL do host JWS (urlPayloadJson).
          type: string
        recipientName:
          description: Nome do recebedor (nomeRecebedor).
          type: string
        status:
          description: Status da cobrança (0=Ativa..3=Removida pelo PSP).
          format: int64
          type: integer
        zipCode:
          description: CEP do recebedor (cep).
          type: string
      required:
        - documentId
        - format
        - key
        - recipientName
        - city
        - amount
        - status
      type: object
    ListedStaticQRResponse:
      additionalProperties: false
      properties:
        additionalData:
          description: Dados adicionais em texto livre (dadosAdicionais).
          type: string
        amount:
          description: Valor da transação em reais.
          format: double
          type: number
        bankIdFss:
          description: ISPB do facilitador de Pix Saque (ispbFss).
          type: string
        categoryCode:
          description: Código de categoria do recebedor (codigoCategoria).
          type: string
        city:
          description: Cidade do recebedor (cidade).
          type: string
        conciliationId:
          description: Id de conciliação (idConciliacaoRecebedor).
          type: string
        format:
          description: formato do upstream (0=imagem, 1=payload, 2=ambos).
          format: int64
          type: integer
        key:
          description: A chave Pix do recebedor.
          type: string
        recipientName:
          description: Nome do recebedor (nomeRecebedor).
          type: string
        zipCode:
          description: CEP do recebedor (cep).
          type: string
      required:
        - format
        - key
        - amount
        - recipientName
        - city
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: Onde o erro ocorreu, ex. 'body.items[3].tags' ou 'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor no local informado
      type: object
    AdditionalDataBody:
      additionalProperties: false
      properties:
        name:
          description: O nome da entrada de dados adicionais.
          type: string
        value:
          description: O valor da entrada de dados adicionais.
          type: string
      required:
        - name
        - value
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticacao por token JWT Bearer. Obtenha o token no endpoint
        `/v1/login/oauth/access_token`

        usando credenciais do cliente (clientId e clientSecret).


        Inclua o token no header Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        O token expira apos 3600 segundos (1 hora).

````