Search the statement by fields the provider cannot filter
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Headers
Query parameters
Inclusive start date (YYYY-MM-DD). Default: today.
Inclusive end date (YYYY-MM-DD). Maximum window is 31 days.
Opaque resume token from a previous nextCursor. Only valid for the
same filter set and only with order=asc; with order=desc it is
refused (400 invalid_cursor) — continue with occurredBefore instead.
Scan direction. asc (default) walks oldest → newest and supports
cursor. desc walks newest → oldest, for “only the most recent”
queries on busy accounts; no cursor, continue with
occurredBefore=<nextOccurredBefore>.
Inclusive lower bound on the row instant (RFC 3339 with offset).
With order=desc it stops the scan once crossed, which is what makes
“everything since 17:00” cheap; with order=asc it is only a filter.
Inclusive upper bound on the row instant (RFC 3339 with offset).
With order=asc it stops the scan once crossed; with order=desc it
is the continuation boundary (pass the previous nextOccurredBefore).
Maximum number of matching items per call (max 100).
Credits (IN) or debits (OUT).
Canonical status (COMPLETED, PROCESSING, FAILED, REFUNDED, REVERSED).
Exact PIX key used in the transaction, case-insensitive. On a credit this is the key of this account that received; on a debit, the destination key. Rows without a key (payer used branch/account, or non-PIX operations) never match this filter.
Partial counterparty name. Accent- and case-insensitive, and order-independent: every whitespace-separated term must appear somewhere in the name, in any order.
Counterparty CPF/CNPJ. Punctuation is ignored.
Response
Matching statement rows for the scanned portion of the period, in the requested order (oldest first by default).
true = o recorte foi varrido até o fim (ou a fronteira de horário
foi cruzada) e estes são TODOS os lançamentos que casam com o
filtro. false = ainda há o que varrer; continue com nextCursor
(asc) ou occurredBefore=nextOccurredBefore (desc).
Direção da varredura, ecoada do pedido. asc (padrão) é a única
com cursor: a varredura tem de ser crescente para o cursor retomar
na posição certa — em ordem decrescente, um lançamento que chega
durante a varredura desloca as posições já lidas. desc continua
por tempo (nextOccurredBefore).
Token opaco de retomada. Presente apenas quando exhausted é
false e order é asc. Só vale para a mesma combinação de
filtros.
Fronteira de continuação em order=desc, presente quando
exhausted é false: instante do último lançamento examinado.
Repita a chamada com occurredBefore igual a este valor. Como o
limite é inclusivo, lançamentos no mesmo segundo podem voltar —
dedupe pelo id. Ausente se o último lançamento examinado não
tinha instante conhecido.
Por que a varredura parou antes do fim do período. page_full = a
resposta encheu; scan_budget / time_budget = o orçamento de
páginas ou de tempo da chamada acabou; partner_error = o
liquidante recusou uma chamada no meio da varredura e devolvemos o
que já havia sido coletado.