统一收单交易撤销接口
注意:只有发生支付系统超时或者支付结果未知时可调用撤销,其他正常支付的单如需实现相同功能请调用申请退款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 | String | 二选一 | 长度范围:[1,64] | 原支付请求的商户订单号,和支付宝交易号不能同时为空 | 20150320010101001 |
trade_no | String | 长度范围:[1,64] | 支付宝交易号,和商户订单号不能同时为空 | 2014112611001004680073956707 |
公共响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 必选 | - | 网关返回码,详见文档 | 40004 |
msg | String | 必选 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 可选 | - | 业务返回码,参见具体的API接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 可选 | - | 业务返回码描述,参见具体的API接口文档 | 交易已被支付 |
sign | String | 必选 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
响应参数
参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
trade_no | String | 必选 | 64 | 支付宝交易号; 当发生交易关闭或交易退款时返回; | 2013112011001004330000121536 |
out_trade_no | String | 必选 | 64 | 商户订单号 | 6823789339978248 |
retry_flag | String | 必选 | 1 | 是否需要重试 | N |
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 | 系统错误 | 请使用相同的参数再次调用 |