淘宝开放平台

请求地址：

环境	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_channel_input	PayChannelInput	可选			支付通道计算输入参数
inner_coupons OtoTaobaoCoupon [] 可选淘宝优惠券 └ shop_code String 可选 abc 专柜编码 └ discount_fee Number 可选 123 券抵扣金额 └ coupon_name String 可选 xxx满减券优惠券名称 └ coupon_type String 可选 ump_offline 优惠券类型目前只有ump线下优惠券 └ coupon_id String 可选 1003 买家领取的优惠券ID └ start_date String 可选 2015-01-01 开始日期 └ end_date String 可选 2015-01-31 结束日期 └ promotion_fee Number 可选 123 券的优惠金额,目前喵街储值卡有这个功能 └ taobao_sales_id Number 可选 123 收银员淘宝账号 eticket_coupons OtoTaobaoCoupon [] 可选淘宝电子凭证代金券 └ shop_code String 可选 abc 专柜编码 └ discount_fee Number 可选 123 券抵扣金额 └ coupon_name String 可选 xxx满减券优惠券名称 └ coupon_type String 可选 ump_offline 优惠券类型目前只有ump线下优惠券 └ coupon_id String 可选 1003 买家领取的优惠券ID └ start_date String 可选 2015-01-01 开始日期 └ end_date String 可选 2015-01-31 结束日期 └ promotion_fee Number 可选 123 券的优惠金额,目前喵街储值卡有这个功能 pay_channel_list AcquireOrderPayChannel [] 可选支付通道数据 └ pay_channel String 可选余额宝支付渠道名 └ pay_fee Number 可选 100 买家使用该支付渠道，支付的金额，单位为分 └ buyer_id Number 可选 123 买家淘宝账号ID out_items OtoOutItem [] 可选外部商品数组 └ shop_code String 可选 abc 专柜编码 └ out_item_id String 可选 abc 外部商品ID └ item_name String 可选 abc 外部商品名字 └ price Number 可选 123 商品价格 └ quantity Number 可选 123 购买数量 └ shop_code String 可选 ab001 外部商家专柜编码

