Skip to content
Raïs

API reference: Objects

The Event object

An event records something that happened to a payment or a refund.

The same object is sent, signed, to your webhook endpoints and can be read with the events API for 30 days.

Event object
{
  "id": "evt_Qm9dMhJ0k8s2Wv7Yc3XnLpAb",
  "object": "event",
  "api_version": "2026-10-26",
  "created": 1793000300,
  "livemode": false,
  "type": "payment.succeeded",
  "data": {
    "object": {
      "id": "5b1c2f4e-9d3a-4c61-8a7e-0f2d6b9e1a33",
      "object": "payment",
      "status": "paid",
      "amount": 500000,
      "currency": "DZD"
    }
  }
}

Attributes

idstring

The unique identifier of the event.

objectstring

The type of the object.

Always event.

api_versionstring

The API version the payload was rendered with.

createdinteger

When the event happened (Unix time, seconds).

livemodeboolean

false for a sandbox event.

typestring

What happened.

One of payment.succeeded, payment.failed, payment.cancelled, payment.reversed, refund.succeeded, refund.failed.

dataobject

The object the event is about.