alipay.fund.trans.common.query(转账业务单据查询接口) 在线调试(沙箱环境)

商户可通过该接口查询转账业务单据的状态,主要应用于统一转账接口(alipay.fund.trans.uni.transfer)和无线转账接口(alipay.fund.trans.app.pay)

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.fund.trans.common.query
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
product_code String 可选 64 销售产品码,商家和支付宝签约的产品码,如果传递了out_biz_no则该字段为必传。可传值如下:
STD_RED_PACKET:现金红包
TRANS_ACCOUNT_NO_PWD:单笔无密转账
STD_RED_PACKET
biz_scene String 可选 64 描述特定的业务场景,如果传递了out_biz_no则该字段为必传。可取的业务场景如下:
PERSONAL_PAY:C2C现金红包-发红包;
PERSONAL_COLLECTION:C2C现金红包-领红包;
REFUND:C2C现金红包-红包退回;
DIRECT_TRANSFER:B2C现金红包、单笔无密转账
PERSONAL_PAY
out_biz_no String 可选 64 商户转账唯一订单号:发起转账来源方定义的转账单据ID。
本参数和支付宝转账单据号、支付宝支付资金流水号三者不能同时为空。
当本参数和支付宝转账单据号、支付宝支付资金流水号同时提供时,将用支付宝支付资金流水号进行查询,忽略本参数;
当本参数和支付宝转账单据号同时提供时,将用支付宝转账单据号进行查询,忽略本参数;
201808080001
order_id String 可选 32 支付宝转账单据号:
本参数和商户转账唯一订单号、支付宝支付资金流水号三者不能同时为空。
当本参数和商户转账唯一订单号、支付宝支付资金流水号三者同时提供时,将用支付宝支付资金流水号进行查询,忽略其余两者;
当本参数和支付宝支付资金流水号同时提供时,将用支付宝支付资金流水号进行查询,忽略本参数。
当本参数和商户转账唯一订单号同时提供时,将用本参数进行查询,忽略商户转账唯一订单号。
20190801110070000006380000250621
pay_fund_order_id String 可选 32 支付宝支付资金流水号:
本参数和支付宝转账单据号、商户转账唯一订单号三者不能同时为空。
当本参数和支付宝转账单据号、商户转账唯一订单号同时提供时,将用本参数进行查询,忽略本参数;
当本参数和支付宝转账单据号同时提供时,将用本参数进行查询,忽略支付宝转账单据号;
当本参数和商户转账唯一订单号同时提供时,将用本参数进行查询,忽略商户转账唯一订单号;
20190801110070001506380000251556

响应参数

参数 类型 是否必填 最大长度 描述 示例值
order_id String 必填 32 支付宝转账单据号,查询失败不返回。 20190801110070000006380000250621
pay_fund_order_id String 选填 32 支付宝支付资金流水号,转账失败不返回。 20190801110070001506380000251556
out_biz_no String 必填 64 商户订单号 201808080001
trans_amount Price 选填 16 付款金额,收银台场景下付款成功后的支付金额,订单状态为SUCCESS才返回,其他状态不返回。 付款金额,单位为元,精确到小数点后两位:32.00
status String 必填 64 转账单据状态。可能出现的状态如下:
SUCCESS:转账成功;
WAIT_PAY:等待支付;
CLOSED:订单超时关闭

