环境 | HTTPS网关 |
正式环境 | https://mapi.alipay.com/gateway.do |
参数 | 参数名称 | 类型(字节长度) | 参数说明 | 是否可为空 | 样例 |
基本参数 | |||||
service | 接口名称 | String | 接口名称。 | 不可空 | alipay.fund.auth.close |
partner | 合作者身份ID | String(16) | 签约的支付宝账号对应的支付宝唯一用户号。以2088开头的16位纯数字组成。 | 不可空 | 2088001159940003 |
_input_charset | 参数编码字符集 | String | 商户网站使用的编码格式,如utf-8、gbk、gb2312等。 | 不可空 | GBK |
sign_type | 签名方式 | String | DSA、RSA、MD5三个值可选,必须大写。 | 不可空 | DSA |
sign | 签名 | String | 请参见 签名机制 | 不可空 | _p_w_l_h_j0b_gd_aejia7n_ko4_m%2Fu_w_jd3_nx_s_k_mxus9_hoxg_y_r_lunli_pmma29_t_q== |
notify_url | 服务器异步通知页面路径 | String(200) | 支付宝服务器主动通知商户网站里指定的页面http路径。 | 可空 | http://www.test.com/alipay/notify_url.php |
业务参数 | |||||
auth_no | 支付宝资金授权订单号 | String(64) | 支付宝资金授权订单号。 | 不可空 | 2014021601002000640012345678 |
operation_id | 支付宝资金操作流水号 | String(64) | 需要关闭的资金操作流水号。l 关闭操作明细时,本参数 不可空 ;l 批量关闭时,不可传本参数。 | 可空 | 2014021601002001640087654321 |
remark | 业务描述 | String(100) | 商户对本次关闭操作的附言描述。长度不超过100个字母或50个汉字。 | 不可空 | closeorder |
extra_param | 业务扩展参数 | String | 用于商户的特定业务信息的传递,json格式。只有商户与支付宝约定了传递此参数且约定了参数含义,此参数才有效。扩展参数,暂时未使用。 | 可空 | {"appId":"123" } |
https://mapi.alipay.com/gateway.do?service=alipay.fund.auth.close&partner=2088001159940003&_input_charset=GBK&sign_type=DSA&sign=_p_w_l_h_j0b_gd_aejia7n_ko4_m%252Fu_w_jd3_nx_s_k_mxus9_hoxg_y_r_lunli_pmma29_t_q%3D%3D¬ify_url=http%3A%2F%2Fwww.test.com%2Falipay%2Fnotify_url.php&auth_no=2014021601002000640012345678&remark=closeorder
参数 | 参数名称 | 类型(字节长度) | 参数说明 | 是否可为空 | 样例 |
基本参数 | |||||
is_success | 是否成功 | String | 请求是否成功。请求成功不代表业务处理成功。l T代表成功l F代表失败 | 不可空 | T |
sign | 签名 | String | 请参见 签名机制 | 可空 | 35708f05c2d87805234bff16751eca67 |
sign_type | 签名方式 | String | DSA、RSA、MD5三个值可选,必须大写。 | 可空 | MD5 |
error | 错误代码 | String | l 请求成功时,不存在本参数;l 请求失败时,本参数为错误代码,参见“10.2 接入错误码”和“10.3 系统错误码”。 | 可空 | ILLEGAL_SIGN |
业务参数 | |||||
result_code | 处理结果码 | String | 处理结果代码。当处理结果码不是SUCCESS时,其他业务参数均可能为空!请参见“10.1 资金授权订单关闭业务处理结果码”。 | 不可空 | SUCCESS |
result_message | 处理结果描述 | String | 详细描述处理失败的原因。请参见“10.1 资金授权订单关闭业务处理结果码”中的“含义”。 | 可空 | 非法参数 |
auth_no | 支付宝资金授权订单号 | String(64) | 支付宝资金授权订单号。 | 不可空 | 2014071100002001030000000800 |
order_status | 授权订单状态 | String | 授权订单的状态。l FINISH:订单结束,在整个授权单的生命周期中发生过解冻转支付成功的请求,关闭操作后,如果剩余冻结资金为0,推进总单状态为完成状态。l CLOSED:订单关闭,在整个授权单的生命周期中没有发生过解冻转支付成功的请求,关闭操作后,如果剩余冻结资金为0,推进总单状态为关闭状态。l AUTHORIZED:已经授权状态,关闭操作后,如果剩余冻结资金大于0,推进总单状态为已授权状态。 | 不可空 | CLOSED |
close_operation_list | 被关闭流水明细列表 | String | 被关闭的资金授权订单操作流水列表。可能包含多个<operation>子节点。<operation>节点参数请参见“表5-2 operation节点参数列表”。 | 可空 | 参见“5.3 样例”的“正常输出” |
operation_id | 支付宝资金操作流水号 | String | 支付宝资金操作流水号。 | 不可空 | 2014071100000803031 |
out_request_no | 商户请求流水号 | String | 商户资金操作的请求流水号。 | 不可空 | 1431313409 |
operation_type | 操作类型 | String | 支付宝资金操作类型。目前支持:l FREEZE:冻结l UNFREEZE:解冻l PAY:支付 | 不可空 | FREEZE |
正常输出
<alipay> <is_success>T</is_success> <request> <param name="auth_no">2014071100002001030000000800</param> <param name="service">alipay.fund.auth.close</param> <param name="remark">订单关闭</param> <param name="notify_url">http://api.test.alipay.net/atinterface/receive_notify.htm</param> <param name="partner">2088102112738609</param> <param name="_input_charset">GBK</param> </request> <response> <order> <auth_no>2014071100002001030000000800</auth_no> <order_status>CLOSED</order_status> <result_code>SUCCESS</result_code> <close_operation_list> <operation> <operation_id>2014071100000803031</operation_id> <operation_type>FREEZE</operation_type> <out_request_no>1431313409</out_request_no> </operation> <operation> <operation_id>2014071100000802031</operation_id> <operation_type>FREEZE</operation_type> <out_request_no>1431313410</out_request_no> </operation> </close_operation_list> </order> </response> <sign>35708f05c2d87805234bff16751eca67</sign> <sign_type>MD5</sign_type> </alipay>
业务处理发生错误时输出:
<alipay> <is_success>T</is_success> <request> <param name="auth_no">2014071100002001030000000800</param> <param name="service">alipay.fund.auth.close</param> <param name="remark">订单关闭</param> <param name="notify_url">http://api.test.alipay.net/atinterface/receive_notify.htm </param> <param name="partner">2088102112738609</param> <param name="_input_charset">GBK</param> </request> <response> <order> <close_operation_list /> <result_code>ILLEGAL_ARGUMENT</result_code> <result_message>非法参数</result_message> </order> </response> <sign>35708f05c2d87805234bff16751eca67</sign> <sign_type>MD5</sign_type> </alipay>
请求发生错误时输出:
<?xml version="1.0" encoding="utf-8"?> <alipay> <is_success>F</is_success> <error>ILLEGAL_SIGN</error> </alipay>
参数 | 参数名称 | 类型(字节长度) | 参数说明 | 是否可为空 | 样例 |
基本参数 | |||||
notify_time | 通知时间 | Date | 通知的发送时间。格式:YYYY-MM-DD HH:MM:SS。 | 不可空 | 2009-08-12 11:08:32 |
notify_type | 通知类型 | String | 通知的类型。本接口为固定值fund_auth_close(资金授权订单关闭通知)。 | 不可空 | fund_auth_close |
notify_id | 通知校验ID | String | 通知校验ID。 | 不可空 | df35c47ed9df1fe4157a555e5c1f4a39 |
sign_type | 签名方式 | String | 签名方式如DSA、RSA、MD5。 | 不可空 | DSA |
sign | 签名 | String | 请参见 签名机制 | 不可空 | b1af584504b8e845ebe40b8e0e733729 |
业务参数 | |||||
auth_no | 支付宝资金授权订单号 | String(64) | 支付宝资金授权订单号。 | 不可空 | 2014021601002000640012345678 |
order_status | 授权订单状态 | String(20) | 授权订单的状态。l FINISH:订单结束,在整个授权单的生命周期中发生过解冻转支付成功的请求,关闭操作后,如果剩余冻结资金为0,推进总单状态为完成状态。l CLOSED:订单关闭,在整个授权单的生命周期中没有发生过解冻转支付成功的请求,关闭操作后,如果剩余冻结资金为0,推进总单状态为关闭状态。l AUTHORIZED:已经授权状态,关闭操作后,如果剩余冻结资金大于0,推进总单状态为已授权状态。 | 不可空 | AUTHORIZED |
close_operation_list | 被关闭流水明细列表 | String | 被关闭的资金授权订单操作流水列表。String类型的字符串,可能包含多个流水记录,多条记录之间用“|”分隔,每条记录中的不同参数之间用“^”分隔。参数含义请参见“表5-2 operation节点参数列表”。 | 可空 | 2014101600024189211^ADD20141014001^FREEZE|2014101600024190211^ADD20141014002^FREEZE |
http://商户自定义地址/alipay/notify_url.php?notify_time=2009-08-12+11%3A08%3A32¬ify_type=fund_auth_close¬ify_id=df35c47ed9df1fe4157a555e5c1f4a39&sign_type=DSA&sign=b1af584504b8e845ebe40b8e0e733729&auth_no=2014021601002000640012345678&order_status=AUTHORIZED&close_operation_list=2014101600024189211%5EADD20141014001%5EFREEZE%7C2014101600024190211%5EADD20141014002%5EFREEZE