追加冻结资金并发码（alipay.fund.auth.additional.freeze.voucher）

更新时间：2016/05/19 访问次数：4230

请求地址
请求参数
业务扩展参数
请求示例
XML同步返回参数
同步返回示例
异步通知参数
异步通知返回示例

请求地址

环境	HTTPS网关
正式环境	https://mapi.alipay.com/gateway.do

请求参数

参数	参数名称	类型（字节长度）	参数说明	是否为空	样例
基本参数
service	接口名称	String	接口名称。	不可空	alipay.fund.auth.additional.freeze.voucher
partner	合作者身份ID	String(16)	签约的支付宝账号对应的支付宝唯一用户号。以2088开头的16位纯数字组成。	不可空	2088101139804083
_input_charset	参数编码字符集	String	商户网站使用的编码格式，如utf-8、gbk、gb2312等。	不可空	gbk
sign_type	签名方式	String	RSA或MD5，必须大写。	不可空	MD5
sign	签名	String	请参见签名机制。	不可空	62b542ca01a471be2bd0174912a7b57f
notify_url	服务器异步通知页面路径	String(200)	支付宝服务器主动通知商户网站里指定的页面http路径。	可空	http://api.test.alipay.net/atinterface/receive_notify.htm
业务参数
auth_no	支付宝资金授权订单号	String(64)	需要追加冻结的支付宝资金授权订单号。	不可空	2014070700002001210000015646
out_request_no	商户请求流水号	String(64)	商户本次资金操作的请求流水号。同一商户每次不同的资金操作请求，商户请求流水号不能重复。	不可空	20140707001
amount	冻结金额	String	本次操作要追加冻结的金额，单位为：元（人民币）。取值范围：[0.01,100000000.00]。	不可空	1
remark	业务描述	String(100)	商户对本次追加冻结操作的附言描述。长度不超过100个字母或50个汉字。	不可空	0元购机
pay_timeout	支付超时	String	付款方超过该时间未付款，则自动关闭订单，不允许付款。商户需要收到支付宝的支付超时通知后，才能关闭自己的订单。否则支付成功通知到商户时，商户需要处理授权订单的解冻操作。取值范围：1m～15d。格式：m-分钟，h-小时，d-天。如果为空，则默认超时为7d。	可空	2d
extra_param	业务扩展参数	String	用于商户的特定业务信息的传递，json格式。参见业务扩展参数说明	可空	{"appId":"123","merchantExt":"key1=value1,key2=value2"}

业务扩展参数

参数	参数名称	类型（长度范围）	参数说明	是否可为空	样例
appId	公众账号ID	String	支付宝钱包中公众服务ID。用户在手机钱包内完成预授权操作后，可以跳转到商户自己的公众账号中。	可空	123
merchantExt	商户扩展信息	String	商户的扩展信息，会在查询资金授权订单时返回给商户。只有商户与支付宝约定了传递此参数且约定了参数含义，此参数才有效。建议格式：key1=value1,key2=value2	可空	key1=value1,key2=value2

请求示例

https://mapi.alipay.com/gateway.do?auth_no=2014070700002001210000015646&remark=0%D4%AA%B9%BA%BB%FA&sign_type=MD5&notify_url=http%3A%2F%2Fapi.test.alipay.net%2Fatinterface%2Freceive_notify.htm&sign=62b542ca01a471be2bd0174912a7b57f&amount=1&service=alipay.fund.auth.additional.freeze.voucher&out_request_no=20140707001&partner=2088101139804083&pay_timeout=1d&_input_charset=GBK

XML同步返回参数

参数	参数名称	类型（长度范围）	参数说明	是否可为空	样例
基本参数
is_success	是否成功	String	请求是否成功。请求成功不代表业务处理成功。 T代表成功 F代表失败	不可空	T
sign	签名	String	请参见签名机制	可空	1dcee8ec30a335132d10f9e6d22c77ab
sign_type	签名方式	String	RSA或MD5，必须大写。	可空	MD5
error	错误代码	String	请求成功时，不存在本参数；请求失败时，本参数为错误代码，参见错误码。	可空	ILLEGAL_SIGN
业务参数
result_code	处理结果码	String	处理结果代码。当处理结果码不是SUCCESS时，其他业务参数均可能为空！。请参见错误码。	不可空	SUCCESS
result_message	处理结果描述	String	详细描述处理失败的原因。请参见错误码;。	可空	超过最大冻结单数量
auth_no	支付宝资金授权订单号	String(64)	追加冻结的支付宝资金授权订单号。	不可空	2014070400002001210000015637
out_request_no	商户请求流水号	String(64)	商户本次资金操作的请求流水号。	不可空	20140702011
voucher_type	凭证类型	String(20)	目前仅支持：qrcode（二维码）。	不可空	qrcode
voucher_value	凭证内容	String(128)	凭证的内容。如果凭证类型为二维码，则内容为二维码码串。	不可空	https://qr.alipay.com/aa2yv818b5l6zvhc03
voucher_url	目标地址	String	根据预下单模式返回的地址。如：二维码地址、钱包唤醒地址等。	不可空	http://mobilecodec.stable.alipay.net/show.htm?code=aa2yv818b5l6zvhc03&picSize=M

同步返回示例

正常输出

