As a Platform Merchant, you can subscribe to various events via Webhook for better management.

First, you can refer to this page to learn how to set up webhooks with KOMOJU. Then, the following events are available for you as a Platform Merchant to subscribe to.

Events (available for Platform Merchant only)

(1) The events are triggered under Platform Merchant account

The merchant value is Platform Merchant name.

Event	Description
ping	The ping event. Used for testing.
payment.authorized	A payment from Platform Merchant was authorized.
payment.captured	A payment from Platform Merchant was captured.
payment.updated	A payment from Platform Merchant was changed.
payment.expired	A payment from Platform Merchant was expired.
payment.cancelled	A payment from Platform Merchant was cancelled.
payment.refund.created	A refund from Platform Merchant was created (may be partial).
payment.refunded	A payment from Platform Merchant was fully refunded.
payment.failed	A payment from Platform Merchant failed.
settlement.created	A settlement to Platform Merchant was created.

(2) The events are triggered under sub-merchant account

The merchant value is sub-merchant name.

Event	Description
submerchant.application.accepted	A merchant application from sub-merchant was accepted.
submerchant.application.declined	A merchant application from sub-merchant was declined.
submerchant.payment_method_application.accepted	A payment method application from sub-merchant was accepted.
submerchant.payment_method_application.declined	A payment method application from sub-merchant was declined.
submerchant.payment.authorized	A payment from sub-merchant was authorized.
submerchant.payment.captured	A payment from sub-merchant was captured.
submerchant.payment.updated	A payment from sub-merchant was changed.
submerchant.payment.expired	A payment from sub-merchant was expired.
submerchant.payment.cancelled	A payment from sub-merchant was cancelled.
submerchant.payment.refund.created	A refund from sub-merchant was created (may be partial).
submerchant.payment.refunded	A payment from sub-merchant was fully refunded.
submerchant.refund_request.updated	A refund request from sub-merchant was changed.
submerchant.payment.failed	A payment from sub-merchant failed.
submerchant.settlement.created	A settlement to sub-merchant was created

Example Delivery

{
  "id": "6h49xdt2jmiq55ffigjz4g5da",
  "type": "submerchant.payment.updated",
  "resource": "event",
  "data": {
    "id": "7p2sohh26a30zs6jp80sla3bw",
    "resource": "payment",
    "status": "captured",
    "amount": 5000,
    "tax": 0,
    "customer": null,
    "payment_deadline": "2024-02-10T14:59:59Z",
    "payment_details": {
      "type": "credit_card",
      "email": "[email protected]",
      "brand": "visa",
      "last_four_digits": "1111",
      "month": 1,
      "year": 2025
    },
    "payment_method_fee": 0,
    "total": 5000,
    "currency": "JPY",
    "description": null,
    "captured_at": "2024-02-08T08:27:31Z",
    "external_order_num": null,
    "metadata": {},
    "created_at": "2024-02-08T08:27:31Z",
    "amount_refunded": 0,
    "locale": "ja",
    "session": null,
    "customer_family_name": null,
    "customer_given_name": null,
    "platform_details": [
      {
        "submerchant_id": "platform-test-seller",
        "amount": 3000,
        "platform_fee": 2000,
        "intermediary": false
      }
    ],
    "mcc": null,
    "statement_descriptor": null,
    "refunds": [],
    "refund_requests": []
  },
  "created_at": "2024-02-08T08:27:31Z",
  "reason": null,
  "submerchant_id": "platform-test-seller"
}