商户进件
特约商户进件
基础支付
JSAPI支付
APP支付
H5支付
Native支付
小程序支付
合单支付
付款码支付
经营能力
支付即服务
点金计划
行业方案
电商收付通(商户进件)
电商收付通(普通支付)
电商收付通(合单支付)
电商收付通(分账)
电商收付通(补差)
电商收付通(退款)
电商收付通(余额查询)
电商收付通(商户提现)
电商收付通(跨境付款)
电商收付通(下载账单)
智慧商圈
微信支付分停车服务
营销工具
代金券
商家券
委托营销
支付有礼
小程序发券插件
H5发券
图片上传(营销专用)
现金红包
资金应用
分账
连锁品牌分账
风险合规
商户开户意愿确认
消费者投诉2.0
商户违规通知回调
其他能力
图片上传
视频上传
微信支付平台证书

营销补差回退API

最新更新时间:2021.04.13 版本说明


商户通过该接口可回退补差款

接口说明

适用对象:服务商

请求URL:https://api.mch.weixin.qq.com/v3/marketing/busifavor/subsidy/return-receipts

请求方式:POST

前置条件:进行补差的微信支付订单发起了退款,且回退金额不得超过补差金额

是否支持幂等:


path 指该参数为路径参数

query 指该参数为URL参数

body 指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
商家券批次号 stock_id string[1, 20] body由微信支付生成,调用创建商家券API成功时返回的唯一批次ID 仅支持“满减券”和“折扣券”的批次,“换购券”批次不支持
示例值:128888000000001
商家券Code coupon_code string[1, 128] body券的唯一标识。
在WECHATPAY_MODE的券Code模式下,商家券Code是由微信支付生成的唯一ID;
在MERCHANT_UPLOAD、MERCHANT_API的券Code模式下,商家券Code是由商户上传或指定,在批次下保证唯一;
示例值:ABCD12345678
微信支付订单号 transaction_id string[28, 32] body微信支付下单支付成功返回的订单号
示例值:4200000913202101152566792388
微信支付退款单号 refund_id string[28, 32] body微信支付退款单号
示例值:50100506732021010105138718375
原营销补差扣款商户号 payer_merchant string[1, 32] body原营销补差扣款商户号,即回退资金收款商户号
示例值:1900000001
原营销补差入账商户号 payee_merchant string[1, 32] body原营销补差入账商户号,即回退资金扣款商户号
示例值:1900000002
补差回退金额 amount int body本次补差回退金额,单位为分。单个券Code回退总金额不能超过补差金额
示例值:100
补差回退描述 description string[1, 1024] body回退备注描述,查询的时候原样带回
示例值:20210115DESCRIPTION
业务请求唯一单号 out_subsidy_return_no string[1, 128] body商户侧需保证唯一性。可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号
示例值:subsidy-abcd-12345678

请求示例


{
  "stock_id": "128888000000001",
  "coupon_code": "ABCD12345678",
  "transaction_id": "4200000913202101152566792388",
  "refund_id": "50100506732021010105138718375",
  "payer_merchant": "1900000001",
  "payee_merchant": "1900000002",
  "amount": 100,
  "description": "20210115DESCRIPTION",
  "out_subsidy_return_no": "subsidy-abcd-12345678"
}

{
JAVA示例代码
}

返回参数

参数名 变量 类型[长度限制] 必填 描述
补差回退单号 subsidy_return_receipt_id string[28, 32] 补差回退唯一单号,由微信支付生成,仅在补差回退成功后有返回
示例值:2120200119165100000000000001
商家券批次号 stock_id string[1, 20] 由微信支付生成,调用创建商家券API成功时返回的唯一批次ID
示例值:128888000000001
商家券Code coupon_code string[1, 128] 券的唯一标识
示例值:ABCD12345678
微信支付订单号 transaction_id string[28, 32] 微信支付下单支付成功返回的订单号
示例值:4200000913202101152566792388
微信支付退款单号 refund_id string[28, 32] 微信支付退款单号
示例值:50100506732021010105138718375
原营销补差扣款商户号 payer_merchant string[1, 32] 原营销补差扣款商户号,即回退资金收款商户号
示例值:1900000001
原营销补差入账商户号 payee_merchant string[1, 32] 原营销补差入账商户号,即回退资金扣款商户号
示例值:1900000002
补差回退金额 amount int 本次补差回退金额,单位为分。单个券Code回退总金额不能超过补差金额
示例值:100
补差回退描述 description string[1, 1024] 回退备注描述,查询的时候原样带回
示例值:20210115DESCRIPTION
补差回退单据状态 status string[1, 32] 补差付款单据状态
SUCCESS:补差回退成功
FAIL:补差回退失败
示例值:SUCCESS
补差回退失败原因 fail_reason string[1, 1024] 仅在补差回退失败时,返回告知对应失败的原因
INSUFFICIENT_BALANCE:扣款商户余额不足
RISK_BLOCK:商户风控拦截
OTHER:其他原因
示例值:INSUFFICIENT_BALANCE
补差回退完成时间 return_done_time string[28, 32] 仅在补差回退成功时,返回完成时间。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值:2021-01-20T10:29:35+08:00
补差付款单号 subsidy_receipt_id string[28, 32] 此次补差回退操作对应的补差付款单号
示例值:1120200119165100000000000001
业务请求唯一单号 out_subsidy_return_no string[1, 128] 商户侧需保证唯一性。可包含英文字母,数字,|,_,*,-等内容,不允许出现其他不合法符号
示例值:subsidy-abcd-12345678
补差回退发起时间 return_create_time string[28, 32] 补差回退单据创建时间。遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35.+08:00表示,北京时间2015年5月20日 13点29分35秒。
示例值:2021-01-20T10:29:35+08:00

返回示例


{
  "subsidy_return_receipt_id": "2120200119165100000000000001",
  "stock_id": "128888000000001",
  "coupon_code": "ABCD12345678",
  "transaction_id": "4200000913202101152566792388",
  "refund_id": "50100506732021010105138718375",
  "payer_merchant": "1900000001",
  "payee_merchant": "1900000002",
  "amount": 100,
  "description": "20210115DESCRIPTION",
  "status": "SUCCESS",
  "return_done_time": "2021-01-20T10:29:35.120+08:00",
  "subsidy_receipt_id": "1120200119165100000000000001",
  "out_subsidy_return_no": "subsidy-abcd-12345678",
  "return_create_time": "2021-01-20T10:29:35.120+08:00"
}
                    

http://2323weixin.qq.com
                    

错误码公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 查看具体错误信息,调整参数
500 SYSTEM_ERROR 系统错误 多为网络超时引起,请使用相同参数稍后重新调用
401 SIGN_ERROR 签名验证失败 请检查签名参数和方法是否都符合签名算法要求
429 FREQUENCY_LIMITED 频率限制 调用太频繁,请降低调用接口频率
404 RESOURCE_NOT_EXISTS 券不存在 请检查批次id和券Code是否填写正确


技术咨询

文档反馈