Endpoints da API

Relatórios

Os endpoints de Relatórios cobrem tudo que envolve leitura histórica das transações. Use a listagem ao vivo para dashboards e a geração assíncrona em CSV para BI/auditoria de períodos grandes.

GETListar transações/user/transactions GETDetalhe da transação/user/transactions/{id}POSTGerar relatório/user/report GETListar relatórios/user/reports GETStatus do relatório/user/report/{id}POSTBaixar relatório/user/report/{id}/download

Quando usar cada um

Cenário	Endpoint
Tela de transações no dashboard	`GET /user/transactions`
Detalhe de uma transação específica	`GET /user/transactions/{id}`
Relatório de período grande (mês, ano)	`POST /user/report`
Listar relatórios solicitados	`GET /user/reports`
Verificar se o relatório terminou	`GET /user/report/{id}`
Baixar o CSV gerado	`POST /user/report/{id}/download`

Listagem vs relatório assíncrono

Cenário	Recomendado
Dashboard, < 10k registros	`GET /user/transactions` paginado
Conciliação diária	`GET /user/transactions` paginado
Mês ou ano completo	`POST /user/report` (CSV assíncrono)
BI / Data Warehouse	`POST /user/report` agendado

Exemplos

Fluxo do relatório assíncrono

Tutoriais e boas práticas

Tutorial: Conciliação Paginação Multi-tenant

Get Transaction Receipt

Retorna o comprovante da transação como JSON com o campo `base64` (PDF codificado). Decodifique pra exibir ou salvar como `.pdf`.

List Transactions

Paginated list of account transactions with filters.

On this page

Quando usar cada um Listagem vs relatório assíncrono Exemplos Fluxo do relatório assíncrono Tutoriais e boas práticas