alipay.trade.refund.apply (异步退款受理接口)

商户通过此接口提交异步退款请求,支付宝受理后,将会异步进行退款处理,失败后定时重试,主要用于商户首笔请求是退款,因为资金不足导致退款失败的场景。

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
out_trade_no String 特殊可选 64 订单支付时传入的商户订单号,不能和 trade_no同时为空 20150320010101001
trade_no String 特殊可选 64 支付宝交易号,和商户订单号不能同时为空 2014112611001004680073956707
refund_amount Price 必须 9 需要退款的金额,该金额不能大于订单金额,单位为元,支持两位小数 200.12
refund_reason String 可选 256 退款的原因说明 正常退款
out_request_no String 可选 64 标识一次退款请求,同一笔交易多次退款需要保证唯一,如需部分退款,则此参数必传。 HZ01RF001
operator_id String 可选 30 商户的操作员编号 OP001
store_id String 可选 32 商户的门店编号 NJ_S_001
terminal_id String 可选 32 商户的终端编号 NJ_T_001

公共响应参数

参数 类型 是否必填 最大长度 描述 示例值
code String - 网关返回码,详见文档 40004
msg String - 网关返回码描述,详见文档 Business Failed
sub_code String - 业务返回码,详见文档 ACQ.TRADE_HAS_SUCCESS
sub_msg String - 业务返回码描述,详见文档 交易已被支付
sign String - 签名,详见文档 DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数 类型 是否必填 最大长度 描述 示例值

请求示例

  • JAVA
  • .NET
  • PHP
  • HTTP请求源码
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayTradeRefundApplyRequest request = new AlipayTradeRefundApplyRequest();
request.setBizContent("{" +
"\"out_trade_no\":\"20150320010101001\"," +
"\"trade_no\":\"2014112611001004680073956707\"," +
"\"refund_amount\":200.12," +
"\"refund_reason\":\"正常退款\"," +
"\"out_request_no\":\"HZ01RF001\"," +
"\"operator_id\":\"OP001\"," +
"\"store_id\":\"NJ_S_001\"," +
"\"terminal_id\":\"NJ_T_001\"" +
"  }");
AlipayTradeRefundApplyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_trade_refund_apply_response":{
		"msg":"Success",
		"code":"10000"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
ACQ.SYSTEM_ERROR 系统繁忙 请使用相同的参数再次调用
ACQ.INVALID_PARAMETER 参数无效 请求参数有错,重新检查请求后,再调用退款
ACQ.REFUND_AMT_NOT_EQUAL_TOTAL 退款金额超限 检查退款金额是否正确,重新修改请求后,重新发起退款
ACQ.TRADE_NOT_EXIST 交易不存在 检查请求中的交易号和商户订单号是否正确,确认后重新发起
ACQ.TRADE_HAS_FINISHED 交易已完结 该交易已完结,不允许进行退款,确认请求的退款的交易信息是否正确
ACQ.TRADE_STATUS_ERROR 交易状态非法 查询交易,确认交易是否已经付款
ACQ.DISCORDANT_REPEAT_REQUEST 不一致的请求 检查该退款号是否已退过款或更换退款号重新发起请求
ACQ.REASON_TRADE_REFUND_FEE_ERR 退款金额无效 检查退款请求的金额是否正确
ACQ.TRADE_NOT_ALLOW_REFUND 当前交易不允许退款 检查当前交易的状态是否为交易成功状态以及签约的退款属性是否允许退款,确认后,重新发起请求

公共错误码

返回
顶部