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

# 33 - Listar Autorizações de Recorrência

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



## OpenAPI

````yaml get /api/v1/pix-automatico/autorizacoes-recorrencias
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/v1/pix-automatico/autorizacoes-recorrencias:
    get:
      tags:
        - AutorizacoesRecorrencias
      summary: Lista as autorizações de recorrência do parceiro
      description: "<p>Scopes:</p>\r\n<b>api.pix api.pixautomatico.autorizacao.consultar</b>"
      parameters:
        - name: Situacao
          in: query
          description: |-
            Filtra pela situação da autorização de recorrência.

            Valores:
            0 - PendenteConfirmacao
            1 - ConfirmadaPagador
            2 - Cancelada
            3 - AguardandoConfirmacao
            4 - AguardandoCancelamento
          schema:
            allOf:
              - $ref: >-
                  #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.SituacaoRecorrencia
            description: |-
              Filtra pela situação da autorização de recorrência.

              Valores:
              0 - PendenteConfirmacao
              1 - ConfirmadaPagador
              2 - Cancelada
              3 - AguardandoConfirmacao
              4 - AguardandoCancelamento
        - name: IncluirPendentes
          in: query
          description: >-
            Indica se as autorizações pendentes de confirmação devem ser
            incluídas na listagem.
          schema:
            type: boolean
            description: >-
              Indica se as autorizações pendentes de confirmação devem ser
              incluídas na listagem.
        - name: PageSize
          in: query
          description: Número de itens devolvidos por página.
          schema:
            type: integer
            format: int32
            description: Número de itens devolvidos por página.
        - name: Page
          in: query
          description: Página que deve ser retornada.
          schema:
            type: integer
            format: int32
            description: Página que deve ser retornada.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.AutorizacoesRecorrenciasExternoResponse
        '400':
          description: Erro de negócio
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                type: object
                properties:
                  sucesso:
                    type: boolean
                  mensagem:
                    type: string
