淘宝开放平台

请求地址：

环境	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_callback_notify_request	PayCallbackNotifyRequest	可选			通知请求入参
└ message String 必须 { "headers": "{\"Wechatpay-Timestamp\":\"1667195507\",\"Wechatpay-Nonce\":\"nGWqiHk0htIctHEgbsfADtoxMWP3vPcs\",\"Wechatpay-Signature\":\"o5LjWqW7b3uRHg0u5LB8IXFftRJA2YIZa4b9OHWuNQ1h8VmXukrf8taJIPEcGrElEVC0cM86f5TlKAo+N4PIFaJpgFbKBHjS0bK3/tHzPm6I9nzU379L4xwpkwioyAV6U6/3PjGgAem+7ayk8y+FdB1KYMqwBh0YxMzZIttMjpYGzSj0DHZGddr76TpXRpHF4vUxzQFJQLhZcVLoDEkjo77e3WpCfYZX0i7zUbDt7ggw5o0CyHwkjRMx3db8OvIucA9OkeiHASodqv+qDT45xgtzvN4C4ViyqKtvlngiIYLHtOMfVZZXokyX4vfI+MUkSVe7+SBaV5x82ORHn7Ltlg==\"}", "body": "{\"id\":\"f6b5b18a-c0ef-5048-a62b-c211e41e7ea6\",\"create_time\":\"2022-10-31T13:51:44+08:00\",\"resource_type\":\"encrypt-resource\",\"event_type\":\"PAYSCORE.USER_CONFIRM\",\"summary\":\"微信支付分服务订单用户已确认\",\"resource\":{\"original_type\":\"payscore\",\"algorithm\":\"AEAD_AES_256_GCM\",\"ciphertext\":\"lwKJMMlKIZB9zn3g+vrW3PVmRPb6dhvr8oSxzAt9Fw1JkQ4uXXFpjWwTmzxaENTvod/dcNnErlhEFuKJBgXa+gkE8Kdg4n1nXzja72jEllDZh9Uj7toShmz4Np+8M2fdrhHE52B7N68IyeEibf9xwVu0LKog6f0ogvw30lEh0SNZLt9GLXR22kwkunN93xvQJfxsMoA+DIi6J+a4dI6lMOLIhBW8EaKOieW7CSgDvmpZ284pjzUWjTrW/O1rbF1kmz8k2IU2gFST9cPPfDkZ88bxEF0oAi7raQdx8zxfJZi8Qnot1K+oGU4OiXzbxNA/KXuD1eBqgBugj0+3d4AEHMKCV9hM4c0JNfh2p3/w7r1HQ7AqDjTzHCeAcI64wwubxFttEMQ0OUjihRRZ+Qn4bzt82OsKXoyJklXo6EjZ/fpuTdW491rUOg/FtxXXOsFf23iwMAHrLPlXF/M9FcmjztzgxI0nQ7HNCxbIvaTFud2yGlII9mikRTGcefUQlpuo490fK5Iy1eUmVnjC9k8l4AAixP64mzXQCqdlCEhicXaj/C5UY2RkPwd+KRFMOLguTZ5wuNeqTS/+v7edrEJXgeQQjDE0dyPa70+o0YV9sdrVQffYKoxkKE053kfzHF4VHcux8g7Bi7XktNDCE0XCbkOt/+IH79airk7y7h9NfU37RtHHFWwaUCY0zJLMbzvNdu896PZjPrTJnTd7wKlS9rMW1nm+SDOaWNW92/fc83+2LbBcKTa14ANUP8hva81ARg==\",\"associated_data\":\"payscore\",\"nonce\":\"O1Hbt220LhPQ\"}}" } 通知消息 └ channel_code String 必须 1001 通知渠道

