统一收单交易撤销接口
更新时间:
统一收单交易撤销接口
接口名称:alipay.trade.cancel
支付交易返回失败或支付系统超时时,可调用该接口撤销交易。如果该订单用户支付失败,支付宝系统会将订单关闭;如果用户支付成功,支付宝系统会将订单资金退还给用户。
注意:只有发生支付系统超时或支付结果未知时才可调用撤销。其他正常支付的订单如需实现相同功能,请调用申请退款 API。提交支付交易后,应先调用查询订单 API;没有明确支付结果时,再调用撤销订单 API。
公共请求参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
app_id | String | 必选 | 32 | 支付宝分配给开发者的应用 ID | 2014072300007148 |
method | String | 必选 | 128 | 接口名称 | alipay.trade.cancel |
format | String | 可选 | 40 | 仅支持 JSON | JSON |
charset | String | 必选 | 10 | 请求使用的编码格式,如 utf-8、gbk、gb2312 等 | utf-8 |
sign_type | String | 必选 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持 RSA2 和 RSA,推荐使用 RSA2 | RSA2 |
sign | String | 必选 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 必选 | 19 | 发送请求的时间,格式为 yyyy-MM-dd HH:mm:ss | 2014-07-24 03:07:50 |
version | String | 必选 | 3 | 调用的接口版本,固定为 1.0 | 1.0 |
app_auth_token | String | 可选 | 40 | 详见应用授权概述 | - |
biz_content | String | 必选 | - | 请求参数集合。除公共参数外,所有请求参数都必须放在该参数中传递 | - |
业务请求参数
out_trade_no与trade_no二选一传入,不能同时为空。
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|---|---|---|---|---|---|
out_trade_no | string | 二选一 | 1-64 | 原支付请求的商户订单号 | 与支付宝交易号不能同时为空 | 20150320010101001 |
trade_no | string | 二选一 | 1-64 | 支付宝交易号 | 与商户订单号不能同时为空 | 2014112611001004680073956707 |
常见请求示例
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.trade.cancel&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2×tamp=${now}' \
-F 'app_auth_token=${app_auth_token}' \
-F 'biz_content={
"out_trade_no":"20150320010101001",
"trade_no":"2014112611001004680073956707"
}'package com.java.sdk.demo;
import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.AlipayConfig;
import com.alipay.api.request.AlipayTradeCancelRequest;
import com.alipay.api.domain.AlipayTradeCancelModel;
import com.alipay.api.response.AlipayTradeCancelResponse;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;
public class AlipayTradeCancel {
public static void main(String[] args) throws AlipayApiException {
// 初始化SDK
AlipayClient alipayClient = new DefaultAlipayClient(getAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeCancelRequest request = new AlipayTradeCancelRequest();
AlipayTradeCancelModel model = new AlipayTradeCancelModel();
// 设置原支付请求的商户订单号
model.setOutTradeNo("20150320010101001");
// 设置支付宝交易号
model.setTradeNo("2014112611001004680073956707");
request.setBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.putOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeCancelResponse response = alipayClient.execute(request);
System.out.println(response.getBody());
if (response.isSuccess()) {
System.out.println("调用成功");
} else {
System.out.println("调用失败");
// sdk版本是"4.38.0.ALL"及以上,可以参考下面的示例获取诊断链接
// String diagnosisUrl = DiagnosisUtils.getDiagnosisUrl(response);
// System.out.println(diagnosisUrl);
}
}
private static AlipayConfig getAlipayConfig() {
String privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
String alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com/gateway.do");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey(privateKey);
alipayConfig.setFormat("json");
alipayConfig.setAlipayPublicKey(alipayPublicKey);
alipayConfig.setCharset("UTF-8");
alipayConfig.setSignType("RSA2");
return alipayConfig;
}
}using System;
using System.Collections.Generic;
using Aop.Api;
using Aop.Api.Request;
using Aop.Api.Response;
using Aop.Api.Domain;
using Aop.Api.Util;
namespace SdkDemoTest
{
public class AlipayTradeCancel
{
public static void Main(string[] args)
{
// 初始化SDK
IAopClient alipayClient = new DefaultAopClient(GetAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeCancelRequest request = new AlipayTradeCancelRequest();
AlipayTradeCancelModel model = new AlipayTradeCancelModel();
// 设置原支付请求的商户订单号
model.OutTradeNo = "20150320010101001";
// 设置支付宝交易号
model.TradeNo = "2014112611001004680073956707";
request.SetBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.PutOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeCancelResponse response = alipayClient.Execute(request);
if(!response.IsError)
{
Console.WriteLine("调用成功");
}
else
{
Console.WriteLine("调用失败");
}
}
private static AlipayConfig GetAlipayConfig()
{
string privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
string alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.ServerUrl = "https://openapi.alipay.com/gateway.do";
alipayConfig.AppId = "<-- 请填写您的AppId,例如:2019091767145019 -->";
alipayConfig.PrivateKey = privateKey;
alipayConfig.Format = "json";
alipayConfig.AlipayPublicKey = alipayPublicKey;
alipayConfig.Charset = "UTF-8";
alipayConfig.SignType = "RSA2";
return alipayConfig;
}
}
}<?php
require_once '../aop/AopClient.php';
require_once '../aop/AopCertClient.php';
require_once '../aop/AopCertification.php';
require_once '../aop/AlipayConfig.php';
require_once '../aop/request/AlipayTradeCancelRequest.php';
// 初始化SDK
$alipayClient = new AopClient(getAlipayConfig());
// 构造请求参数以调用接口
$request = new AlipayTradeCancelRequest();
$model = array();
// 设置原支付请求的商户订单号
$model['out_trade_no'] = "20150320010101001";
// 设置支付宝交易号
$model['trade_no'] = "2014112611001004680073956707";
$request->setBizContent(json_encode($model,JSON_UNESCAPED_UNICODE));
// 如果是第三方代调用模式,请设置app_auth_token(应用授权令牌)
$responseResult = $alipayClient->execute($request, null, "<-- 请填写应用授权令牌 -->", null);
$responseApiName = str_replace(".","_",$request->getApiMethodName())."_response";
$response = $responseResult->$responseApiName;
if(!empty($response->code)&&$response->code==10000){
echo("调用成功");
}
else{
echo("调用失败");
}
function getAlipayConfig()
{
$privateKey = '<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->';
$alipayPublicKey = '<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->';
$alipayConfig = new AlipayConfig();
$alipayConfig->setServerUrl('https://openapi.alipay.com/gateway.do');
$alipayConfig->setAppId('<-- 请填写您的AppId,例如:2019091767145019 -->');
$alipayConfig->setPrivateKey($privateKey);
$alipayConfig->setFormat('json');
$alipayConfig->setAlipayPublicKey($alipayPublicKey);
$alipayConfig->setCharset('UTF-8');
$alipayConfig->setSignType('RSA2');
return $alipayConfig;
}公共响应参数
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|---|---|---|---|
| code | String | 必选 | 网关返回码,详见文档 | 40004 |
| msg | String | 必选 | 网关返回码描述,详见文档 | Business Failed |
| sub_code | String | 可选 | 业务返回码,参见具体的 API 接口文档 | ACQ.TRADE_HAS_SUCCESS |
| sub_msg | String | 可选 | 业务返回码描述,参见具体的 API 接口文档 | 交易已被支付 |
| sign | String | 必选 | 签名,详见文档 | DZXh8eeTuAHoYE3w1J… |
业务响应参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|---|---|---|---|---|---|
out_trade_no | string | 必选 | 64 | 商户订单号 | - | 6823789339978248 |
retry_flag | string | 必选 | 1 | 是否需要重试 | - | N |
trade_no | string | 可选 | 64 | 支付宝交易号 | 当发生交易关闭或交易退款时返回 | 2013112011001004330000121536 |
action | string | 可选 | 10 | 本次撤销触发的交易动作 | 接口调用成功且交易存在时返回。close:交易未支付,触发关闭交易动作,无退款;refund:交易已支付,触发交易退款动作;未返回:未查询到交易,或接口调用失败 | close |
响应示例
正常示例
{
"alipay_trade_cancel_response": {
"code": "10000",
"msg": "Success",
"trade_no": "2013112011001004330000121536",
"out_trade_no": "6823789339978248",
"retry_flag": "N",
"action": "close"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
异常示例
{
"alipay_trade_cancel_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
公共错误码
业务错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
ACQ.CANCEL_NOT_ALLOWED | 交易不允许撤销 | 该笔交易不支持撤销 |
ACQ.INVALID_PARAMETER | 参数无效 | 请求参数有误,重新检查请求后再调用撤销 |
ACQ.REASON_TRADE_BEEN_FREEZEN | 当前交易被冻结,不允许进行撤销 | 联系支付宝小二,确认该笔交易的具体情况 |
ACQ.REASON_TRADE_REFUND_FEE_ERR | 退款金额无效 | 请确认交易是否已经发起过退款,已退款场景下不能再发起撤销 |
ACQ.SELLER_BALANCE_NOT_ENOUGH | 商户的支付宝账户中无足够的资金进行撤销 | 商户支付宝账户充值后重新发起撤销 |
ACQ.SYSTEM_ERROR | 系统异常 | 请过一段时间后重试 |
ACQ.TRADE_CANCEL_TIME_OUT | 超过撤销时间范围 | 交易超过撤销时间范围,可使用退款接口发起交易退款 |
ACQ.TRADE_HAS_FINISHED | 交易已经完结 | 交易已完结状态下不允许退款 |
AQC.SYSTEM_ERROR | 系统错误 | 请使用相同参数再次调用 |