Skip to main content
GET
Consultar Pix recebidos

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de consulta

inicio
string<date-time>
obrigatório

Window start, RFC 3339 (required).

fim
string<date-time>
obrigatório

Window end, RFC 3339 (required).

txid
string

Optional txid filter ([a-zA-Z0-9]{1,35}).

Pattern: ^[a-zA-Z0-9]{1,35}$
txIdPresente
enum<string>

Optional tri-state filter on whether the Pix carries a txid (true/false; absent = no filter).

Opções disponíveis:
true,
false
devolucaoPresente
enum<string>

Optional tri-state filter on whether the Pix has returns (true/false; absent = no filter).

Opções disponíveis:
true,
false
cpf
string

Optional payer CPF filter; mutually exclusive with cnpj.

Pattern: ^\d{11}$
cnpj
string

Optional payer CNPJ filter ([0-9A-Z]{12}[0-9]{2} — the BACEN alphanumeric-CNPJ PICnpj facet); mutually exclusive with cpf.

Pattern: ^[0-9A-Z]{12}[0-9]{2}$
paginaAtual
integer<int64>
padrão:1

1-based page number (default 1).

Intervalo obrigatório: x >= 1
itensPorPagina
integer<int64>
padrão:20

Page size (default 20, max 100).

Intervalo obrigatório: 1 <= x <= 100

Resposta

OK

parametros
object
obrigatório

Echoed query parameters plus pagination metadata.

pix
object[] | null
obrigatório

Received Pix matching the filters, each with its devoluções.