获取解约挽留信息

更新时间：2024.08.19

注意

对后台交互时，如果微信收到应答不是成功或超时（当前是1秒的超时），微信认为获取失败，不会展示挽留信息。

特别提醒：商户系统对于获取的内容一定要做签名验证，并校验获取的信息是否与商户侧的信息一致，防止数据泄露导致出现“假获取”，造成资金损失。

接口说明

支持商户：【普通商户】【直连服务商子商户】

请求方式：【POST】

获取URL：获取的路径为商户配置委托扣款模版时填写的解约回调地址。回调地址必须为HTTPS协议。如果回调地址无法访问，用户解约时，商户将无法收到微信问询商户进行解约挽留的请求，用户侧则无挽留进行解约。回调地址必须为直接可访问的URL，不能携带参数。示例："https://pay.weixin.qq.com/wxpay/pay.action"

接口规则： https://pay.weixin.qq.com/docs/merchant/development/interface-rules/introduction.html

获取规则

当用户关闭协议时，协议所关联的模板在获取范围内，则主动的获取挽留信息。

获取报文

获取是以POST方法访问商户设置的获取URL，获取的数据以JSON格式通过请求主体（BODY）传输。获取的数据包括了加密结果详情。

验证签名

加密不能保证获取请求来自微信。微信支付会对发送给商户的获取进行签名，并将签名值放在获取的HTTP头Wechatpay-Signature。商户应当验证签名，以确认请求来自微信支付，而不是其他的第三方。签名验证的算法请参考《微信支付API v3签名验证》。

参数解密

下面详细描述对获取数据进行解密的流程：

用商户平台上设置的APIv3密钥【微信商户平台—>账户设置—>API安全—>设置APIv3密钥】，记为key。
针对resource.algorithm中描述的算法（目前为AEAD_AES_256_GCM），取得对应的参数nonce和associated_data。
使用key、nonce和associated_data，对数据密文resource.ciphertext进行解密，得到JSON形式的资源对象。

注意

AEAD_AES_256_GCM算法的接口细节，请参考rfc5116。微信支付使用的密钥key长度为32个字节，随机串nonce长度12个字节，associated_data长度小于16个字节并可能为空。
Java回调解密Json取值不带引号

字段说明

获取回调加密报文

id 必填 string(36)

获取的唯一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年5月20日13点29分35秒。

event_type 必填 string(32)

获取类型，枚举值：
ENTRUST.TERMINATE_RETENTION：解约挽留信息

resource_type 必填 string(32)

获取的资源数据类型固定为encrypt-resource。

summary 必填 object

获取摘要

resource 必填 object

获取资源数据。 json格式，见示例

属性

algorithm 必填 string(32)

对开启结果数据进行加密的加密算法，目前只支持AEAD_AES_256_GCM。

ciphertext 必填 string(1048576)

Base64编码后的开启/停用结果数据密文。

associated_data 选填 string(16)

附加数据

nonce 必填 string(16)

加密使用的随机串。

original_type 必填 string(64)

原始回调类型，entrust

获取信息

1{
2    "id":"EV-2018022511223320873",
3    "create_time":"2020-06-08T10:34:56+08:00",
4    "resource_type":"encrypt-resource",
5    "event_type":"ENTRUST.TERMINATE_RETENTION",   
6    "summary": "获取解约挽留信息",
7    "resource" : {                      
8        "original_type":"entrust",
9        "algorithm":"AEAD_AES_256_GCM",
10        "ciphertext": "...",
11        "nonce": "...",
12        "associated_data": ""
13    }
14}

获取解密后数据参数

mchid 必填 string(32)

微信支付分配的商户号

contract_id 必填 string(32)

委托代扣协议的主键，唯一定义此资源的标识

appid 必填 string(32)

商户在微信申请的公众号或移动应用AppID

plan_id 必填 int

委托代扣协议模板ID

out_contract_code 必填 string(32)

商户侧的签约协议号，商户侧需保证唯一性。只能是数字、大小写字母的组合

openid 必填 string(64)

商户AppID下的用户唯一标识

商户对resource对象进行解密后，得到的资源对象示例

1{
2  "appid": "wxd678efh567hg6787",
3  "contract_id": "123124412412423431",
4  "mchid": "1900000109",
5  "openid": "o-MYE42l80oelYMDE34nYD456Xoy",
6  "out_contract_code": "wxwtdk20200910100000",
7  "plan_id": 12535
8}

获取应答

接收成功： HTTP应答状态码需返回200或204，同时需返回应答报文。

接收失败： HTTP应答状态码需返回5XX或4XX，无需返回应答报文。

code 必填 string(32)

错误码，SUCCESS为接收成功，其他错误码为失败。

message 必填 string(64)

返回信息，如非空，为错误原因。

retention_type 必填 string(64)

挽留类型，枚举值：
COUPON：代金券

coupon_info 必填 object

代金券信息

属性

state 必填 string(64)

状态，枚举值：
SEND_COUPON：发券
UNUSED_COUPON：券未使用
NOT_SEND_COUPON：不发送券

coupon_id 必填 string(64)

代金券ID，当 state为NOT_SEND_COUPON时为空

应答示例

1{  
2  "code": "SUCCESS",
3  "message": "",
4  "retention_type": "COUPON",
5  "coupon_info": {
6     "state": "SEND_COUPON",
7     "coupon_id": "9867041"
8   }
9}

文档是否有帮助

更多支持

开发文档(服务商)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服