统一收单交易关闭接口

更新时间:

接口说明

接口名称:alipay.trade.close

用于交易创建后,用户在一定时间内未进行支付,可调用该接口直接将未付款的交易进行关闭。

公共请求参数

参数类型是否必选最大长度描述示例值
app_idString必选32支付宝分配给开发者的应用 ID2014072300007148
methodString必选128接口名称alipay.trade.close
formatString可选40仅支持 JSONJSON
charsetString必选10请求使用的编码格式,如 utf-8gbkgb2312utf-8
sign_typeString必选10商户生成签名字符串所使用的签名算法类型,目前支持 RSA2RSA,推荐使用 RSA2RSA2
signString必选344商户请求参数的签名串,详见签名详见示例
timestampString必选19发送请求的时间,格式为 yyyy-MM-dd HH:mm:ss2014-07-24 03:07:50
versionString必选3调用的接口版本,固定为 1.01.0
app_auth_tokenString可选40详见应用授权概述-
biz_contentString必选-请求参数集合。除公共参数外,所有请求参数都必须放在该参数中传递,具体参照各产品快速接入文档-

业务请求参数

trade_noout_trade_no 二选一传入,不能同时为空。若两者同时传入,以 trade_no 为准。

参数类型是否必选最大长度描述注意事项/枚举值示例值
trade_nostring二选一64该交易在支付宝系统中的交易流水号,最短 16 位,最长 64 位out_trade_no 不能同时为空;若同时传入 out_trade_notrade_no,以 trade_no 为准2013112611001004680073956707
out_trade_nostring二选一64订单支付时传入的商户订单号与支付宝交易号不能同时为空;若 trade_noout_trade_no 同时存在,优先取 trade_noHZ0120131127001

常见请求示例

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&timestamp=${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",
  },
});

公共响应参数

参数类型是否必选描述示例值
codeString必选网关返回码,详见文档40004
msgString必选网关返回码描述,详见文档Business Failed
sub_codeString可选业务返回码,参见具体的 API 接口文档ACQ.TRADE_HAS_SUCCESS
sub_msgString可选业务返回码描述,参见具体的 API 接口文档交易已被支付
signString必选签名,详见文档DZXh8eeTuAHoYE3w1J…

业务响应参数

参数类型是否必选最大长度描述注意事项/枚举值示例值
trade_nostring特殊可选64支付宝交易号-2013112111001004500000675971
out_trade_nostring特殊可选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&notify_id=91722adff935e8cfa58b3aabf4dead6ibe&notify_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