协议查询

商家在某些场景下如果需要了解用户当前在支付宝的协议状态，可调用 zhima.credit.pe.zmgo.agreement.query（芝麻Go协议查询接口）查询。例如已知用户协议号，查询用户协议状态（建议使用）在每次数据回传的时候建议查询一下协议是否在途（不为 N 即是在途）。

接口调用

具体请求参数、响应参数、错误码，可查看 zhima.credit.pe.zmgo.agreement.query（芝麻Go协议查询接口）文档。

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaCreditPeZmgoAgreementQueryRequest request = new ZhimaCreditPeZmgoAgreementQueryRequest();
request.setBizContent("{" +
"\"agreement_id\":\"201855134478591920x7\"," +
"\"alipay_user_id\":\"20883024244193x0\"" +
"  }");
ZhimaCreditPeZmgoAgreementQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
"zhima_credit_pe_zmgo_agreement_query_response":{
    "code":"10000",
    "msg":"Success",
"agreement_id":"201855134478591920x7",
"agreement_name":"芝麻GO",
"alipay_user_id":"20883024244193x0",
"agreement_status":"Y"
  }
,"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

协议变更通知

用户协议状态变更后都会有相应的通知发送给商家。

通知的消息属性、响应值具体可查看 zhima.credit.pe.zmgo.agreement.changed（芝麻GO业务协议变更商户通知）文档。

向商家发送通知的地址，使用模板中配置的应用对应的网关地址，开发者请注意设置。

通知消息中的关键字段值，在不同场景下传值不一样，请商家区分消费。

关键字段

字段值\场景	用户主动退出	会员到期	商家结算退出
changed_type	QUIT 或 null	QUIT 或 null	QUIT 或 null
agreement_status	P（失效中）	P（失效中）	P（失效中）
withhold_plan_no	用于后续费用结算时传入	用于后续费用结算时传入	用于后续费用结算时传入
quit_type	USER_CANCEL_QUIT	EXPIRE_QUIT	SETTLE_APPLY_QUIT
费用结算	要发起结算	要发起结算	要发起结算

消息示例

ISV_GATEWAY_URL?charset=GBK&biz_content=
{
    "alipay_user_id": "2088101117955611", 
    "agreement_id": "ZMGO_AGR2021012910020604010000000001", 
    "agreement_status": "Y", 
    "withhold_plan_no": "ZMGO_WHD2021010910020603000000006002", 
    "quit_type": "EXPIRE_QUIT", 
    "gmt_changed": "2021-01-29 11:35:59", 
    "biz_type": "EASY_MEMBER", 
    "expire_aisle_data": "API", 
    "product_version": "zhimaGoV2"
}
&msg_method=zhima.credit.pe.zmgo.agreement.changed&utc_timestamp=1516797622752&version=1.1&sign_type=RSA2&notify_id=d275fec564e62af6bedbcee73f3f05fi5x&app_id=2013121700999429&sign=I+Y/lvqYUEEc10EPdpntRhFIQ==

其他辅助功能

协议查询#

接口调用#

请求示例#

响应示例#

协议变更通知#

关键字段#

消息示例#