最新更新時(shí)間：2023.03.10 版本說(shuō)明
服務(wù)商下單的時(shí)候帶上補(bǔ)差標(biāo)識(shí)，微信訂單支付成功并結(jié)算完成后，發(fā)起分賬前，調(diào)用該接口進(jìn)行補(bǔ)差。
? 電商平臺(tái)下單時(shí)傳入補(bǔ)差金額，詳見(jiàn)【合單下單API】文檔中補(bǔ)差字段說(shuō)明。
? 在發(fā)起分賬前，調(diào)用該接口進(jìn)行補(bǔ)差。
? 補(bǔ)差金額需要和下單的時(shí)候傳入的補(bǔ)差金額保持一致(發(fā)生用戶退款時(shí)可以小于下單時(shí)的補(bǔ)差金額，須有對(duì)應(yīng)的微信退款單號(hào)，任意一筆該訂單的微信退款單)。
? 該接口支持重入，請(qǐng)求參數(shù)相同只會(huì)扣款一次，重入有效期180天。
? 系統(tǒng)異常（如返回SYSTEM_ERROR），請(qǐng)使用相同參數(shù)稍后重新調(diào)用，請(qǐng)務(wù)必用原參數(shù)來(lái)重入此接口，如更換金額重試，可能會(huì)導(dǎo)致重復(fù)扣款，系統(tǒng)會(huì)在1天后回退到原賬戶。
接口頻率：
? 發(fā)起方維度=500QPS。
? 特約商戶維度=500QPS。
? 訂單維度1QPS。
適用對(duì)象：電商平臺(tái)
請(qǐng)求URL：https://api.mch.weixin.qq.com/v3/ecommerce/subsidies/create
請(qǐng)求方式：POST
path指該參數(shù)為路徑參數(shù)
query指該參數(shù)需在請(qǐng)求URL傳參
body指該參數(shù)需在請(qǐng)求JSON傳參
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
二級(jí)商戶號(hào) |
sub_mchid | string[1,32] | 是 | body 補(bǔ)差的電商平臺(tái)二級(jí)商戶，填寫微信支付分配的商戶號(hào)。 示例值：1900000109 |
| 微信訂單號(hào) | transaction_id | string[1,64] | 是 | body 微信支付訂單號(hào)。 示例值： 4208450740201411110007820472 |
| 商戶補(bǔ)差單號(hào) | out_subsidy_no | string[1,64] | 是 | body 商戶系統(tǒng)內(nèi)部的補(bǔ)差單號(hào)，在商戶系統(tǒng)內(nèi)部唯一，同一補(bǔ)差單號(hào)多次請(qǐng)求等同一次。 示例值：P20150806125347 |
| 補(bǔ)差金額 | amount | int | 是 | body 補(bǔ)差金額，單位為分，只能為整數(shù)，不能超過(guò)下單時(shí)候的最大補(bǔ)差金額。 注意：?jiǎn)喂P訂單最高補(bǔ)差金額為10000元 示例值：10 |
| 補(bǔ)差描述 | description | string[1,80] | 是 | body 補(bǔ)差備注描述，查詢的時(shí)候原樣帶回。 示例值：測(cè)試備注 |
| 微信退款單號(hào) | refund_id | string[1,64] | 否 | body 微信退款單號(hào)，微信支付系統(tǒng)退款返回的唯一標(biāo)識(shí)，當(dāng)補(bǔ)差金額小于下單時(shí)候的金額，該字段必填 示例值：3008450740201411110007820472 |
{
?"sub_mchid": "1900000109",
?"transaction_id": "4208450740201411110007820472",
?"amount": 10,
?"description": "測(cè)試備注",
?"refund_id": "3008450740201411110007820472",
"out_subsidy_no": "P20150806125347"
}
| 參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 二級(jí)商戶號(hào) | sub_mchid | string[1,32] | 是 | 補(bǔ)差的電商平臺(tái)二級(jí)商戶，填寫微信支付分配的商戶號(hào)。 示例值：1900000109 |
| 微信訂單號(hào) | transaction_id | string[1,64] | 是 | 微信支付訂單號(hào)。 示例值： 4208450740201411110007820472 |
| 微信補(bǔ)差單號(hào) | subsidy_id | string[1,64] | 是 | 微信補(bǔ)差單號(hào)，微信支付系統(tǒng)返回的唯一標(biāo)識(shí)。 示例值： 3008450740201411110007820472 |
| 補(bǔ)差描述 | description | string[1,80] | 是 | 補(bǔ)差描述 示例值：滿減補(bǔ)差活動(dòng) |
| 補(bǔ)差金額 | amount | int | 是 | 補(bǔ)差金額 示例值：10 |
| 補(bǔ)差單結(jié)果 | result | string[1,16] | 是 | 補(bǔ)差單狀態(tài)，枚舉值： SUCCESS：補(bǔ)差成功 FAIL：補(bǔ)差失敗 REFUND：已全額回退 示例值：SUCCESS |
| 補(bǔ)差完成時(shí)間 | success_time | string[1,32] | 是 | 補(bǔ)貼完成時(shí)間，遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss:sss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開(kāi)頭，HH:mm:ss:sss表示時(shí)分秒毫秒，TIMEZONE表示時(shí)區(qū)（+08:00表示東八區(qū)時(shí)間，領(lǐng)先UTC 8小時(shí)，即北京時(shí)間）。例如：2015-05-20T13:29:35+08:00表示，北京時(shí)間2015年5月20日13點(diǎn)29分35秒。 示例值： 2015-05-20T13:29:35.120+08:00 |
{
?"sub_mchid": "1900000109",
?"transaction_id": "4208450740201411110007820472",
?"subsidy_id": "3008450740201411110007820472",
?"description": "滿減補(bǔ)差活動(dòng)",
?"amount": 10,
?"result": "PROCESSING",
?"success_time": "2015-05-20T13:29:35.120+08:00"
}
| 狀態(tài)碼 | 錯(cuò)誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 500 | SYSTEM_ERROR | 系統(tǒng)錯(cuò)誤 | 系統(tǒng)異常，請(qǐng)使用相同參數(shù)稍后重新調(diào)用 |
| 400 | PARAM_ERROR | 參數(shù)錯(cuò)誤 | 請(qǐng)使用正確的參數(shù)重新調(diào)用 |
| 400 | INVALID_REQUEST | 參數(shù)錯(cuò)誤 | 請(qǐng)使用正確的參數(shù)重新調(diào)用 |
| 429 | FREQUENCY_LIMITED | 頻率限制 | 請(qǐng)降低頻率后重試 |