Eventos

Listar eventos

GET/v1/eventsevents:readNOVO

Os mesmos eventos que os webhooks entregam, para conciliar ou reprocessar o que você perdeu.

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.

typestringopcional

charge.createdcharge.paidcharge.failedcharge.expiredcharge.canceledcharge.reversedwithdrawal.createdwithdrawal.completedwithdrawal.failedmed.createdmed.updated

created_fromdatetimeopcional

Criados a partir deste instante (inclusive).

created_todatetimeopcional

Criados antes deste instante.

Resposta 200

Página, mais novos primeiro

dataobject[]

5 campos

iduuid

Igual ao event_id e ao cabeçalho X-Mainum-Event-Id do webhook.

typestring

charge.createdcharge.paidcharge.failedcharge.expiredcharge.canceledcharge.reversedwithdrawal.createdwithdrawal.completedwithdrawal.failedmed.createdmed.updated

created_atdatetime

api_version"v1"

dataobject

Os campos que o webhook sempre trouxe, mais object com o recurso atual.

1 campo

objectobject

Cobrança, saque ou caso MED, no mesmo formato da consulta.

next_cursorstring | null

Códigos de resposta

HTTP	Quando acontece
200	Página, mais novos primeiro
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/events?type=charge.paid&limit=20" \
  -H "Authorization: Bearer $MAINUM_API_KEY"

Resposta

{
  "data": [
    {
      "id": "0192a7c4-6e02-7f55-8b1a-3c4d5e6f7a8b",
      "type": "charge.paid",
      "created_at": "2026-09-24T14:35:49.000Z",
      "api_version": "v1",
      "data": {
        "charge_id": "0192a7c4-5b1e-7d3a-9f10-6c2e8b4d1a77",
        "external_id": "pedido-48213",
        "status": "PAID",
        "amount_cents": "4990",
        "fee_cents": "149",
        "net_amount_cents": "4841",
        "object": {
          "id": "0192a7c4-5b1e-7d3a-9f10-6c2e8b4d1a77",
          "external_id": "pedido-48213",
          "method": "PIX",
          "status": "PAID",
          "amount_cents": 4990,
          "fee_cents": 149,
          "net_amount_cents": 4841,
          "description": "Plano Pro mensal",
          "metadata": {
            "pedido": "48213",
            "canal": "loja"
          },
          "payer": {
            "name": "Ana Souza",
            "document_masked": "***.982.247-**"
          },
          "paid_by": {
            "name": "ANA P SOUZA",
            "document_masked": "***.982.247-**",
            "bank": "Nu Pagamentos S.A."
          },
          "end_to_end_id": "E18236120202609241535s04b9c2e7d1f",
          "expires_at": "2026-09-24T15:02:11.000Z",
          "paid_at": "2026-09-24T14:35:48.000Z",
          "reversed_at": null,
          "created_at": "2026-09-24T14:32:11.000Z",
          "updated_at": "2026-09-24T14:35:49.000Z",
          "settlement": {
            "mode": "D0",
            "source": "MERCHANT",
            "withdrawable_at": "2026-09-24T14:35:48.000Z"
          },
          "pix": null,
          "card": null,
          "product_id": null
        }
      }
    }
  ],
  "next_cursor": null,
  "request_id": "req_0192a7c4-5b20-7c11-8e4f-2b9d0c6a3e58"
}

Página, mais novos primeiro