---
title: "Consulta de recorrência de agendamentos"
method: GET
path: "/pix/scheduling-payments/recurrences"
tags: ["Pix agendado"]
---

# Consulta de recorrência de agendamentos

`GET /pix/scheduling-payments/recurrences`

Utilize este endpoint para consultar agendamentos recorrentes a partir dos campos informados na requisição.

## Query parameters

- `debtorAccountIdentification` string
- `debtorAccountIssuer` string
- `status` 'PROCESSING' | 'CANCELED' | 'COMPLETED' | 'AWAITING_ENRICHMENT'
- `initialDate` string
- `endDate` string
- `page` integer
- `pageSize` integer

## 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
- `#/paths/~1pix~1claims/get/parameters/1` — unresolved $ref

## Response `200`

Consulta realizada com sucesso.

- object
  - `totalItems` integer — Número total de itens.
  - `totalPages` integer — Número total de páginas.
  - `currentPage` integer — Página atual.
  - `recurrence` object[] — Lista de recorrências.
    - `requestIdentifier` string — Identificador da solicitação da recorrência.
    - `initialDateSchedule` string, date-time — Data inicial da recorrência.
    - `finalDateSchedule` string, date-time — Data final da recorrência.
    - `insertDateTime` string, date-time — Data de inserção da recorrência.
    - `status` 'PROCESSING' | 'CANCELED' | 'COMPLETED' | 'AWAITING_ENRICHMENT' — Status da recorrência.
    - `repetition` integer — Número de repetições.
    - `interbankSettlementAmount` number, float — Valor interbancário da recorrência.
    - `recurrenceDescription` string — Descrição da recorrência.
    - `invalidDatePayment` string — Indica se o agendamento deve ser antecipado ou postergado em caso de data inexistente (ex. dias 29 e 31).
    - `frequency` 'WEEKLY' | 'MONTHLY' | 'YEARLY' — Frequência da recorrência.
    - `initiationForm` 'DICT' | 'MANU' — Forma de iniciação da recorrência.
    - `creditor` object
      - `accountIdentification` string — Conta do cliente recebedor.
      - `accountIssuer` string — Agência do cliente recebedor.
      - `accountType` 'CACC' | 'TRAN' | 'SLRY' | 'SVGS' — Tipo da conta do cliente recebedor.
      - `agentMemberIdentification` string — ISPB do cliente recebedor.
      - `name` string — Nome do cliente recebedor.
      - `privateIdentification` string — CPF ou CNPJ do cliente recebedor. `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
    - `debtor` object
      - `accountIdentification` string — Conta do cliente pagador.
      - `accountIssuer` string — Agência do cliente pagador.
      - `accountType` 'CACC' | 'TRAN' | 'SLRY' | 'SVGS' — Tipo da conta do cliente pagador.
      - `agentMemberIdentification` string — ISPB do cliente pagador.
      - `name` string — Nome do cliente pagador.
      - `privateIdentification` string — CPF ou CNPJ do cliente pagador. `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref
- `403` — 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)