淘宝开放平台

登录
文档中心 > API类目 > 资金API

alipay.fund.auth.operation.cancel (资金授权撤销接口)

只有商户由于业务系统处理超时需要终止后续业务处理或者授权结果未知时可调用撤销，其他正常授权冻结的操作如需实现相同功能请调用资金授权解冻服务。提交资金授权后调用【资金授权操作查询】，没有明确的授权结果再调用【资金授权撤销】

公共参数

请求地址：
环境 HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do
公共请求参数：
参数 类型 是否必填 最大长度 描述 示例值
app_id String 是 32 支付宝分配给开发者的应用ID 2014072300007148
method String 是 128 接口名称 alipay.fund.auth.operation.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 是 256 商户请求参数的签名串，详见签名 详见示例
timestamp String 是 19 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 是 3 调用的接口版本，固定为：1.0 1.0
notify_url String 否 256 支付宝服务器主动通知商户服务器里指定的页面http/https路径。 http://api.test.alipay.net/atinterface/receive_notify.htm
app_auth_token String 否 40 详见应用授权概述
biz_content String 是 - 请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
auth_no String 特殊可选 64 支付宝授权资金订单号，与商户的授权资金订单号不能同时为空，二者都存在时，以支付宝资金授权订单号为准，该参数与支付宝授权资金操作流水号配对使用。 2014070800002001550000014417
out_order_no String 特殊可选 64 商户的授权资金订单号，与支付宝的授权资金订单号不能同时为空，二者都存在时，以支付宝的授权资金订单号为准，该参数与商户的授权资金操作流水号配对使用。 4977164666634053
operation_id String 特殊可选 64 支付宝的授权资金操作流水号，与商户的授权资金操作流水号不能同时为空，二者都存在时，以支付宝的授权资金操作流水号为准，该参数与支付宝授权资金订单号配对使用。 20161012405744018102
out_request_no String 特殊可选 64 商户的授权资金操作流水号，与支付宝的授权资金操作流水号不能同时为空，二者都存在时，以支付宝的授权资金操作流水号为准，该参数与商户的授权资金订单号配对使用。 2016100810000003551
remark String 必须 100 商户对本次撤销操作的附言描述，长度不超过100个字母或50个汉字 授权撤销

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String 是 - 网关返回码,详见文档 40004
msg String 是 - 网关返回码描述,详见文档 Business Failed
sub_code String 否 - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String 否 - 业务返回码描述,详见文档 交易已被支付
sign String 是 - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值
auth_no String 必填 64 支付宝资金授权订单号。 2016101210002001810258115912
out_order_no String 必填 64 商户的授权资金订单号。 4977164666634053
operation_id String 必填 64 支付宝的冻结操作流水号。 20161012405744018102
out_request_no String 必填 64 商户的冻结操作流水号 。 234555553333444334
action String 选填 10 本次撤销触发的资金动作
close：关闭冻结明细，无资金解冻
unfreeze：产生了资金解冻 		close

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayFundAuthOperationCancelRequest request = new AlipayFundAuthOperationCancelRequest();
request.setBizContent("{" +
"\"auth_no\":\"2014070800002001550000014417\"," +
"\"out_order_no\":\"4977164666634053\"," +
"\"operation_id\":\"20161012405744018102\"," +
"\"out_request_no\":\"2016100810000003551\"," +
"\"remark\":\"授权撤销\"" +
"}");
AlipayFundAuthOperationCancelResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
1
2
3
4
5
6
7
8
9
10
11
12
{
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
    "alipay_fund_auth_operation_cancel_response":{
        "msg":"Success",
        "code":"10000",
        "out_order_no":"4977164666634053",
        "action":"close",
        "operation_id":"20161012405744018102",
        "out_request_no":"234555553333444334",
        "auth_no":"2016101210002001810258115912"
    }
}

异常示例

  • JSON示例
1
2
3
4
5
6
7
8
9
{
    "sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
    "alipay_fund_auth_operation_cancel_response":{
        "msg":"Service Currently Unavailable",
        "code":"20000",
        "sub_msg":"系统繁忙",
        "sub_code":"isp.unknow-error"
    }
}

业务错误码

错误码 错误描述 解决方案
ILLEGAL_ARGUMENT 参数异常或参数缺失 请求参数有错，重新检查请求后，再调用资金预授权明细撤销操作
ACCESS_FORBIDDEN 无权限使用接口 未签约条码支付或者合同已到期
PAYER_USER_STATUS_LIMIT 付款方状态受限 买家支付宝账户受限，请登录支付宝认证升级，详情咨询95188
ORDER_ALREADY_FINISH 授权订单已经完结，无法再进行资金操作 本笔授权订单已经完结，不允许进行资金撤销操作，确认请求资金解冻的资金授权订单号是否正确
CANCEL_OPERATION_TIME_OUT 撤销操作超过允许时间范围 撤销操作需要在预授权冻结操作之后的24小时之内发起
REQUEST_AMOUNT_EXCEED 撤销触发的解冻金额超过冻结金额 请商户确认该笔预授权单是否已发生过解冻操作，如若发生过，则无法再发起撤销操作
SYSTEM_ERROR 系统错误 请使用相同的参数再次调用

公共错误码

公共错误码

触发通知类型

通知类型 描述 默认开启
fund_auth_operation_cancel 资金预授权明细撤销 1

触发通知字段

参数 类型 是否必填 最大长度 描述 示例值
auth_no String 选填 - 支付宝资金授权订单号
out_order_no String 选填 - 商户的资金授权订单号
operation_id String 选填 - 支付宝资金操作流水号
out_request_no String 选填 - 商户资金操作流水号
action String 选填 - 本次撤销触发的资金动作
close：关闭冻结明细，无资金解冻
unfreeze：产生了资金解冻

触发通知示例

1
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=&auth_no=null&out_order_no=null&operation_id=null&out_request_no=null&action=null

异步通知验签方式

异步通知验签方式
有用(0)
我要提问
返回
顶部