---
title: "Consulta de detalhes de autorizações"
method: GET
path: "/pix/recurring-payments"
tags: ["Pix automático"]
---

# Consulta de detalhes de autorizações

`GET /pix/recurring-payments`

Realize a consulta de uma ou mais autorizações de recorrência de Pix automático.

## Query parameters

- `initialDate` string, date, nullable
- `finalDate` string, date, nullable
- `idRecurrence` string, nullable
- `contractNumber` string, nullable
- `status` 'PENDING' | 'APPROVED' | 'CANCELED' | 'EXPIRED' | 'REJECTED' | 'ERROR' | 'COMPLETED' — Status da recorrência de pagamento.
- `page` integer
- `pageSize` integer

## Headers

- `x-correlation-id` Schema, required — unresolved $ref

## Parameters

- `#/paths/~1pix~1claims/get/parameters/0` — unresolved $ref
- `#/paths/~1pix~1claims/get/parameters/2` — unresolved $ref
- `#/paths/~1pix~1claims/get/parameters/3` — unresolved $ref

## Response `200`

Consulta realizada com sucesso.

- ListPixAutomaticRecurrence
  - `pagination` PixAutomaticPagination, required — Resposta da consulta paginada.
    - `page` number, required — Número da página atual.
    - `pageSize` number, required — Tamanho da página.
    - `totalPages` number, required — Total de páginas.
    - `totalItems` number, required — Total de itens da página.
  - `items` PixAutomaticRecurrence[], required — Lista de recorrências de pagamento.
    - `idRecurrence` string, required — Identificador único da recorrência de pagamento.
    - `agents` PixAutomaticAgentResponse, required — Dados dos agentes envolvidos na recorrência de pagamento.
      - `debtor` PixAutomaticDebtorResponse, required
        - `accountIdentification` string, required — Conta do cliente pagador.
        - `accountIssuer` string, required — Agência do cliente pagador.
        - `agentMemberIdentification` string, required — ISPB do banco do cliente pagador.
        - `cityCode` string, nullable — Código de município do usuário pagador no IBGE. Retornará sempre que a autorização for aceita (accepted = true).
        - `name` string, required — Nome do pagador.
        - `privateIdentification` string, required — CPF ou CNPJ do cliente pagador. `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
      - `originalDebtor` PixAutomaticOriginalDebtorResponse
        - `name` string, required — Nome do usuário devedor. Retornará somente quando o campo <code>authorizationType</code> apresentar valor "AUT2", "AUT3" ou "AUT4".
        - `privateIdentification` string, required — CPF ou CNPJ do usuário devedor. Retornará somente quando o campo <code>authorizationType</code> apresentar valor "AUT2", "AUT3" ou "AUT4". `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
      - `creditor` PixAutomaticCreditorResponse, required
        - `agentMemberIdentification` string, required — ISPB do banco do recebedor. Retornará somente quando o campo <code>authorizationType</code> apresentar valor "AUT2", "AUT3" ou "AUT4".
        - `name` string, required — Nome do recebedor. Retornará somente quando o campo <code>authorizationType</code> apresentar valor "AUT2", "AUT3" ou "AUT4".
        - `privateIdentification` string, required — CNPJ do cliente recebedor. Retornará somente quando o campo <code>authorizationType</code> apresentar valor "AUT2", "AUT3" ou "AUT4". `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
    - `amount` PixAutomaticAmountResponse — Valores da recorrência de pagamento.
      - `fixedValue` string, nullable — Valor fixo configurado para a recorrência. Retornado somente quando a autorização utiliza um modelo de valor fixo (<code>authorizationType</code> seja igual a "AUT2", "AUT3" ou "AUT4"). Não é retornado em autorizações com valores variáveis. O Formato é uma string que representa um decimal com duas casas após a vírgula.
      - `minimumValue` string, nullable — Valor mínimo permitido para cada débito da recorrência quando a autorização usa valores variáveis. Pode ser limitado pelo valor máximo definido pelo usuário recebedor. Ignorado em autorizações de valor fixo. O Formato é uma string que representa um decimal com duas casas após a vírgula.
      - `maximumValue` string, nullable — Valor máximo permitido para cada débito da recorrência quando a autorização usa valores variáveis. Pode ser limitado pelo valor mínimo definido pelo usuário recebedor. Não se aplica a autorizações de valor fixo. O Formato é uma string que representa um decimal com duas casas após a vírgula.
      - `currency` string, required — Moeda utilizada nos valores da autorização.
    - `calendar` PixAutomaticCalendar — Dados do calendário da recorrência de pagamento.
      - `frequency` 'WEEK' | 'MNTH' | 'QURT' | 'MIAN' | 'YEAR' — Periodicidade do pagamento recorrente via Pix automático.
      - `initialDate` string, date-time, nullable — Data do primeiro pagamento.
      - `finalDate` string, date-time, nullable — Data do último pagamento.
    - `contractNumber` string, nullable — Número de contrato referente à recorrência.
    - `status` 'PENDING' | 'APPROVED' | 'CANCELED' | 'EXPIRED' | 'REJECTED' | 'ERROR' | 'COMPLETED', required — Status da recorrência de pagamento.
    - `description` string, nullable — Descrição do serviço/produto associado à recorrência.
    - `authorization` PixAutomaticAuthorization, required — Dados da autorização da recorrência.
      - `authorizationType` 'AUT1' | 'AUT2' | 'AUT3' | 'AUT4' — Tipo da jornada da autorização.
      - `authorizationDateTime` string, date-time — Data de criação da autorização.
    - `rejectReason` 'AP13' | 'AP14' — Especifica o motivo de rejeição de uma autorização.
    - `retryPolicy` 'ALLOW_3R_7D' | 'DOES_NOT_ALLOW' — Política de retentativa de pagamento após vencimento da recorrência.
    - `endToEndId` string, nullable — Identificador de pagamento vinculado ao QR code composto. Retornará somente quando o campo <code>authorizationType</code> apresentar valor "AUT3" ou "AUT4".
    - `expirationDateTime` string, date-time, required — Data de expiração da recorrência.
    - `recurrenceCreationDateTime` string, date-time, required — Data de criação da recorrência.

## Other responses

- `400` — unresolved $ref
- `401` — Acesso não autorizado.
- `403` — O acesso ao recurso foi negado pelo servidor.
- `404` — unresolved $ref
- `408` — unresolved $ref
- `422` — unresolved $ref
- `500` — unresolved $ref

---

[API](https://skmtc.net/bankly/apis/autentica-o.md) · [All operations](https://skmtc.net/bankly/apis/autentica-o/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bankly/autentica-o/revisions/e20afa10cd0e/schema)