Skip to main content
GET
Listar agendamentos de Pix Automático

Autorizações

Authorization
string
header
obrigatório

Autenticacao por token JWT Bearer. Obtenha o token no endpoint /v1/login/oauth/access_token usando credenciais do cliente (clientId e clientSecret).

Inclua o token no header Authorization: Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

O token expira apos 3600 segundos (1 hora).

Parâmetros de consulta

flow
integer<int64>

fluxo (0=Enviados/PSP Recebedor, 1=Recebidos/PSP Pagador).

recipientCnpj
string

Filtro cnpjRecebedor (string).

payerPersonType
string

filtro tpPessoaPagador (0/1; vazio = sem filtro).

payerDocument
string

Filtro cpfCnpjPagador (string).

payerAgency
string

nrAgenciaPagador filtro (string).

payerAccount
string

nrContaPagador filtro (string).

scheduleStatus
string

filtro stAgendamento (0/1; vazio = sem filtro).

dueDateFrom
string

dtVencimentoInicio (aaaa-mm-dd).

dueDateTo
string

dtVencimentoFim (aaaa-mm-dd).

page
integer<int64>

pagina (padrão 1).

pageSize
integer<int64>

tamanhoPagina (padrão 50, máx. 100).

Resposta

OK

jdPiAt
string
obrigatório

Data/hora da resposta do upstream (upstream timestamp, UTC).

schedules
object[] | null
obrigatório

Os snapshots de agendamento correspondentes (agendamentos).