文档中心 > API类目 > 盒马接力go对接API

qimen.alibaba.wdk.vertical.nb.reverse.refund (盒马NB执行用户退款)

盒马NB执行用户退款

公共参数

请求地址：

环境	HTTP请求地址
正式环境	http://qimen.api.taobao.com/router/qm
测试环境	http://qimen.api.taobao.com/router/qmtest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
customerId	String	是	WMS颁发给用户的ID
sign_method	String	是	签名的摘要算法，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
request	Request	必须			入参请求
└ hmSubOrderId String 必须 123 盒马子订单号 └ hmReverseId Number 必须 123456 盒马退款单号 └ hmMainOrderId String 可选 123 盒马主订单号 └ refundAmount Number 必须 100 退款金额

响应参数

名称	类型	示例值	描述
success	Boolean	false	成功状态。
errorMessage	String	参数校验失败	错误信息
errorCode	String	10001	错误编码
data	Body		出参对象
└ outReversePayId String 123456 外部退款唯一凭证 └ outReverseId String 123456 外部退款单号 └ reverseResultStatus Number 1 外部执行结果，1：退款中。2：退款成功。-1：退款失败

请求示例

{"request":{"hmSubOrderId":"123","hmReverseId":123456,"hmMainOrderId":"123","refundAmount":100}}

响应示例

{
    "success":false,
    "errorMessage":"参数校验失败",
    "errorCode":"10001",
    "data":{
        "outReversePayId":"123456",
        "outReverseId":"123456",
        "reverseResultStatus":1
    }
}

验签示例

{"success":"false","errorMessage":"Illegal request","errorCode":"sign-check-failure"}

错误码解释

错误码	错误描述	解决方案

API工具

错误码查询工具 SDK下载

FAQ

有用( 0 ) 我要提问

返回
顶部

开放平台

盒马接力go对接API

qimen.alibaba.wdk.vertical.nb.reverse.refund (盒马NB执行用户退款)

公共参数

请求参数

响应参数

请求示例

响应示例

验签示例

错误码解释

API工具

FAQ