Webhook (Platform Model 向け)
加盟店は、管理を効率化するために、Webhook 経由でのさまざまなイベントにサブスクライブできます。
まず、こちらのページで KOMOJU で Webhook を設定する方法を確認します。次に、加盟店としてサブスクライブできるイベントを以下で確認します。
イベント (加盟店のみ利用可能)
(1) 以下のイベントは加盟店アカウントでトリガーされます。
merchant
の値は加盟店名です。
イベント | 説明 |
---|---|
ping | ping イベント。テストに使用されます。 |
payment.authorized | 加盟店からの支払いが承認されました。 |
payment.captured | 加盟店からの支払いが入金されました。 |
payment.updated | 加盟店からの支払いが変更されました。 |
payment.expired | 加盟店からの支払いが期限切れになりました。 |
payment.cancelled | 加盟店からの支払いがキャンセルされました。 |
payment.refund.created | 加盟店からの返金が作成されました (部分返金の場合もあります)。 |
payment.refunded | 加盟店からの支払いが全額返金されました。 |
payment.failed | 加盟店からの支払いが失敗しました。 |
settlement.created | 加盟店への精算が作成されました。 |
(2) 以下のイベントは販売事業者アカウントでトリガーされます。
merchant
の値は販売事業者名です。
イベント | 説明 |
---|---|
submerchant.application.accepted | 販売事業者からの事業者申請が承認されました。 |
submerchant.application.declined | 販売事業者からの事業者申請が拒否されました。 |
submerchant.payment_method_application.accepted | 販売事業者からの決算方法の申請が承認されました。 |
submerchant.payment_method_application.declined | 販売事業者からの決算方法の申請が拒否されました。 |
submerchant.payment.authorized | 販売事業者からの支払いが承認されました。 |
submerchant.payment.captured | 販売事業者からの支払いが入金されました。 |
submerchant.payment.updated | 販売事業者からの支払いが変更されました。 |
submerchant.payment.expired | 販売事業者からの支払いが期限切れになりました。 |
submerchant.payment.cancelled | 販売事業者からの支払いがキャンセルされました。 |
submerchant.payment.refund.created | 販売事業者からの返金が作成されました (部分返金の場合もあります)。 |
submerchant.payment.refunded | 販売事業者からの支払いが全額返金されました。 |
submerchant.refund_request.updated | 販売事業者からの返金リクエストが変更されました。 |
submerchant.payment.failed | 販売事業者からの支払いが失敗しました。 |
submerchant.settlement.created | 販売事業者への精算が作成されました。 |
配信の例
{
"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"
}
Updated 3 months ago