zhima.merchant.borrow.entity.upload(信用借还借用实体数据上传接口) 在线调试(沙箱环境)

在线下信用借还场景中,需要商户上传借用实体(如充电宝机柜、借还门店点、借用实物自行车等)的地址位置及描述信息数据,C端用户可以在芝麻信用借还频道地图页中展示。

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 zhima.merchant.borrow.entity.upload
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
product_code String 必选 20 信用借还的签约产品码,传入固定值:w1010100000000002858 w1010100000000002858
category_code String 必选 32 类目Code,传入芝麻借还规定的类目Code,其他值会认为非法参数,参数值如下:
雨伞:umbrella
充电宝:power_bank
umbrella
entity_code String 必选 32 外部实体编号,唯一标识一个实体,如自行车编号,机柜编号
注:商户维度下,类目Code(categoryCode)+实体编号(entity_code)唯一,一个商户下相同类目code+实体编号多次调用,将按照上传时间(upload_time)更新,更新规则取最新的upload_time快照数据
2016000100010011
longitude String 必选 20 地址位置经度,取值范围:经度-180~180,中国地区经度范围:73.66~135.05 83.66
latitude String 必选 20 地址位置纬度,取值范围:纬度-90~90,中国地区经度范围:纬度3.86~53.55 5.87
entity_name String 必选 20 实体名称,借用实体的描述,如XX雨伞,XX充电宝,XX自行车 爱心雨伞
address_desc String 可选 50 地址描述 杭州市西湖区文三路478号
office_hours_desc String 可选 20 营业时间,格式:xx:xx-xx:xx,24小时制,如果是昼夜00:00—24:00 09:00—22:00
contact_number String 可选 20 联系电话,手机11位数字,座机:区号-数字 0571-26888888
collect_rent String 必选 1 是否收租金,Y:收租金,N:不收租金 Y
rent_desc String 可选 30 租金描述,该借还点的租金描述,例如:5元/小时,5-10元/小时 5元/小时
can_borrow String 必选 1 是否可借用,Y:可借,N:不可借。如果不可借用,则不在芝麻借还频道地图展示 Y
can_borrow_cnt String 必选 5 可借用数量,如果是借用实物,如自行车,传1即可。如果是借用门店或借还机柜,则传入可借用的物品数量 12
total_borrow_cnt String 必选 6 借用总数,如果是借用实物,如自行车,传1即可。如果是借用门店或借还机柜,则传入提供借还物品的总量 20
upload_time String 必选 19 实体上传时间,某一借还实体信息多次上传,以最新上传时间数据为当前最新快照,格式:yyyy-mm-dd hh:MM:ss 2017-01-01 15:34:38

响应参数

参数 类型 是否必填 最大长度 描述 示例值

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaMerchantBorrowEntityUploadRequest request = new ZhimaMerchantBorrowEntityUploadRequest();
request.setBizContent("{" +
"\"product_code\":\"w1010100000000002858\"," +
"\"category_code\":\"umbrella\"," +
"\"entity_code\":\"2016000100010011\"," +
"\"longitude\":\"83.66\"," +
"\"latitude\":\"5.87\"," +
"\"entity_name\":\"爱心雨伞\"," +
"\"address_desc\":\"杭州市西湖区文三路478号\"," +
"\"office_hours_desc\":\"09:00—22:00\"," +
"\"contact_number\":\"0571-26888888\"," +
"\"collect_rent\":\"Y\"," +
"\"rent_desc\":\"5元/小时\"," +
"\"can_borrow\":\"Y\"," +
"\"can_borrow_cnt\":\"12\"," +
"\"total_borrow_cnt\":\"20\"," +
"\"upload_time\":\"2017-01-01 15:34:38\"" +
"  }");
ZhimaMerchantBorrowEntityUploadResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "zhima_merchant_borrow_entity_upload_response": {
        "code": "10000",
        "msg": "Success"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
NULL_ARGUMENT 参数为空 阅读接口接入文档,入参列表参数"是否必填"选项
ILLEGAL_ARGUMENT 参数格式或者长度非法 阅读接口接入文档,入参列表参数"描述"和"最大长度"选项
CATEGORY_CODE_ILLEGAL 类目code参数非法 阅读接口接入文档,category_code(类目Code)参数"描述"选项
INFOSEC_VERIFY_FAILED 信息含敏感内容 请检查入参信息是否包含敏感内容
onlineServer