使用场景:使用商户外部协议号或开通/授权协议号,查询服务开通/授权信息
接口编号:zhima.credit.payafteruse.creditagreement.query
请求参数(bizdata):
| 参数 | 参数名称 | 取值 | 可空 | 类型 | 备注 |
|---|---|---|---|---|---|
| out_agreement_no | 商户外部协议号 | 【描述】商户外部协议号 | 否 | string(32) |
out_agreement_no credit_agreement_id 必填一个 推荐使用credit_agreement_id |
| credit_agreement_id | 开通/授权协议号 | 【描述】芝麻开通/授权协议号 | 否 | string(128) |
响应参数(bizdata):
| 参数 | 参数名称 | 取值 | 可空 | 类型 | 备注 |
|---|---|---|---|---|---|
| agreement_status |
开通/授权 状态 |
【描述】开通/授权状态 VALID:有效 INVALID:无效 |
否 | string(16) | |
| credit_agreement_id |
开通/授权 协议号 |
【描述】芝麻开通/授权协议号 | 否 | string(128) | |
| out_agreement_no |
商户外部 协议号 |
【描述】商户外部协议号 | 是 | string(32) | |
| biz_time |
开通/授权 状态变更 的时间 |
【示例值】2021-01-19 00:00:00 | 是 | string(64) | |
| alipay_user_id | 用户ID | 【描述】蚂蚁统一会员ID | 否 | string(64) | alipay_user_id和open_id任选其一传入,必传 |
| open_id | 开放ID | 【描述】开放ID | 否 | string(128) | |
| ext_info | 扩展字段 |
【描述】该字段只在特殊业务场景下 根据业务方约定返回 一般业务场景下不需要消费该字段 【示例值】{"key":"value"} |
是 | string(1024) |
分期单协议号获取: ext_info.deductAgreement.GENERAL_WITHHOLDING_P |
样例数据:
请求报文:{"out_agreement_no":"agree2088102318125883"}
返回报文:
{"agreement_status":"VALID","biz_time":"2024-06-25 16:52:19","credit_agreement_id":"ZMOP99202406250200880035288485","ext_info":{"deductAgreement":"{"GENERAL_WITHHOLDING_P":"20245425175068923888"}"},"out_agreement_no":"agree2088102318125883","open_id":"0883cFGaAab_fBEtKjki0gYRk21tsDa30R4zTol_uT1ywc7"}
业务错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| SYSTEM_ERROR | 系统繁忙 | 服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试 |
| INVALID_PARAMETER | 参数有误 | 请根据接口返回的参数非法的具体错误信息,修改参数后进行重试 |
| BIZ_ERROR | 业务异常业务异常 | 稍后重试,或联系技术支持 |
| CREDIT_AGREEMENT_NOT_EXIST | 信用服务开通信息不存在 | 请检查参数是否正确 |
| CREDIT_AUTH_NOT_EXIST | 信用服务开通授权信息不存在 | 请检查请求参数 |
| DEPEND_FAILURE | 系统异常 | 系统异常,请重试 |
| EXTRA_PARAM_FORMAT_ERROR | 扩展参数格式错误 | 请检查扩展参数格式 |
| ILLEGAL_QUERY | 查询商户与开通授权信息关联商户不匹配 | 仅支持查询商户相关的开通授权信息 |