> ## 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 the PSP's Pix QR codes

> Lists the Pix QR codes the PSP created, filtered by type and a registration window (≤90 days). Returns the static and immediate-dynamic blocks; composite / cobv / recurrence QR codes are out of this context's scope and not projected.



## OpenAPI

````yaml en/openapi/v3-current/pix.yaml GET /v1/qrcodes/list
openapi: 3.0.3
info:
  title: Plugin BR Pix Direct - Complete API
  description: |
    Complete API for Brazilian Pix instant payment system including
    Pix key dictionary operations, QR code generation/decoding, transactions and
    transaction limits.
  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: List the PSP's Pix QR codes
      description: >-
        Lists the Pix QR codes the PSP created, filtered by type and a
        registration window (≤90 days). Returns the static and immediate-dynamic
        blocks; composite / cobv / recurrence QR codes are out of this context's
        scope and not projected.
      parameters:
        - description: >-
            tpQRCode filter (11=static, 12=immediate dynamic, 13=cobv,
            14-17=composite).
          explode: false
          in: query
          name: qrCodeType
          schema:
            description: >-
              tpQRCode filter (11=static, 12=immediate dynamic, 13=cobv,
              14-17=composite).
            format: int64
            type: integer
        - description: Window start (dtHrInicial; aaaa-mm-ddTHH:mm:ss.sssZ).
          explode: false
          in: query
          name: startDateTime
          schema:
            description: Window start (dtHrInicial; aaaa-mm-ddTHH:mm:ss.sssZ).
            type: string
        - description: Window end (dtHrFinal; aaaa-mm-ddTHH:mm:ss.sssZ; ≤90d from start).
          explode: false
          in: query
          name: endDateTime
          schema:
            description: Window end (dtHrFinal; aaaa-mm-ddTHH:mm:ss.sssZ; ≤90d from start).
            type: string
        - description: Page number (pagina; default 1).
          explode: false
          in: query
          name: page
          schema:
            description: Page number (pagina; default 1).
            format: int64
            type: integer
        - description: Page size (tamanhoPagina; default 50, max 100).
          explode: false
          in: query
          name: pageSize
          schema:
            description: Page size (tamanhoPagina; default 50, max 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: Error
components:
  schemas:
    ListQRResponse:
      additionalProperties: false
      properties:
        consultedAt:
          description: The upstream consult timestamp (upstream timestamp).
          type: string
        dynamicQrCodes:
          description: The immediate-dynamic QR codes (qrCodeDinamico).
          items:
            $ref: '#/components/schemas/ListedDynamicQRResponse'
          type: array
          nullable: true
        staticQrCodes:
          description: The static QR codes (qrCodeEstatico).
          items:
            $ref: '#/components/schemas/ListedStaticQRResponse'
          type: array
          nullable: true
      required:
        - consultedAt
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          format: uri
          type: string
        status:
          description: HTTP status code
          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.
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          format: uri
          type: string
      type: object
    ListedDynamicQRResponse:
      additionalProperties: false
      properties:
        amount:
          description: Original amount in reais (valorOriginal).
          format: double
          type: number
        categoryCode:
          description: Recipient category code (codigoCategoria).
          type: string
        city:
          description: Recipient city (cidade).
          type: string
        conciliationId:
          description: Conciliation id (idConciliacaoRecebedor).
          type: string
        description:
          description: Additional-data entries (dadosAdicionais).
          items:
            $ref: '#/components/schemas/AdditionalDataBody'
          type: array
          nullable: true
        documentId:
          description: The upstream charge GUID (idDocumento).
          type: string
        expirationTime:
          description: QR expiration in seconds (expiracaoQR).
          format: int64
          type: integer
        format:
          description: Upstream formato (0=image, 1=payload, 2=both).
          format: int64
          type: integer
        key:
          description: The recipient Pix key.
          type: string
        payloadUrl:
          description: JWS host URL (urlPayloadJson).
          type: string
        recipientName:
          description: Recipient name (nomeRecebedor).
          type: string
        status:
          description: Charge status (0=Active..3=Removed by PSP).
          format: int64
          type: integer
        zipCode:
          description: Recipient postal code (cep).
          type: string
      required:
        - documentId
        - format
        - key
        - recipientName
        - city
        - amount
        - status
      type: object
    ListedStaticQRResponse:
      additionalProperties: false
      properties:
        additionalData:
          description: Free-text additional data (dadosAdicionais).
          type: string
        amount:
          description: Transaction amount in reais.
          format: double
          type: number
        bankIdFss:
          description: Pix Saque facilitator ISPB (ispbFss).
          type: string
        categoryCode:
          description: Recipient category code (codigoCategoria).
          type: string
        city:
          description: Recipient city (cidade).
          type: string
        conciliationId:
          description: Conciliation id (idConciliacaoRecebedor).
          type: string
        format:
          description: Upstream formato (0=image, 1=payload, 2=both).
          format: int64
          type: integer
        key:
          description: The recipient Pix key.
          type: string
        recipientName:
          description: Recipient name (nomeRecebedor).
          type: string
        zipCode:
          description: Recipient postal code (cep).
          type: string
      required:
        - format
        - key
        - amount
        - recipientName
        - city
      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
    AdditionalDataBody:
      additionalProperties: false
      properties:
        name:
          description: The additional-data entry name.
          type: string
        value:
          description: The additional-data entry value.
          type: string
      required:
        - name
        - value
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        JWT Bearer token authentication. Obtain token from
        `/v1/login/oauth/access_token` endpoint

        using client credentials (clientId and clientSecret).


        Include token in Authorization header:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        Token expires after 3600 seconds (1 hour).

````