zhima.credit.ep.scene.agreement.use(加入信用服务) 在线调试(沙箱环境)

商户使用了芝麻企业征信提供的信用评估服务,并在用户签约使用商户提供的信用场景服务时,通过该接口同步给芝麻,芝麻开始给用户提供履约管理服务。

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 zhima.credit.ep.scene.agreement.use
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
rating_order_no String 必选 64 评估订单号。在用户完成信用评估后可以获取。信用评估流程关联接口见:zhima.credit.ep.scene.rating.initialize;zhima.credit.ep.scene.rating.apply。 zme20181106154144730565715957902
out_order_no String 必选 64 商户请求订单号,必须唯一。用于唯一标识商户的一笔业务请求。 test201805301527674106562F0000954216
biz_time Date 必选 19 业务时间,日期格式为 yyyy-MM-dd HH:mm:ss 2018-12-06 18:53:59
provision_code String 必选 64 条款编码。请参考条款编码 P$ZMSCCO_5_1_1$00001
biz_ext_param String 特殊可选 1024 特定业务场景传输的扩展参数,以JSON形式传输。具体业务场景需要传入参数请参考业务场景传输的扩展参数 {"total_amount":"32890"}

响应参数

参数 类型 是否必填 最大长度 描述 示例值
credit_order_no String 必填 64 信用订单号 zme20181106***********5615964647

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaCreditEpSceneAgreementUseRequest request = new ZhimaCreditEpSceneAgreementUseRequest();
request.setBizContent("{" +
"\"rating_order_no\":\"zme20181106154144730565715957902\"," +
"\"out_order_no\":\"test201805301527674106562F0000954216\"," +
"\"biz_time\":\"2018-12-06 18:53:59\"," +
"\"provision_code\":\"P$ZMSCCO_5_1_1$00001\"," +
"\"biz_ext_param\":\"{\\\"total_amount\\\":\\\"32890\\\"}\"" +
"  }");
ZhimaCreditEpSceneAgreementUseResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "zhima_credit_ep_scene_agreement_use_response": {
        "code": "10000",
        "msg": "Success",
        "credit_order_no": "zme20181106***********5615964647"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "zhima_credit_ep_scene_agreement_use_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 技术支持
INVALID_RATING_ORDER_STATUS 评估单状态异常 请检查传入的评估订单号,必须是评估完成的单号
INVALID_PARAMETER 参数有误参数有误 请检查传入参数
RATING_ORDER_NOT_EXIST 评估订单不存在 请确认传入的评估订单号是否有效
INVALID_BIZ_TIME 业务时间格式不符 请检查biz_time的值是否符合格式:yyyy-MM-dd HH:mm:ss
PROVISION_CODE_NOT_EXIST 条款编码不存在 请联系技术支持确认传入的条款编码值
INVALID_EXT_PARAM biz_ext_param 里缺少行业指定必须传输的参数 请参照相应的行业对接说明传入相应的扩展参数
onlineServer