名称	类型	示例值	描述
results	PayChannelResult []		动态计算结果
tb_channel_list AcquireOrderPayChannel [] 淘宝系支付渠道 └ pay_channel String 余额宝支付渠道代码 └ pay_fee Number 100 买家使用该支付渠道，支付的金额，单位为分 └ pay_channel_name String 代金券支付渠道名字 └ promotion_fee Number 123 渠道优惠金额 ap_channel_list AcquireOrderPayChannel [] 支付宝系支付渠道 └ pay_channel String 余额宝支付渠道代码 └ pay_fee Number 100 买家使用该支付渠道，支付的金额，单位为分 └ pay_channel_name String 代金券支付渠道名字 └ promotion_fee Number 123 渠道优惠金额 └ tb_channel_promotion_fee Number 123 实际优惠金额(输入订单金额-实付金额) 单位分 └ tb_channel_buy_fee Number 123 所有优惠券的购买金额. 单位分 └ ap_channel_pay_fee Number 123 支付宝总的支付金额单位分

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OtoOrderPaychannelCalculateRequest req = new OtoOrderPaychannelCalculateRequest();
PayChannelInput obj1 = new PayChannelInput();
List<OtoTaobaoCoupon> list3 = new ArrayList<OtoTaobaoCoupon>();
OtoTaobaoCoupon obj4 = new OtoTaobaoCoupon();
list3.add(obj4);
obj4.setShopCode("abc");
obj4.setDiscountFee(123L);
obj4.setCouponName("xxx满减券");
obj4.setCouponType("ump_offline");
obj4.setCouponId("20001");
obj4.setStartDate("2015-01-01");
obj4.setEndDate("2015-01-31");
obj4.setPromotionFee(123L);
obj1.setInnerCoupons(list3);
obj1.setTaobaoSalesId(123L);
List<OtoTaobaoCoupon> list6 = new ArrayList<OtoTaobaoCoupon>();
OtoTaobaoCoupon obj7 = new OtoTaobaoCoupon();
list6.add(obj7);
obj7.setShopCode("abc");
obj7.setDiscountFee(123L);
obj7.setCouponName("xxx满减券");
obj7.setCouponType("ump_offline");
obj7.setCouponId("20001");
obj7.setStartDate("2015-01-01");
obj7.setEndDate("2015-01-31");
obj7.setPromotionFee(123L);
obj1.setEticketCoupons(list6);
List<AcquireOrderPayChannel> list9 = new ArrayList<AcquireOrderPayChannel>();
AcquireOrderPayChannel obj10 = new AcquireOrderPayChannel();
list9.add(obj10);
obj10.setPayChannel("余额宝");
obj10.setPayFee(100L);
obj1.setPayChannelList(list9);
obj1.setBuyerId(123L);
List<OtoOutItem> list12 = new ArrayList<OtoOutItem>();
OtoOutItem obj13 = new OtoOutItem();
list12.add(obj13);
obj13.setShopCode("abc");
obj13.setOutItemId("abc");
obj13.setItemName("abc");
obj13.setPrice(123L);
obj13.setQuantity(123L);
obj1.setOutItems(list12);
obj1.setShopCode("ab001");
req.setPayChannelInput(obj1);
OtoOrderPaychannelCalculateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OtoOrderPaychannelCalculateRequest req = new OtoOrderPaychannelCalculateRequest();
PayChannelInput obj1 = new PayChannelInput();
List<OtoTaobaoCoupon> list3 = new List<OtoTaobaoCoupon>();
OtoTaobaoCoupon obj4 = new OtoTaobaoCoupon();
list3.Add(obj4);
obj4.ShopCode = "abc";
obj4.DiscountFee = 123L;
obj4.CouponName = "xxx满减券";
obj4.CouponType = "ump_offline";
obj4.CouponId = "20001";
obj4.StartDate = "2015-01-01";
obj4.EndDate = "2015-01-31";
obj4.PromotionFee = 123L;
obj1.InnerCoupons= list3;
obj1.TaobaoSalesId = 123L;
List<OtoTaobaoCoupon> list6 = new List<OtoTaobaoCoupon>();
OtoTaobaoCoupon obj7 = new OtoTaobaoCoupon();
list6.Add(obj7);
obj7.ShopCode = "abc";
obj7.DiscountFee = 123L;
obj7.CouponName = "xxx满减券";
obj7.CouponType = "ump_offline";
obj7.CouponId = "20001";
obj7.StartDate = "2015-01-01";
obj7.EndDate = "2015-01-31";
obj7.PromotionFee = 123L;
obj1.EticketCoupons= list6;
List<AcquireOrderPayChannel> list9 = new List<AcquireOrderPayChannel>();
AcquireOrderPayChannel obj10 = new AcquireOrderPayChannel();
list9.Add(obj10);
obj10.PayChannel = "余额宝";
obj10.PayFee = 100L;
obj1.PayChannelList= list9;
obj1.BuyerId = 123L;
List<OtoOutItem> list12 = new List<OtoOutItem>();
OtoOutItem obj13 = new OtoOutItem();
list12.Add(obj13);
obj13.ShopCode = "abc";
obj13.OutItemId = "abc";
obj13.ItemName = "abc";
obj13.Price = 123L;
obj13.Quantity = 123L;
obj1.OutItems= list12;
obj1.ShopCode = "ab001";
req.PayChannelInput_ = obj1;
OtoOrderPaychannelCalculateResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OtoOrderPaychannelCalculateRequest;
$pay_channel_input = new PayChannelInput;
$inner_coupons = new OtoTaobaoCoupon;
$inner_coupons->shop_code="abc";
$inner_coupons->discount_fee="123";
$inner_coupons->coupon_name="xxx满减券";
$inner_coupons->coupon_type="ump_offline";
$inner_coupons->coupon_id="20001";
$inner_coupons->start_date="2015-01-01";
$inner_coupons->end_date="2015-01-31";
$inner_coupons->promotion_fee="123";
$pay_channel_input->inner_coupons = $inner_coupons;
$pay_channel_input->taobao_sales_id="123";
$eticket_coupons = new OtoTaobaoCoupon;
$eticket_coupons->shop_code="abc";
$eticket_coupons->discount_fee="123";
$eticket_coupons->coupon_name="xxx满减券";
$eticket_coupons->coupon_type="ump_offline";
$eticket_coupons->coupon_id="20001";
$eticket_coupons->start_date="2015-01-01";
$eticket_coupons->end_date="2015-01-31";
$eticket_coupons->promotion_fee="123";
$pay_channel_input->eticket_coupons = $eticket_coupons;
$pay_channel_list = new AcquireOrderPayChannel;
$pay_channel_list->pay_channel="余额宝";
$pay_channel_list->pay_fee="100";
$pay_channel_input->pay_channel_list = $pay_channel_list;
$pay_channel_input->buyer_id="123";
$out_items = new OtoOutItem;
$out_items->shop_code="abc";
$out_items->out_item_id="abc";
$out_items->item_name="abc";
$out_items->price="123";
$out_items->quantity="123";
$pay_channel_input->out_items = $out_items;
$pay_channel_input->shop_code="ab001";
$req->setPayChannelInput(json_encode($pay_channel_input));
$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=taobao.oto.order.paychannel.calculate' \
-d 'partner_id=apidoc' \
-d 'session=55335f88-63df-4f67-b153-ff2c71491b69' \
-d 'sign=BFB0EABB0E9DA8E4E708F8963181D101' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-07+12%3A07%3A39' \
-d 'v=2.0' \
-d 'pay_channel_input=null'

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

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

