文档中心 > API类目 > 钉钉API

dingtalk.oapi.dingpay.order.terminate (中止订单支付)

中止dingpay订单的支付

公共参数

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

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
extension	Json	可选	map json		扩展信息
order_nos	String []	必须	123,321	最大列表长度：20	dingpay单号列表
operator	String	必须	12345		操作者员工号
reason	String	必须	REJECT		中止原因

响应参数

名称	类型	示例值	描述
result	OrderTerminationOpenResponse		result
terminate_result OrderTerminateResultItem [] 终止结果列表 └ order_no String 订单号 └ terminated Boolean 是否终止
errcode	Number	0	钉钉错误代码
errmsg	String		result
success	Boolean	true	是否成功

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/dingpay/order/terminate");
OapiDingpayOrderTerminateRequest req = new OapiDingpayOrderTerminateRequest();
req.setExtensionString("map json");
req.setOrderNos("123,321");
req.setOperator("12345");
req.setReason("REJECT");
OapiDingpayOrderTerminateResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/dingpay/order/terminate");
OapiDingpayOrderTerminateRequest req = new OapiDingpayOrderTerminateRequest();
req.Extension = "map json";
req.OrderNos = "123,321";
req.Operator = "12345";
req.Reason = "REJECT";
OapiDingpayOrderTerminateResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiDingpayOrderTerminateRequest;
$req->setExtension("map json");
$req->setOrderNos("123,321");
$req->setOperator("12345");
$req->setReason("REJECT");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/dingpay/order/terminate");

curl -X POST "https://oapi.dingtalk.com/topapi/dingpay/order/terminate" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2ca1b335-4a76-4b6a-9a47-5fc76b955c7f' \
-d 'extension=map+json' \
-d 'operator=12345' \
-d 'order_nos=123%2C321' \
-d 'reason=REJECT'

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

req=dingtalk.api.OapiDingpayOrderTerminateRequest("https://oapi.dingtalk.com/topapi/dingpay/order/terminate")

req.extension="map json"
req.order_nos="123,321"
req.operator="12345"
req.reason="REJECT"
try:
	resp= req.getResponse(access_token)
	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,"dingtalk.oapi.dingpay.order.terminate");
add_param(pRequest,"extension","map json");
add_param(pRequest,"order_nos","123,321");
add_param(pRequest,"operator","12345");
add_param(pRequest,"reason","REJECT");
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('dingtalk.oapi.dingpay.order.terminate', {
	'extension':'map json',
	'order_nos':'123,321',
	'operator':'12345',
	'reason':'REJECT'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":{
        "terminate_result":[
            {
                    "order_no":"",
                    "terminated":
            }
        ]
    },
    "errcode":0,
    "errmsg":"",
    "success":true
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.dingpay.order.terminate (中止订单支付)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