latestOpenAPI 3.1.02026-07-2440101174.2 KB
e20afa10cd0e
Pix agendado
Consulta de agendamentos
Utilize este endpoint para consultar os agendamentos a partir de campos informados na requisição.
get/pix/scheduling-payments
Query parameters
liquidationCodeSubType'COMMON_SCHEDULING' | 'AUTOMATIC_PIX_SCHEDULING'
Subtipo de código de liquidação.
Identificação do subtipo da liquidação.
debtorAccountIdentificationstring
Conta transacional do usuário pagador (obrigatório se debtorAccountIssuer estiver preenchido).
debtorAccountIssuerstring
Agência do usuário pagador sem dígito verificador (obrigatório se debtorAccountIdentification estiver preenchido).
status'AWAITING_ENRICHMENT' | 'CANCELED' | 'SENT_PRE_VALIDATION' | 'PROCESSING' | 'RESCHEDULED' | 'SCHEDULED' | 'ATTEMPTS_EXCEEDED' | 'SUCCESSFULLY_COMPLETED' | 'UNSUCCESSFULLY_COMPLETED'
Status do agendamento.
Status dos agendamentos.
initialDatestring
Data de início do período para a busca das regras de agendamentos.
endDatestring
Data fim do período para a busca das regras de agendamentos.
pagestring
Número da página para paginação.
pageSizestring
Quantidade de registros por página.
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
Retorno da consulta com sucesso.