<alipay>
    <is_success>T</is_success>
    <request>
        <param name="auth_no">2014070400002001210000015637</param>
        <param name="remark">0元购机</param>
        <param name="notify_url">http://api.test.alipay.net/atinterface/
receive_notify.htm</param>
        <param name="amount">2</param>
        <param name="service">alipay.fund.auth.additional.freeze.voucher</param>
        <param name="out_request_no">20140702011</param>
        <param name="partner">2088101139804083</param>
        <param name="pay_timeout">1d</param>
    </request>
    <response>
        <order>
            <auth_no>2014070400002001210000015637</auth_no>
            <out_request_no>20140702011</out_request_no>
            <result_code>SUCCESS</result_code>
            <voucher_type>qrCode</voucher_type>
            <voucher_url>http://mobilecodec.stable.alipay.net/
show.htm?code=aa2yv818b5l6zvhc03&picSize=M</voucher_url>
            <voucher_value>https://qr.alipay.com/aa2yv818b5l6zvhc03
</voucher_value>
        </order>
    </response>
    <sign>1dcee8ec30a335132d10f9e6d22c77ab</sign>
    <sign_type>MD5</sign_type>
</alipay>

业务处理发生错误时输出

<alipay>
<is_success>T</is_success>
<request>
    <param name="auth_no">2014070400002001210000015637</param>
    <param name="remark">0元购机</param>
    <param name="notify_url">http://api.test.alipay.net/atinterface/
receive_notify.htm</param>
    <param name="amount">2</param>
    <param name="service">alipay.fund.auth.additional.freeze.voucher</param>
    <param name="out_request_no">20140702013</param>
    <param name="partner">2088101139804083</param>
    <param name="pay_timeout">1d</param>
</request>
<response>
    <order>
        <result_code>EXCEED_MAX_FREEZE_NUM</result_code>
        <result_message>超过最大冻结单数量</result_message>
    </order>
</response>
<sign>5544f4db759c804cbbd621485537975f</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_freeze（资金授权订单冻结通知）。	不可空	fund_auth_freeze
notify_id	通知校验ID	String	通知校验ID。	不可空	df35c47ed9df1fe4157a555e5c1f4a39
sign_type	签名方式	String	签名方式如RSA、MD5。	不可空	DSA
sign	签名	String	请参见签名机制	不可空	b1af584504b8e845ebe40b8e0e733729
业务参数
auth_no	支付宝资金授权订单号	String(64)	支付宝资金授权订单号。	不可空	2014021601002000640012345678
out_order_no	商户授权资金订单号	String(64)	商户的授权资金订单号。	不可空	20140216001
total_freeze_amount	累计冻结金额	String	订单累计的冻结金额，单位为：元（人民币）。取值范围：[0.01,9999999999999.99]。	不可空	4800.00
total_unfreeze_amount	累计解冻金额	String	订单累计的解冻金额，单位为：元（人民币）。取值范围：[0.01,9999999999999.99]。	不可空	0.00
total_pay_amount	累计支付金额	String	订单累计用于支付的金额，单位为：元（人民币）。取值范围：[0.00,9999999999999.99]。	不可空	0.00
rest_amount	剩余冻结金额	String	订单总共剩余的冻结金额，单位为：元（人民币）。取值范围：[0.00,9999999999999.99]。	不可空	4600.00
order_status	支付宝订单状态	String(20)	支付宝订单的状态。目前包括： INIT：初始 AUTHORIZED：已授权 FINISH：完成 CLOSED：关闭	不可空	AUTHORIZED
operation_id	支付宝资金操作流水号	String	支付宝资金操作流水号。	不可空	2014021601002001640087654321
out_request_no	商户请求流水号	String	商户本次资金操作的请求流水号。	不可空	20140216001001
operation_type	操作类型	String	支付宝资金操作类型。本接口为FREEZE（冻结）。	不可空	FREEZE
amount	冻结金额	String	本次操作冻结的金额，单位为：元（人民币）。取值范围：[0.00,99999999.99]。	不可空	4800.00
status	操作流水状态	String	资金操作流水的状态。目前支持： INIT：初始 PROCESSING：处理中 SUCCESS：成功 FAIL：失败 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
target_order_no	目标业务单据号	String(64)	当操作类型为支付时，该字段标识该笔资金用于支付交易的交易号。	可空	2014010111001004390000105126
target_order_type	目标业务单据类型	String(20)	当操作类型为支付时，该字段标识target_order_no的类型。目前仅支持TRADE_NO（交易号）。	可空	TRADE_NO
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&notify_type=fund_auth_freeze&notify_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_unfreeze_amount=0.00&total_pay_amount=0.00&rest_amount=4600.00&order_status=AUTHORIZED&operation_id=2014021601002001640087654321&out_request_no=20140216001001&operation_type=FREEZE&amount=4800.00&status=SUCCESS&gmt_trans=2014-01-01+20%3A00%3A00&gmt_create=2014-01-01+20%3A00%3A00

FAQ

关于此文档暂时还没有FAQ

有用(0) 我要提问

淘宝开放平台

花呗预授权

追加冻结资金并发码（alipay.fund.auth.additional.freeze.voucher）

请求地址

请求参数

业务扩展参数

请求示例

XML同步返回参数

同步返回示例

异步通知参数

异步通知返回示例

FAQ