Pular para o conteúdo principal

Extrato da conta

Recupera o extrato de transações financeiras da conta.

Fazendo Requisição

A chamada deverá ser feita utilizando o método GET.

GET/v1/account/extract

Parâmetros de Filtro (Query Params)

PARÂMETRODESCRIÇÃOTIPOOBRIGATÓRIO
start_dateData inicial do período de buscaSTRING
formato datetime YYYY-mm-dd
Sim
end_dateData final do período de buscaSTRING
formato datetime YYYY-mm-dd
Sim
register_typeFiltro por tipo de transação (credit ou debit)STRINGNão
pageNúmero da página para paginação (padrão é 1)INTEGERNão

[!IMPORTANT] O intervalo máximo permitido entre start_date e end_date é de 31 dias.

Sucesso

Em caso de sucesso, será retornado uma mensagem HTTP 200 – OK, contendo os dados, conforme apresentado abaixo:

HTTP 200 Response Body - Exemplo
{
"extract": [
{
"register_date": "2026-07-14T09:00:00.000-03:00",
"register_type": "credit",
"description": "Pix recebido",
"value_cents": 1000,
"operation_id": "op_12345"
}
],
"meta": {
"current_page": 1,
"total_pages": 1,
"total_items_amount": 1
}
}

Erros

Em caso de erros ou parâmetros inválidos (como intervalo maior que 31 dias), será retornado um json com o atributo error/errors especificando o motivo da operação ter sido invalidada.

HTTP 400 Response Body - Exemplo
{
"error": "end_date max interval: 31 days"
}