Resumo do extrato
GET /accounts/:id/statement/summary — totais agregados no intervalo.
Resumo do extrato
Totais agregados das transações da conta no intervalo informado: saldo atual, soma de créditos, soma de débitos e contagem de transações.
GET/accounts/:accountId/statement/summary
balance é instantâneo (saldo atual da conta), enquanto credits/debits/count são agregados do intervalo solicitado. Útil para gerar dashboards e telas de resumo sem precisar paginar pelo extrato completo. Diferença credits − debits no intervalo reflete a variação de saldo no período (se o saldo inicial era 0).
Path params
- accountIdObrigatóriostring (UUID)ID da conta.
Query string
- startDateObrigatóriostring (YYYY-MM-DD)Início do intervalo (inclusivo, UTC).
- endDateObrigatóriostring (YYYY-MM-DD)Fim do intervalo (inclusivo, UTC).
Headers
- AcceptObrigatóriostringapplication/json
- AuthorizationObrigatóriostringBearer <token> — JWT de /authenticate.
- X-Tenant-IdObrigatóriostring (UUID)Identificador do tenant.
Exemplo de requisição
bash
curl "https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/statement/summary?startDate=2026-04-14&endDate=2026-05-13" \ -H "Accept: application/json" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \ -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000"Resposta
- balancenumberSaldo atual da conta em reais (independente do intervalo).
- creditsnumberSoma dos valores de transações de entrada (credit: true) no intervalo.
- debitsnumberSoma dos valores de transações de saída (credit: false) no intervalo.
- countnumberTotal de transações no intervalo (entradas + saídas).
json
{ "balance": 6.44, "credits": 13.60, "debits": 7.16, "count": 18}URL base:
https://baas.staterpay.io