名称	类型	示例值	描述
result	String	{ "code": "SUCCESS", "message": "接收成功" }	返回值

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
YunosBanmapayChannelNotifyRequest req = new YunosBanmapayChannelNotifyRequest();
YunosBanmapayChannelNotifyRequest.PayCallbackNotifyRequest obj1 = new YunosBanmapayChannelNotifyRequest.PayCallbackNotifyRequest();
obj1.setMessage("{ 	\"headers\": \"{\\"Wechatpay-Timestamp\\":\\"1667195507\\",\\"Wechatpay-Nonce\\":\\"nGWqiHk0htIctHEgbsfADtoxMWP3vPcs\\",\\"Wechatpay-Signature\\":\\"o5LjWqW7b3uRHg0u5LB8IXFftRJA2YIZa4b9OHWuNQ1h8VmXukrf8taJIPEcGrElEVC0cM86f5TlKAo+N4PIFaJpgFbKBHjS0bK3/tHzPm6I9nzU379L4xwpkwioyAV6U6/3PjGgAem+7ayk8y+FdB1KYMqwBh0YxMzZIttMjpYGzSj0DHZGddr76TpXRpHF4vUxzQFJQLhZcVLoDEkjo77e3WpCfYZX0i7zUbDt7ggw5o0CyHwkjRMx3db8OvIucA9OkeiHASodqv+qDT45xgtzvN4C4ViyqKtvlngiIYLHtOMfVZZXokyX4vfI+MUkSVe7+SBaV5x82ORHn7Ltlg==\\"}\", 	\"body\": \"{\\"id\\":\\"f6b5b18a-c0ef-5048-a62b-c211e41e7ea6\\",\\"create_time\\":\\"2022-10-31T13:51:44+08:00\\",\\"resource_type\\":\\"encrypt-resource\\",\\"event_type\\":\\"PAYSCORE.USER_CONFIRM\\",\\"summary\\":\\"微信支付分服务订单用户已确认\\",\\"resource\\":{\\"original_type\\":\\"payscore\\",\\"algorithm\\":\\"AEAD_AES_256_GCM\\",\\"ciphertext\\":\\"lwKJMMlKIZB9zn3g+vrW3PVmRPb6dhvr8oSxzAt9Fw1JkQ4uXXFpjWwTmzxaENTvod/dcNnErlhEFuKJBgXa+gkE8Kdg4n1nXzja72jEllDZh9Uj7toShmz4Np+8M2fdrhHE52B7N68IyeEibf9xwVu0LKog6f0ogvw30lEh0SNZLt9GLXR22kwkunN93xvQJfxsMoA+DIi6J+a4dI6lMOLIhBW8EaKOieW7CSgDvmpZ284pjzUWjTrW/O1rbF1kmz8k2IU2gFST9cPPfDkZ88bxEF0oAi7raQdx8zxfJZi8Qnot1K+oGU4OiXzbxNA/KXuD1eBqgBugj0+3d4AEHMKCV9hM4c0JNfh2p3/w7r1HQ7AqDjTzHCeAcI64wwubxFttEMQ0OUjihRRZ+Qn4bzt82OsKXoyJklXo6EjZ/fpuTdW491rUOg/FtxXXOsFf23iwMAHrLPlXF/M9FcmjztzgxI0nQ7HNCxbIvaTFud2yGlII9mikRTGcefUQlpuo490fK5Iy1eUmVnjC9k8l4AAixP64mzXQCqdlCEhicXaj/C5UY2RkPwd+KRFMOLguTZ5wuNeqTS/+v7edrEJXgeQQjDE0dyPa70+o0YV9sdrVQffYKoxkKE053kfzHF4VHcux8g7Bi7XktNDCE0XCbkOt/+IH79airk7y7h9NfU37RtHHFWwaUCY0zJLMbzvNdu896PZjPrTJnTd7wKlS9rMW1nm+SDOaWNW92/fc83+2LbBcKTa14ANUP8hva81ARg==\\",\\"associated_data\\":\\"payscore\\",\\"nonce\\":\\"O1Hbt220LhPQ\\"}}\" }");
obj1.setChannelCode("1001");
req.setPayCallbackNotifyRequest(obj1);
YunosBanmapayChannelNotifyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
YunosBanmapayChannelNotifyRequest req = new YunosBanmapayChannelNotifyRequest();
YunosBanmapayChannelNotifyRequest.PayCallbackNotifyRequestDomain obj1 = new YunosBanmapayChannelNotifyRequest.PayCallbackNotifyRequestDomain();
obj1.Message = "{ 	\"headers\": \"{\\"Wechatpay-Timestamp\\":\\"1667195507\\",\\"Wechatpay-Nonce\\":\\"nGWqiHk0htIctHEgbsfADtoxMWP3vPcs\\",\\"Wechatpay-Signature\\":\\"o5LjWqW7b3uRHg0u5LB8IXFftRJA2YIZa4b9OHWuNQ1h8VmXukrf8taJIPEcGrElEVC0cM86f5TlKAo+N4PIFaJpgFbKBHjS0bK3/tHzPm6I9nzU379L4xwpkwioyAV6U6/3PjGgAem+7ayk8y+FdB1KYMqwBh0YxMzZIttMjpYGzSj0DHZGddr76TpXRpHF4vUxzQFJQLhZcVLoDEkjo77e3WpCfYZX0i7zUbDt7ggw5o0CyHwkjRMx3db8OvIucA9OkeiHASodqv+qDT45xgtzvN4C4ViyqKtvlngiIYLHtOMfVZZXokyX4vfI+MUkSVe7+SBaV5x82ORHn7Ltlg==\\"}\", 	\"body\": \"{\\"id\\":\\"f6b5b18a-c0ef-5048-a62b-c211e41e7ea6\\",\\"create_time\\":\\"2022-10-31T13:51:44+08:00\\",\\"resource_type\\":\\"encrypt-resource\\",\\"event_type\\":\\"PAYSCORE.USER_CONFIRM\\",\\"summary\\":\\"微信支付分服务订单用户已确认\\",\\"resource\\":{\\"original_type\\":\\"payscore\\",\\"algorithm\\":\\"AEAD_AES_256_GCM\\",\\"ciphertext\\":\\"lwKJMMlKIZB9zn3g+vrW3PVmRPb6dhvr8oSxzAt9Fw1JkQ4uXXFpjWwTmzxaENTvod/dcNnErlhEFuKJBgXa+gkE8Kdg4n1nXzja72jEllDZh9Uj7toShmz4Np+8M2fdrhHE52B7N68IyeEibf9xwVu0LKog6f0ogvw30lEh0SNZLt9GLXR22kwkunN93xvQJfxsMoA+DIi6J+a4dI6lMOLIhBW8EaKOieW7CSgDvmpZ284pjzUWjTrW/O1rbF1kmz8k2IU2gFST9cPPfDkZ88bxEF0oAi7raQdx8zxfJZi8Qnot1K+oGU4OiXzbxNA/KXuD1eBqgBugj0+3d4AEHMKCV9hM4c0JNfh2p3/w7r1HQ7AqDjTzHCeAcI64wwubxFttEMQ0OUjihRRZ+Qn4bzt82OsKXoyJklXo6EjZ/fpuTdW491rUOg/FtxXXOsFf23iwMAHrLPlXF/M9FcmjztzgxI0nQ7HNCxbIvaTFud2yGlII9mikRTGcefUQlpuo490fK5Iy1eUmVnjC9k8l4AAixP64mzXQCqdlCEhicXaj/C5UY2RkPwd+KRFMOLguTZ5wuNeqTS/+v7edrEJXgeQQjDE0dyPa70+o0YV9sdrVQffYKoxkKE053kfzHF4VHcux8g7Bi7XktNDCE0XCbkOt/+IH79airk7y7h9NfU37RtHHFWwaUCY0zJLMbzvNdu896PZjPrTJnTd7wKlS9rMW1nm+SDOaWNW92/fc83+2LbBcKTa14ANUP8hva81ARg==\\",\\"associated_data\\":\\"payscore\\",\\"nonce\\":\\"O1Hbt220LhPQ\\"}}\" }";
obj1.ChannelCode = "1001";
req.PayCallbackNotifyRequest_ = obj1;
YunosBanmapayChannelNotifyResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new YunosBanmapayChannelNotifyRequest;
$pay_callback_notify_request = new PayCallbackNotifyRequest;
$pay_callback_notify_request->message="{ 	\"headers\": \"{\\"Wechatpay-Timestamp\\":\\"1667195507\\",\\"Wechatpay-Nonce\\":\\"nGWqiHk0htIctHEgbsfADtoxMWP3vPcs\\",\\"Wechatpay-Signature\\":\\"o5LjWqW7b3uRHg0u5LB8IXFftRJA2YIZa4b9OHWuNQ1h8VmXukrf8taJIPEcGrElEVC0cM86f5TlKAo+N4PIFaJpgFbKBHjS0bK3/tHzPm6I9nzU379L4xwpkwioyAV6U6/3PjGgAem+7ayk8y+FdB1KYMqwBh0YxMzZIttMjpYGzSj0DHZGddr76TpXRpHF4vUxzQFJQLhZcVLoDEkjo77e3WpCfYZX0i7zUbDt7ggw5o0CyHwkjRMx3db8OvIucA9OkeiHASodqv+qDT45xgtzvN4C4ViyqKtvlngiIYLHtOMfVZZXokyX4vfI+MUkSVe7+SBaV5x82ORHn7Ltlg==\\"}\", 	\"body\": \"{\\"id\\":\\"f6b5b18a-c0ef-5048-a62b-c211e41e7ea6\\",\\"create_time\\":\\"2022-10-31T13:51:44+08:00\\",\\"resource_type\\":\\"encrypt-resource\\",\\"event_type\\":\\"PAYSCORE.USER_CONFIRM\\",\\"summary\\":\\"微信支付分服务订单用户已确认\\",\\"resource\\":{\\"original_type\\":\\"payscore\\",\\"algorithm\\":\\"AEAD_AES_256_GCM\\",\\"ciphertext\\":\\"lwKJMMlKIZB9zn3g+vrW3PVmRPb6dhvr8oSxzAt9Fw1JkQ4uXXFpjWwTmzxaENTvod/dcNnErlhEFuKJBgXa+gkE8Kdg4n1nXzja72jEllDZh9Uj7toShmz4Np+8M2fdrhHE52B7N68IyeEibf9xwVu0LKog6f0ogvw30lEh0SNZLt9GLXR22kwkunN93xvQJfxsMoA+DIi6J+a4dI6lMOLIhBW8EaKOieW7CSgDvmpZ284pjzUWjTrW/O1rbF1kmz8k2IU2gFST9cPPfDkZ88bxEF0oAi7raQdx8zxfJZi8Qnot1K+oGU4OiXzbxNA/KXuD1eBqgBugj0+3d4AEHMKCV9hM4c0JNfh2p3/w7r1HQ7AqDjTzHCeAcI64wwubxFttEMQ0OUjihRRZ+Qn4bzt82OsKXoyJklXo6EjZ/fpuTdW491rUOg/FtxXXOsFf23iwMAHrLPlXF/M9FcmjztzgxI0nQ7HNCxbIvaTFud2yGlII9mikRTGcefUQlpuo490fK5Iy1eUmVnjC9k8l4AAixP64mzXQCqdlCEhicXaj/C5UY2RkPwd+KRFMOLguTZ5wuNeqTS/+v7edrEJXgeQQjDE0dyPa70+o0YV9sdrVQffYKoxkKE053kfzHF4VHcux8g7Bi7XktNDCE0XCbkOt/+IH79airk7y7h9NfU37RtHHFWwaUCY0zJLMbzvNdu896PZjPrTJnTd7wKlS9rMW1nm+SDOaWNW92/fc83+2LbBcKTa14ANUP8hva81ARg==\\",\\"associated_data\\":\\"payscore\\",\\"nonce\\":\\"O1Hbt220LhPQ\\"}}\" }";
$pay_callback_notify_request->channel_code="1001";
$req->setPayCallbackNotifyRequest(json_encode($pay_callback_notify_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=yunos.banmapay.channel.notify' \
-d 'partner_id=apidoc' \
-d 'sign=EDEB10D028380BCA430A6C646D8EFF55' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-23+23%3A02%3A04' \
-d 'v=2.0' \
-d 'pay_callback_notify_request=null'

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

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

req.pay_callback_notify_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,"yunos.banmapay.channel.notify");
add_param(pRequest,"pay_callback_notify_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('yunos.banmapay.channel.notify', {
	'pay_callback_notify_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<yunos_banmapay_channel_notify_response>
    <result>{   &quot;code&quot;: &quot;SUCCESS&quot;,   &quot;message&quot;: &quot;接收成功&quot; }</result>
</yunos_banmapay_channel_notify_response>

{
    "yunos_banmapay_channel_notify_response":{
        "result":"{   \"code\": \"SUCCESS\",   \"message\": \"接收成功\" }"
    }
}

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下载

AliOS支付API

yunos.banmapay.channel.notify (支付回调通知)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