文档中心 > API类目 > 喵街API

alibaba.xlife.onsite.trade.confirm (交易确认)

应用场景实例：本接口提供喵街订单的确认功能，商户可以通过本接口主动确认订单状态，完成下一步的业务逻辑。商户POS应在三种场景下调用此接口：在商户POS通过查询订单接口获知到订单状态为付款成功后，应修改自己的订单状态为付款成功，并在修改成功后调用此接口通知喵街，如果喵街没有在同步返回参数中返回确认成功，商户POS应采用一定的重试逻辑，直到喵街返回确认成功为止或到达一定的重试上限（此时，喵街订单将进入异常订单，可通过异常订单接口获知）。在商户POS通过申请退款接口获知喵街订单退款成功后，应修改自己的订单状态为退款成功，并在修改成功后调用此接口通知喵街，如果喵街没有在同步返回参数中返回确认成功，商户POS应采用一定的重试逻辑，直到喵街返回确认成功为止或到达一定的重试上限（此时，喵街订单将进入异常订单，可通过异常订单接口获知）。在商户POS通过撤销订单接口获知喵街订单撤销成功后，应修改自己的订单状态为撤销成功，并在修改成功后调用此接口通知喵街，如果喵街没有在同步返回参数中返回确认成功，商户POS应采用一定的重试逻辑，直到喵街返回确认成功为止或到达一定的重试上限（此时，喵街订单将进入异常订单，可通过异常订单接口获知）。

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
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。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
onsite_trade_confirm_request	OnsiteTradeConfirmRequest	必须			交易确认请求
└ extend_params String 可选 [{"abc":"123"}] 业务扩展参数，json格式 └ out_requeset_no String 可选 HZ01RF001 在退款确认时，由于可以发起多次部分退款，因此用此参数标识退款请求 └ trade_no String 可选 2013112011001004330000121536 喵街交易凭证号。与喵街订单号二者至少要填写一个，如果二者均有，默认使用喵街订单号 └ type String 必须 pay 交易确认的类型。取值：pay、refund和cancel。分别对应付款成功、退款成功和撤销成功的确认 └ out_trade_no String 可选 20150320010101001 原支付请求的商户订单号。与喵街订单号二者至少要填写一个，如果二者均有，默认使用喵街订单号

响应参数

名称	类型	示例值	描述
trade_no	String	2013112011001004330000121536	喵街交易凭证号。必然返回

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaXlifeOnsiteTradeConfirmRequest req = new AlibabaXlifeOnsiteTradeConfirmRequest();
AlibabaXlifeOnsiteTradeConfirmRequest.OnsiteTradeConfirmRequest obj1 = new AlibabaXlifeOnsiteTradeConfirmRequest.OnsiteTradeConfirmRequest();
obj1.setExtendParams("[{\"abc\":\"123\"}]");
obj1.setOutRequesetNo("HZ01RF001");
obj1.setTradeNo("2013112011001004330000121536");
obj1.setType("pay");
obj1.setOutTradeNo("20150320010101001");
req.setOnsiteTradeConfirmRequest(obj1);
AlibabaXlifeOnsiteTradeConfirmResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaXlifeOnsiteTradeConfirmRequest req = new AlibabaXlifeOnsiteTradeConfirmRequest();
AlibabaXlifeOnsiteTradeConfirmRequest.OnsiteTradeConfirmRequestDomain obj1 = new AlibabaXlifeOnsiteTradeConfirmRequest.OnsiteTradeConfirmRequestDomain();
obj1.ExtendParams = "[{\"abc\":\"123\"}]";
obj1.OutRequesetNo = "HZ01RF001";
obj1.TradeNo = "2013112011001004330000121536";
obj1.Type = "pay";
obj1.OutTradeNo = "20150320010101001";
req.OnsiteTradeConfirmRequest_ = obj1;
AlibabaXlifeOnsiteTradeConfirmResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaXlifeOnsiteTradeConfirmRequest;
$onsite_trade_confirm_request = new OnsiteTradeConfirmRequest;
$onsite_trade_confirm_request->extend_params="[{\"abc\":\"123\"}]";
$onsite_trade_confirm_request->out_requeset_no="HZ01RF001";
$onsite_trade_confirm_request->trade_no="2013112011001004330000121536";
$onsite_trade_confirm_request->type="pay";
$onsite_trade_confirm_request->out_trade_no="20150320010101001";
$req->setOnsiteTradeConfirmRequest(json_encode($onsite_trade_confirm_request));
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.xlife.onsite.trade.confirm' \
-d 'partner_id=apidoc' \
-d 'session=2a92bc21-f45d-4efe-ab90-9d80ac8a08aa' \
-d 'sign=1799E0B141DA10C6C0B1D5933D9247EE' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-23+17%3A22%3A43' \
-d 'v=2.0' \
-d 'onsite_trade_confirm_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaXlifeOnsiteTradeConfirmRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.onsite_trade_confirm_request=""
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.xlife.onsite.trade.confirm");
add_param(pRequest,"onsite_trade_confirm_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.xlife.onsite.trade.confirm', {
	'onsite_trade_confirm_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

XML示例
JSON示例

<alibaba_xlife_onsite_trade_confirm_response>
    <trade_no>2013112011001004330000121536</trade_no>
</alibaba_xlife_onsite_trade_confirm_response>

{
    "alibaba_xlife_onsite_trade_confirm_response":{
        "trade_no":"2013112011001004330000121536"
    }
}

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码解释

错误码	错误描述	解决方案
isv.INVALID_PARAMETER	无效参数	ISV开发人员需检查参数是否正常。
isv.TRADE_ORDER_NOT_FOUND	交易订单不存在	请确认入参中的订单号是否正常。
isp.INVALID_OPERATION	当前订单状态下不能执行此操作	必须在付款成功、交易关闭（取消、退款引起）的状态下执行此操作。
isp.SYSTEM_ERROR	系统异常	可间隔2秒重试最多5次。如果还是有问题，则需将该问题提交到喵街技术支持人员解决。

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

喵街API

alibaba.xlife.onsite.trade.confirm (交易确认)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