Webhooks (Platform Model only)

Learn how webhooks work with KOMOJU Platform Model

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

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

Events (Platform Merchant only)

EventDescription
pingThe ping event. Used for testing.
payment.authorizedA payment from Platform Merchant was authorized.
payment.capturedA payment from Platform Merchant was captured.
payment.updatedA payment from Platform Merchant was changed.
payment.expiredA payment from Platform Merchant was expired.
payment.cancelledA payment from Platform Merchant was cancelled.
payment.refund.createdA refund from Platform Merchant was created (may be partial).
payment.refundedA payment from Platform Merchant was fully refunded.
payment.failedA payment from Platform Merchant failed.
settlement.createdA settlement to Platform Merchant was created.
submerchant.application.acceptedA merchant application from sub-merchant was accepted.
submerchant.application.declinedA merchant application from sub-merchant was declined.
submerchant.payment_method_application.acceptedA payment method application from sub-merchant was accepted.
submerchant.payment_method_application.declinedA payment method application from sub-merchant was declined.
submerchant.payment.authorizedA payment from sub-merchant was authorized.
submerchant.payment.capturedA payment from sub-merchant was captured.
submerchant.payment.updatedA payment from sub-merchant was changed.
submerchant.payment.expiredA payment from sub-merchant was expired.
submerchant.payment.cancelledA payment from sub-merchant was cancelled.
submerchant.payment.refund.createdA refund from sub-merchant was created (may be partial).
submerchant.payment.refundedA payment from sub-merchant was fully refunded.
submerchant.refund_request.updatedA refund request from sub-merchant was changed.
submerchant.payment.failedA payment from sub-merchant failed.
submerchant.settlement.createdA 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"
}