统一收单交易退款查询接口
更新时间:
接口说明
接口名称:alipay.trade.fastpay.refund.query
商户可使用该接口查询自己通过 alipay.trade.refund 提交的退款请求是否执行成功。
注意事项
- 该接口返回码
10000仅代表本次查询操作成功,不代表退款成功。当接口返回的refund_status值为REFUND_SUCCESS时,表示退款成功;否则表示退款没有执行成功。 - 如果退款未成功,商户可以调用退款接口重试。重试时请务必保证退款请求号和退款金额一致,防止重复退款。
- 发起退款查询接口的时间不能离退款请求时间太短,建议间隔 10 秒以上。
公共请求参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
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与out_trade_no二选一传入,不能同时为空。两者同时存在时,优先使用trade_no。
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|---|---|---|---|---|---|
out_request_no | string | 必选 | 64 | 退款请求号 | 请求退款接口时传入的退款请求号;如果退款请求时未传入,则该值为创建交易时的商户订单号 | HZ01RF001 |
trade_no | string | 二选一 | 64 | 支付宝交易号 | 与商户订单号不能同时为空 | 2021081722001419121412730660 |
out_trade_no | string | 二选一 | 64 | 商户订单号,订单支付时传入 | 与支付宝交易号不能同时为空;trade_no、out_trade_no 同时存在时,优先取 trade_no | 2014112611001004680073956707 |
请求示例
curl 'https://openapi.alipay.com/gateway.do?charset=UTF-8&method=alipay.trade.fastpay.refund.query&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=RSA2×tamp=${now}' \
-F 'app_auth_token=${app_auth_token}' \
-F 'biz_content={
"trade_no":"2021081722001419121412730660",
"out_trade_no":"2014112611001004680073956707",
"out_request_no":"HZ01RF001",
"query_options":[
"refund_detail_item_list"
]
}'package com.java.sdk.demo;
import com.alipay.api.AlipayApiException;
import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import com.alipay.api.AlipayConfig;
import com.alipay.api.domain.AlipayTradeFastpayRefundQueryModel;
import com.alipay.api.response.AlipayTradeFastpayRefundQueryResponse;
import com.alipay.api.request.AlipayTradeFastpayRefundQueryRequest;
import com.alipay.api.FileItem;
import java.util.Base64;
import java.util.ArrayList;
import java.util.List;
public class AlipayTradeFastpayRefundQuery {
public static void main(String[] args) throws AlipayApiException {
// 初始化SDK
AlipayClient alipayClient = new DefaultAlipayClient(getAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeFastpayRefundQueryRequest request = new AlipayTradeFastpayRefundQueryRequest();
AlipayTradeFastpayRefundQueryModel model = new AlipayTradeFastpayRefundQueryModel();
// 设置支付宝交易号
model.setTradeNo("2021081722001419121412730660");
// 设置商户订单号
model.setOutTradeNo("2014112611001004680073956707");
// 设置退款请求号
model.setOutRequestNo("HZ01RF001");
// 设置查询选项
List<String> queryOptions = new ArrayList<String>();
queryOptions.add("refund_detail_item_list");
model.setQueryOptions(queryOptions);
request.setBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.putOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeFastpayRefundQueryResponse response = alipayClient.execute(request);
System.out.println(response.getBody());
if (response.isSuccess()) {
System.out.println("调用成功");
} else {
System.out.println("调用失败");
// sdk版本是"4.38.0.ALL"及以上,可以参考下面的示例获取诊断链接
// String diagnosisUrl = DiagnosisUtils.getDiagnosisUrl(response);
// System.out.println(diagnosisUrl);
}
}
private static AlipayConfig getAlipayConfig() {
String privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
String alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.setServerUrl("https://openapi.alipay.com/gateway.do");
alipayConfig.setAppId("<-- 请填写您的AppId,例如:2019091767145019 -->");
alipayConfig.setPrivateKey(privateKey);
alipayConfig.setFormat("json");
alipayConfig.setAlipayPublicKey(alipayPublicKey);
alipayConfig.setCharset("UTF-8");
alipayConfig.setSignType("RSA2");
return alipayConfig;
}
}using System;
using System.Collections.Generic;
using Aop.Api;
using Aop.Api.Request;
using Aop.Api.Response;
using Aop.Api.Domain;
using Aop.Api.Util;
namespace SdkDemoTest
{
public class AlipayTradeFastpayRefundQuery
{
public static void Main(string[] args)
{
// 初始化SDK
IAopClient alipayClient = new DefaultAopClient(GetAlipayConfig());
// 构造请求参数以调用接口
AlipayTradeFastpayRefundQueryRequest request = new AlipayTradeFastpayRefundQueryRequest();
AlipayTradeFastpayRefundQueryModel model = new AlipayTradeFastpayRefundQueryModel();
// 设置支付宝交易号
model.TradeNo = "2021081722001419121412730660";
// 设置商户订单号
model.OutTradeNo = "2014112611001004680073956707";
// 设置退款请求号
model.OutRequestNo = "HZ01RF001";
// 设置查询选项
List<String> queryOptions = new List<String>();
queryOptions.Add("refund_detail_item_list");
model.QueryOptions = queryOptions;
request.SetBizModel(model);
// 第三方代调用模式下请设置app_auth_token
// request.PutOtherTextParam("app_auth_token", "<-- 请填写应用授权令牌 -->");
AlipayTradeFastpayRefundQueryResponse response = alipayClient.Execute(request);
if(!response.IsError)
{
Console.WriteLine("调用成功");
}
else
{
Console.WriteLine("调用失败");
}
}
private static AlipayConfig GetAlipayConfig()
{
string privateKey = "<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->";
string alipayPublicKey = "<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->";
AlipayConfig alipayConfig = new AlipayConfig();
alipayConfig.ServerUrl = "https://openapi.alipay.com/gateway.do";
alipayConfig.AppId = "<-- 请填写您的AppId,例如:2019091767145019 -->";
alipayConfig.PrivateKey = privateKey;
alipayConfig.Format = "json";
alipayConfig.AlipayPublicKey = alipayPublicKey;
alipayConfig.Charset = "UTF-8";
alipayConfig.SignType = "RSA2";
return alipayConfig;
}
}
}<?php
require_once '../aop/AopClient.php';
require_once '../aop/AopCertClient.php';
require_once '../aop/AopCertification.php';
require_once '../aop/AlipayConfig.php';
require_once '../aop/request/AlipayTradeFastpayRefundQueryRequest.php';
// 初始化SDK
$alipayClient = new AopClient(getAlipayConfig());
// 构造请求参数以调用接口
$request = new AlipayTradeFastpayRefundQueryRequest();
$model = array();
// 设置支付宝交易号
$model['trade_no'] = "2021081722001419121412730660";
// 设置商户订单号
$model['out_trade_no'] = "2014112611001004680073956707";
// 设置退款请求号
$model['out_request_no'] = "HZ01RF001";
// 设置查询选项
$queryOptions = array();
$queryOptions[] = "refund_detail_item_list";
$model['query_options'] = $queryOptions;
$request->setBizContent(json_encode($model,JSON_UNESCAPED_UNICODE));
// 如果是第三方代调用模式,请设置app_auth_token(应用授权令牌)
$responseResult = $alipayClient->execute($request, null, "<-- 请填写应用授权令牌 -->", null);
$responseApiName = str_replace(".","_",$request->getApiMethodName())."_response";
$response = $responseResult->$responseApiName;
if(!empty($response->code)&&$response->code==10000){
echo("调用成功");
}
else{
echo("调用失败");
}
function getAlipayConfig()
{
$privateKey = '<-- 请填写您的应用私钥,例如:MIIEvQIBADANB ... ... -->';
$alipayPublicKey = '<-- 请填写您的支付宝公钥,例如:MIIBIjANBg... -->';
$alipayConfig = new AlipayConfig();
$alipayConfig->setServerUrl('https://openapi.alipay.com/gateway.do');
$alipayConfig->setAppId('<-- 请填写您的AppId,例如:2019091767145019 -->');
$alipayConfig->setPrivateKey($privateKey);
$alipayConfig->setFormat('json');
$alipayConfig->setAlipayPublicKey($alipayPublicKey);
$alipayConfig->setCharset('UTF-8');
$alipayConfig->setSignType('RSA2');
return $alipayConfig;
}公共响应参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 示例值 |
|---|---|---|---|---|---|
code | String | 必选 | - | 网关返回码,详见公共错误码 | 40004 |
msg | String | 必选 | - | 网关返回码描述,详见公共错误码 | Business Failed |
sub_code | String | 可选 | - | 业务返回码,参见具体 API 接口文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 可选 | - | 业务返回码描述,参见具体 API 接口文档 | 交易已被支付 |
sign | String | 必选 | - | 签名,详见签名文档 | DZXh8eeTuAHoY... |
业务响应参数
| 参数 | 类型 | 是否必选 | 最大长度 | 描述 | 注意事项/枚举值 | 示例值 |
|---|---|---|---|---|---|---|
trade_no | string | 特殊可选 | 64 | 支付宝交易号 | - | 2014112611001004680073956707 |
out_trade_no | string | 特殊可选 | 64 | 创建交易传入的商户订单号 | - | 20150320010101001 |
out_request_no | string | 特殊可选 | 64 | 本笔退款对应的退款请求号 | - | 20150320010101001 |
total_amount | price | 特殊可选 | 11 | 该笔退款所对应交易的订单金额,单位为元 | - | 100.20 |
refund_amount | price | 特殊可选 | 11 | 本次退款请求对应的退款金额,单位为元 | - | 12.33 |
refund_status | string | 特殊可选 | 32 | 退款状态 | REFUND_SUCCESS:退款处理成功。未返回该字段表示退款请求未收到或退款失败。如果退款查询发起时间早于退款时间,或距离退款发起时间太短,可能出现查询时尚未处理成功、后续又处理成功的情况,建议退款发起后间隔 10 秒以上再查询 | REFUND_SUCCESS |
响应示例
{
"alipay_trade_fastpay_refund_query_response": {
"code": "10000",
"msg": "Success",
"trade_no": "2014112611001004680073956707",
"out_trade_no": "20150320010101001",
"out_request_no": "20150320010101001",
"total_amount": "100.20",
"refund_amount": "12.33",
"refund_status": "REFUND_SUCCESS",
"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",
"ori_trans_out": "2088111111111111",
"ori_trans_in": "2088111111111111"
}
],
"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",
"deposit_back_info": {
"has_deposit_back": "true",
"dback_status": "S",
"dback_amount": "1.01",
"bank_ack_time": "2020-06-02 14:03:48",
"est_bank_receipt_time": "2020-06-02 14:03:48"
},
"refund_hyb_amount": "10.24",
"refund_charge_info_list": [
{
"refund_charge_fee": "0.01",
"switch_fee_rate": "0.01",
"charge_type": "trade",
"refund_sub_fee_detail_list": [
{
"refund_charge_fee": "0.10",
"switch_fee_rate": "0.01"
}
]
}
],
"deposit_back_info_list": [
{
"has_deposit_back": "true",
"dback_status": "S",
"dback_amount": "1.01",
"bank_ack_time": "2020-06-02 14:03:48",
"est_bank_receipt_time": "2020-06-02 14:03:48"
}
],
"refund_voucher_detail_list": [
{
"id": "2015102600073002039000002D5O",
"name": "XX超市5折优惠",
"type": "ALIPAY_FIX_VOUCHER",
"amount": "10.00",
"merchant_contribute": "9.00",
"other_contribute": "1.00",
"memo": "学生专用优惠",
"template_id": "20171030000730015359000EMZP0",
"other_contribute_detail": [
{
"contribute_type": "BRAND",
"contribute_amount": "8.00"
}
],
"purchase_buyer_contribute": "2.01",
"purchase_merchant_contribute": "1.03",
"purchase_ant_contribute": "0.82"
}
],
"pre_auth_cancel_fee": "12.45"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}{
"alipay_trade_fastpay_refund_query_response": {
"code": "20000",
"msg": "Service Currently Unavailable",
"sub_code": "isp.unknow-error",
"sub_msg": "系统繁忙"
},
"sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}公共错误码
业务错误码
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
ACQ.ENTERPRISE_PAY_BIZ_ERROR | 因公付业务异常 | 重新发起查询请求;如果多次重试后仍返回同样错误,请联系支付宝小二处理 |
ACQ.INVALID_PARAMETER | 参数无效 | 请根据接口返回的错误信息检查请求参数,修改后重新发起请求 |
ACQ.SYSTEM_ERROR | 系统错误 | 重新发起查询请求;如果多次重试后仍返回系统错误,请联系支付宝小二处理 |
ACQ.TRADE_NOT_EXIST | 交易不存在 | 请确认传入的外部订单号或交易号是否正确 |
TRADE_NOT_EXIST | 查询退款的交易不存在 | 确认交易号是否为正确的支付宝交易号,修改后重新查询 |