最新更新时间:2021.03.16 版本说明
订单发起退款的时候,可以对补贴成功的补差单发起回退。
• 补差回退以原补差单为依据,支持多次回退,申请回退总金额不能超过补差金额。
• 此接口采用同步处理模式,即在接收到商户请求后,会实时返回处理结果。
• 补差回退的前置条件是订单发生退款。
• 系统异常(如返回SYSTEM_ERROR),请使用相同参数稍后重新调用,请务必用原商户补差回退单号和原参数来重入此接口。
• 发起方维度=200QPS。
• 特约商户维度=200QPS。
• 订单维度1QPS。
适用对象:电商平台
请求URL:https://api.mch.weixin.qq.com/v3/ecommerce/subsidies/return
请求方式:POST
path指该参数为路径参数
query指该参数需在请求URL传参
body指该参数需在请求JSON传参
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
二级商户号 | sub_mchid | string[1,32] | 是 | body 补差的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109 |
商户补差回退单号 | out_order_no | string[1,64] | 是 | body原发起补差请求时使用的商户系统内部的补差单号。 示例值:P20150806125346 |
微信订单号 | transaction_id | string[1,64] | 是 | body 微信支付订单号。 示例值:4208450740201411110007820472 |
微信退款单号 | refund_id | string[1,64] | 否 | body 微信退款单号,微信支付系统退款返回的唯一标识。 用户零钱账户异常,无法在线发起退款时,此字段可以不传;其他情况下必传。 示例值:3008450740201411110007820472 |
补差回退金额 | amount | int | 是 | body 补差回退金额,单位为分,只能为整数,不能超过补差单的补差金额。 示例值:10 |
补差回退描述 | description | string[1,80] | 是 | body 补差回退描述,查询的时候原样带回。 示例值:测试备注 |
{
"sub_mchid": "1900000109",
"out_order_no": "P20150806125346",
"transaction_id": "4208450740201411110007820472",
"refund_id": "3008450740201411110007820472",
"amount": 10,
"description": "测试备注"
}
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
二级商户号 | sub_mchid | string[1,32] | 是 | 补差的电商平台二级商户,填写微信支付分配的商户号。 示例值:1900000109 |
微信订单号 | transaction_id | string[1,64] | 是 | 微信支付订单号。 示例值: 4208450740201411110007820472 |
微信补差回退单号 | subsidy_refund_id | string[1,64] | 是 | 微信补差回退单号,微信补差回退系统返回的唯一标识。 示例值: 3008450740201411110007820472 |
微信退款单号 | refund_id | string[1,64] | 是 | 微信退款单号,微信支付系统退款返回的唯一标识。 示例值: 3008450740201411110007820472 |
商户补差回退单号 | out_order_no | string[1,64] | 是 | 商户系统内部的补差回退单号,在商户系统内部唯一,只能是数字、大小写字母_-|*@ ,同一补差回退单号多次请求等同一次。 示例值:P20150806125346 |
补差回退金额 | amount | int | 是 | 补差回退金额 示例值:10 |
补差回退描述 | description | string[1,80] | 是 | 补差回退描述 示例值:测试备注 |
补差回退结果 | result | string[1,16] | 是 | 补差回退结果,枚举值: SUCCESS:成功 FAIL:失败 示例值:SUCCESS |
补差回退完成时间 | success_time | string[1,32] | 是 | 补差回退完成时间,遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.sss表示时分秒毫秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日13点29分35秒。 示例值:2015-05-20T13:29:35.120+08:00 |
{
"sub_mchid": "1900000109",
"transaction_id": "4208450740201411110007820472",
"subsidy_refund_id": "3008450740201411110007820472",
"refund_id": "3008450740201411110007820472",
"out_order_no": "P20150806125346",
"amount": 10,
"description": "测试备注",
"result": "SUCCESS",
"success_time": "2015-05-20T13:29:35.120+08:00"
}
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
500 | SYSTEM_ERROR | 系统错误 | 系统异常,请使用相同参数稍后重新调用 |
400 | PARAM_ERROR | 参数错误 | 请使用正确的参数重新调用 |
400 | INVALID_REQUEST | 参数错误 | 请使用正确的参数重新调用 |
429 | FREQUENCY_LIMITED | 频率限制 | 请降低频率后重试 |