Eventos

Histórico de eventos e reenvio.

Listar eventos

GET /v1/events

Eventos dos últimos 30 dias da unidade. Requer o escopo events:read.

Parâmetros

Nome	Onde	Tipo	Descrição
`limit`	consulta	integer
`starting_after`	consulta	string	Cursor — ID do último objeto da página anterior.
`ending_before`	consulta	string	Cursor — ID do primeiro objeto da página seguinte.
`created_gte`	consulta	string (date-time)
`created_lte`	consulta	string (date-time)
`type`	consulta	EventType

Respostas

200 Lista paginada de eventos.
400 Requisição inválida (formato ou campos).
401 Chave ausente, inválida, expirada ou revogada.
403 Operação não permitida: escopo insuficiente (`insufficient-scope`), IP fora da lista permitida
429 Limite de requisições (`rate-limited`) ou cota diária de cobranças (`quota-exceeded`) excedidos.
500 Erro interno. É seguro repetir com a mesma `Idempotency-Key`.

Exemplo

curl -X GET "https://api.exemplo.com.br/v1/events?limit=20" \
  -H "Authorization: Bearer $PIX_API_KEY"

Identificador nos logs: api.events.list

Consultar evento

GET /v1/events/{event_id}

Parâmetros

Nome	Onde	Tipo	Descrição
`event_id` obrigatório	caminho	string

Respostas

200 Evento.
401 Chave ausente, inválida, expirada ou revogada.
403 Operação não permitida: escopo insuficiente (`insufficient-scope`), IP fora da lista permitida
404 Recurso não encontrado (ou pertencente a outra unidade).
429 Limite de requisições (`rate-limited`) ou cota diária de cobranças (`quota-exceeded`) excedidos.
500 Erro interno. É seguro repetir com a mesma `Idempotency-Key`.

Exemplo

curl -X GET "https://api.exemplo.com.br/v1/events/evt_01J9Z3F0A1B2C3D4E5F6G7H8J9" \
  -H "Authorization: Bearer $PIX_API_KEY"

Identificador nos logs: api.events.retrieve

Reenviar evento

POST /v1/events/{event_id}/redeliver

Reenfileira a entrega do evento para todos os endpoints ativos inscritos no seu tipo (ou para um endpoint específico).

Exige o cabeçalho Idempotency-Key (os SDKs enviam automaticamente).

Parâmetros

Nome	Onde	Tipo	Descrição
`event_id` obrigatório	caminho	string

Corpo da requisição

Campo	Tipo	Descrição
`webhook_endpoint_id`	string

Respostas

202 Reenvio enfileirado — uma nova entrega (tentativa 1) por endpoint.
401 Chave ausente, inválida, expirada ou revogada.
403 Operação não permitida: escopo insuficiente (`insufficient-scope`), IP fora da lista permitida
404 Recurso não encontrado (ou pertencente a outra unidade).
429 Limite de requisições (`rate-limited`) ou cota diária de cobranças (`quota-exceeded`) excedidos.
500 Erro interno. É seguro repetir com a mesma `Idempotency-Key`.

Exemplo

curl -X POST "https://api.exemplo.com.br/v1/events/evt_01J9Z3F0A1B2C3D4E5F6G7H8J9/redeliver" \
  -H "Authorization: Bearer $PIX_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Identificador nos logs: api.events.redeliver