接口说明
接口名称:alipay.trade.close
用于交易创建后,用户在一定时间内未进行支付,可调用该接口直接将未付款的交易进行关闭。
公共请求参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|
app_id | String | 必选 | 32 | 支付宝分配给开发者的应用 ID | 2014072300007148 |
method | String | 必选 | 128 | 接口名称 | alipay.trade.close |
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 | 必选 | - | 请求参数集合。除公共参数外,所有请求参数都必须放在该参数中传递,具体参照各产品快速接入文档 | - |
业务请求参数
trade_no 与 out_trade_no 二选一传入,不能同时为空。若两者同时传入,以 trade_no 为准。
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|
trade_no | string | 二选一 | 64 | 该交易在支付宝系统中的交易流水号,最短 16 位,最长 64 位 | 与 out_trade_no 不能同时为空;若同时传入 out_trade_no 和 trade_no,以 trade_no 为准 | 2013112611001004680073956707 |
out_trade_no | string | 二选一 | 64 | 订单支付时传入的商户订单号 | 与支付宝交易号不能同时为空;若 trade_no、out_trade_no 同时存在,优先取 trade_no | HZ0120131127001 |
常见请求示例
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.trade.close&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={
"trade_no":"2013112611001004680073956707",
"out_trade_no":"HZ0120131127001",
"operator_id":"YX01"
}'
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.AlipayTradeCloseRequest;
import com.alipay.api.domain.AlipayTradeCloseModel;
import com.alipay.api.response.AlipayTradeCloseResponse;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;
public class AlipayTradeClose {
public static void main(String[] args) throws AlipayApiException {
// 初始化SDK
AlipayClient alipayClient = new DefaultAlipayClient(getAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeCloseRequest request = new AlipayTradeCloseRequest();
AlipayTradeCloseModel model = new AlipayTradeCloseModel();
// 设置该交易在支付宝系统中的交易流水号
model.setTradeNo("2013112611001004680073956707");
// 设置订单支付时传入的商户订单号
model.setOutTradeNo("HZ0120131127001");
// 设置商家操作员编号 id
model.setOperatorId("YX01");
request.setBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.putOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeCloseResponse 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 AlipayTradeClose
{
public static void Main(string[] args)
{
// 初始化SDK
IAopClient alipayClient = new DefaultAopClient(GetAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeCloseRequest request = new AlipayTradeCloseRequest();
AlipayTradeCloseModel model = new AlipayTradeCloseModel();
// 设置该交易在支付宝系统中的交易流水号
model.TradeNo = "2013112611001004680073956707";
// 设置订单支付时传入的商户订单号
model.OutTradeNo = "HZ0120131127001";
// 设置商家操作员编号 id
model.OperatorId = "YX01";
request.SetBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.PutOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeCloseResponse 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/AlipayTradeCloseRequest.php';
// 初始化SDK
$alipayClient = new AopClient(getAlipayConfig());
// 构造请求参数以调用接口
$request = new AlipayTradeCloseRequest();
$model = array();
// 设置该交易在支付宝系统中的交易流水号
$model['trade_no'] = "2013112611001004680073956707";
// 设置订单支付时传入的商户订单号
$model['out_trade_no'] = "HZ0120131127001";
// 设置商家操作员编号 id
$model['operator_id'] = "YX01";
$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;
}
const { AlipaySdk } = require("alipay-sdk");
const alipaySdk = new AlipaySdk({
appId: "<-- 请填写您的AppId,例如:2019091767145019 -->",
privateKey: "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->",
alipayPublicKey: "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->",
gateway: "https://openapi.alipay.com/gateway.do",
appAuthToken: "<-- 请填写应用授权令牌 -->",
});
const result = await alipaySdk.exec("alipay.trade.close", {
bizContent: {
trade_no: "2013112611001004680073956707",
out_trade_no: "HZ0120131127001",
operator_id: "YX01",
},
});
公共响应参数
| 参数 | 类型 | 是否必选 | 描述 | 示例值 |
|---|
| code | String | 必选 | 网关返回码,详见文档 | 40004 |
| msg | String | 必选 | 网关返回码描述,详见文档 | Business Failed |
| sub_code | String | 可选 | 业务返回码,参见具体的 API 接口文档 | ACQ.TRADE_HAS_SUCCESS |
| sub_msg | String | 可选 | 业务返回码描述,参见具体的 API 接口文档 | 交易已被支付 |
| sign | String | 必选 | 签名,详见文档 | DZXh8eeTuAHoYE3w1J… |
业务响应参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|
trade_no | string | 特殊可选 | 64 | 支付宝交易号 | - | 2013112111001004500000675971 |
out_trade_no | string | 特殊可选 | 64 | 创建交易传入的商户订单号 | - | YX_001 |
响应示例
{
"alipay_trade_close_response": {
"code": "10000",
"msg": "Success",
"trade_no": "2013112111001004500000675971",
"out_trade_no": "YX_001"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
{
"alipay_trade_close_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}
公共错误码
前往查看公共错误码
业务错误码
| 错误码 | 错误描述 | 解决方案 |
|---|
ACQ.INVALID_PARAMETER | 参数无效 | 检查请求参数,修改后重新发起请求 |
ACQ.REASON_ILLEGAL_STATUS | 交易状态异常 | 确认交易状态,非待支付状态下不支持关单操作 |
ACQ.REASON_TRADE_STATUS_INVALID | 交易状态异常 | 确认交易状态,非待支付状态下不支持关单操作 |
ACQ.SYSTEM_ERROR | 系统异常 | 重新发起请求 |
ACQ.TRADE_NOT_EXIST | 交易不存在 | 检查传入的交易号和外部订单号是否正确,修改后重新发起 |
ACQ.TRADE_STATUS_ERROR | 交易状态不合法 | 检查当前交易的状态是否为等待买家付款。只有等待买家付款状态下才能发起交易关闭 |
触发通知类型
| 通知类型 | 描述 | 默认开启 |
|---|
tradeStatus.TRADE_CLOSED | 交易关闭 | 1 |
tradeStatus.TRADE_SUCCESS | 交易成功 | 0 |
触发通知示例
https://www.merchant.com/receive_notify.htm?notify_type=trade_status_sync¬ify_id=91722adff935e8cfa58b3aabf4dead6ibe¬ify_time=2017-02-16 21:46:15&sign_type=RSA2&sign=WcO+t3D8Kg71dTlKwN7r9PzUOXeaBJwp8/FOuSxcuSkXsoVYxBpsAidprySCjHCjmaglNcjoKJQLJ28/Asl93joTW39FX6i07lXhnbPknezAlwmvPdnQuI01HZsZF9V1i6ggZjBiAd5lG8bZtTxZOJ87ub2i9GuJ3Nr/NUc9VeY=&trade_no=null&app_id=null&out_trade_no=null&out_biz_no=null&buyer_logon_id=null&seller_id=null&seller_email=null&trade_status=null&total_amount=null&refund_fee=null&subject=null&body=null&gmt_create=null&gmt_payment=null&gmt_refund=null&gmt_close=null&fund_bill_list=null&receipt_amount=null&invoice_amount=null&buyer_pay_amount=null&point_amount=null&buyer_id=null