Skip to main content
GET
List PIX Automatico schedules

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

flow
integer<int64>
obrigatório

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

Exemplo:

0

recipientCnpj
string

cnpjRecebedor filter (string).

Exemplo:

"61695227000193"

payerPersonType
string

tpPessoaPagador filter (0/1; empty = no filter).

Exemplo:

"0"

payerDocument
string

cpfCnpjPagador filter (string).

Exemplo:

"04623217035"

payerAgency
string

nrAgenciaPagador filter (string).

Exemplo:

"0001"

payerAccount
string

nrContaPagador filter (string).

Exemplo:

"0007654321"

scheduleStatus
string

stAgendamento filter (0/1; empty = no filter).

Exemplo:

"0"

dueDateFrom
string
obrigatório

dtVencimentoInicio (aaaa-mm-dd).

Exemplo:

"2024-09-01"

dueDateTo
string
obrigatório

dtVencimentoFim (aaaa-mm-dd).

Exemplo:

"2024-09-30"

page
integer<int64>

pagina (default 1).

Exemplo:

1

pageSize
integer<int64>

tamanhoPagina (default 50, max 100).

Exemplo:

50

Resposta

OK

jdPiAt
string
obrigatório

JDPI response timestamp (dtHrJdPi, UTC).

Exemplo:

"2024-06-08T06:00:05Z"

schedules
object[] | null
obrigatório

The matching schedule snapshots (agendamentos).