# 门店运费退款
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:intracity_store_refund
该接口可以将门店指定运力的运费余额退还,如果门店有在途的配送订单,需要等配送完成或者取消配送订单之后才可以操作退款;操作退款后,退款金额五分钟内到账。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/cgi-bin/express/intracity/storerefund?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:51
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 | 枚举 |
|---|---|---|---|---|
| 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
| 参数名 | 类型 | 说明 |
|---|---|---|
| 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
| 枚举值 | 描述 |
|---|---|
| PAY_MODE_STORE | 门店 |
| PAY_MODE_APP | 小程序 |
| PAY_MODE_COMPONENT | 服务商 |
# 5. 注意事项
本接口无特殊注意事项
# 6. 代码示例
请求示例
{
"wx_store_id":"4000000000000042001",
"service_trans_id":"SFTC"
}
返回示例
{
"appid":"wx539e0b4872f196d1",
"wx_store_id":"4000000000000042001",
"refund_amount":3000
}
# 7. 错误码
此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
# 8. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。