Listar Transacoes

Listar transacoes

GET /api/v1/transacoes

Retorna uma lista paginada de transacoes PIX/CNAB com suporte a filtros avancados.

Request

Query Parameters

Parametro	Tipo	Obrigatorio	Validacao	Descricao
`dataInicio`	date	sim	Formato `YYYY-MM-DD`	Data inicial do periodo
`dataFim`	date	sim	Formato `YYYY-MM-DD`, >= `dataInicio`	Data final do periodo
`status`	enum	nao	Ver status	Filtrar por status
`valor`	number	nao	Nao combina com `valorMinimo`/`valorMaximo`	Valor exato da transacao
`valorMinimo`	number	nao	Nao combina com `valor`	Valor minimo da faixa
`valorMaximo`	number	nao	Nao combina com `valor`	Valor maximo da faixa
`chavePix`	string	nao	—	Chave PIX do favorecido
`nomeFavorecido`	string	nao	Minimo 3 caracteres	Nome do favorecido
`numeroDocumento`	string	nao	6 digitos	Numero do documento
`nomeArquivo`	string	nao	—	Nome do arquivo CNAB
`loteServico`	integer	nao	—	Numero do lote de servico
`page`	integer	nao	0-100, padrao `0`	Numero da pagina (base zero)
`size`	integer	nao	1-100, padrao `50`	Itens por pagina

O intervalo entre dataInicio e dataFim nao pode exceder 180 dias.

Os parametros valor e valorMinimo/valorMaximo sao mutuamente exclusivos. Use valor para busca exata ou valorMinimo/valorMaximo para busca por faixa.

Exemplo de requisicao

GET /api/v1/transacoes?dataInicio=2026-04-01&dataFim=2026-04-30&status=SETTLED&page=0&size=20

Response

`200 OK`

{
  "content": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "numeroDocumento": "123456",
      "dataVencimento": "2026-04-26",
      "status": "SETTLED",
      "valor": 150.00,
      "formaLancamento": "PIX_TRANSFERENCIA",
      "favorecidoNome": "Joao da Silva",
      "favorecidoNumeroInscricao": "12345678901",
      "chavePix": "favorecido@empresa.com",
      "tipoChavePix": "CHAVE_PIX_EMAIL",
      "createdAt": "2026-04-26T14:30:01.234"
    }
  ],
  "totalElements": 42,
  "totalPages": 3,
  "size": 20,
  "number": 0
}

Campos da response

Campo	Tipo	Descricao
`id`	UUID	Identificador unico da transacao
`numeroDocumento`	string	Numero do documento (6 digitos)
`dataVencimento`	date	Data de vencimento
`status`	string	Status da transacao
`valor`	number	Valor em reais
`formaLancamento`	string	Forma de lancamento
`favorecidoNome`	string	Nome do favorecido
`favorecidoNumeroInscricao`	string	CPF ou CNPJ do favorecido
`chavePix`	string	Chave PIX utilizada
`tipoChavePix`	string	Tipo da chave PIX
`createdAt`	datetime	Timestamp de criacao

Paginacao

A response segue o formato Spring Data Page:

Campo	Tipo	Descricao
`content`	array	Lista de transacoes da pagina atual
`totalElements`	integer	Total de transacoes encontradas
`totalPages`	integer	Total de paginas
`size`	integer	Tamanho da pagina
`number`	integer	Numero da pagina atual (base zero)

Formas de lancamento

Valor	Descricao
`CREDITO_CONTA`	Credito em conta
`PAGAMENTO_CHEQUE`	Pagamento de cheque
`DOC`	DOC
`TED`	TED
`PIX_TRANSFERENCIA`	PIX transferencia
`PIX_QR_CODE`	PIX via QR Code
`PIX_CHAVE`	PIX via chave

Erros

`400 Bad Request`

Erro de validacao nos parametros de consulta.

{
  "code": "VALIDATION_ERROR",
  "message": "Falha de validacao",
  "details": [
    { "campo": "dataInicio", "erro": "must not be null" }
  ],
  "traceId": "abc123def456",
  "timestamp": "2026-04-26T14:30:01.234Z"
}

`500 Internal Server Error`

Erro interno. Inclua o traceId ao reportar.

Listar Transacoes

On this page