alipay.trade.page.refund(统一收单退款页面接口) 在线调试(沙箱环境)

当交易发生之后一段时间内,由于买家或者卖家的原因需要退款时,卖家可以通过退款页面接口将支付款退还给买家,支付宝将在收到退款请求并且验证成功之后,按照退款规则将支付款按原路退到买家帐号上。 目前该接口用于信用退款场景,通过biz_type指定信用退款。支付宝页面会提示用户退款成功或失败,退款处理完成后支付宝回跳到商户请求指定的回跳地址页面。

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.trade.page.refund
format String 40 仅支持JSON JSON
return_url String 256 HTTP/HTTPS开头字符串 https://m.alipay.com/Gk8NF23
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 支付宝交易号,和商户订单号不能同时为空 2014112611001004680073956707
out_trade_no String 特殊可选 64 订单支付时传入的商户订单号,不能和 trade_no同时为空。 20150320010101001
out_request_no String 必选 64 标识一次退款请求,同一笔交易多次退款需要保证唯一。 HZ01RF001
refund_amount Price 必选 9 需要退款的金额,该金额不能大于订单金额,单位为元,支持两位小数。 200.12
biz_type String 可选 32 退款场景。
信用退款传CREDIT_REFUND;
CREDIT_REFUND
refund_reason String 可选 256 退款的原因说明 正常退款
operator_id String 可选 30 商户的操作员编号 OP001
store_id String 可选 32 商户的门店编号 NJ_S_001
terminal_id String 可选 32 商户的终端编号 NJ_T_001
extend_params RefundExtendParams 可选 业务扩展参数
credit_service_id String 可选 64 信用服务ID 2019031400000000000000369900
credit_category_id String 可选 64 芝麻外部类目 REFUND

响应参数

参数 类型 是否必填 最大长度 描述 示例值
trade_no String 必填 64 支付宝交易号 2014112611001004680073956707
out_trade_no String 必填 64 商户订单号 20150320010101001
out_request_no String 必填 64 退款请求号 HZ01RF001
refund_amount Price 必填 9 本次退款请求金额 200.12

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayTradePageRefundRequest request = new AlipayTradePageRefundRequest();
request.setBizContent("{" +
"\"trade_no\":\"2014112611001004680073956707\"," +
"\"out_trade_no\":\"20150320010101001\"," +
"\"out_request_no\":\"HZ01RF001\"," +
"\"refund_amount\":200.12," +
"\"biz_type\":\"CREDIT_REFUND\"," +
"\"refund_reason\":\"正常退款\"," +
"\"operator_id\":\"OP001\"," +
"\"store_id\":\"NJ_S_001\"," +
"\"terminal_id\":\"NJ_T_001\"," +
"\"extend_params\":{" +
"\"credit_service_id\":\"2019031400000000000000369900\"," +
"\"credit_category_id\":\"REFUND\"" +
"    }" +
"  }");
AlipayTradePageRefundResponse response = alipayClient.pageExecute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_trade_page_refund_response": {
        "code": "10000",
        "msg": "Success",
        "trade_no": "2014112611001004680073956707",
        "out_trade_no": "20150320010101001",
        "out_request_no": "HZ01RF001",
        "refund_amount": 200.12
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
onlineServer