环境 | HTTPS网关 |
正式环境 | https://mapi.alipay.com/gateway.do |
参数 | 参数名称 | 类型(字节长度) | 参数说明 | 是否可为空 | 样例 |
基本参数 | |||||
service | 接口名称 | String | 接口名称。 | 不可空 | alipay.fund.auth.unfreeze |
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%252Fu_w_jd3_nx_s_k_mxus9_hoxg_y_r_lunli_pmma29_t_q%3D%3D |
notify_url | 服务器异步通知页面路径 | String(200) | 支付宝服务器主动通知商户网站里指定的页面http路径。 | 可空 | http://www.test.com/alipay/notify_url.php |
业务参数 | |||||
auth_no | 支付宝资金授权订单号 | String(64) | 支付宝资金授权订单号。 | 不可空 | 2014021601002000640012345678 |
out_request_no | 商户请求流水号 | String(64) | 商户本次资金操作的请求流水号。同一商户每次不同的资金操作请求,商户请求流水号不能重复。 | 不可空 | 20140216001002 |
amount | 解冻金额 | String | 本次操作解冻的金额,单位为:元(人民币)。取值范围:[0.01,100000000.00]。 | 不可空 | 200.00 |
remark | 业务描述 | String(100) | 商户对本次解冻操作的附言描述。长度不超过100个字母或50个汉字。 | 不可空 | 2014-05期解冻200.00元 |
https://mapi.alipay.com/gateway.do?service=alipay.fund.auth.unfreeze&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&out_request_no=20140216001002&amount=200.00&remark=2014-05%C6%DA%BD%E2%B6%B3200.00%D4%AA
参数 | 参数名称 | 类型(长度范围) | 参数说明 | 是否可为空 | 样例 | |
基本参数 | ||||||
is_success | 是否成功 | String | 请求是否成功。请求成功不代表业务处理成功。l T代表成功l F代表失败 | 不可空 | T | |
sign | 签名 | String | 请参见 签名机制 | 可空 | 8d34527bb746762b5ddc764e7fdea9af | |
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) | 支付宝资金授权订单号。 | 不可空 | 2014021601002000640012345678 | |
out_request_no | 商户请求流水号 | String | 商户本次操作的请求流水号,用作同一笔商户订单下的唯一性/幂等性约束。 | 不可空 | 20140216001001 | |
operation_id | 支付宝资金操作流水号 | String | 支付宝资金操作流水号。 | 不可空 | 2014021601002001640087654321 | |
gmt_create | 操作创建时间 | String | 资金授权单据操作创建时间。格式:YYYY-MM-DD HH:MM:SS。 | 不可空 | 2014-01-01 20:00:00 | |
gmt_trans | 操作处理成功时间 | String | 支付宝账务处理成功时间。格式:YYYY-MM-DD HH:MM:SS。 | 可空 | 2014-01-01 20:00:00 |
正常输出
<alipay> <is_success>T</is_success> <request> <param name="service">alipay.fund.auth.unfreeze</param> <param name="partner">2088001159940003</param> <param name="_input_charset ">GBK</param> <param name="sign_type">DSA</param> <param name="sign">_p_w_l_h_j0b_gd_aejia7n_ko4_m%2Fu_w_jd3_nx_s_k_mxus9_hoxg_y_r_lunli_pmma29_t_q==</param> <param name="notify_url">http://www.test.com/alipay/notify_url.php </param> <param name="auth_no">2014021601002000640012345678</param> <param name="out_request_no">20140216001002</param> <param name="amount">200.00</param> <param name="remark">2014-05期解冻200.00元</param> </request> <response> <order> <result_code>SUCCESS</result_code> <auth_no>2014021601002000640012345678</auth_no> <out_request_no>20140216001001</out_request_no> <operation_id>2014021601002001640087654321</operation_id> <gmt_trans>2014-01-01 20:00:00</gmt_trans> <gmt_create>2014-01-01 20:00:00</gmt_create> </order> </response> <sign>8d34527bb746762b5ddc764e7fdea9af</sign> <sign_type>MD5</sign_type> </alipay>
业务处理发生错误时输出:
<alipay> <is_success>T</is_success> <request> <param name="service">alipay.fund.auth.unfreeze</param> <param name="partner">2088001159940003</param> <param name="_input_charset ">GBK</param> <param name="sign_type">DSA</param> <param name="sign">_p_w_l_h_j0b_gd_aejia7n_ko4_m%2Fu_w_jd3_nx_s_k_mxus9_hoxg_y_r_lunli_pmma29_t_q== </param> <param name="notify_url">http://www.test.com/alipay/notify_url.php </param> <param name="auth_no">2014021601002000640012345678</param> <param name="out_request_no">20140216001002</param> <param name="amount">200.00</param> <param name="remark">2014-05期解冻200.00元</param> </request> <response> <order> <result_code>ILLEGAL_ARGUMENT</result_code> <result_message>非法参数</result_message> </order> </response> <sign>8d34527bb746762b5ddc764e7fdea9af</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_unfreeze(资金授权订单解冻通知)。 | 不可空 | fund_auth_unfreeze |
notify_id | 通知校验ID | String | 通知校验ID。 | 不可空 | df35c47ed9df1fe4157a555e5c1f4a39 |
sign_type | 签名方式 | String | 签名方式如DSA、RSA、MD5。 | 不可空 | DSA |
sign | 签名 | String | 请参见 签名机制 | 不可空 | b1af584504b8e845ebe40b8e0e733729 |
业务参数 | |||||
auth_no | 支付宝资金授权订单号 | String(64) | 支付宝资金授权订单号。 | 不可空 | 2014021601002000640012345678 |
out_order_no | 商户资金授权订单号 | String(64) | 商户的授权资金订单号。 | 不可空 | 20140216001 |
total_freeze_amount | 累计冻结金额 | String | 订单累计的冻结金额,单位为:元(人民币)。 | 不可空 | 4800.00 |
total_pay_amount | 累计支付金额 | String | 订单累计用于支付的金额,单位为:元(人民币)。 | 不可空 | 0.00 |
rest_amount | 剩余冻结金额 | String | 订单总共剩余的冻结金额,单位为:元(人民币)。 | 不可空 | 4600.00 |
order_status | 支付宝订单状态 | String(20) | 支付宝订单的状态。目前包括:l INIT:初始l AUTHORIZED:已授权l FINISH:完成l CLOSED:关闭 | 不可空 | AUTHORIZED |
operation_id | 支付宝资金操作流水号 | String | 支付宝资金操作流水号。 | 不可空 | 2014021601002001640087654321 |
out_request_no | 商户请求流水号 | String | 商户本次资金操作的请求流水号。 | 不可空 | 20140216001001 |
operation_type | 操作类型 | String | 支付宝资金操作类型。本接口为UNFREEZE(解冻)。 | 不可空 | UNFREEZE |
amount | 解冻金额 | String | 本次操作解冻的金额,单位为:元(人民币)。 | 不可空 | 4800.00 |
status | 操作流水状态 | String | 资金操作流水的状态。目前支持:l INIT:初始l PROCESSING:处理中l SUCCESS:成功l FAIL:失败l CLOSED:关闭 | 不可空 | SUCCESS |
gmt_create | 操作创建时间 | String | 资金授权单据操作创建时间。格式:YYYY-MM-DD HH:MM:SS。 | 不可空 | 2014-01-01 20:00:00 |
payer_logon_id | 付款方支付宝账号 | String(100) | 付款方支付宝账号(Email或手机号)。仅作展示使用,默认会加“*”号处理。 | 可空 | ali*@alipay.com |
payer_user_id | 付款方支付宝用户号 | String(32) | 付款方支付宝账号对应的支付宝唯一用户号。以2088开头的16位纯数字组成。 | 可空 | 2088402019148643 |
payee_logon_id | 收款方支付宝账号 | String(100) | 如果操作类型为支付,该字段标识当前操作收款方支付宝账号(Email或手机号)。商户请求支付时传递给交易的收款方信息。 | 可空 | test*@alipay.com |
payee_user_id | 收款方支付宝用户号 | String(32) | 如果操作类型为支付,该字段标识当前操作收款方支付宝账号对应的支付宝唯一用户号。以2088开头的16位纯数字组成。商户请求支付时传递给交易的收款方信息。 | 可空 | 2088400012341234 |
gmt_trans | 操作处理成功时间 | String | 支付宝账务处理成功时间。格式:YYYY-MM-DD HH:MM:SS。 | 可空 | 2014-01-01 20:00:00 |
http://商户自定义地址/alipay/notify_url.php?notify_time=2009-08-12+11%3A08%3A32¬ify_type=fund_auth_unfreeze¬ify_id=df35c47ed9df1fe4157a555e5c1f4a39&sign_type=DSA&sign=b1af584504b8e845ebe40b8e0e733729&auth_no=2014021601002000640012345678&out_order_no=20140216001&payer_logon_id=ali*%40alipay.com&payer_user_id=2088402019148643&total_freeze_amount=4800.00&total_pay_amount=0.00&rest_amount=4600.00&order_status=AUTHORIZED&operation_id=2014021601002001640087654321&out_request_no=20140216001001&operation_type=UNFREEZE&amount=4800.00&status=SUCCESS&gmt_trans=2014-01-01+20%3A00%3A00&gmt_create=2014-01-01+20%3A00%3A00