# 门店运费退款

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：intracity_store_refund

该接口可以将门店指定运力的运费余额退还，如果门店有在途的配送订单，需要等配送完成或者取消配送订单之后才可以操作退款；操作退款后，退款金额五分钟内到账。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/cgi-bin/express/intracity/storerefund?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：51

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "wx_store_id",
    "类型": "string",
    "必填": "否",
    "说明": "微信门店编号（pay_mode = PAY_MODE_STORE时必传，不传pay_mode时必传wx_store_id）",
    "枚举": "-"
  },
  {
    "参数名": "pay_mode",
    "类型": "string",
    "必填": "否",
    "说明": "充值/扣费主体，不传pay_mode默认pay_mode=PAY_MODE_STORE",
    "枚举": "枚举值"
  },
  {
    "参数名": "service_trans_id",
    "类型": "string",
    "必填": "是",
    "说明": "运力ID",
    "枚举": "-"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码（0:请求成功，其他：请求失败）"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误描述"
  },
  {
    "参数名": "appid",
    "类型": "string",
    "说明": "小程序appid"
  },
  {
    "参数名": "wx_store_id",
    "类型": "string",
    "说明": "微信门店编号"
  },
  {
    "参数名": "refund_amount",
    "类型": "number",
    "说明": "退款金额（单位：分）"
  }
]
```

## 4. 枚举信息

### Body.pay_mode `Enum`

充值/扣费主体，不传pay_mode默认pay_mode=PAY_MODE_STORE

```json
[
  {
    "枚举值": "PAY_MODE_STORE",
    "描述": "门店"
  },
  {
    "枚举值": "PAY_MODE_APP",
    "描述": "小程序"
  },
  {
    "枚举值": "PAY_MODE_COMPONENT",
    "描述": "服务商"
  }
]
```

## 5. 注意事项

本接口无特殊注意事项

## 6. 代码示例

请求示例

```json
{
    "wx_store_id":"4000000000000042001",
    "service_trans_id":"SFTC"
}
```

返回示例

```json
{
    "appid":"wx539e0b4872f196d1",
    "wx_store_id":"4000000000000042001"，
    "refund_amount":3000
}
```

## 7. 错误码

此接口没有特殊错误码，可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

## 8. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。