淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
pay_order_refund_request	PayOrderRefundRequest	必须			请求入参
└ user_country String 必须 CHINA 国家 └ order_id String 必须 1 订单ID └ tenant_id Number 必须 1 租户ID └ currency String 必须 CNY 币种 └ apply_refund_time Number 必须 1 退订时间 └ idempotent_code String 必须 1 幂等号 └ refund_amount Number 必须 1 退款金额 └ refund_order_id String 必须 2 退订单ID └ refund_serial_id String 必须 1 退款流水号

名称	类型	示例值	描述
result_success	Boolean	true	是否成功
error	CommonError		错误
error_code ErrorCode 错误码 └ code String 1 编码 └ prefix String HP 错误码前缀 └ location String 1 系统名 └ message String 1 说明
value	PayOrderRefundResponse		返回值
└ huijin_refund_order_id Number 1 汇金退订单号 └ refund_status String 1 退订状态

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCloudgameTradeplatformApplypayorderrefundRequest req = new AlibabaCloudgameTradeplatformApplypayorderrefundRequest();
AlibabaCloudgameTradeplatformApplypayorderrefundRequest.PayOrderRefundRequest obj1 = new AlibabaCloudgameTradeplatformApplypayorderrefundRequest.PayOrderRefundRequest();
obj1.setUserCountry("CHINA");
obj1.setOrderId("1");
obj1.setTenantId(1L);
obj1.setCurrency("CNY");
obj1.setApplyRefundTime(1L);
obj1.setIdempotentCode("1");
obj1.setRefundAmount(1L);
obj1.setRefundOrderId("2");
obj1.setRefundSerialId("1");
req.setPayOrderRefundRequest(obj1);
AlibabaCloudgameTradeplatformApplypayorderrefundResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCloudgameTradeplatformApplypayorderrefundRequest req = new AlibabaCloudgameTradeplatformApplypayorderrefundRequest();
AlibabaCloudgameTradeplatformApplypayorderrefundRequest.PayOrderRefundRequestDomain obj1 = new AlibabaCloudgameTradeplatformApplypayorderrefundRequest.PayOrderRefundRequestDomain();
obj1.UserCountry = "CHINA";
obj1.OrderId = "1";
obj1.TenantId = 1L;
obj1.Currency = "CNY";
obj1.ApplyRefundTime = 1L;
obj1.IdempotentCode = "1";
obj1.RefundAmount = 1L;
obj1.RefundOrderId = "2";
obj1.RefundSerialId = "1";
req.PayOrderRefundRequest_ = obj1;
AlibabaCloudgameTradeplatformApplypayorderrefundResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCloudgameTradeplatformApplypayorderrefundRequest;
$pay_order_refund_request = new PayOrderRefundRequest;
$pay_order_refund_request->user_country="CHINA";
$pay_order_refund_request->order_id="1";
$pay_order_refund_request->tenant_id="1";
$pay_order_refund_request->currency="CNY";
$pay_order_refund_request->apply_refund_time="1";
$pay_order_refund_request->idempotent_code="1";
$pay_order_refund_request->refund_amount="1";
$pay_order_refund_request->refund_order_id="2";
$pay_order_refund_request->refund_serial_id="1";
$req->setPayOrderRefundRequest(json_encode($pay_order_refund_request));
$resp = $c->execute($req);

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.cloudgame.tradeplatform.applypayorderrefund' \
-d 'partner_id=apidoc' \
-d 'sign=A5D98956B8DC779BE561435A989AA334' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+16%3A59%3A59' \
-d 'v=2.0' \
-d 'pay_order_refund_request=null'

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

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

req.pay_order_refund_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	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.cloudgame.tradeplatform.applypayorderrefund");
add_param(pRequest,"pay_order_refund_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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.cloudgame.tradeplatform.applypayorderrefund', {
	'pay_order_refund_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_cloudgame_tradeplatform_applypayorderrefund_response>
    <result_success>true</result_success>
    <error>
        <error_code>
            <code>1</code>
            <prefix>HP</prefix>
        </error_code>
        <location>1</location>
        <message>1</message>
    </error>
    <value>
        <huijin_refund_order_id>1</huijin_refund_order_id>
        <refund_status>1</refund_status>
    </value>
</alibaba_cloudgame_tradeplatform_applypayorderrefund_response>

{
    "alibaba_cloudgame_tradeplatform_applypayorderrefund_response":{
        "result_success":true,
        "error":{
            "error_code":{
                "code":"1",
                "prefix":"HP"
            },
            "location":"1",
            "message":"1"
        },
        "value":{
            "huijin_refund_order_id":1,
            "refund_status":"1"
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案

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

云游戏API

alibaba.cloudgame.tradeplatform.applypayorderrefund (订单退款)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