Stater Platform

Exportar extrato

POST /accounts/:id/transactions/export — gera PDF e Excel e envia por e-mail.

Exportar extrato

Dispara a geração assíncrona do extrato em PDF e Excel para o intervalo informado. Os arquivos são enviados por e-mail para o endereço cadastrado na entidade autenticada — a resposta da requisição não traz body (a geração acontece em background).

POST/accounts/:accountId/transactions/export

Endpoint assíncrono. A resposta volta vazia (sem body) imediatamente; a geração roda em background e dois arquivos (PDF + Excel) são enviados para o e-mail cadastrado em entity.email da conta autenticada. Use o mesmo intervalo de /transactions ou /statement/summary. Para intervalos grandes (>3 meses), a geração pode levar minutos.

Path params

  • accountIdObrigatório
    string (UUID)
    ID da conta cujo extrato será exportado.

Query string

  • startDateObrigatório
    string (YYYY-MM-DD)
    Início do intervalo (inclusivo, UTC).
  • endDateObrigatório
    string (YYYY-MM-DD)
    Fim do intervalo (inclusivo, UTC).

Headers

  • AcceptObrigatório
    string
    application/json
  • Content-TypeObrigatório
    string
    application/json
  • AuthorizationObrigatório
    string
    Bearer <token> — JWT de /authenticate.
  • X-Tenant-IdObrigatório
    string (UUID)
    Identificador do tenant.

Body

  • (body)Obrigatório
    object
    Body vazio `{}`. Os filtros vêm pela query string (startDate, endDate).

Exemplo de requisição

bash
curl -X POST "https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000010/transactions/export?startDate=2026-04-14&endDate=2026-05-13" \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \  -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000" \  -d '{}'

Resposta

json
// Sem body. Geração assíncrona — verifique o e-mail cadastrado.
URL base:https://baas.staterpay.io

On this page