对于特定的借用场景及物品的情况下,芝麻信用借还产品为商户提供对借用申请人是否能够享受免押金服务的评估,以及基于此次借用订单下的相关费用的结算。
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | zhima.merchant.order.rent.create |
format | String | 否 | 40 | 仅支持JSON | JSON |
return_url | String | 否 | 256 | HTTP/HTTPS开头字符串 | https://m.alipay.com/Gk8NF23 |
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 | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
invoke_type | String | 必须 | 10 | 商户访问蚂蚁的对接模式:
WINDOWS:支付宝服务窗。 目前是固定值,有新增类型会同步到文档上 |
WINDOWS |
invoke_return_url | String | 必须 | 30 | 回调到商户的url地址 | https://www.bing.com |
notify_url | String | 可选 | 30 | 废弃,使用蚂蚁开放平台应用中的网关地址 | 废弃,使用蚂蚁开放平台应用中的网关地址 |
invoke_state | String | 可选 | 50 | 商户请求状态上下文。商户发起借用服务时,需要在借用结束后返回给商户的参数,格式:json | {\"xxx\":\"xxx\"} |
out_order_no | String | 必须 | 20 | 外部订单号,需要唯一,由商户传入,芝麻内部会做幂等控制,格式为:yyyyMMddHHmmss+随机数 | 2016100100000xxxx |
product_code | String | 必须 | 20 | 信用借还的产品码,传入固定值:w1010100000000002858 | w1010100000000002858 |
goods_name | String | 必须 | 20 | 物品名称,最长不能超过14个汉字 | 充电宝 |
rent_info | String | 可选 | 30 | 租金信息描述 ,长度不超过14个汉字,只用于页面展示给C端用户,除此之外无其他意义。 | 2小时内免费,超过2元/小时 |
rent_unit | String | 必须 | 10 | 租金单位,租金+租金单位组合才具备实际的租金意义。
取值定义如下: DAY_YUAN:元/天 HOUR_YUAN:元/小时 YUAN:元 YUAN_ONCE: 元/次 |
DAY_YUAN |
rent_amount | String | 必须 | 10 | 租金,租金+租金单位组合才具备实际的租金意义。
>0.00元,代表有租金 =0.00元,代表无租金,免费借用 注:参数传值必须>=0,传入其他值会报错参数非法 |
100.00 |
deposit_amount | String | 必须 | 10 | 押金,金额单位:元。
注:不允许免押金的用户按此金额支付押金;当物品丢失时,赔偿金额不得高于该金额。 |
200.00 |
deposit_state | String | 必须 | 10 | 是否支持当借用用户信用不够(不准入)时,可让用户支付押金借用:
Y:支持 N:不支持 注:支付押金的金额等同于deposit_amount |
Y |
borrow_cycle | String | 可选 | 10 | 此字段已废弃,请商户参考expiry_time字段。
借用周期,必须是正整数 |
2 |
borrow_cycle_unit | String | 可选 | 10 | 此字段已废弃,请商户参考expiry_time字段。
借用周期单位: HOUR:小时 DAY:天 |
HOUR |
borrow_shop_name | String | 可选 | 20 | 物品借用地点的描述,便于用户知道物品是在哪里借的。可为空 | 肯德基文三路门店 |
name | String | 可选 | 20 | 借用用户的真实姓名,非必填字段。但name和cert_no必须同时非空,或者同时为空,一旦传入会对用户身份进行校验。 | 张三 |
cert_no | String | 可选 | 18 | 借用用户的真实身份证号,非必填字段。但name和cert_no必须同时非空,或者同时为空,一旦传入会对用户身份进行校验。 | 310101198001012567 |
rent_settle_type | String | 可选 | 20 | 租金的结算方式,非必填字段,默认是支付宝租金结算支付
merchant:表示商户自行结算,信用借还不提供租金支付能力; alipay:表示使用支付宝支付功能,给用户提供租金代扣及赔偿金支付能力; |
alipay |
borrow_time | String | 可选 | 20 | 商户订单创建的起始借用时间,格式:YYYY-MM-DD HH:MM:SS。如果不传入或者为空,则认为订单创建起始时间为调用此接口时的时间。 | 2017-04-27 10:01:01 |
expiry_time | String | 可选 | 20 | 到期时间,是指最晚归还时间,表示借用用户如果超过此时间还未完结订单(未归还物品或者未支付租金)将会进入逾期状态,芝麻会给借用用户发送催收提醒。如果此时间不传入或传空,将视为无限期借用 | 2017-04-30 12:06:31 |
mobile_no | String | 可选 | 11 | 借用用户的手机号码,可选字段。推荐商户传入此值,会将此手机号码与用户身份信息进行匹配验证,防范欺诈风险。 | 13088888888 |
address | String | 可选 | 128 | 借用用户的收货地址,可选字段。推荐商户传入此值,会将此手机号码与用户身份信息进行匹配验证,防范欺诈风险。 | 浙江省杭州市西湖区万塘路18号黄龙时代广场B座2楼101室 |
credit_biz | String | 可选 | 16 | 信用业务服务,默认为空,商户入驻信用借还时,特定场景下由芝麻信用借还分配后传入即可,商户自助接入流程里不需要传入该字段,否则会对该字段进行合法性校验 | ZMRB170925160744 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
invoke_state | String | 选填 | 50 | 商户发起借用服务时,需要在借用结束后返回给商户的参数 | {"xxx":"xxx"} |
out_order_no | String | 必填 | 20 | 外部订单号,需要唯一,由商户传入,芝麻内部会做幂等控制,格式为:yyyyMMddHHmmss+4位随机数 | 20161001000000dddd |
order_no | String | 必填 | 10 | 芝麻信用借还订单号 | 100000 |
admit_state | String | 必填 | 5 |
是否准入:
Y-准入 N-不准入 |
Y |
user_id | String | 必填 | 20 | 借用者的userId | 2088202924240029 |
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2"); ZhimaMerchantOrderRentCreateRequest request = new ZhimaMerchantOrderRentCreateRequest(); request.setBizContent("{" + "\"invoke_type\":\"WINDOWS\"," + "\"invoke_return_url\":\"https://www.bing.com\"," + "\"notify_url\":\"废弃,使用蚂蚁开放平台应用中的网关地址\"," + "\"invoke_state\":\"{\\\\\\\"xxx\\\\\\\":\\\\\\\"xxx\\\\\\\"}\"," + "\"out_order_no\":\"2016100100000xxxx\"," + "\"product_code\":\"w1010100000000002858\"," + "\"goods_name\":\"充电宝\"," + "\"rent_info\":\"2小时内免费,超过2元/小时\"," + "\"rent_unit\":\"DAY_YUAN\"," + "\"rent_amount\":\"100.00\"," + "\"deposit_amount\":\"200.00\"," + "\"deposit_state\":\"Y\"," + "\"borrow_cycle\":\"2\"," + "\"borrow_cycle_unit\":\"HOUR\"," + "\"borrow_shop_name\":\"肯德基文三路门店\"," + "\"name\":\"张三\"," + "\"cert_no\":\"310101198001012567\"," + "\"rent_settle_type\":\"alipay\"," + "\"borrow_time\":\"2017-04-27 10:01:01\"," + "\"expiry_time\":\"2017-04-30 12:06:31\"," + "\"mobile_no\":\"13088888888\"," + "\"address\":\"浙江省杭州市西湖区万塘路18号黄龙时代广场B座2楼101室\"," + "\"credit_biz\":\"ZMRB170925160744\"" + " }"); ZhimaMerchantOrderRentCreateResponse response = alipayClient.pageExecute(request); if(response.isSuccess()){ System.out.println("调用成功"); } else { System.out.println("调用失败"); }
{ "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE", "zhima_merchant_order_rent_create_response":{ "msg":"Success", "order_no":"100000", "code":"10000", "user_id":"2088202924240029", "admit_state":"Y", "invoke_state":"{\"xxx\":\"xxx\"}", "out_order_no":"20161001000000dddd" } }
{ "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE", "zhima_merchant_order_rent_create_response":{ "msg":"Service Currently Unavailable", "code":"20000", "sub_msg":"系统繁忙", "sub_code":"isp.unknow-error" } }
错误码 | 错误描述 | 解决方案 |
---|---|---|
INVALID_PARAMETER | 参数有误。 | 请确认参数格式 |
INVALID_PARAMETER | 参数有误。 | 请确认参数是否正确 |
ARRANGEMENT_NOT_EXIST | 商户对产品未签约 | 请联系业务与芝麻签约信用借还产品 |
DEPOSIT_CLOSED | 不支持押金模式 | 目前不支持押金模式,请与芝麻业务确认 |
GOODS_HAS_BORROW | 该物品已经借用,请先归还后再借 | 请先归还物品 |
PREAUTH_FREEZE_ERROR | 该用户预授权冻结押金失败 | 请确认支付宝账号中是否有足够的金额 |
WITHHOLD_CONTRACT_ERROR | 签约代扣协议错误 | 请联系支付宝客服 |
ZM_ACCOUT_REGISTER_FAIL | 芝麻会员开通失败 | 请确保支付宝会员是否正常 |
OUT_ORDER_NO_INVALID | 外部订单号重复 | 请更换外部订单号 |
USER_NOT_LOGON | 该支付宝账号没有登录 | 请登录支付宝 |
INFOSEC_VERIFY_FAILED | 信息含敏感内容 | 请检查入参信息是否包含敏感内容 |