v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB

Events

Event Show

View an event given an id. Event ids can be saved from a webhook or found by querying all events.

get/events/{id}

Path parameters

idstring required

A unique 25-character alphanumeric resource identifier.

A unique identifier for an event.

Response

200 response

idstring required

A unique 25-character alphanumeric resource identifier.

typestring required

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

resource'event' required

Resource type name, always "event".

created_atstring date-time required

Timestamp when this event was created.

reasonstring nullable required

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

Example response

{
  "data": {
    "id": "pay3fj6nnhvws08idzacf6et8",
    "status": "captured",
    "amount": 1000,
    "payment_details": {
      "month": 10,
      "year": 2031,
      "email": "example@komoju.com",
      "name": "John Doe",
      "given_name": "John",
      "family_name": "Doe",
      "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"
    },
    "currency": "JPY",
    "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
        }
      ]
    },
    "refunds": [
      {
        "id": "ref442o1crn4qn3a3c7gspfik",
        "amount": 1000,
        "currency": "JPY",
        "payment": "pay3fj6nnhvws08idzacf6et8",
        "description": "Full refund",
        "platform_details": {
          "submerchants": [
            {
              "submerchant_id": "submerc1od2nc89s6u5hh6x4g",
              "amount": 900,
              "platform_fee": 100
            }
          ]
        }
      }
    ],
    "refund_requests": [
      {
        "id": "refreqlv6wny1ew1a1aq4zum1",
        "payment": "pay3fj6nnhvws08idzacf6et8",
        "customer_name": "ｻｲﾄｳ ﾏｻﾋﾛ",
        "bank_name": "サンプル銀行",
        "bank_code": "0900",
        "branch_name": "本店",
        "branch_number": "100",
        "account_number": "1234567",
        "status": "completed",
        "platform_details": {
          "submerchants": [
            {
              "submerchant_id": "submerc1od2nc89s6u5hh6x4g",
              "amount": 900,
              "platform_fee": 100
            }
          ]
        }
      }
    ]
  }
}