Events

Events represent things that happened in your account. They are the payloads delivered to your webhook endpoints.

Current event retrieval is primarily exposed through merchant-scoped routes.

The Event object

{
  "id": "evt_abc123",
  "object": "event",
  "type": "payment_intent.succeeded",
  "created": 1708300800,
  "data": {
    "id": "pi_xyz789",
    "object": "payment_intent",
    "amount": 10000,
    "currency": "xof",
    "status": "succeeded"
  }
}

Implemented route family

Current merchant event routes include:

• GET /api/v1/merchant/events
• GET /api/v1/merchant/events/{id}

Legacy-compatible merchant paths may also be available under api/merchant/*.

List Events

GET /api/v1/merchant/events

Parameter	Type	Description
type	string	Filter by event type
page	integer	Page number
limit	integer	Number of results per page
environment	string	Filter by environment
from	string	Filter events created after this date
to	string	Filter events created before this date

Retrieve an Event

GET /api/v1/merchant/events/{id}

See Event Types for the full list of event types.