Consulta de Extrato da Conta

Retorna o histórico de movimentações financeiras (entradas e saídas) de uma conta específica.

Este endpoint retorna o extrato completo da conta bancária informada por accountId, listando as movimentações financeiras associadas — como PIX enviados e recebidos, transferências, tarifas e pagamentos de QR Code.

O accountId deve ser obtido através do endpoint Consulta de Conta Bancária ou do campo accounts[].id retornado em Consulta de Perfil — Pessoa Física ou Jurídica.

É possível realizar a paginação do resultado para consultar grandes volumes de transações.

O retorno inclui:

  • amount: valor da transação

  • category: tipo de operação (Pix, TEF, QR Code, Tarifa, etc.)

  • credit: indica se foi entrada (true) ou saída (false)

  • beneficiaryName: nome do favorecido ou remetente

  • status e externalStatus: estados de processamento da operação

  • createdAt: data e hora da transação

Este endpoint é protegido e requer o uso do cabeçalho Authorization: Bearer <token> e x-tenant-id

Endpoint Extrato

GET /accounts/{accountId}/transactions

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

x-tenant-id

Tenant ID

Query Parameters

Name
Type
Description

page

Number

Página atual

startDate

Date

yyyy-MM-dd

endDate

Date

yyyy-MM-dd

Status
Descrição

PROCESSING

Transação em processamento

DONE

Transação processada e concluída

CANCELED

Transação cancelada

ERROR

Transação com erro