用户欠款状态商户通知
更新时间:2024.11.18用户欠款状态发生变化时主动通知所有与该用户签订了合约的商户。
|
接口说明
支持商户:【普通服务商】
请求方式:【POST】
回调URL: 该链接商户接入校园轻松付时要求登记的「欠款状态商户通知回调地址」,必须为HTTPS协议。如果链接无法访问,商户将无法接收到微信通知。 通知URL必须为直接可访问的URL,不能携带参数。示例: "http://pay.weixin.qq.com/wxpay/pay.action"
通知规则
用户欠款状态,微信后台会把相关确认结果和订单信息发送给商户,商户需要接收处理该消息,并返回应答。
对后台通知交互时,如果微信收到商户的应答不符合规范或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。 (通知频率为:1/60/60/60/60/60/60/60/60/60/60/300/300/300/300/300/300/300/300/300/300/(单位:秒) )
通知报文
用户欠款状态通知是以POST 方法访问商户设置的通知URL,通知的数据以JSON 格式通过请求主体(BODY)传输。通知的数据包括了加密的支付结果详情。
注意:由于涉及到回调加密和解密,商户必须先设置好APIv3密钥后才能解密回调通知,APIv3密钥设置文档指引详见APIv3密钥设置指引
步骤说明
步骤一:验证签名
微信支付会对发送给商户的通知进行签名,并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名,以确认请求来自微信,而不是其他的第三方。签名验证的算法请参考 《微信支付API v3签名验证》。
步骤二:参数解密
为了保证安全性,微信支付在回调通知,对关键信息进行了AES-256-GCM加密。商户应当按照以下的流程进行解密关键信息,解密的流程:
用商户平台上设置的APIv3密钥【微信服务商平台—>账户设置—>API安全—>设置APIv3密钥】,记为key;
获取resource.algorithm中描述的算法(目前为AEAD_AES_256_GCM),以及resource.nonce和resource.associated_data;
使用key、nonce和associated_data,对数据密文resource.ciphertext进行解密,得到JSON形式的资源对象。
|
字段说明
通知参数
id
必填 string(32)
通知的唯一ID。
create_time
必填 string(32)
通知创建的时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒
event_type
必填 string(32)
通知的类型:
用户欠款状态更新-通知类型:EDU_SCHOOL_PAY.USER_DEBT_STATE_UPDATE
resource
必填 object
通知资源数据。
属性 | |
用户欠款状态通知
resource解密后字段
appid
必填 string(32)
微信公众平台为服务商商户分配的公众账号ID,与商户号存在绑定关系。 如果是服务商模式接入则为服务商商户号绑定的AppID;如果是直连商户模式接入则为直连商户号绑定的AppID。
openid
必填 string(128)
使用字段AppID生成的用户唯一标识,与返回字段AppID有对应关系。
state
必填 string(32)
根据校园轻松付风控规则,当用户在校园轻松付产品中欠款超过一定限制后,会处于无法扣款的状态,直到用户归还欠款。
可选状态:
NORMAL:正常,允许扣款
FORBIDDEN:禁止扣款
debt_count
必填 int
用户在校园轻松付中尚未归还的欠款笔数。 用户使用校园轻松付进行消费时,如果微信账户上可用的付款方式均没有足够的余额完成支付,会由微信支付出资对该笔订单进行垫付。这次垫付即会产生一笔用户向微信支付的欠款,直到用户对该笔欠款进行归还。
update_time
必填 string(32)
遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒。
对resource对象进行解密后,得到的资源对象示例
通知应答
接收成功: HTTP应答状态码需返回200或204,无需返回应答报文。
接收失败: HTTP应答状态码需返回5XX或4XX,同时需返回应答报文,格式如下:
BODY 包体参数
code
必填 string(32)
【返回状态码】 错误码,SUCCESS为清算机构接收成功,其他错误码为失败。
message
必填 string(64)
【返回信息】 返回信息,如非空,为错误原因。
应答示例