Skip to main content

Webhook

您可以在网关GUI界面上设置一个WebhookURL。当有事件时，网关将事件通知给WebhookURL。Webhook的一个典型例子是，当订单的支付状态发生更改时，就会出现事件通知。

picture 1

每当订单状态发生变化时，一个GET请求将被发送到WebhookURL，其参数如下：

nametypedesc
typestring事件类型，固定值为order
instancestringmerchant_order_id 字段，商家传递的订单号
codestring事件代码，固定值为statuschange
messagestring订单状态变更说明
signaturestring请求签名

  • 请求可以通过签名规则进行签名验证，签名规则中的apiUrl使用的是webhook的完整地址

  • 如果webhook地址响应为200，则通知成功，否则会重复通知，每5秒重复一次，最多6次

  • 收到webhook通知时，需要验证参数。 验证过程请参考下方签名计算部分。

  • 请注意，签名用于验证webhook是否来自支付网关。 您应该使用与其他 API 调用相同的算法来验证签名。

Message#

message 字段值

valueinstruction
Order Timeout订单超时
Order Closed订单关闭
Order Paid订单已支付
Order Refunded订单部分全额或部分退款

Webhook 通知示例#

URLwebhook address
MethodGET

请求内容#

查询字符串示例#

{https://your_url_webhook_setup}?code=StatusChange&instance=test_linepay01&message=Order%20Paid&signature=DA0608731FA24D4C8694D839A2D990D4AEDF3A897126C09BE4C9D6B4DB605932&type=Order

在Postman中演示#

webhook_sample_request.png

测试 Webhook 端点#

If you don't have public url you can setup Webhook URL to send some test webhook like https://webhook.site

or you can read info about Test WebHook registration with request logging site from Microsoft.

如果您还没有域名，您可以设置例如 https://webhook.site 这样的 Webhook URL 来进行测试。

或者您可以从 Microsoft 获取相关信息 Test WebHook registration with request logging site 。

Edit this page