zhima.merchant.order.rent.complete(信用借还订单完结) 在线调试(沙箱环境)

对于特定的借用场景及物品的情况下,芝麻信用借还产品为商户提供对借用申请人是否能够享受免押金服务的评估,以及基于此次借用订单下的相关费用的结算。

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
order_no String 必选 20 信用借还订单号 100000
product_code String 必选 20 信用借还的产品码:w1010100000000002858 w1010100000000002858
restore_time String 必选 20 物品实际归还时间,borrow_time 2016-10-01 12:00:00
pay_amount_type String 必选 10 金额类型:
RENT:租金
DAMAGE:赔偿金
RENT
pay_amount String 必选 10 支付金额 100.00
restore_shop_name String 可选 20 物品归还门店名称 肯德基文三路门店
extend_info String 可选 128 扩展信息。商户发起借用服务时的扩展信息字段,格式:json,注意,如果字符串对应的json对象包含中文字符,需要对包含中文的字段进行编码 {"restore_shop_code":"A123456"}

响应参数

参数 类型 是否必填 最大长度 描述 示例值
user_id String 必填 16 借用人支付宝userId. 2088202924240029
order_no String 必填 20 信用借还的订单号 100000
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");
ZhimaMerchantOrderRentCompleteRequest request = new ZhimaMerchantOrderRentCompleteRequest();
request.setBizContent("{" +
"\"order_no\":\"100000\"," +
"\"product_code\":\"w1010100000000002858\"," +
"\"restore_time\":\"2016-10-01 12:00:00\"," +
"\"pay_amount_type\":\"RENT\"," +
"\"pay_amount\":\"100.00\"," +
"\"restore_shop_name\":\"肯德基文三路门店\"," +
"\"extend_info\":\"{\\\"restore_shop_code\\\":\\\"A123456\\\"}\"" +
"  }");
ZhimaMerchantOrderRentCompleteResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "zhima_merchant_order_rent_complete_response": {
        "code": "10000",
        "msg": "Success",
        "user_id": "2088202924240029",
        "order_no": "100000",
        "alipay_fund_order_no": "2088000000000000"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
ILLEGAL_ARGUMENT 参数有误。 请确认参数格式
INVALID_PARAMETER 参数有误。 请确认参数是否正确
ARRANGEMENT_NOT_EXIST 商户对产品未签约 请联系业务与芝麻签约信用借还产品
AMOUNT_GREATER_DEPOSIT 支付金额大于押金 请检查支付金额
NO_RENT_PAY_ERROR 免租金订单不能支付租金 请检查订单金额
UNITRADE_WITHHOLDING_PAY_FAILED 代扣支付失败 请检查余额中是否有足够的金额或者查看是否超过代扣限额,代扣失败原因有多种情况。代扣失败后可以引导用户主动支付
UNITRADE_PREAUTH_PAY_FAILED 预授权转支付失败 请检查支付宝账户状态
ORDER_GOODS_IS_RESTORED 此订单已归还,不能重复操作 请检查订单状态
UNITRADE_WITHHOLDING_PAY_INPROGR 代扣支付进行中 请稍后重试
UNITRADE_PREAUTH_PAY_INPROGRESS 预授权转支付进行中 请稍后重试
ORDER_NOT_EXISTS 订单不存在 根据传入借还订单号查询不到对应的订单,请检查传入借还订单号
ORDER_IS_CANCEL 订单已经撤销 订单已经被商户撤销,不行进行归还完结操作
RENT_SHOULD_NOT_GREAT_THAN_ZERO 免租金情况下租金金额不应大于0 请检查支付金额字段
ORDER_RESTORE_PAY_AMOUNT_ERROR 该订单的归还金额不能调整 请检查支付金额字段,当用户扣款失败后,再次调用完结接口,同一支付金额类型(租金或赔偿金),的支付金额不能修改
TRADE_ORDER_IS_IN_PROGRESS 交易付款处于进行中,不能变更交易信息 请稍后重试
UNITRADE_PAYMENT_ALREADY_SUCCESS 订单支付已成功,无需再次支付 请调用订单查询接口确认订单状态
UNITRADE_QUERY_ORDER_FAILED 查询交易订单失败 请稍后重试
INVALID_PARAMETER 参数有误归还时间已晚于借用时间 检查归还时间,确认归还时间不能早于借用时间
PREAUTH_PAY_FORBID_MODIFY_AMOUNT 支付已经受理,不能修改支付金额,请检查支付金额字段 检查支付金额大小,修改支付金额大小后重试
ADD_AUTH_FREEZE_FAILURE 已付押金不足以支付租金或赔偿金时追加押金额度失败,请稍后再试 请稍后再试
ADD_AUTH_FREEZE_STATUS_ILLEGAL 物品正在归还处理中,请稍后再试 物品正在归还处理中,请稍后再试
onlineServer