koubei.trade.itemorder.refund(口碑商品交易退货接口)

口碑商品交易退货接口

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.trade.itemorder.refund
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 必选 64 口碑订单号 20171114111040030100030100002400
out_request_no String 必选 64 标识一次退款请求,同一笔订单多次退款需要保证唯一 B201701180000002
reason String 可选 256 退款原因描述 正常退款
refund_infos RefundInfo[] 必选 退货明细信息
item_order_no String 必填 32 商品单ID 201701220000008000000001
amount Price 必填 9 退款金额 10.00

响应参数

参数 类型 是否必填 最大长度 描述 示例值
order_no String 必填 64 口碑订单号 20170427000000001000000001
out_request_no String 必填 64 退款唯一请求号 B201701180000002
real_refund_amount String 必填 9 实际退的资金。 5.00

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiTradeItemorderRefundRequest request = new KoubeiTradeItemorderRefundRequest();
request.setBizContent("{" +
"\"order_no\":\"20171114111040030100030100002400\"," +
"\"out_request_no\":\"B201701180000002\"," +
"\"reason\":\"正常退款\"," +
"      \"refund_infos\":[{" +
"        \"item_order_no\":\"201701220000008000000001\"," +
"\"amount\":10.00" +
"        }]" +
"  }");
KoubeiTradeItemorderRefundResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_trade_itemorder_refund_response": {
        "code": "10000",
        "msg": "Success",
        "order_no": "20170427000000001000000001",
        "out_request_no": "B201701180000002",
        "real_refund_amount": "5.00"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
INVALID_PARAMETER 参数有误 参数有误,请参考文档检查入参
SYSTEM_ERROR 系统繁忙 系统繁忙,请稍后重试
ORDER_NOT_EXISTS 订单不存在 订单不存在,请检查查传入的订单号
AMOUNT_UN_BALANCE 退款金额超限 请检查传入的退款金额
BUSINESS_ERROR 未知原因的业务异常 未知原因的业务异常,请联系技术支持
REFUND_NOT_ALLOWED 当前订单不允许退款 当前订单不允许退款,请联系技术支持
ILLEGAL_ACCOUNT_STATUS 退款账户状态非法 退款账户状态非法,无法退款
ORDER_NOT_BELONG_TO_PID 订单不归属当前商户,无法退款 订单不归属当前商户,无法退款
BALANCE_NOT_ENOUGH 退款账户余额不足 退款账户余额不足
BUYER_ILLEGAL_STATUS 用户状态非法,无法退款 用户状态非法,无法退款
NOT_DUPLICATED_REQ 非幂等请求 外部退款请求号相同,但是请求参数不同
ITEM_ORDER_NOT_EXIST 商品单不存在 商品单不存在,请检查传入的商品单id
ILLEGAL_ORDER_STATUS 订单状态非法 订单因没有支付或已关闭导致无法退款。
onlineServer