跳至主要内容

Webhook接口

註冊 / 更新 Webhook 配置​

POST /abc/v1/webhook/register

註冊新的 Webhook 配置；已有配置時更新回調地址。

請求頭​

X-API-Key
string
說明
API 存取密鑰
範例
{apiKey}
X-Timestamp
integer
說明
請求時間戳
範例
{{Timestamp}}
X-Nonce
string
說明
請求唯一隨機值
範例
{{Nonce}}
X-Signature
string
說明
請求簽名
範例
{{Signature}}
Content-Type
string
說明
請求內容類型
範例
application/json

請求體​

數據模型：OpenWebhookRegisterRequest

callbackUrl
string必填
說明
接收 Webhook 通知的 HTTPS 回調地址，最長 512 個字元
範例 / 默認值
https://merchant.com/webhook

成功響應​

數據模型：CommonResultBoolean

響應欄位​

code
integer
說明
錯誤碼
msg
string
說明
使用者可閱讀的提示訊息
message
string
說明
響應訊息
data
boolean
說明
操作是否成功
範例 / 默認值
true

查詢 Webhook 配置​

POST /abc/v1/webhook/query

查詢目前商戶的 Webhook 配置。

請求頭​

X-API-Key
string
說明
API 存取密鑰
範例
{apiKey}
X-Timestamp
integer
說明
請求時間戳
範例
{{Timestamp}}
X-Nonce
string
說明
請求唯一隨機值
範例
{{Nonce}}
X-Signature
string
說明
請求簽名
範例
{{Signature}}

請求體​

此接口不需要請求體。

成功響應​

數據模型：CommonResultOpenWebhookConfigResponse

響應欄位​

code
integer
說明
錯誤碼
msg
string
說明
使用者可閱讀的提示訊息
message
string
說明
響應訊息
data
object
說明
Webhook 配置

data 結構

id
integer
說明
配置 ID
範例 / 默認值
1001
merchantId
string
說明
商戶 ID
範例 / 默認值
merchant_001
callbackUrl
string
說明
接收 Webhook 通知的回調地址
範例 / 默認值
https://merchant.com/webhook
eventTypes
string
說明
訂閱事件類型的 JSON 陣列字串
範例 / 默認值
["card.transaction","card.status"]
status
integer
說明
配置狀態：1 表示啟用，0 表示停用
範例 / 默認值
1
retryCount
integer
說明
失敗後的重試次數
範例 / 默認值
3
createTime
string
說明
建立時間
範例 / 默認值
2026-09-22T10:00:00Z
updateTime
string
說明
最後更新時間
範例 / 默認值
2026-09-22T10:00:00Z

停用 Webhook 配置​

POST /abc/v1/webhook/disable

停用目前商戶的 Webhook 配置。

請求頭​

X-API-Key
string
說明
API 存取密鑰
範例
{apiKey}
X-Timestamp
integer
說明
請求時間戳
範例
{{Timestamp}}
X-Nonce
string
說明
請求唯一隨機值
範例
{{Nonce}}
X-Signature
string
說明
請求簽名
範例
{{Signature}}

請求體​

此接口不需要請求體。

成功響應​

數據模型：CommonResultBoolean

響應欄位​

code
integer
說明
錯誤碼
msg
string
說明
使用者可閱讀的提示訊息
message
string
說明
響應訊息
data
boolean
說明
操作是否成功
範例 / 默認值
true