Extrato

Consultar Extrato

Movimentações financeiras da conta titular em um período.

Objetivo

Lista créditos, débitos, tarifas, Pix e demais movimentos entre start_date e end_date.

Pré-requisito: Login da conta. Scope baas.statements.read.

Regras de negócio

  • Janela start_date a end_date (YYYY-MM-DD) controla volume; janela muito ampla pode paginar ou limitar no serviço.
  • Filtros opcionais: page, limit, type, search, end_to_end_id (localizar Pix em disputa).
  • Read-only: não altera saldo.
  • Para saldo pontual sem lista de movimentos, use Saldo.

Contrato HTTP: Consultar extrato.

Endpoints

Listar

MétodoGET
Path/api/v2/baas/statements

Autenticação

Bearer da conta, HMAC. Corpo [] na assinatura.

Query

ParâmetroUso
start_date, end_dateIntervalo YYYY-MM-DD
page, limitPaginação
type, search, end_to_end_idFiltros opcionais

Regras de negócio

  • Movimentos agendados podem aparecer só após liquidação.
  • Resposta inclui data, meta, links, account e balances (quando balances=1).
  • Cada linha traz movement_type e detalhe do produto (pix_cash_in, pix_cash_out, boleto, etc.) quando aplicável.
  • Valores monetários vêm em reais (não centavos); débito/crédito vem de movement_type.type.
  • Retenção de Pix cash-in: movimento Reserva de valor (débito). Devolução operacional: Devolução de reserva de valor (crédito). Ver Saldo.

2025 © Nuvende - CNPJ 38.297.374/0001-93