zhima.merchant.order.rent.query(信用借还订单查询) 在线调试(沙箱环境)

芝麻信用借还产品为商户提供的供商户查询借还订单详情的接口。

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
out_order_no String 必选 20 外部订单号,需要唯一,由商户传入,芝麻内部会做幂等控制,格式为:yyyyMMddHHmmss+随机数 2016100100000xxxx
product_code String 必选 20 信用借还的产品码:w1010100000000002858 w1010100000000002858

响应参数

参数 类型 是否必填 最大长度 描述 示例值
order_no String 必填 20 芝麻信用借还订单号 100000
goods_name String 必填 20 物品名称,最长不能超过14个汉字 充电宝
user_id String 必填 20 支付宝userId 2088201844891355
borrow_time String 必填 20 借用时间 2016-10-10 12:00:00
restore_time String 选填 20 归还时间 2016-10-10 12:00:00
use_state String 必填 10 订单状态:
borrow:借出
restore:归还
cancel:撤销
borrow
pay_status String 选填 10 支付状态
PAY_INIT:待支付
PAY_SUCCESS:支付成功
PAY_FAILED:支付失败
PAY_INPROGRESS:支付中
PAY_SUCCESS
pay_amount_type String 选填 10 支付金额类型
RENT:租金
DAMAGE:赔偿金
RENT
pay_amount String 选填 10 支付金额 100.00
pay_time String 选填 10 支付时间 2016-10-10 12:00:00
admit_state String 必填 10 是否准入:
Y:准入
N:不准入
Y
alipay_fund_order_no String 选填 20 资金流水号 2088000000000000

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
ZhimaMerchantOrderRentQueryRequest request = new ZhimaMerchantOrderRentQueryRequest();
request.setBizContent("{" +
"\"out_order_no\":\"2016100100000xxxx\"," +
"\"product_code\":\"w1010100000000002858\"" +
"  }");
ZhimaMerchantOrderRentQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "zhima_merchant_order_rent_query_response": {
        "code": "10000",
        "msg": "Success",
        "order_no": "100000",
        "goods_name": "充电宝",
        "user_id": "2088201844891355",
        "borrow_time": "2016-10-10 12:00:00",
        "restore_time": "2016-10-10 12:00:00",
        "use_state": "borrow",
        "pay_status": "PAY_SUCCESS",
        "pay_amount_type": "RENT",
        "pay_amount": "100.00",
        "pay_time": "2016-10-10 12:00:00",
        "admit_state": "Y",
        "alipay_fund_order_no": "2088000000000000"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误。 请检查参数
ARRANGEMENT_NOT_EXIST 商户对产品未签约 请联系业务与芝麻签约信用借还产品
ORDER_NOT_EXISTS 订单不存在 请检查外部订单号是否正确
onlineServer