ウェブフック – 概要
“webhook”オブジェクトのデータ構造
レスポンスで返却されるフィールドおよび値の詳細は、以下を参照してください。
その他data内のフィールドおよび値は、イベントごとのリソースタイプによって異なります。こちらから確認して下さい。
| フィールド | データ型 | 備考 |
|---|---|---|
| id | 半角英数（UUID） | ウェブフックを識別するためのUUID |
| merchant_id | 半角英数（UUID） | ウェブフックが帰属する「加盟店」のUUID |
| store_id | 半角英数（UUID） | ウェブフックが帰属する「店舗」のUUID |
| triggers | 配列（テキスト） | ウェブフック送信契機となるイベント （イベント名の一覧を参照） 複数指定可能 |
| url | 半角英数（URLとして有効なもの） | ウェブフックの送信先 |
| auth_token | 半角英数 | ウェブフック実行時にヘッダーに含める認証用の値 authorizationというフィールド名を利用 |
| active | 真偽 | 作成時の有効性trueで有効、falseで無効 |
| created_on | ISO-8601 YYYY-MM-DD Thh:mm:ss | ウェブフックの作成日 |
| updated_on | ISO-8601 YYYY-MM-DD Thh:mm:ss | ウェブフックの更新日 |
ウェブフックのサンプル（body）
課金成功
{
"id": "11ef1288-37b0-2f15-a097-d3a0d4243d4c",
"event": "charge_finished",
"data": {
"id": "11ef1288-399b-eb84-a215-038628c5c460",
"store_id": "11ecda54-12g0-1c78-bd0f-73aa270d700f",
"transaction_token_id": "11ef1118-3766-4fdc-baed-b72c5ac3e0ba",
"transaction_token_type": "one_time",
"subscription_id": null,
"requested_amount": 100,
"requested_currency": "JPY",
"requested_amount_formatted": 100,
"charged_amount": 100,
"charged_currency": "JPY",
"charged_amount_formatted": 100,
"fee_amount": null,
"fee_currency": null,
"fee_amount_formatted": null,
"only_direct_currency": true,
"capture_at": null,
"descriptor": null,
"descriptor_phone_number": null,
"status": "successful",
"metadata": {},
"mode": "test",
"created_on": "2024-05-15T06:56:12.852465Z",
"redirect": {}
},
"created_on": "2024-05-15T06:56:13.140163783Z",
"webhook_id": "11ee8cf5-2be5-67d8-bc18-7b7c584c5735",
"successful": true,
"fired_on": "2024-05-15T06:56:13.092717474Z"
}課金失敗
{
"id": "11ef1288-37b0-2f15-a097-d3a0d7843d4c",
"event": "charge_finished",
"data": {
"id": "11ef1288-399b-eb84-a215-038628c5c460",
"store_id": "11ecda54-12g0-1c78-bd0f-73aa270d700f",
"transaction_token_id": "11ef1118-3766-4fdc-baed-b72c5ac3e0ba",
"transaction_token_type": "one_time",
"subscription_id": null,
"requested_amount": 100,
"requested_currency": "JPY",
"requested_amount_formatted": 100,
"charged_amount": 100,
"charged_currency": "JPY",
"charged_amount_formatted": 100,
"fee_amount": null,
"fee_currency": null,
"fee_amount_formatted": null,
"only_direct_currency": true,
"capture_at": null,
"descriptor": null,
"descriptor_phone_number": null,
"status": "failed",
"error": {
"code": 309,
"message": "Test charge failed purposely",
"details": "Test charge failed purposely"
},
"metadata": {},
"mode": "test",
"created_on": "2024-05-15T06:56:12.852465Z",
"redirect": {}
},
"created_on": "2024-05-15T06:56:13.140163783Z",
"webhook_id": "11ee8cf5-2be5-67d8-bc18-7b7c584c5735",
"successful": true,
"fired_on": "2024-05-15T06:56:13.092717474Z"
}