淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
payer_id	Number	必须	2204239493205	买家阿里id
param1	StandardPayRequest	可选		支付请求对象
└ pay_time Date 可选 2017-12-12 12:12:12 本次支付请求时间 └ cashier_order_no String 可选 V2_53839f222cad42de8b34e166cc4e16be 收银单号 └ source String 可选 allin 请求来源 payer UserVO 可选 payer 买家信息 └ ali_id Number 可选 2204239493205 买家userId device_info DeviceVO 可选 deviceInfo deviceInfo └ pay_entrance String 可选 ALLIN_POS 支付入口 pay_tool_pay_infos PayToolPayVO [] 可选 payToolPayInfos 支付工具支付信息 └ pay_tool_code String 可选 ALLIN_POS_PAY 支付工具code └ pay_option_id String 可选 ALLIN_POS_PAY 支付选项ID(唯一编码) └ pay_actual_amount_currency String 可选 CNY 实际支付币种 └ pay_actual_amount Number 可选 1000 实际支付金额 └ pay_option_code String 可选 ALLIN_POS_PAY 支付工具code └ pay_amount Number 可选 1000 优惠前的付款金额，包含手续费等费用 └ pay_amount_currency String 可选 CNY pay_amount_currency └ actual_pay_amount Number 可选 1000 支付金额 └ biz_cashier_mode String 可选 POST_STANDARD_V2 收银模式 └ request_id String 可选 7555cc6f-e107-4839-9140-da04b8d6eb24 请求号 └ pay_currency String 可选 CNY 支付币种 term_pay_request_infos TermPayVO [] 可选 termPayRequestInfos 支付收单条款信息 └ checkout_order_no String 可选 11140600021091761034786493205 pp的收单号 └ pay_term_no String 可选 11140600121091753185818493205 pp的阶段号 └ pay_order_amount_currency String 可选 CNY 订单币种 └ pay_order_amount Number 可选 1000 订单支付金额 └ pay_mode String 必须 POST_STANDARD_V2 支付模式

