webhook

POST{notifyUrl}

说明

目前支持两种方式配置webhook

接口中传输notifyUrl (优先级更高，先取接口中传输notifyUrl，如果没传就取在MC商户后台配置通知地址 )
在MC商户后台配置通知地址

https://mc.useepay.com/#/home/mainManage/asynNotification

::: tip
被请求方返回 httpstatus 200表示接收通知成功，否则useepay会重新发送通知
通知频率 1m,3m,5m,10m,15m,15m,30m,1h
:::

时序图

sequenceDiagram
UseePay-->>Merchant: 订单终态后通知商户
Merchant->>UseePay: 返回httpstatus(200)

什么情况下会触发webhook?

订单变成终态时会出发webhook。

resultCode	说明
succeed	订单成功
failed	订单失败
closed	订单超时未支付关闭
cancelled	指在交易完成之前被取消。通常是发生在预授权订单
pending_review	预授权交易ok,等待预授权完成。此状态只有3d动态预授权才会返回

注意事项

::: caution

因为UseePay允许商户使用相同订单号进行支付，所以商户可能会收到同一笔订单成功和失败的通知
UseePay并不能保证发送webhook的顺序
请注意此处的参数未来可能会增加，请您不要根据固定参数名验签。应根据响应动态生成加签参数
同样的通知可能会多次发送给机构系统。机构系统必须能够正确处理重复的通知
:::

请求参数

Path 参数

notifyUrl

string

必需

Header 参数

Content-Type

string

必需

示例值:

application/x-www-form-urlencoded

Body 参数application/x-www-form-urlencoded

version

string

可选

max=5 交易异步通知报文版本，固定为：1.0

示例值:

1.0

merchantNo

string

必需

max=16 商户编号，由USEEPAY 分配

示例值:

500000000007362

transactionId

string

必需

max=64 商户订单号

示例值:

202212070142347

originalTransactionId

string

可选

max=64 原始商户订单号

示例值:

originalTransactionId

reference

string

必需

max=64 USEEPAY 订单号

示例值:

reference

transactionType

string

必需

max=64 交易类型： pay；authorization; refund; capture;authorizationVoid;

示例值:

pay

amount

string

必需

max=12 交易金额，单位为对应币种的最小货币单位(详见 ISO 4217)

示例值:

1234

currency

string

可选

max=3 3 位 ISO 大写字母货币代码((详见 ISO 4217)

示例值:

USD

resultCode

string

必需

max=32 业务结果业务结果码

示例值:

succeed

errorCode

string

可选

max=4 [错误码](https://app.apifox.com/link/project/2038036/apis/doc-1990078）

示例值:

0000

errorMsg

string

可选

max=256 错误码消息描述

示例值:

0000

echoParam

string

可选

max=256 回声参数，响应报文会原样返回

示例值:

echoParam

signType

string

MD5/RSA

必需

示例值:

MD5

sign

string

必需

max=256 商户请求参数的签名串

示例值:

decb3b9b728c7af4251acae23804939b

issuerResponse

string

可选

发卡行返回的新 Json String的格式

示例值:

{"issuerResponseMsg":"Not sufficient funds","issuerResponseCode":"51"}

reserved

string

可选

回声参数: UseePay内部使用

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

object {0}

amount=1234&resultCode=closed&sign=5cb57302e93b8b2342e7f587437f0855&errorCode=3300&version=1.0&transactionId=202110140304347&errorMsg=Transaction is expired&reference=1012110141504650869&transactionType=pay&echoParam=echoParam&reserved=reserved&signType=MD5&currency=USD&merchantNo=500000000007381

最后修改时间： 1 个月前