退款订单
API 说明
使用此 API 通过商户订单号对现有订单进行退款。
Settlement 通道重要提示:如果使用 settlement 通道,需确保原订单创建时已传递支付地址(payAddress
参数)。没有此地址将无法完成退款。
接口信息
- 接口 URL:
POST /v2/refundOrder
- Content-Type:
application/json
- 认证: 需要在 Header 中传递
app-id
和签名验证
请求头参数
参数 | 类型 | 是否必需 | 描述 |
---|---|---|---|
app-id | string | 是 | 商户应用 ID |
Content-Type | string | 是 | application/json |
请求参数
参数 | 类型 | 是否必需 | 描述 |
---|---|---|---|
sign | string | 是 | 请求签名 |
outTradeNo | string | 是 | 要退款的商户订单号 |
payChannel | string | 是 | 原订单使用的支付渠道 |
响应参数
成功响应
{
"code": 0,
"data": {},
"msg": "success"
}
错误响应
{
"code": 1001,
"data": {},
"msg": "Order not found"
}
错误代码
代码 | 描述 |
---|---|
0 | 成功 |
1001 | 订单未找到 |
1002 | 订单状态不允许退款 |
1003 | 退款失败 |
重要说明
- 订单状态:只有已支付成功的订单才能申请退款
- 退款金额:目前仅支持全额退款
- 退款时效:退款到账时间取决于支付渠道,一般在 1-3 个工作日内完成
- 多次退款:同一笔订单仅支持一次退款操作