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

# Consulta de agendamentos

`GET /pix/scheduling-payments`

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

## Query parameters

- `liquidationCodeSubType` 'COMMON_SCHEDULING' | 'AUTOMATIC_PIX_SCHEDULING' — Subtipo de código de liquidação.
- `debtorAccountIdentification` string
- `debtorAccountIssuer` string
- `status` 'AWAITING_ENRICHMENT' | 'CANCELED' | 'SENT_PRE_VALIDATION' | 'PROCESSING' | 'RESCHEDULED' | 'SCHEDULED' | 'ATTEMPTS_EXCEEDED' | 'SUCCESSFULLY_COMPLETED' | 'UNSUCCESSFULLY_COMPLETED' — Status do agendamento.
- `initialDate` string
- `endDate` string
- `page` string
- `pageSize` string

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

Retorno da consulta com sucesso.

- GetAllSchedulingPaymentsResponse
  - `totalItems` integer — Número total de itens.
  - `totalPages` integer — Número total de páginas.
  - `currentPage` integer — Página atual.
  - `scheduling` SchedulingPaymentDetail[] — Lista de agendamentos.
    - `initiationForm` 'MANU' | 'DICT' | 'QRDN' | 'QRES' | 'AUTO' | 'INIC' | 'APES' | 'APDN' — Forma de iniciação.
    - `interbankSettlementAmount` number — Valor do agendamento interbancário.
    - `liquidationCodeSubType` 'COMMON_SCHEDULING' | 'AUTOMATIC_PIX_SCHEDULING' — Subtipo de código de liquidação.
    - `dateSchedule` string, date — Data do agendamento.
    - `requestIdentifier` string — Identificador da solicitação.
    - `remittanceInformation` string — Informação da remessa.
    - `endToEndIdentification` string — Identificador de ponta a ponta.
    - `transactionIdentification` string — Identificador da transação.
    - `insertDateTime` string, date-time — Data e hora de inserção.
    - `status` 'AWAITING_ENRICHMENT' | 'CANCELED' | 'SENT_PRE_VALIDATION' | 'PROCESSING' | 'RESCHEDULED' | 'SCHEDULED' | 'ATTEMPTS_EXCEEDED' | 'SUCCESSFULLY_COMPLETED' | 'UNSUCCESSFULLY_COMPLETED' — Status do agendamento.
    - `purpose` 'AGND' | 'NTAG' | 'RIFL' — Propósito do agendamento.
    - `paymentInitiator` string — CNPJ do iniciador do pagamento. `^([A-Z0-9]{12}[0-9]{2})$`
    - `creditor` SchedulingPaymentCreditor
      - `accountIdentification` string — Identificação da conta.
      - `accountIssuer` string — Número da Agência.
      - `accountType` 'CACC' | 'TRAN' | 'SLRY' | 'SVGS' — Tipo de conta.
      - `agentMemberIdentification` string — ISPB do participante.
      - `name` string — Nome do recebedor.
      - `privateIdentification` string — CPF/CNPJ. `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
      - `accountProxy` string — Chave Pix do recebedor.
    - `debtor` SchedulingPaymentDebtor
      - `accountIdentification` string — Identificação da conta.
      - `accountIssuer` string — Número da Agência.
      - `accountType` 'CACC' | 'TRAN' | 'SLRY' | 'SVGS' — Tipo de conta.
      - `agentMemberIdentification` string — ISPB do participante.
      - `name` string — Nome do pagador.
      - `privateIdentification` string — CPF/CNPJ. `^([0-9]{11}|[A-Z0-9]{12}[0-9]{2})$`
    - `recurrence` SchedulingPaymentRecurrence
      - `frequency` 'WEEK' | 'MNTH' | 'QURT' | 'MIAN' | 'YEAR' — Periodicidade do pagamento recorrente via Pix automático.
      - `initialDateSchedule` string, date — Data inicial da recorrência.
      - `finalDateSchedule` string, date — Data final da recorrência.
      - `repetition` integer — Número de repetições.
      - `interbankSettlementAmount` number — Valor interbancário da recorrência.
      - `description` string — Descrição da recorrência.
      - `requestIdentifier` string — Identificador da solicitação da recorrência.

## Other responses

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