Skip to main content
GET
Consultar extrato financeiro consolidado

Authorizations

X-Api-Client-Token
string
header
required

Token de autenticação do cliente obtido via endpoint /auth

Query Parameters

page
integer

Página da listagem (padrão 1)

Required range: x >= 1
Example:

1

filter[betweenDates]
string

Intervalo de datas para filtrar as movimentações no formato DD/MM/YYYY,DD/MM/YYYY (data inicial e final separadas por vírgula).

Pattern: ^\d{2}\/\d{2}\/\d{4},\d{2}\/\d{2}\/\d{4}$
Example:

"01/07/2026,31/07/2026"

include_release
enum<integer>
default:0

Quando 1, inclui no extrato os lançamentos de liberação de saldo (MONEY_RELEASED), de ajuste (BALANCE_ADJUSTMENT) e de auditoria (STATEMENT_AUDIT), que por padrão ficam de fora — assim como no painel do vendedor. Nesse modo os lançamentos de MONEY_UNBLOCKED não são retornados.

Available options:
0,
1
Example:

1

Response

Extrato financeiro retornado com sucesso

status
string
required
Example:

"success"

message
string
required
Example:

"Recurso retornado com sucesso"

data
object
required