---
title: "Events"
description: "An **Event** is an immutable record of something that happened in your KOMOJU account — a payment being captured, a chargeback being filed, a subscription renewing, and so on."
url: "https://docs.komoju.com/en/api-reference#2025-01-28/tag/events"
source_url: "https://docs.komoju.com/en/api-reference/2025-01-28/resources/events.md"
language: en
api_version: "2025-01-28"
---

# Events

An **Event** is an immutable record of something that happened in your KOMOJU account — a payment being captured, a chargeback being filed, a subscription renewing, and so on. Events are the source of truth behind webhooks: you can list historical events via the API to reconcile state or replay missed webhook deliveries.

## The Event object

An **Event** is an immutable record of something that happened in your
KOMOJU account — a payment being captured, a chargeback being filed, a
subscription renewing, and so on. Events are the source of truth behind
webhooks: you can list historical events via the API to reconcile state or
replay missed webhook deliveries.

### Attributes

- **`id`** *string (UUID)* *required*

  A unique 25-character alphanumeric resource identifier.

- **`type`** *string* *required*

  Event type slug (e.g. "payment.captured", "payment.expired").

- **`resource`** *string enum* *required*

  Resource type name, always "event".

- **`created_at`** *string* *required*

  Timestamp when this event was created.

- **`reason`** *string or null* *required*

  Human-readable reason or description for this event, or null.

- **`data`** *The Payment object object or null* *required*

  A **Payment** represents a single charge against a customer for a specific
  amount in a specific currency. Payments are the primary way money is moved
  through KOMOJU — every accepted charge, whether initiated directly through
  the API or via a hosted `Session`, results in a `Payment` object.

  A payment moves through a series of statuses (`pending`, `authorized`,
  `captured`, `cancelled`, `expired`, `refunded`, `failed`) as the customer
  completes the flow and funds are captured or refunded.

### Example

```json
{
  "id": "string",
  "type": "payment.captured",
  "resource": "event",
  "created_at": "2025-01-15T10:10:00Z",
  "reason": "string",
  "data": {
    "id": "pay3fj6nnhvws08idzacf6et8",
    "resource": "payment",
    "status": "captured",
    "amount": 1000,
    "tax": 0,
    "customer": "string",
    "payment_deadline": "2024-01-01T00:00:00Z",
    "payment_details": {
      "type": "credit_card",
      "brand": "string",
      "last_four_digits": "string",
      "month": 10,
      "year": 2031,
      "email": "example@komoju.com",
      "verification_value": "Approved",
      "name": "John Doe",
      "given_name": "John",
      "family_name": "Doe",
      "expiry_days": 0,
      "intent": "one_time",
      "initiator": "merchant",
      "usage": "first",
      "scheme_reference": "string",
      "installments": "3",
      "shipping_address_name": "Taro Tanaka",
      "shipping_address_line1": "5-2-1 Ginza",
      "shipping_address_line2": "3rd floor",
      "shipping_address_city": "Chuo-ku",
      "shipping_address_state": "Tokyo",
      "shipping_address_zip": "170-3293",
      "shipping_address_country": "Japan",
      "billing_address_name": "Taro Tanaka",
      "billing_address_line1": "5-2-1 Ginza",
      "billing_address_line2": "3rd floor",
      "billing_address_city": "Chuo-ku",
      "billing_address_state": "Tokyo",
      "billing_address_zip": "170-3293",
      "billing_address_country": "Japan"
    },
    "payment_method_fee": 0,
    "total": 0,
    "currency": "JPY",
    "description": "string",
    "captured_at": "2024-01-01T00:00:00Z",
    "external_order_num": "string",
    "metadata": {},
    "created_at": "2025-01-15T10:10:00Z",
    "amount_refunded": 0,
    "locale": "ja",
    "session": "string",
    "customer_family_name": "string",
    "customer_given_name": "string",
    "mcc": "string",
    "statement_descriptor": {
      "statement_descriptor": "株式会社KOMOJU",
      "statement_descriptor_alpha": "KOMOJU",
      "statement_descriptor_kana": "コモジュ",
      "statement_city": "Tokyo",
      "contact_phone": "0312345678"
    },
    "platform_details": {
      "submerchants": [
        {
          "submerchant_id": "submerc1od2nc89s6u5hh6x4g",
          "amount": 900,
          "platform_fee": 100
        }
      ],
      "processing_merchant_id": "string"
    },
    "refunds": [
      {
        "id": "ref442o1crn4qn3a3c7gspfik",
        "resource": "refund",
        "amount": 1000,
        "currency": "JPY",
        "payment": "pay3fj6nnhvws08idzacf6et8",
        "description": "Full refund",
        "created_at": "2024-01-01T00:00:00Z",
        "chargeback": false,
        "refund_type": "string",
        "platform_details": {
          "submerchants": [
            {
              "submerchant_id": "submerc1od2nc89s6u5hh6x4g",
              "amount": 900,
              "platform_fee": 100
            }
          ],
          "processing_merchant_id": "string"
        }
      }
    ],
    "refund_requests": [
      {
        "id": "refreqlv6wny1ew1a1aq4zum1",
        "payment": "pay3fj6nnhvws08idzacf6et8",
        "customer_name": "ｻｲﾄｳ ﾏｻﾋﾛ",
        "bank_name": "サンプル銀行",
        "bank_code": "0900",
        "branch_name": "本店",
        "branch_number": "100",
        "account_number": "1234567",
        "description": "string",
        "status": "completed",
        "created_at": "2024-01-01T00:00:00Z",
        "platform_details": {
          "submerchants": [
            {
              "submerchant_id": "submerc1od2nc89s6u5hh6x4g",
              "amount": 900,
              "platform_fee": 100
            }
          ],
          "processing_merchant_id": "string"
        }
      }
    ]
  }
}
```

## Endpoints

### Event: List

- [GET /events](https://docs.komoju.com/en/api-reference/2025-01-28/list-events.md)

### Event Show

- [GET /events/{id}](https://docs.komoju.com/en/api-reference/2025-01-28/show-event.md)