> ## 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 (JDPI §8.3.12), 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.1.0
info:
  description: Brazilian PIX Direct (DICT + SPI) plugin API.
  title: plugin-br-pix-jd
  version: 1.0.0
servers: []
security:
  - BearerAuth: []
paths:
  /v1/qrcodes/list:
    get:
      tags:
        - QR Codes
      summary: List the PSP's PIX QR codes
      description: >-
        Lists the PIX QR codes the PSP created (JDPI §8.3.12), 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.
      operationId: listQRCodes
      parameters:
        - description: >-
            tpQRCode filter (11=static, 12=immediate dynamic, 13=cobv,
            14=recurrence, 15-17=composite). Omit to list every type.
          explode: false
          in: query
          name: qrCodeType
          schema:
            description: >-
              tpQRCode filter (11=static, 12=immediate dynamic, 13=cobv,
              14=recurrence, 15-17=composite). Omit to list every type.
            examples:
              - 12
            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).
            examples:
              - '2024-10-01T00:00:00.001Z'
            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).
            examples:
              - '2024-11-25T23:59:59.999Z'
            type: string
        - description: Page number (pagina; default 1).
          explode: false
          in: query
          name: page
          schema:
            description: Page number (pagina; default 1).
            examples:
              - 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).
            examples:
              - 100
            format: int64
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListQRResponse'
          description: OK
        '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
