请求补差 API
服务商下单的时候带上补差标识, 微信订单支付成功并结算完成后, 发起分账前, 调用该口进行补差。
注意
- 电商平台下单时传入补差金额, 详见【合单下单 API】文档中补差字段说明。
- 在发起分账前, 调用该接口进行补差。
- 补差金额需要和下单的时候传入的补差金额保持一致(发生用户退款时可以小于下单时的补差金额, 须有对应的微信退款单号, 任意一笔该订单的微信退款单)。
- 该接口支持重入, 请求参数相同只会扣款一次, 重入有效期 180 天。
- 系统异常(如返回 SYSTEM_ERROR）, 请使用相同参数稍后重新调用, 请务必用原参数来重入此接口, 如更换金额重试, 可能会导致重复扣款, 系统会在 1 天后回退到原账户。
接口说明
适用对象: 电商平台
请求 URL: https://api.mch.weixin.qq.com/v3/ecommerce/subsidies/create
请求方式: POST
接口规则: https://wechatpay-api.gitbook.io/wechatpay-api-v3
path 指该参数需在请求 URL 传参query 指该参数需在请求 JSON 传参
请求参数
| 变量 | 类型 | 必填 | 参数名/描述/示例值 |
|---|---|---|---|
| sub_mchid | string(32) | 是 | query 二级商户号 补差的电商平台二级商户, 填写微信支付分配的商户号。 |
| 1900000109 | |||
| transaction_id | string(64) | 是 | query 微信订单号 微信支付订单号。 |
| 4208450740201411110007820472 | |||
| amount | int | 是 | query 补差金额, 单位为分, 只能为整数, 不能超过下单时候的最大补差金额。 |
| 10 | |||
| description | string(80) | 是 | query 补差描述, 查询的时候原样带回。 |
| 测试备注 | |||
| refund_id | string(64) | 否 | query 微信退款单号, 微信系统退款返回的唯一标识, 当补差金额小于下单时候的金额必选带上微信退款单号。 |
| 3008450740201411110007820472 |
请求示例
{
"sub_mchid": "1900000109",
"transaction_id": "4208450740201411110007820472",
"amount": 10,
"description": "测试备注",
"refund_id": "3008450740201411110007820472"
}
返回参数
| 变量 | 类型 | 必填 | 参数名/描述/示例值 |
|---|---|---|---|
| sub_mchid | string(32) | 是 | 二级商户号 补差的电商平台二级商户, 填写微信支付分配的商户号。 |
| 1900000109 | |||
| transaction_id | string(64) | 是 | 微信订单号 微信支付订单号。 |
| 4208450740201411110007820472 | |||
| subsidy_id | string(64) | 是 | 微信补差单号 微信补差单号, 微信系统返回的唯一标识。 |
| 3008450740201411110007820472 | |||
| description | string(80) | 是 | 补差描述 |
| 满减补差活动 | |||
| amount | int | 否 | 补差金额 |
| 10 | |||
| result | enum | 是 | 补差单结果 补差单状态, 枚举值:SUCCESS: 补差成功 FAIL: 补差失败 REFUND: 已全额回退 |
| SUCCESS | |||
| success_time | string(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_id": "3008450740201411110007820472",
"description": "满减补差活动",
"amount": 10,
"result": "PROCESSING",
"success_time": "2015-05-20T13:29:35.120+08:00"
}
错误码公共错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 500 | SYSTEM_ERROR | 系统错误 | 系统异常, 请使用相同参数稍后重新调用 |
| 400 | PARAM_ERROR | 参数错误 | 请使用正确的参数重新调用 |
| 400 | INVALID_REQUEST | 参数错误 | 请使用正确的参数重新调用 |
| 429 | FREQUENCY_LIMITED | 频率限制 | 请降低频率后重试 |
Feedback
Was this page helpful?
很高兴听到！ 请告诉我们，我们如何才能改善.
很遗憾听到这个消息。 请告诉我们，我们如何才能改善.
最后修改 April 12, 2020: 整理文档 (f36b91e)