名称	类型	示例值	描述
pay_instruction_no	String	pay_instruction_no	指令号
channel_error_message	String	channel_error_message	渠道错误信息
instrument_detail_map	Json	instrument_detail_map	渠道明细，payTermNo维度的
channel_error_code	String	channel_error_code	渠道错误码
response_code	String	B_PP_EXECUTE_SUCCESS	中台响应code
result_status	String	result_status	中台结果码
third_system_code	String	third_system_code	third_system_code
institution_code	String	ALLIN	机构编码
pay_option	String	ALLIN_POS_PAY	支付选项
response_message	String	response_message	中台响应信息
succeeded	Boolean	succeeded	是否成功
callback_url	String	支付回调url	支付回调url

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PaymentCashierAllinPayPayRequest req = new PaymentCashierAllinPayPayRequest();
req.setPayerId(2204239493205L);
PaymentCashierAllinPayPayRequest.StandardPayRequest obj1 = new PaymentCashierAllinPayPayRequest.StandardPayRequest();
obj1.setPayTime(StringUtils.parseDateTime("2017-12-12 12:12:12"));
obj1.setCashierOrderNo("V2_53839f222cad42de8b34e166cc4e16be");
obj1.setSource("allin");
PaymentCashierAllinPayPayRequest.UserVO obj2 = new PaymentCashierAllinPayPayRequest.UserVO();
obj2.setAliId(2204239493205L);
obj1.setPayer(obj2);
PaymentCashierAllinPayPayRequest.DeviceVO obj3 = new PaymentCashierAllinPayPayRequest.DeviceVO();
obj3.setPayEntrance("ALLIN_POS");
obj1.setDeviceInfo(obj3);
List<PaymentCashierAllinPayPayRequest.PayToolPayVO> list5 = new ArrayList<PaymentCashierAllinPayPayRequest.PayToolPayVO>();
PaymentCashierAllinPayPayRequest.PayToolPayVO obj6 = new PaymentCashierAllinPayPayRequest.PayToolPayVO();
list5.add(obj6);
obj6.setPayToolCode("ALLIN_POS_PAY");
obj6.setPayOptionId("ALLIN_POS_PAY");
obj6.setPayActualAmountCurrency("CNY");
obj6.setPayActualAmount(1000L);
obj6.setPayOptionCode("ALLIN_POS_PAY");
obj6.setPayAmount(1000L);
obj6.setPayAmountCurrency("CNY");
obj1.setPayToolPayInfos(list5);
obj1.setActualPayAmount(1000L);
obj1.setBizCashierMode("POST_STANDARD_V2");
obj1.setRequestId("7555cc6f-e107-4839-9140-da04b8d6eb24");
obj1.setPayCurrency("CNY");
List<PaymentCashierAllinPayPayRequest.TermPayVO> list8 = new ArrayList<PaymentCashierAllinPayPayRequest.TermPayVO>();
PaymentCashierAllinPayPayRequest.TermPayVO obj9 = new PaymentCashierAllinPayPayRequest.TermPayVO();
list8.add(obj9);
obj9.setCheckoutOrderNo("11140600021091761034786493205");
obj9.setPayTermNo("11140600121091753185818493205");
obj9.setPayOrderAmountCurrency("CNY");
obj9.setPayOrderAmount(1000L);
obj1.setTermPayRequestInfos(list8);
obj1.setPayMode("POST_STANDARD_V2");
req.setParam1(obj1);
PaymentCashierAllinPayPayResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
PaymentCashierAllinPayPayRequest req = new PaymentCashierAllinPayPayRequest();
req.PayerId = 2204239493205L;
PaymentCashierAllinPayPayRequest.StandardPayRequestDomain obj1 = new PaymentCashierAllinPayPayRequest.StandardPayRequestDomain();
obj1.PayTime = DateTime.Parse(2017-12-12 12:12:12");
obj1.CashierOrderNo = "V2_53839f222cad42de8b34e166cc4e16be";
obj1.Source = "allin";
PaymentCashierAllinPayPayRequest.UserVODomain obj2 = new PaymentCashierAllinPayPayRequest.UserVODomain();
obj2.AliId = 2204239493205L;
obj1.Payer= obj2;
PaymentCashierAllinPayPayRequest.DeviceVODomain obj3 = new PaymentCashierAllinPayPayRequest.DeviceVODomain();
obj3.PayEntrance = "ALLIN_POS";
obj1.DeviceInfo= obj3;
List<PaymentCashierAllinPayPayRequest.PayToolPayVODomain> list5 = new List<PaymentCashierAllinPayPayRequest.PayToolPayVODomain>();
PaymentCashierAllinPayPayRequest.PayToolPayVODomain obj6 = new PaymentCashierAllinPayPayRequest.PayToolPayVODomain();
list5.Add(obj6);
obj6.PayToolCode = "ALLIN_POS_PAY";
obj6.PayOptionId = "ALLIN_POS_PAY";
obj6.PayActualAmountCurrency = "CNY";
obj6.PayActualAmount = 1000L;
obj6.PayOptionCode = "ALLIN_POS_PAY";
obj6.PayAmount = 1000L;
obj6.PayAmountCurrency = "CNY";
obj1.PayToolPayInfos= list5;
obj1.ActualPayAmount = 1000L;
obj1.BizCashierMode = "POST_STANDARD_V2";
obj1.RequestId = "7555cc6f-e107-4839-9140-da04b8d6eb24";
obj1.PayCurrency = "CNY";
List<PaymentCashierAllinPayPayRequest.TermPayVODomain> list8 = new List<PaymentCashierAllinPayPayRequest.TermPayVODomain>();
PaymentCashierAllinPayPayRequest.TermPayVODomain obj9 = new PaymentCashierAllinPayPayRequest.TermPayVODomain();
list8.Add(obj9);
obj9.CheckoutOrderNo = "11140600021091761034786493205";
obj9.PayTermNo = "11140600121091753185818493205";
obj9.PayOrderAmountCurrency = "CNY";
obj9.PayOrderAmount = 1000L;
obj1.TermPayRequestInfos= list8;
obj1.PayMode = "POST_STANDARD_V2";
req.Param1_ = obj1;
PaymentCashierAllinPayPayResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new PaymentCashierAllinPayPayRequest;
$req->setPayerId("2204239493205");
$param1 = new StandardPayRequest;
$param1->pay_time="2017-12-12 12:12:12";
$param1->cashier_order_no="V2_53839f222cad42de8b34e166cc4e16be";
$param1->source="allin";
$payer = new UserVO;
$payer->ali_id="2204239493205";
$param1->payer = $payer;
$device_info = new DeviceVO;
$device_info->pay_entrance="ALLIN_POS";
$param1->device_info = $device_info;
$pay_tool_pay_infos = new PayToolPayVO;
$pay_tool_pay_infos->pay_tool_code="ALLIN_POS_PAY";
$pay_tool_pay_infos->pay_option_id="ALLIN_POS_PAY";
$pay_tool_pay_infos->pay_actual_amount_currency="CNY";
$pay_tool_pay_infos->pay_actual_amount="1000";
$pay_tool_pay_infos->pay_option_code="ALLIN_POS_PAY";
$pay_tool_pay_infos->pay_amount="1000";
$pay_tool_pay_infos->pay_amount_currency="CNY";
$param1->pay_tool_pay_infos = $pay_tool_pay_infos;
$param1->actual_pay_amount="1000";
$param1->biz_cashier_mode="POST_STANDARD_V2";
$param1->request_id="7555cc6f-e107-4839-9140-da04b8d6eb24";
$param1->pay_currency="CNY";
$term_pay_request_infos = new TermPayVO;
$term_pay_request_infos->checkout_order_no="11140600021091761034786493205";
$term_pay_request_infos->pay_term_no="11140600121091753185818493205";
$term_pay_request_infos->pay_order_amount_currency="CNY";
$term_pay_request_infos->pay_order_amount="1000";
$param1->term_pay_request_infos = $term_pay_request_infos;
$param1->pay_mode="POST_STANDARD_V2";
$req->setParam1(json_encode($param1));
$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=taobao.payment.cashier.allinPay.pay' \
-d 'partner_id=apidoc' \
-d 'sign=AFDEEA08772EE3A79E68B083D6F95DBF' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-03-03+22%3A28%3A05' \
-d 'v=2.0' \
-d 'param1=StandardPayRequest' \
-d 'payer_id=2204239493205'

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

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

req.payer_id=2204239493205
req.param1="StandardPayRequest"
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,"taobao.payment.cashier.allinPay.pay");
add_param(pRequest,"payer_id","2204239493205");
add_param(pRequest,"param1","数据结构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('taobao.payment.cashier.allinPay.pay', {
	'payer_id':'2204239493205',
	'param1':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<payment_cashier_allinPay_pay_response>
    <pay_instruction_no>pay_instruction_no</pay_instruction_no>
    <channel_error_message>channel_error_message</channel_error_message>
    <instrument_detail_map>instrument_detail_map</instrument_detail_map>
    <channel_error_code>channel_error_code</channel_error_code>
    <response_code>B_PP_EXECUTE_SUCCESS</response_code>
    <result_status>result_status</result_status>
    <third_system_code>third_system_code</third_system_code>
    <institution_code>ALLIN</institution_code>
    <pay_option>ALLIN_POS_PAY</pay_option>
    <response_message>response_message</response_message>
    <succeeded>succeeded</succeeded>
    <callback_url>支付回调url</callback_url>
</payment_cashier_allinPay_pay_response>

{
    "payment_cashier_allinPay_pay_response":{
        "pay_instruction_no":"pay_instruction_no",
        "channel_error_message":"channel_error_message",
        "instrument_detail_map":"instrument_detail_map",
        "channel_error_code":"channel_error_code",
        "response_code":"B_PP_EXECUTE_SUCCESS",
        "result_status":"result_status",
        "third_system_code":"third_system_code",
        "institution_code":"ALLIN",
        "pay_option":"ALLIN_POS_PAY",
        "response_message":"response_message",
        "succeeded":succeeded,
        "callback_url":"支付回调url"
    }
}

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

开放平台

pos交易api

taobao.payment.cashier.allinPay.pay (通联pos支付)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