# 退款查询 refund_query


退款查询接口，用于开发者查询某笔退款的详细信息，包括退款状态、退款金额、退款时间等。支持通过交易订单号、开发者退款单号或平台退款单号进行查询。

## 使用限制

- 调用频次限制：请遵守平台默认 QPS 限制，避免高频调用。
- 查询时需提供 order_id、out_refund_no、refund_id 三者中的至少一个，否则查询将失败。

## 接口说明

- 业务场景：适用于开发者在发起退款后，主动查询退款处理状态及详细信息。常见场景包括：退款结果页展示、退款状态轮询、退款对账等。通过 order_id 查询时将返回该订单下所有退款单信息。
- 前提条件：调用方需已完成应用创建，并通过 get_client_token 接口获取到有效的应用级 AccessToken。
- 注意事项：
- order_id、out_refund_no、refund_id 三者为三选一关系，建议优先使用 refund_id 精确查询单笔退款。
- 通过 order_id 查询时，返回的 refund_list 中可能包含多条退款记录（部分退款场景）。

## 基本信息

| 名称 | 描述 |
|-|-|
| HTTP Path | /api/trade_basic/v1/developer/refund_query |
| HTTP Method | POST |
| 权限要求 | - 需要申请权限 - 申请路径：豆包开放平台控制台 > 应用详情 > 能力 > 支付权限 - 需要应用级 AccessToken |

## 请求头

| 名称 | 类型 | 必填 | 描述 |
|-|-|-|-|
| content-type | string | 是 | 固定值 "application/json" |
| x-DB-AccessToken | string | 是 | 调用 get_client_token 接口生成的应用级访问凭证 |

## 请求参数

### Body

| 名称 | 类型 | 是否必填 | 描述 | 示例值 |
|-|-|-|-|-|
| order_id | string | 否（三选一） | 交易订单号，order_id、out_refund_no、refund_id 三选一 | 70214322040407612\*\*\* |
| out_refund_no | string | 否（三选一） | 开发者侧退款单号，三选一 | ext_refund_1 |
| refund_id | string | 否（三选一） | 交易系统的退款单号，三选一 | 80214322040407612\*\*\* |

## 请求示例

cURL

```shell
curl -X POST 'https://api.doubao-dev.com/api/trade_basic/v1/developer/refund_query' \
  -H 'content-type: application/json' \
  -H 'x-DB-AccessToken: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqn******' \
  -d '{
    "out_refund_no": "ext_refund_1"
  }'
```

Go

```go
package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    url := "https://api.doubao-dev.com/api/trade_basic/v1/developer/refund_query"
    reqBody := map[string]string{
        "out_refund_no": "ext_refund_1",
    }
    jsonData, _ := json.Marshal(reqBody)

    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
    req.Header.Set("content-type", "application/json")
    req.Header.Set("x-DB-AccessToken", "clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqn******")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    defer resp.Body.Close()
    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
}
```

Java

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class RefundQuery {
    public static void main(String[] args) throws Exception {
        String url = "https://api.doubao-dev.com/api/trade_basic/v1/developer/refund_query";
        String requestBody = "{\"out_refund_no\":\"ext_refund_1\"}";

        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
                .uri(URI.create(url))
                .header("content-type", "application/json")
                .header("x-DB-AccessToken", "clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqn******")
                .POST(HttpRequest.BodyPublishers.ofString(requestBody))
                .build();

        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}
```

Node.js

```javascript
const axios = require('axios');

async function refundQuery() {
    const url = 'https://api.doubao-dev.com/api/trade_basic/v1/developer/refund_query';
    const headers = {
        'content-type': 'application/json',
        'x-DB-AccessToken': 'clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqn******'
    };
    const data = {
        out_refund_no: 'ext_refund_1'
    };

    try {
        const response = await axios.post(url, data, { headers });
        console.log(response.data);
    } catch (error) {
        console.error('Error:', error.message);
    }
}

refundQuery();
```

## 响应参数

| 名称 | 类型 | 是否必填 | 描述 | 示例值 |
|-|-|-|-|-|
| code | int32 | 是 | 错误码，0 表示成功，非 0 表示失败 | 0 |
| msg | string | 是 | 错误提示 | success |
| log_id | string | 是 | 请求日志 ID，用于问题排查时提供给技术支持 | 2022092115392201020812109511046 |
| data | object | 否 | 退款查询结果对象，仅在查询成功时返回 | 见下方 data 字段说明 |

### data 字段说明

| 名称 | 类型 | 是否必填 | 描述 | 示例值 |
|-|-|-|-|-|
| refund_list | RefundDetail[] | 是 | 退款信息列表 | 见下方 RefundDetail 结构说明 |

### RefundDetail 结构

| 名称 | 类型 | 是否必填 | 描述 | 示例值 |
|-|-|-|-|-|
| order_id | string | 是 | 系统订单号，开放平台生成的订单号 | 70214322040407612\*\*\* |
| refund_id | string | 是 | 系统退款单号，开放平台生成的退款单号 | 80214322040407612\*\*\* |
| out_refund_no | string | 是 | 开发者退款单号 | ext_refund_1 |
| refund_status | string | 是 | 退款状态，枚举值：PROCESSING - 退款中；SUCCESS - 已退款；FAIL - 退款失败 | SUCCESS |
| refund_total_amount | string | 是 | 退款总金额，单位：分 | 1000 |
| refund_create_time | string | 是 | 退款创建时间，13 位毫秒时间戳 | 1671994501000 |
| refund_finish_time | string | 否 | 退款完成时间，13 位毫秒时间戳，仅已退款状态才有 | 1672994501000 |

## 响应示例

### 正常示例

```json
{
    "data": {
        "refund_list": [
            {
                "refund_create_time": "1671994501000",
                "refund_finish_time": "1672994501000",
                "refund_status": "SUCCESS",
                "refund_total_amount": "1000",
                "order_id": "70214322040407612***",
                "out_refund_no": "ext_refund_1",
                "refund_id": "80214322040407612***"
            }
        ]
    },
    "code": 0,
    "msg": "success",
    "log_id": "2022092115392201020812109511046"
}
```

### 异常示例

```json
{
    "code": 500020006,
    "msg": "Refund not found",
    "log_id": "2022092115392201020812109511047"
}
```

## 错误码

### 通用错误码

| 错误码 | 错误名称 | 描述（msg） | 排查建议 |
|-|-|-|-|
| 500000000 | OApiCommonInternalError | internal error | 系统内部错误，请稍后重试；若持续出现请携带 log_id 联系技术支持 |
| 500000001 | OApiCommonDeveloperParamError | Parameter error | 请求参数错误，请检查 order_id、out_refund_no、refund_id 是否至少传入一个，以及参数格式是否正确 |
| 500000002 | OApiCommonDeveloperRateLimitError | Rate limit error | 请求触发限流，请降低调用频率后重试 |

### 交易模块错误码

| 错误码 | 错误名称 | 描述（msg） | 是否稳定 | 排查建议 |
|-|-|-|-|-|
| 500020005 | OApiTradeOrderNotFoundError | Order not found | 是 | 订单不存在，请确认 order_id 是否正确，订单是否已成功创建 |
| 500020006 | OApiTradeRefundNotFoundError | Refund not found | 是 | 退款单不存在，请确认 out_refund_no 或 refund_id 是否正确，退款是否已成功发起 |