PaybytokenDocs
Events
API reference · Events

Get Event

Retrieve one API event and its associated resource data.

GET /api/v1/events/:id

Overview

Retrieves the details of a specific event using its unique identifier.

Authorization

  • Header: Authorization: Bearer $PAYBYTOKEN_SECRET_KEY
Request Details

Request

curl https://api-prod.paybytoken.io/api/v1/events/evt_pe3C6ngyvcfAvNeW \
  -X GET \
  -H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY"

Request Parameters

ParameterTypeDescription
idstringUnique identifier of the event (e.g., evt_pe3C6ngyvcfAvNeW).
Response Details

Response

The response returns an Event object containing the details of the specified event. See Events Overview for the full object definition.

Example Response

{
  "id": "evt_pe3C6ngyvcfAvNeW",
  "account_id": "p226968785",
  "resource_type": "payment_intent",
  "resource_id": "pay_pe337Vo53qcUJInIr4i3",
  "type": "payment_intent.succeeded",
  "api_version": "v1",
  "livemode": 0,
  "data": {
    "id": "pay_pe337Vo53qcUJInIr4i3",
    "object": "payment_intent",
    "status": "succeeded"
  },
  "created_at": "2025-09-25T11:44:10.000Z",
  "updated_at": "2025-09-25T19:44:10.000Z"
}

Errors

HTTP StatusError CodeDescription
404404Event not found.
400400Invalid event ID.
500500Internal server error.

On this page

API Workbench

Full Explorer

Open in new tab