商户可以查询资金授权订单相关信息。
环境 | HTTPS网关 |
正式环境 | https://mapi.alipay.com/gateway.do |
参数 |
参数名称 |
类型(字节长度) |
参数说明 |
是否为空 |
样例 |
基本参数 |
|||||
service |
接口名称 |
String |
接口名称。 |
不可空 |
alipay.fund.auth.query |
partner |
合作者身份ID |
String(16) |
签约的支付宝账号对应的支付宝唯一用户号。 以2088开头的16位纯数字组成。 |
不可空 |
2088001159940003 |
_input_charset |
参数编码字符集 |
String |
商户网站使用的编码格式,如utf-8、gbk、gb2312等。 |
不可空 |
GBK |
sign_type |
签名方式 |
String |
RSA或MD5,必须大写。 |
不可空 |
RSA |
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 |
业务参数 |
|||||
auth_no |
支付宝资金授权订单号 |
String(64) |
支付宝资金授权订单号。 auth_no和out_order_no不能同时为空。如果本字段非空则优先以本字段进行查询。 |
可空 |
2014031600002001260000001000 |
out_order_no |
商户资金授权订单号 |
String(64) |
商户的授权资金订单号。 auth_no和out_order_no不能同时为空。 |
可空 |
20140216001 |
https://mapi.alipay.com/gateway.do?service=alipay.fund.auth.query&partner=2088001159940003&_input_charset=GBK&sign_type=DSA&sign=_p_w_l_h_j0b_gd_aejia7n_ko4_m%2Fu_w_jd3_nx_s_k_mxus9_hoxg_y_r_lunli_pmma29_t_q==&auth_no=2014031600002001260000001000&out_order_no=20140216001
参数 |
参数名称 |
类型(长度范围) |
参数说明 |
是否为空 |
样例 |
基本参数 |
|||||
is_success |
是否成功 |
String |
请求是否成功。请求成功不代表业务处理成功。 l T代表成功 l F代表失败 |
不可空 |
T |
sign |
签名 |
String |
请参见“签名机制”。 |
可空 |
8d34527bb746762b5ddc764e7fdea9af |
sign_type |
签名方式 |
String |
RSA或MD5,必须大写。 |
可空 |
MD5 |
error |
错误代码 |
String |
l 请求成功时,不存在本参数; l 请求失败时,本参数为错误代码,参见“接入错误码”和“系统错误码”。 |
可空 |
ILLEGAL_SIGN |
业务参数 |
|||||
result_code |
处理结果码 |
String |
处理结果代码。当处理结果码不是SUCCESS时,其他业务参数均可能为空!。 请参见“资金授权订单查询业务处理结果码”。 |
可空 |
SUCCESS |
result_message |
处理结果描述 |
String |
详细描述处理失败的原因。 请参见“资金授权订单查询业务处理结果码”中的“含义”。 |
可空 |
非法参数 |
auth_no |
支付宝资金授权订单号 |
String(64) |
支付宝资金授权订单号。 |
不可空 |
2014031600002001260000001000 |
out_order_no |
商户资金授权订单号 |
String(64) |
商户的授权资金订单号。 |
不可空 |
20140216001 |
product_code |
业务产品码 |
String(50) |
对应销售产品,商户签约时,由支付宝统一分配。 |
不可空 |
BUY_FOR_FREE |
scene_code |
业务场景码 |
String(50) |
对应业务场景,商户签约时,由支付宝统一分配 。 |
不可空 |
BUY_IPHONE_FOR_FREE |
total_freeze_amount |
累计冻结金额 |
String |
订单累计的冻结金额,单位为:元(人民币)。 |
不可空 |
4800.00 |
total_unfreeze_amount |
累计解冻金额 |
String |
订单累计的解冻金额,单位为:元(人民币)。 |
不可空 |
0.00 |
total_pay_amount |
累计支付金额 |
String |
订单累计用于支付的金额,单位为:元(人民币)。 |
不可空 |
0.00 |
rest_amount |
剩余冻结金额 |
String |
订单总共剩余的冻结金额,单位为:元(人民币)。 |
不可空 |
4600.00 |
order_status |
支付宝订单状态 |
String |
支付宝订单的状态。目前包括:INIT:初始、AUTHORIZED:已授权、FINISH:完成、CLOSED:关闭 |
不可空 |
AUTHORIZED |
gmt_create |
操作创建时间 |
String |
资金授权单据操作创建时间。 格式:YYYY-MM-DD HH:MM:SS。 |
不可空 |
2014-01-01 20:00:00 |
order_title |
订单标题 |
String(100) |
业务订单的简单描述,如商品名称等。 |
可空 |
0元购土豪金 |
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 |
expire_time |
业务结束时间 |
String |
订单到期时间,只做展示用,到期支付宝不自动解冻剩余资金。 格式:YYYY-MM-DD HH:MM。 |
可空 |
2015-01-01 00:00 |
extra_param/p> |
业务扩展参数 |
String(300) |
商户请求创建预授权订单时传入的扩展参数。 仅返回商户自定义的扩展信息(merchantExt)。 |
可空 |
{"merchantExt":"key1=value1,key2=value2"} |
<alipay> <is_success>T</is_success> <request> <param name="service">alipay.fund.auth.query</param> <param name="partner">2088001159940003</param> <param name="_input_charset ">GBK</param> <param name="auth_no">2014031600002001260000001000</param> <param name="out_order_no">20140216001</param> </request> <response> <order> <result_code>SUCCESS</result_code> <auth_no>2014031600002001260000001000</auth_no> <out_order_no>20140216001</out_order_no> <product_code>BUY_FOR_FREE</product_code> <scene_code>BUY_IPHONE_FOR_FREE</scene_code> <order_title>0元购土豪金</order_title> <payer_logon_id>ali*@alipay.com</payer_logon_id> <payer_user_id>2088402019148643</payer_user_id> <total_freeze_amount>4800.00</total_freeze_amount> <total_unfreeze_amount>0.00</total_unfreeze_amount> <total_pay_amount>0.00</total_pay_amount> <rest_amount>4600.00</rest_amount> <order_status>AUTHORIZED</order_status> <expire_time>2015-01-01 00:00</expire_time> <gmt_create>2014-01-01 20:00:00</gmt_create> <extra_param>{"merchantExt":"key1=value1,key2=value2"} </extra_param> </order> </response> <sign>8d34527bb746762b5ddc764e7fdea9af</sign> <sign_type>MD5</sign_type> </alipay>
业务处理发生错误输出
<alipay> <is_success>T</is_success> <request> <param name="service">alipay.fund.auth.query</param> <param name="partner">2088001159940003</param> <param name="_input_charset ">GBK</param> <param name="auth_no">2014031600002001260000001000</param> <param name="out_order_no">20140216001</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>