Financeiro

Consultar extrato

GET/v1/statementstatement:read

Cabeçalhos

Authorizationstringobrigatório

Bearer seguido da sua chave: gw_test_ em teste, gw_live_ em produção.

Parâmetros de consulta

limitinteger · 1–100opcional

cursorstring · 1–512opcional

Cursor opaco devolvido pela página anterior.

Resposta 200

Página do extrato

currency"BRL"

dataobject[]

9 campos

iduuid

journal_iduuid

reference_iduuid

reference_typestring

typestring

Tipo do lançamento no livro-caixa, por exemplo PIX_CASH_IN_PAID ou PIX_WITHDRAWAL_RESERVED.

categorystring

PENDINGAVAILABLEWITHDRAWABLEBLOCKEDRESERVEDUNCLASSIFIED

amount_centsinteger

Positivo entra na categoria, negativo sai.

occurred_atdatetime

descriptionstring | nullNOVO

Descrição do lançamento, quando houver.

next_cursorstring | null

Códigos de resposta

HTTP	Quando acontece
200	Página do extrato
400	Requisição ou cursor inválido
401	Chave ausente, inválida ou sem o escopo exigido
429	Limite de requisições excedido

Cada código de erro está explicado em Erros.

Requisição

curl -X GET "https://api.mainumpay.com/v1/statement" \
  -H "Authorization: Bearer $MAINUM_API_KEY"

Resposta

{
  "currency": "BRL",
  "data": [
    {
      "id": "0192a7c4-6d10-7a2e-9b3c-1f2e3d4c5b6a",
      "journal_id": "0192a7c4-6d0f-7c11-8e4f-2b9d0c6a3e58",
      "reference_id": "0192a7c4-5b1e-7d3a-9f10-6c2e8b4d1a77",
      "reference_type": "CHARGE",
      "type": "PIX_CASH_IN_WITHDRAWABLE",
      "category": "WITHDRAWABLE",
      "amount_cents": 4841,
      "occurred_at": "2026-09-24T14:35:48.000Z",
      "description": "Recebimento Pix"
    }
  ],
  "next_cursor": null,
  "request_id": "req_0192a7c4-5b20-7c11-8e4f-2b9d0c6a3e58"
}

Página do extrato