Asbamboo Openpay API
版本: v1.0

发起退款trade.refund

发起一笔交易的退款,一个交易可以有多次退款,退款总的金额不能超过交易金额

请求地址

演示请求地址 http://demo.asbamboo.com/openpay-example/public/index.php/api

说明: 如果请求地址(url),浏览器不信任它,使用测试工具时,无法正常获取响应结果。所以,请先在浏览器受访问一下请求地址(url),确定请求地址(url)是受信任的。


公共请求参数

字段 类型 取值范围 必须 默认值 说明
api_name string api列表中支持的名称 必须 trade.refund api名称
format string json json 表示需要接口返回什么格式的数据,仅支持json
version string api列表中支持的版本 api版本。如果没传,表示使用最新的版本

请求参数

字段 类型 取值范围 必须 默认值 说明
in_trade_no string length(32) 当out_trade_no为空时必填 交易编号(聚合系统内的)
out_refund_no string length(45) 必须 退款编号(对接应用的)
out_trade_no string length(45) 当in_trade_no为空时必填 交易编号(对接应用的)
refund_fee int 必填 退款金额 1.不能大于交易金额 - 已经退款金额
third_part json() 可选 [] 第三方支付平台的参数,请自行查阅相关支付平台相关文档中的参数列表

请求示例

curl http://demo.asbamboo.com/openpay-example/public/index.php/api \
-d api_name=trade.refund \
-d format=json \
-d in_trade_no= \
-d out_refund_no=20211204065756680 \
-d out_trade_no=2018101310270023 \
-d refund_fee=1 \
-d third_part=%7B%22limit_pay%22%3A%22no_credit%22%7D \
-d version=v1.0 \

响应参数

字段名 类型 取值范围 说明
code string 状态码。成功时返回'0'。
data data 响应数据信息 见响应信息data具体字段
message string 状态说明。成功时是"success", 错误时返回与code对应的错误信息

响应信息data具体字段

字段名 类型 取值范围 说明
in_refund_no string length(32) 退款编号 与退款请求的编号对应的聚合平台生成的退款编号 是一个全局唯一的编号
in_trade_no string length(32) 交易编号 与支付请求的编号对应的聚合平台生成的交易编号 是一个全局唯一的编号
out_refund_no string length(45) 对接应用的退款编号
out_trade_no string length(45) 对接应用的交易编号
refund_fee int 退款金额
refund_pay_ymdhis string date('YYYY-mm-dd HH:ii:ss') 退款的付款时间
refund_status string REQUEST[正在请求] SUCCESS[申请成功] FAILED[申请失败] 退款申请状态

响应示例