Skip to main content
GET
List PIX Automatico authorizations

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

flow
integer<int64>

fluxo (0=payer's PSP, 1=recipient's PSP).

Example:

1

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-9]{8}$
Example:

"12345678"

recipientCnpj
string

cnpjRecebedor filter (string).

Example:

"61695227000193"

payerPersonType
string

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

Example:

"0"

payerDocument
string

cpfCnpjPagador filter (string).

Example:

"04623217035"

payerAgency
string

nrAgenciaPagador filter (string).

Example:

"0001"

payerAccount
string

nrContaPagador filter (string).

Example:

"0007654321"

authorizationOk
string

resultadoAutorizacao filter (true/false; empty = no filter).

Example:

"true"

stJdPiProc
string

stJdPiProc filter (0..10; empty = no filter).

Example:

"9"

updatedFrom
string<date-time>
required

dtHrAtualizacaoRecorrenciaInicio (an RFC 3339 date-time).

Example:

"2024-01-01T00:00:00.000Z"

updatedTo
string<date-time>
required

dtHrAtualizacaoRecorrenciaFim (an RFC 3339 date-time).

Example:

"2024-06-19T00:00:00.000Z"

page
integer<int64>

pagina (default 1).

Example:

1

pageSize
integer<int64>

tamanhoPagina (default 50, max 100).

Example:

50

Response

OK

authorizations
object[] | null
required

The matching authorization snapshots.

jdPiAt
string
required

JDPI response timestamp (dtHrJdPi, UTC).

Example:

"2024-06-19T00:00:00Z"