alipay.fund.trans.app.pay涉及的状态: WAIT_PAY、SUCCESS、CLOSED
alipay.fund.trans.uni.transfer、alipay.fund.trans.refund涉及的状态:SUCCESS
SUCCESS
pay_date String 选填 20 支付时间,格式为yyyy-MM-dd HH:mm:ss,转账失败不返回。 2013-01-01 08:08:08
arrival_time_end String 选填 20 预计到账时间,转账到银行卡专用,格式为yyyy-MM-dd HH:mm:ss,转账受理失败不返回。
注意:
此参数为预计时间,可能与实际到账时间有较大误差,不能作为实际到账时间使用,仅供参考用途。
2013-01-01 08:08:08
order_fee String 选填 20 预计收费金额(元),转账到银行卡专用,数字格式,精确到小数点后2位,转账失败或转账受理失败不返回。 0.02
error_code String 选填 64 查询到的订单状态为FAIL失败或REFUND退票时,返回错误代码 PAYEE_CARD_INFO_ERROR
fail_reason String 选填 128 查询到的订单状态为FAIL失败或REFUND退票时,返回具体的原因。 收款方银行卡信息有误
deduct_bill_info String 选填 1024 商户查询代扣订单信息时返回其在代扣请求中传入的账单属性 {"bizDesc":"代扣账单属性","bizNos":"M{529316162343612472}","billSource":"账房","bizOrigNo":"529316162343612472","reqSystem":"PointCenter"}
transfer_bill_info String 选填 1024 商户在查询代发订单信息时返回其在代发请求中传入的账单属性。 {"bizDesc":"代扣账单属性","bizNos":"M{529316162343612472}","billSource":"账房","bizOrigNo":"529316162343612472","reqSystem":"PointCenter"}

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayFundTransCommonQueryRequest request = new AlipayFundTransCommonQueryRequest();
request.setBizContent("{" +
"\"product_code\":\"STD_RED_PACKET\"," +
"\"biz_scene\":\"PERSONAL_PAY\"," +
"\"out_biz_no\":\"201808080001\"," +
"\"order_id\":\"20190801110070000006380000250621\"," +
"\"pay_fund_order_id\":\"20190801110070001506380000251556\"" +
"  }");
AlipayFundTransCommonQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_fund_trans_common_query_response": {
        "code": "10000",
        "msg": "Success",
        "order_id": "20190801110070000006380000250621",
        "pay_fund_order_id": "20190801110070001506380000251556",
        "out_biz_no": "201808080001",
        "trans_amount": 1,
        "status": "SUCCESS",
        "pay_date": "2013-01-01 08:08:08",
        "arrival_time_end": "2013-01-01 08:08:08",
        "order_fee": "0.02",
        "error_code": "PAYEE_CARD_INFO_ERROR",
        "fail_reason": "收款方银行卡信息有误",
        "deduct_bill_info": "{\"bizDesc\":\"代扣账单属性\",\"bizNos\":\"M{529316162343612472}\",\"billSource\":\"账房\",\"bizOrigNo\":\"529316162343612472\",\"reqSystem\":\"PointCenter\"}",
        "transfer_bill_info": "{\"bizDesc\":\"代扣账单属性\",\"bizNos\":\"M{529316162343612472}\",\"billSource\":\"账房\",\"bizOrigNo\":\"529316162343612472\",\"reqSystem\":\"PointCenter\"}"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_fund_trans_common_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
ORDER_NOT_EXIST 转账订单不存在 转账订单不存在的原因,可能是转账还在处理中,也可能是转账处理失败,导致转账订单没有落地。商户首先需要检查该订单号是否确实是自己发起的, 如果确认是自己发起的转账订单,请不要直接当作转账失败处理,请隔几分钟再尝试查询,或者通过相同的 out_biz_no 再次发起转账。如果误把还在转账处理中的订单直接当转账失败处理,商户自行承担因此而产生的所有损失。
INVALID_PARAMETER 参数有误请求参数有误 请确认商户订单号(out_biz_no)和支付宝单据号(order_id)至少一个不为空, 请确认销售产品码(product_code),和场景码(biz_scene)的取值
SYSTEM_ERROR 系统繁忙 支付宝系统处理异常,请稍后再试
INVALID_PARAMETER 参数有误参数有误 请参考接口文档确认传参是否正确
NO_ORDER_PERMISSION 当前操作用户没有该笔单据的操作权限 当前操作用户(requestUserId)与单据所属用户(partnerid)需要保持一致
onlineServer