Get a payment timeline

GET/v1/payments/{id}/timelineRun

Requires payments:read permission.

Path parameters

idstringrequired

The id of the payment (pay_…).

Example: pay_01k7q3m8x2v5t9n4b6c1d0e7fa

Prefixed with pay_.

Response (200)

dataarray of objectrequired

The returned object, or an array of objects for a list.

atstringrequired

When it happened (RFC 3339, UTC).

Example: 2026-10-26T03:04:05.000Z

Format: date-time

eventstringrequired

What happened, as a short name.

Example: payment_paid

from_statusstring | nullrequired

The status before; null for the first entry.

Example: pending

to_statusstringrequired

The status after.

Example: paid

actorstringrequired

Who caused it: merchant, staff (Baiyar), provider (the payment provider) or system.

Example: provider

Possible values: merchant, staff, provider, system

metaobjectrequired

Request details such as its id and pagination cursor.

request_idstringrequired

The id of this request. Quote it when you ask support about it.

Example: req_Hy3k9QzT2LmN8vXa

A failed request answers with the common error shape; see Errors.

Request

curl "https://api.baiyar.com/v1/payments/{id}/timeline" \
  -H "Authorization: Bearer $BAIYAR_KEY"

Response

{
  "data": [
    {
      "at": "2026-10-26T03:04:05.000Z",
      "event": "payment_paid",
      "from_status": "pending",
      "to_status": "paid",
      "actor": "provider"
    }
  ],
  "meta": {
    "request_id": "req_Hy3k9QzT2LmN8vXa"
  }
}