components:
  schemas:
    BMPSPB.Infra.Enums.PixAutomatico.SituacaoRecorrencia:
      enum:
        - 0
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Domain.Messaging.SPI.PixAutomatico.AutorizacoesRecorrenciasExternoResponse:
      type: object
      properties:
        autorizacoes:
          type: array
          items:
            $ref: >-
              #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.AutorizacaoRecorrenciaExterno
          description: Lista de autorizações de recorrência da página.
          nullable: true
        totalPages:
          type: integer
          description: Quantidade total de páginas.
          format: int32
        totalRecords:
          type: integer
          description: Quantidade total de registros.
          format: int32
      additionalProperties: false
    BMPSPB.Domain.Messaging.SPI.PixAutomatico.AutorizacaoRecorrenciaExterno:
      type: object
      properties:
        codigo:
          type: string
          description: Código identificador da autorização de recorrência.
          format: uuid
        codigoConta:
          type: string
          description: Código identificador da conta do pagador.
          format: uuid
        recebedor:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.Pessoa
          description: Dados do recebedor (usuário recebedor da recorrência).
          nullable: true
        devedor:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.Pessoa
          description: Dados do devedor.
          nullable: true
        contrato:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Domain.Messaging.SPI.PixAutomatico.Contrato
          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
        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
        valorMaximo:
          type: number
          description: Valor máximo autorizado pelo pagador para cada cobrança.
          format: double
          nullable: true
        valorPagamento:
          type: number
          description: Valor fixo de cada cobrança, quando definido pelo recebedor.
          format: double
          nullable: true
        permitePagamentoPosVencimento:
          type: boolean
          description: Indica se a recorrência permite pagamento após o vencimento.
        idRecorrencia:
          type: string
          description: Identificador da recorrência no SPI (idRec).
          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
        tipoJornada:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.TipoJornadaRecorrencia
          description: |-
            Jornada pela qual a autorização foi criada.

            Valores:
            1 - SemQrCode
            2 - QrCodeRecorrencia
            3 - QrCodeRecorrenciaImediato
            4 - QrCodeOfertaRecorrencia
        situacaoRecorrencia:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.SituacaoRecorrencia
          description: |-
            Situação da autorização de recorrência.

            Valores:
            0 - PendenteConfirmacao
            1 - ConfirmadaPagador
            2 - Cancelada
            3 - AguardandoConfirmacao
            4 - AguardandoCancelamento
        motivoRejeicao:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.MotivoRejeicaoRecorrencia
          description: |-
            Motivo da rejeição da autorização, quando rejeitada.

            Valores:
            1 - AC01 - NumeroContaIncorreta
            2 - AC04 - NumeroContaEncerrada
            3 - AC06 - ContaBloqueada
            4 - AG12 - TransferenciaNaoPermitida
            5 - AM05 - Duplicidade
            6 - AP01 - DataHoraProcessamentoIncorreta
            7 - AP02 - IdentificacaoDevedorIncorreta
            8 - AP03 - EmissorContaDevedorIncorreto
            9 - AP04 - IdRecorrenciaIncorreto
            10 - AP05 - StatusRecorrenciaIncorreto
            11 - AP06 - IdentificacaoCredorIncorreta
            12 - AP07 - SolicitacaoExpirada
            13 - AP08 - PagamentoInstantaneoAssociadoNaoLiquidado
            14 - AP09 - SolicitacaoNaoIdentificada
            15 - AP10 - IniciadorIncorreto
            16 - AP11 - AgenteDevedorIncorreto
            17 - AP12 - AgenteCredorIncorreto
            18 - AP13 - NaoReconhecidoPeloDevedor
            19 - AP14 - RejeitadoPeloDevedor
            20 - AP15 - NaoOferecido
            21 - CH16 - ConteudoElementoFormalmenteIncorreto
            22 - DS27 - UsuarioAindaNaoAtivado
            23 - MD01 - SemRecorrencia
            24 - MD20 - RecorrenciaExpirada
            25 - RC09 - IdentificadorSistemaCompensacaoDevedorInvalido
            26 - RC10 - IdentificadorSistemaCompensacaoCredorInvalido
          nullable: true
        motivoCancelamento:
          allOf:
            - $ref: >-
                #/components/schemas/BMPSPB.Infra.Enums.PixAutomatico.MotivoCancelamentoRecorrencia
          description: |-
            Motivo do cancelamento da autorização, quando cancelada.

            Valores:
            1 - ACCL - EncerramentoConta
            2 - CPCL - EncerramentoEmpresa
            3 - DCSD - Falecimento
            4 - ERSL - ErroSolicitacaoConfirmacao
            5 - FRUD - Fraude
            6 - NRES - ExpiracaoConfirmacao
            7 - PCFD - ConfirmacaoJaRealizada
            8 - SLCR - SolicitadoRecebedor
            9 - SLDB - SolicitadoPagador
          nullable: true
        dtCancelamento:
          type: string
          description: Data do cancelamento da autorização.
          format: date-time
          nullable: true
      additionalProperties: false
    BMPSPB.Domain.Messaging.SPI.PixAutomatico.Pessoa:
      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.SPI.PixAutomatico.Contrato:
      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
    BMPSPB.Infra.Enums.PixAutomatico.TipoJornadaRecorrencia:
      enum:
        - 1
        - 2
        - 3
        - 4
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.PixAutomatico.MotivoRejeicaoRecorrencia:
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
        - 10
        - 11
        - 12
        - 13
        - 14
        - 15
        - 16
        - 17
        - 18
        - 19
        - 20
        - 21
        - 22
        - 23
        - 24
        - 25
        - 26
      type: integer
      description: ''
      format: int32
    BMPSPB.Infra.Enums.PixAutomatico.MotivoCancelamentoRecorrencia:
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
      type: integer
      description: ''
      format: int32
  securitySchemes:
    Bearer:
      type: apiKey
      description: Copie 'Bearer ' + token
      name: Authorization
      in: header

````