Skip to main content

Visão geral

Este endpoint retorna o extrato financeiro da sua conta, incluindo entradas (recebimentos via Pix, cartão e boleto), saídas (transferências Pix Out) e ajustes (reembolsos, taxas).

Endpoint

curl --request GET \
  --url "https://api.avanttifinance.com/v1/account/statement?start_date=2026-06-01&end_date=2026-06-11&page=1&limit=20" \
  --header "Authorization: Bearer SEU_TOKEN_DE_ACESSO"

Parâmetros de consulta

start_date
string
required
Data inicial do período (formato YYYY-MM-DD).
end_date
string
required
Data final do período (formato YYYY-MM-DD).
type
string
Filtra pelo tipo de movimentação: credit (entradas) ou debit (saídas).
page
integer
default:"1"
Número da página de resultados.
limit
integer
default:"20"
Quantidade de itens por página. Máximo de 100.

Resposta

data
array
Lista de movimentações financeiras, ordenadas da mais recente para a mais antiga.
pagination
object
Informações de paginação, incluindo página atual, total de páginas e total de registros.

Exemplo de resposta

{
  "data": [
    {
      "id": "mov_1a2b3c4d5e",
      "type": "credit",
      "category": "pix_in",
      "amount": 15000,
      "description": "Recebimento Pix - txn_8f3a1b2c9d",
      "date": "2026-06-10T14:33:12Z"
    },
    {
      "id": "mov_2b3c4d5e6f",
      "type": "debit",
      "category": "pix_out",
      "amount": 50000,
      "description": "Transferência Pix - trf_4d2f1a9c7b",
      "date": "2026-06-10T14:28:00Z"
    },
    {
      "id": "mov_3c4d5e6f7a",
      "type": "debit",
      "category": "fee",
      "amount": 450,
      "description": "Taxa de transação - txn_8f3a1b2c9d",
      "date": "2026-06-10T14:33:12Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total_pages": 3,
    "total_items": 47
  }
}

Categorias de movimentação

CategoriaDescrição
pix_inRecebimento via Pix
cardRecebimento via cartão de crédito
boletoRecebimento via boleto
pix_outTransferência enviada via Pix
refundReembolso de transação
feeTaxa cobrada pela plataforma

Próximos passos

Saldo

Consulte o saldo disponível e a prever da sua conta.

Ver transação

Consulte os detalhes de uma transação específica.