> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# 31 - Consultar Recorrência por QR Code

> <p>Scopes:</p>
<b>api.pix api.pixautomatico.autorizacao.consultar</b>



## OpenAPI

````yaml get /api/QRCode/Consulta/{codigoQrCode}/Recorrencia
openapi: 3.0.1
info:
  title: Api Externa BMP SPI
  description: '<p><strong>Build Number: </strong>#0.0</p>'
  version: v1
servers:
  - url: https://api.ext.pix.dbs.moneyp.com.br/
    description: Localhost
security:
  - Bearer: []
paths:
  /api/QRCode/Consulta/{codigoQrCode}/Recorrencia:
    get:
      tags:
        - QRCode
      summary: Consulta a autorização de recorrência por código de consulta do QR Code
      description: "<p>Scopes:</p>\r\n<b>api.pix api.pixautomatico.autorizacao.consultar</b>"
      parameters:
        - name: codigoQrCode
          in: path
          description: >-
            Código de consulta (UUID) do QR Code de recorrência, retornado na
            leitura do QR Code.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.QRCode.RecorrenciaQRCodeResponse
        '400':
          description: Erro de negócio
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
        '404':
          description: QR Code de recorrência não encontrado
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
components:
  schemas:
    BMPSPB.Domain.Messaging.API.Pix.QRCode.RecorrenciaQRCodeResponse:
      type: object
      properties:
        recebedor:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.QRCode.PessoaResponse
          description: Dados do recebedor (usuário recebedor da recorrência).
          nullable: true
        devedor:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.QRCode.PessoaResponse
          description: Dados do devedor.
          nullable: true
        contrato:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Domain.Messaging.API.Pix.QRCode.ContratoResponse
          description: Dados do contrato vinculado à recorrência.
          nullable: true
        primeiroPagamento:
          type: string
          description: Data do primeiro pagamento da recorrência.
          format: date-time
          nullable: true
        frequenciaRecorrencia:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.FrequenciaRecorrencia
          description: |-
            Periodicidade das cobranças.

            Valores:
            1 - Semanal
            2 - Mensal
            3 - Trimestral
            4 - Semestral
            5 - Anual
          nullable: true
        descricaoRecorrencia:
          type: string
          description: Descrição da periodicidade da recorrência.
          nullable: true
        prazoAutorizacao:
          type: string
          description: Data limite para o pagador confirmar a autorização da recorrência.
          format: date-time
          nullable: true
        valorMinimo:
          type: number
          description: Valor mínimo definido pelo recebedor para as cobranças.
          format: double
          nullable: true
        idRecorrencia:
          type: string
          description: Identificador da recorrência no SPI (idRec).
          nullable: true
        permitePagamentoPosVencimento:
          type: boolean
          description: Indica se a recorrência permite pagamento após o vencimento.
        valorPagamento:
          type: number
          description: Valor fixo de cada cobrança, quando definido pelo recebedor.
          format: double
          nullable: true
      additionalProperties: false
    BMPSPB.Domain.Messaging.API.Pix.QRCode.PessoaResponse:
      type: object
      properties:
        nome:
          type: string
          description: Nome da pessoa.
          nullable: true
        documento:
          type: string
          description: CPF/CNPJ da pessoa.
          nullable: true
      additionalProperties: false
    BMPSPB.Domain.Messaging.API.Pix.QRCode.ContratoResponse:
      type: object
      properties:
        descricao:
          type: string
          description: Descrição do contrato/objeto da recorrência.
          nullable: true
        numero:
          type: string
          description: Número do contrato.
          nullable: true
      additionalProperties: false
    BMPSPB.Infra.Enums.PixAutomatico.FrequenciaRecorrencia:
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````