req.pay_channel_input="数据结构示例JSON格式"
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,"taobao.oto.order.paychannel.calculate");
add_param(pRequest,"pay_channel_input","数据结构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('taobao.oto.order.paychannel.calculate', {
	'pay_channel_input':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<oto_order_paychannel_calculate_response>
    <results>
        <pay_channel_result>
            <tb_channel_list>
                <acquire_order_pay_channel>
                    <pay_channel>余额宝</pay_channel>
                    <pay_fee>100</pay_fee>
                    <pay_channel_name>代金券</pay_channel_name>
                    <promotion_fee>123</promotion_fee>
                </acquire_order_pay_channel>
            </tb_channel_list>
            <ap_channel_list>
                <acquire_order_pay_channel>
                    <pay_channel>余额宝</pay_channel>
                    <pay_fee>100</pay_fee>
                    <pay_channel_name>代金券</pay_channel_name>
                    <promotion_fee>123</promotion_fee>
                </acquire_order_pay_channel>
            </ap_channel_list>
            <tb_channel_promotion_fee>123</tb_channel_promotion_fee>
            <tb_channel_buy_fee>123</tb_channel_buy_fee>
            <ap_channel_pay_fee>123</ap_channel_pay_fee>
        </pay_channel_result>
    </results>
</oto_order_paychannel_calculate_response>

{
    "oto_order_paychannel_calculate_response":{
        "results":{
            "pay_channel_result":[
                {
                    "tb_channel_list":{
                        "acquire_order_pay_channel":[
                            {
                                "pay_channel":"余额宝",
                                "pay_fee":100,
                                "pay_channel_name":"代金券",
                                "promotion_fee":123
                            }
                        ]
                    },
                    "ap_channel_list":{
                        "acquire_order_pay_channel":[
                            {
                                "pay_channel":"余额宝",
                                "pay_fee":100,
                                "pay_channel_name":"代金券",
                                "promotion_fee":123
                            }
                        ]
                    },
                    "tb_channel_promotion_fee":123,
                    "tb_channel_buy_fee":123,
                    "ap_channel_pay_fee":123
                }
            ]
        }
    }
}

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

taobao.oto.order.paychannel.calculate (o2o支付通道金额计算)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