Pular para o conteúdo principal
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=sent, as the recipient's PSP; 1=received, as the payer's PSP).

Exemplo:

0

ispb
string

The ISPB of the direct participant this listing is made AS. OPTIONAL: omit it and the listing is made on the default credential, exactly as before. Named, JDPI is asked with that participant's credential, and it answers only for what that participant holds. An ISPB this deployment does not act as is 422 PIX-0128. It is ROUTING DATA you supply, never a credential, and a token confined to one participant has to name it here. Sending it empty (ispb=) reads the same as omitting it.

Pattern: ^[0-9A-Z]{8}$
Exemplo:

"12345678"

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).