alipay.trade.fastpay.refund.query(统一收单交易退款查询)

商户可使用该接口查询自已通过alipay.trade.refund提交的退款请求是否执行成功。 该接口的返回码10000,仅代表本次查询操作成功,不代表退款成功。如果该接口返回了查询数据,则代表退款成功,如果没有查询到则代表未退款成功,可以调用退款接口进行重试。重试时请务必保证退款请求号一致。

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.trade.fastpay.refund.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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
trade_no String 特殊可选 64 支付宝交易号,和商户订单号不能同时为空 20150320010101001
out_trade_no String 特殊可选 64 订单支付时传入的商户订单号,和支付宝交易号不能同时为空。 trade_no,out_trade_no如果同时存在优先取trade_no 2014112611001004680073956707
out_request_no String 必选 64 请求退款接口时,传入的退款请求号,如果在退款请求时未传入,则该值为创建交易时的外部交易号 2014112611001004680073956707
org_pid String 可选 16 银行间联模式下有用,其它场景请不要使用;
双联通过该参数指定需要查询的交易所属收单机构的pid;
2088101117952222

响应参数

参数 类型 是否必填 最大长度 描述 示例值
trade_no String 选填 64 支付宝交易号 2014112611001004680073956707
out_trade_no String 选填 64 创建交易传入的商户订单号 20150320010101001
out_request_no String 选填 64 本笔退款对应的退款请求号 20150320010101001
refund_reason String 选填 256 发起退款时,传入的退款原因 用户退款请求
total_amount Price 选填 11 该笔退款所对应的交易的订单金额 100.20
refund_amount Price 选填 11 本次退款请求,对应的退款金额 12.33
refund_royaltys RefundRoyaltyResult 选填 退分账明细信息
refund_amount Price 必填 9 退分账金额 10
royalty_type String 可选 32 分账类型.
普通分账为:transfer;
补差为:replenish;
为空默认为分账transfer;
transfer
result_code String 必填 32 退分账结果码 SUCCESS
trans_out String 可选 28 转出人支付宝账号对应用户ID 2088102210397302
trans_out_email String 可选 64 转出人支付宝账号 alipay-test03@alipay.com
trans_in String 可选 28 转入人支付宝账号对应用户ID 2088102210397302
trans_in_email String 可选 64 转入人支付宝账号 zen_gwen@hotmail.com
gmt_refund_pay Date 选填 32 退款时间;
默认不返回该信息,需与支付宝约定后配置返回;
2014-11-27 15:45:57
refund_detail_item_list TradeFundBill 选填 本次退款使用的资金渠道;
默认不返回该信息,需与支付宝约定后配置返回;
fund_channel String 必填 32 交易使用的资金渠道,详见 支付渠道列表 ALIPAYACCOUNT
amount Price 必填 32 该支付工具类型所使用的金额 10
real_amount Price 可选 11 渠道实际付款金额 11.21
fund_type String 可选 32 渠道所使用的资金类型,目前只在资金渠道(fund_channel)是银行卡渠道(BANKCARD)的情况下才返回该信息(DEBIT_CARD:借记卡,CREDIT_CARD:信用卡,MIXED_CARD:借贷合一卡) DEBIT_CARD
send_back_fee String 选填 11 本次商户实际退回金额;
默认不返回该信息,需与支付宝约定后配置返回;
88
refund_charge_amount String 选填 11 本次退款针对收款方的退收费金额;
默认不返回该信息,需与支付宝约定后配置返回;
8.88
refund_settlement_id String 选填 64 退款清算编号,用于清算对账使用;
只在银行间联交易场景下返回该信息;
2018101610032004620239146945
present_refund_buyer_amount String 选填 11 本次退款金额中买家退款金额 88.88
present_refund_discount_amount String 选填 11 本次退款金额中平台优惠退款金额 88.88
present_refund_mdiscount_amount String 选填 11 本次退款金额中商家优惠退款金额 88.88

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayTradeFastpayRefundQueryRequest request = new AlipayTradeFastpayRefundQueryRequest();
request.setBizContent("{" +
"\"trade_no\":\"20150320010101001\"," +
"\"out_trade_no\":\"2014112611001004680073956707\"," +
"\"out_request_no\":\"2014112611001004680073956707\"," +
"\"org_pid\":\"2088101117952222\"" +
"  }");
AlipayTradeFastpayRefundQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_trade_fastpay_refund_query_response": {
        "code": "10000",
        "msg": "Success",
        "trade_no": "2014112611001004680073956707",
        "out_trade_no": "20150320010101001",
        "out_request_no": "20150320010101001",
        "refund_reason": "用户退款请求",
        "total_amount": 100.2,
        "refund_amount": 12.33,
        "refund_royaltys": [
            {
                "refund_amount": 10,
                "royalty_type": "transfer",
                "result_code": "SUCCESS",
                "trans_out": "2088102210397302",
                "trans_out_email": "alipay-test03@alipay.com",
                "trans_in": "2088102210397302",
                "trans_in_email": "zen_gwen@hotmail.com"
            }
        ],
        "gmt_refund_pay": "2014-11-27 15:45:57",
        "refund_detail_item_list": [
            {
                "fund_channel": "ALIPAYACCOUNT",
                "amount": 10,
                "real_amount": 11.21,
                "fund_type": "DEBIT_CARD"
            }
        ],
        "send_back_fee": "88",
        "refund_charge_amount": "8.88",
        "refund_settlement_id": "2018101610032004620239146945",
        "present_refund_buyer_amount": "88.88",
        "present_refund_discount_amount": "88.88",
        "present_refund_mdiscount_amount": "88.88"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
ACQ.SYSTEM_ERROR 系统错误 重新发起请求
ACQ.INVALID_PARAMETER 参数无效 检查请求参数,修改后重新发起请求
TRADE_NOT_EXIST 查询退款的交易不存在 确认交易号是否为正确的支付宝交易号,修改后重新查询
onlineServer