Events

Events are created by the platform, never by you. Each one names the resource it is about by its public id (col_..., po_..., rf_..., stl_...) and carries a data snapshot. The stream is scoped to the merchant and environment of your API key, and each event is retained for 90 days.

The events you see here are exactly the events delivered to your webhook endpoints, signed with the X-Capay-Signature header. Polling this endpoint is your reconciliation fallback when a webhook delivery is missed; see Authentication for how to verify webhook signatures.

List events for your account, newest first.

Headers

• Authorization: Bearer sk_... - Your secret key. The events:read scope is required.

Query parameters

Example request

curl "https://api.capayglobal.com/v1/events?type=collection.completed&limit=2" \
  -H "Authorization: Bearer sk_test_8fK2q0Zr41Xa"

Example response

{
  "status": "success",
  "data": {
    "object": "list",
    "data": [
      {
        "id": "evt_2n4Kq8Zr41Xa",
        "object": "event",
        "type": "collection.completed",
        "resource_type": "collection",
        "resource_id": "col_7pQ2r9Xm4KdA",
        "data": {
          "id": "col_7pQ2r9Xm4KdA",
          "status": "completed",
          "amount": "5000",
          "currency": "XAF"
        },
        "livemode": false,
        "created_at": "2026-08-29T12:30:05.000Z"
      },
      {
        "id": "evt_9c1Lp7Ws30Vb",
        "object": "event",
        "type": "collection.completed",
        "resource_type": "collection",
        "resource_id": "col_5aH0m3Tn8QeZ",
        "data": {
          "id": "col_5aH0m3Tn8QeZ",
          "status": "completed",
          "amount": "12000",
          "currency": "XAF"
        },
        "livemode": false,
        "created_at": "2026-08-29T11:58:41.000Z"
      }
    ],
    "has_more": true
  },
  "request_id": "d4c3b2a1-6f50-4e71-9a82-b0c1d2e3f4a5"
}

Results are ordered by created_at descending. has_more is true whenever a full page was returned, a hint that older events may remain.

This endpoint paginates by page size only: it does not accept a starting_after cursor (the collections and payouts list endpoints do). To walk history, narrow with the type filter, keep the newest id you have seen, and de-duplicate by event id across polls.

Each entry in the list is an event object.

This is the closed list of event types the platform emits. It is also the set a webhook endpoint can subscribe to; an endpoint with no filter receives them all.

Re-arm delivery of a past event. Every webhook delivery for the event, including ones already delivered or exhausted, is reset to pending for an immediate retry, and the event is fanned out again to every matching active endpoint, including endpoints you have added since.

Use it after fixing a broken endpoint, or to deliver historical events to a newly created endpoint. Replay is naturally idempotent, so no Idempotency-Key is required.

Headers

• Authorization: Bearer sk_... - Your secret key. The events:write scope is required.

Path parameters

Example request

curl -X POST https://api.capayglobal.com/v1/events/evt_2n4Kq8Zr41Xa/replay \
  -H "Authorization: Bearer sk_test_8fK2q0Zr41Xa"

Example response

{
  "status": "success",
  "data": {
    "replayed": true,
    "event": "evt_2n4Kq8Zr41Xa",
    "deliveries": 2
  },
  "request_id": "a1b2c3d4-5e60-4f71-8a92-b0c1d2e3f4a5"
}

The response confirms the replay and reports deliveries, the number of delivery rows re-armed across your matching endpoints.

Errors use the standard envelope: a machine-readable code, a human message, and a next_step. Every error carries the request_id to quote to support.