components:
  schemas:
    ListQRResponse:
      additionalProperties: false
      properties:
        cobvQrCodes:
          description: The due-date dynamic QR codes (qrCodeDinamicoCobv).
          items:
            $ref: '#/components/schemas/ListedCobvQRResponse'
          type:
            - array
            - 'null'
        consultedAt:
          description: The JDPI consult timestamp (dtHrJdPi).
          examples:
            - '2024-11-26T18:08:49.025Z'
          type: string
        dynamicQrCodes:
          description: The immediate-dynamic QR codes (qrCodeDinamico).
          items:
            $ref: '#/components/schemas/ListedDynamicQRResponse'
          type:
            - array
            - 'null'
        recurrenceQrCodes:
          description: The recurrence-only composite QR codes (qrCodeRecorrencia).
          items:
            $ref: '#/components/schemas/ListedRecurrenceQRResponse'
          type:
            - array
            - 'null'
        staticQrCodes:
          description: The static QR codes (qrCodeEstatico).
          items:
            $ref: '#/components/schemas/ListedStaticQRResponse'
          type:
            - array
            - 'null'
      required:
        - consultedAt
        - staticQrCodes
        - dynamicQrCodes
        - cobvQrCodes
        - recurrenceQrCodes
      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
        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.
      type: object
    ListedCobvQRResponse:
      additionalProperties: false
      properties:
        categoryCode:
          description: Recipient category code (codigoCategoria).
          examples:
            - '0000'
          type: string
        city:
          description: Recipient city (cidade).
          examples:
            - Sao Paulo
          type: string
        conciliationId:
          description: Conciliation id (idConciliacaoRecebedor).
          examples:
            - TX-001
          type: string
        daysAfterDue:
          description: Days after the due date the charge stays payable (diasAposVenc).
          examples:
            - 30
          format: int64
          type: integer
        description:
          description: Additional-data entries (dadosAdicionais).
          items:
            $ref: '#/components/schemas/AdditionalDataBody'
          type:
            - array
            - 'null'
        discount:
          description: Early-payment discount in centavos (desconto).
          examples:
            - 200
          format: int64
          type: integer
        documentId:
          description: The JDPI charge GUID (idDocumento).
          examples:
            - 52c43361-caa1-4ddb-9152-708426a25db3
          type: string
        dueDate:
          description: Payment due date (dtVenc; aaaa-mm-dd).
          examples:
            - '2026-01-30'
          type: string
        finalAmount:
          description: Final payable amount in centavos (valorFinal).
          examples:
            - 10400
          format: int64
          type: integer
        fine:
          description: Late fine in centavos (multa).
          examples:
            - 400
          format: int64
          type: integer
        format:
          description: JDPI formato (0=image, 1=payload, 2=both).
          examples:
            - 1
          format: int64
          type: integer
        interest:
          description: Late interest in centavos (juros).
          examples:
            - 300
          format: int64
          type: integer
        key:
          description: The recipient PIX key.
          examples:
            - recipient@bank.com
          type: string
        originalAmount:
          description: Amount before interest/fine, in centavos (valorOriginal).
          examples:
            - 10000
          format: int64
          type: integer
        payerCnpj:
          description: Payer CNPJ (cnpjPagador).
          examples:
            - '01234567000199'
          type: string
        payerCpf:
          description: Payer CPF (cpfPagador).
          examples:
            - '01234567890'
          type: string
        payerName:
          description: Payer name (nomePagador).
          examples:
            - John Doe
          type: string
        payerRequest:
          description: Text shown to the payer (solicitacaoPagador).
          examples:
            - Informe o pedido
          type: string
        payloadUrl:
          description: JWS host URL (urlPayloadJson).
          examples:
            - pix.example.com/qr/abc
          type: string
        rebate:
          description: Rebate in centavos (abatimento).
          examples:
            - 100
          format: int64
          type: integer
        recipientCnpj:
          description: Recipient CNPJ (cnpjRecebedor).
          examples:
            - '61695227000193'
          type: string
        recipientCpf:
          description: Recipient CPF (cpfRecebedor).
          examples:
            - '01234567890'
          type: string
        recipientName:
          description: Recipient name (nomeRecebedor).
          examples:
            - Jane Doe
          type: string
        recipientStreet:
          description: Recipient street (logradouroRecebedor).
          examples:
            - Rua 1
          type: string
        recipientTradeName:
          description: Recipient trade name (nomeFantasiaRecebedor).
          examples:
            - Jane ME
          type: string
        recurrence:
          $ref: '#/components/schemas/ListedRecurrenceResponse'
          description: Recurrence configuration (dadosRecorrencia; qrCodeType 17 only).
        reusable:
          description: Whether the QR can be reused (reutilizavel).
          examples:
            - false
          type: boolean
        state:
          description: Recipient federal unit (uf).
          examples:
            - SP
          type: string
        status:
          description: Charge status (0=Active..3=Removed by PSP).
          examples:
            - 0
          format: int64
          type: integer
        zipCode:
          description: Recipient postal code (cep).
          examples:
            - '01310100'
          type: string
      required:
        - documentId
        - format
        - key
        - recipientName
        - recipientStreet
        - city
        - state
        - zipCode
        - payerName
        - originalAmount
        - rebate
        - discount
        - interest
        - fine
        - finalAmount
        - dueDate
        - daysAfterDue
        - reusable
        - status
      type: object
    ListedDynamicQRResponse:
      additionalProperties: false
      properties:
        amount:
          description: Original amount in centavos (valorOriginal).
          examples:
            - 10050
          format: int64
          type: integer
        categoryCode:
          description: Recipient category code (codigoCategoria).
          examples:
            - '0000'
          type: string
        city:
          description: Recipient city (cidade).
          examples:
            - Sao Paulo
          type: string
        conciliationId:
          description: Conciliation id (idConciliacaoRecebedor).
          examples:
            - TX-001
          type: string
        description:
          description: Additional-data entries (dadosAdicionais).
          items:
            $ref: '#/components/schemas/AdditionalDataBody'
          type:
            - array
            - 'null'
        documentId:
          description: The JDPI charge GUID (idDocumento).
          examples:
            - 52c43361-caa1-4ddb-9152-708426a25db3
          type: string
        expirationTime:
          description: QR expiration in seconds (expiracaoQR).
          examples:
            - 3600
          format: int64
          type: integer
        format:
          description: JDPI formato (0=image, 1=payload, 2=both).
          examples:
            - 1
          format: int64
          type: integer
        key:
          description: The recipient PIX key.
          examples:
            - recipient@bank.com
          type: string
        payloadUrl:
          description: JWS host URL (urlPayloadJson).
          examples:
            - pix.example.com/qr/abc
          type: string
        recipientName:
          description: Recipient name (nomeRecebedor).
          examples:
            - Jane Doe
          type: string
        recurrence:
          $ref: '#/components/schemas/ListedRecurrenceResponse'
          description: Recurrence configuration (dadosRecorrencia; qrCodeType 16 only).
        status:
          description: Charge status (0=Active..3=Removed by PSP).
          examples:
            - 0
          format: int64
          type: integer
        zipCode:
          description: Recipient postal code (cep).
          examples:
            - '01310100'
          type: string
      required:
        - documentId
        - format
        - key
        - recipientName
        - city
        - amount
        - status
      type: object
    ListedRecurrenceQRResponse:
      additionalProperties: false
      properties:
        amount:
          description: Payment amount in centavos (valor).
          examples:
            - 1050
          format: int64
          type: integer
        certificateIspb:
          description: Indirect PSP certificate ISPB (ispbCertificadoJws).
          examples:
            - '04358798'
          type: string
        city:
          description: Transaction city (cidade).
          examples:
            - Sao Paulo
          type: string
        conciliationId:
          description: Conciliation id (idConciliacaoRecebedor).
          examples:
            - TX-001
          type: string
        contractDescription:
          description: Free-text contract note (descContrato).
          examples:
            - Conta de energia
          type: string
        contractNumber:
          description: Authorization object id (nrContrato).
          examples:
            - 1234567890ABC
          type: string
        debtor:
          $ref: '#/components/schemas/RecurrenceDebtorResponse'
          description: Recurrence debtor (devedor).
        documentId:
          description: The JDPI recurrence GUID (idDocumento).
          examples:
            - 52c43361-caa1-4ddb-9152-708426a25db3
          type: string
        endDate:
          description: Last expected payment (dtFinalRecorrencia).
          examples:
            - '2026-01-10'
          type: string
        format:
          description: JDPI formato (0=image, 1=payload, 2=both).
          examples:
            - 1
          format: int64
          type: integer
        frequency:
          description: Payment frequency (tpFrequencia; 0=weekly..4=annual).
          examples:
            - 4
          format: int64
          type: integer
        jwkUrl:
          description: JWK Set URL (urlJwk).
          examples:
            - pix.example.com/jwks
          type: string
        maxFloorAmount:
          description: Recipient-defined floor in centavos (pisoValorMaximo).
          examples:
            - 55000
          format: int64
          type: integer
        payloadUrl:
          description: JWS host URL (urlPayloadJson).
          examples:
            - pix.example.com/qr/abc
          type: string
        recipient:
          $ref: '#/components/schemas/RecurrenceRecipientResponse'
          description: Recurrence recipient (recebedor).
        recurrenceId:
          description: Recurrence id (idRecorrencia).
          examples:
            - RR0435879820240605njua7shf40o
          type: string
        retryPolicy:
          description: Retry policy (retentativa; 0=none, 1=up to 3 retries).
          examples:
            - 1
          format: int64
          type: integer
        startDate:
          description: First expected payment (dtInicialRecorrencia).
          examples:
            - '2024-01-10'
          type: string
        updates:
          description: Recurrence status history (atualizacoes).
          items:
            $ref: '#/components/schemas/RecurrenceUpdateResponse'
          type:
            - array
            - 'null'
      required:
        - documentId
        - format
        - city
        - recurrenceId
        - frequency
        - startDate
        - amount
        - maxFloorAmount
        - recipient
        - debtor
        - contractNumber
        - retryPolicy
      type: object
    ListedStaticQRResponse:
      additionalProperties: false
      properties:
        additionalData:
          description: Free-text additional data (dadosAdicionais).
          examples:
            - Invoice 42
          type: string
        amount:
          description: Transaction amount in centavos.
          examples:
            - 10050
          format: int64
          type: integer
        categoryCode:
          description: Recipient category code (codigoCategoria).
          examples:
            - '0000'
          type: string
        city:
          description: Recipient city (cidade).
          examples:
            - Sao Paulo
          type: string
        conciliationId:
          description: Conciliation id (idConciliacaoRecebedor).
          examples:
            - '***'
          type: string
        format:
          description: JDPI formato (0=image, 1=payload, 2=both).
          examples:
            - 0
          format: int64
          type: integer
        ispbFss:
          description: Pix Saque facilitator ISPB.
          examples:
            - '04358798'
          type: string
        key:
          description: The recipient PIX key.
          examples:
            - recipient@bank.com
          type: string
        recipientName:
          description: Recipient name (nomeRecebedor).
          examples:
            - Jane Doe
          type: string
        recurrence:
          $ref: '#/components/schemas/ListedRecurrenceResponse'
          description: Recurrence configuration (dadosRecorrencia; qrCodeType 15 only).
        zipCode:
          description: Recipient postal code (cep).
          examples:
            - '01310100'
          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
    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
    AdditionalDataBody:
      additionalProperties: false
      properties:
        name:
          description: The additional-data entry name.
          examples:
            - order
          type: string
        value:
          description: The additional-data entry value.
          examples:
            - '42'
          type: string
      required:
        - name
        - value
      type: object
    ListedRecurrenceResponse:
      additionalProperties: false
      properties:
        amount:
          description: Payment amount in centavos (valor).
          examples:
            - 1050
          format: int64
          type: integer
        certificateIspb:
          description: Indirect PSP certificate ISPB (ispbCertificadoJws).
          examples:
            - '04358798'
          type: string
        contractDescription:
          description: Free-text contract note (descContrato).
          examples:
            - Conta de energia
          type: string
        contractNumber:
          description: Authorization object id (nrContrato).
          examples:
            - 1234567890ABC
          type: string
        debtor:
          $ref: '#/components/schemas/RecurrenceDebtorResponse'
          description: Recurrence debtor (devedor).
        endDate:
          description: Last expected payment (dtFinalRecorrencia; aaaa-mm-dd).
          examples:
            - '2026-01-10'
          type: string
        frequency:
          description: Payment frequency (tpFrequencia; 0=weekly..4=annual).
          examples:
            - 1
          format: int64
          type: integer
        jwkUrl:
          description: JWK Set URL (urlJwk).
          examples:
            - pix.example.com/jwks
          type: string
        maxFloorAmount:
          description: Recipient-defined floor in centavos (pisoValorMaximo).
          examples:
            - 55000
          format: int64
          type: integer
        payloadUrl:
          description: JWS host URL (urlPayloadJson).
          examples:
            - pix.example.com/qr/abc
          type: string
        recipient:
          $ref: '#/components/schemas/RecurrenceRecipientResponse'
          description: Recurrence recipient (recebedor).
        recurrenceId:
          description: Recurrence id (idRecorrencia).
          examples:
            - RR0435879820240605njua7shf40o
          type: string
        retryPolicy:
          description: Retry policy (retentativa; 0=none, 1=up to 3 retries).
          examples:
            - 1
          format: int64
          type: integer
        startDate:
          description: First expected payment (dtInicialRecorrencia; aaaa-mm-dd).
          examples:
            - '2024-01-10'
          type: string
        updates:
          description: Recurrence status history (atualizacoes).
          items:
            $ref: '#/components/schemas/RecurrenceUpdateResponse'
          type:
            - array
            - 'null'
      required:
        - recurrenceId
        - frequency
        - startDate
        - amount
        - maxFloorAmount
        - recipient
        - debtor
        - contractNumber
        - retryPolicy
      type: object
    RecurrenceDebtorResponse:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: Debtor CPF or CNPJ.
          examples:
            - '04623217035'
          type: string
        name:
          description: Debtor name.
          examples:
            - Ciclano da Silva
          type: string
        personType:
          description: Debtor person type (tpPessoa; 0=natural, 1=legal).
          examples:
            - 0
          format: int64
          type: integer
      required:
        - personType
        - cpfCnpj
        - name
      type: object
    RecurrenceRecipientResponse:
      additionalProperties: false
      properties:
        cnpj:
          description: Recipient CNPJ.
          examples:
            - '61695227000193'
          type: string
        ispb:
          description: Recipient participant ISPB.
          examples:
            - '04358798'
          type: string
        name:
          description: Recipient legal/trade name.
          examples:
            - Enel
          type: string
      required:
        - ispb
        - cnpj
        - name
      type: object
    RecurrenceUpdateResponse:
      additionalProperties: false
      properties:
        status:
          description: Recurrence status (stRecorrencia; 0=created..4=cancelled).
          examples:
            - 0
          format: int64
          type: integer
        statusDateTime:
          description: When the status was set (dtHrSituacao).
          examples:
            - '2024-11-08T14:25:49.025Z'
          type: string
      required:
        - status
        - statusDateTime
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````