最新更新時間：2021.04.13 版本說明
該API主要用于商戶營銷補(bǔ)貼場景，支持基于單張券進(jìn)行不同商戶賬戶間的資金補(bǔ)差，從而提升財(cái)務(wù)結(jié)算、資金利用效率。具體可參考操作文檔
適用對象：直連商戶
請求URL：https://api.mch.weixin.qq.com/v3/marketing/busifavor/subsidy/pay-receipts
請求方式：POST
前置條件：商家必須核銷了商家券且發(fā)起了微信支付收款
是否支持冪等：是
path 指該參數(shù)為路徑參數(shù)
query 指該參數(shù)為URL參數(shù)
body 指該參數(shù)需在請求JSON傳參
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 商家券批次號 | stock_id | string[1, 20] | 是 | body由微信支付生成，調(diào)用創(chuàng)建商家券API成功時返回的唯一批次ID 僅支持“滿減券”，“換購券”批次不支持 示例值：128888000000001 |
| 商家券Code | coupon_code | string[1, 128] | 是 | body券的唯一標(biāo)識。 在WECHATPAY_MODE的券Code模式下，商家券Code是由微信支付生成的唯一ID； 在MERCHANT_UPLOAD、MERCHANT_API的券Code模式下，商家券Code是由商戶上傳或指定，在批次下保證唯一； 示例值：ABCD12345678 |
| 微信支付訂單號 | transaction_id | string[28, 32] | 是 | body微信支付下單支付成功返回的訂單號 示例值：4200000913202101152566792388 |
| 營銷補(bǔ)差扣款商戶號 | payer_merchant | string[1, 32] | 是 | body營銷補(bǔ)差扣款商戶號 注：補(bǔ)差扣款商戶號 = 制券商戶號 或 補(bǔ)差扣款商戶號 = 歸屬商戶號 示例值：1900000001 |
| 營銷補(bǔ)差入賬商戶號 | payee_merchant | string[1, 32] | 是 | body營銷補(bǔ)差入賬商戶號 注：補(bǔ)差入帳商戶號 = 券歸屬商戶號 或者和 券歸屬商戶號有連鎖品牌關(guān)系 示例值：1900000002 |
| 補(bǔ)差付款金額 | amount | int | 是 | body單位為分，單筆訂單補(bǔ)差金額不得超過券的優(yōu)惠金額，最高補(bǔ)差金額為5000元 > 券的優(yōu)惠金額定義： 滿減券：滿減金額即為優(yōu)惠金額 換購券：不支持 示例值：100 |
| 補(bǔ)差付款描述 | description | string[1, 1024] | 是 | body付款備注描述，查詢的時候原樣帶回 示例值：20210115DESCRIPTION |
| 業(yè)務(wù)請求唯一單號 | out_subsidy_no | string[1, 128] | 是 | body商戶側(cè)需保證唯一性。可包含英文字母，數(shù)字，｜，_，*，-等內(nèi)容，不允許出現(xiàn)其他不合法符號 示例值：subsidy-abcd-12345678 |
{
"stock_id": "128888000000001",
"coupon_code": "ABCD12345678",
"transaction_id": "4200000913202101152566792388",
"payer_merchant": "1900000001",
"payee_merchant": "1900000002",
"amount": 100,
"description": "20210115DESCRIPTION",
"out_subsidy_no": "subsidy-abcd-12345678"
}
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 補(bǔ)差付款單號 | subsidy_receipt_id | string[28, 32] | 是 | 補(bǔ)差付款唯一單號，由微信支付生成，僅在補(bǔ)差付款成功后有返回 示例值：1120200119165100000000000001 |
| 商家券批次號 | stock_id | string[1, 20] | 是 | 由微信支付生成，調(diào)用創(chuàng)建商家券API成功時返回的唯一批次ID 示例值：128888000000001 |
| 商家券Code | coupon_code | string[1, 128] | 是 | 券的唯一標(biāo)識 示例值：ABCD12345678 |
| 微信支付訂單號 | transaction_id | string[28, 32] | 是 | 微信支付下單支付成功返回的訂單號 示例值：4200000913202101152566792388 |
| 營銷補(bǔ)差扣款商戶號 | payer_merchant | string[1, 32] | 是 | 營銷補(bǔ)差扣款商戶號 示例值：1900000001 |
| 營銷補(bǔ)差入賬商戶號 | payee_merchant | string[1, 32] | 是 | 營銷補(bǔ)差入賬商戶號 示例值：1900000002 |
| 補(bǔ)差付款金額 | amount | int | 是 | 單位為分，單筆訂單補(bǔ)差金額不得超過券的優(yōu)惠金額，最高補(bǔ)差金額為5000元 > 券的優(yōu)惠金額定義： 滿減券：滿減金額即為優(yōu)惠金額 換購券：不支持 示例值：100 |
| 補(bǔ)差付款描述 | description | string[1, 1024] | 是 | 付款備注描述，查詢的時候原樣帶回 示例值：20210115DESCRIPTION |
| 補(bǔ)差付款單據(jù)狀態(tài) | status | string[1, 32] | 是 | 補(bǔ)差付款單據(jù)狀態(tài) ACCEPTED：受理成功 SUCCESS：補(bǔ)差補(bǔ)款成功 FAIL：補(bǔ)差付款失敗 RETURNING：補(bǔ)差回退中 PARTIAL_RETURN：補(bǔ)差部分回退 FULL_RETURN：補(bǔ)差全額回退 示例值：SUCCESS |
| 補(bǔ)差付款失敗原因 | fail_reason | string[1, 1024] | 否 | 僅在補(bǔ)差付款失敗時，返回告知對應(yīng)失敗的原因 INSUFFICIENT_BALANCE：扣款商戶余額不足 NOT_INCOMESPLIT_ORDER：非分賬訂單 EXCEED_SUBSIDY_AMOUNT_QUOTA：超出訂單補(bǔ)差總額限制 EXCEED_SUBSIDY_COUNT_QUOTA：超出訂單補(bǔ)差總數(shù)限制 OTHER：其他原因 示例值：INSUFFICIENT_BALANCE |
| 補(bǔ)差付款完成時間 | success_time | string[28, 32] | 否 | 僅在補(bǔ)差付款成功時，返回完成時間。遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss表示時分秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領(lǐng)先UTC 8小時，即北京時間）。例如：2015-05-20T13:29:35.+08:00表示，北京時間2015年5月20日 13點(diǎn)29分35秒。 示例值：2021-01-20T10:29:35+08:00 |
| 業(yè)務(wù)請求唯一單號 | out_subsidy_no | string[1, 128] | 是 | 商戶側(cè)需保證唯一性。可包含英文字母，數(shù)字，｜，_，*，-等內(nèi)容，不允許出現(xiàn)其他不合法符號 示例值：subsidy-abcd-12345678 |
| 補(bǔ)差付款發(fā)起時間 | create_time | string[28, 32] | 否 | 補(bǔ)差付款單據(jù)創(chuàng)建時間。遵循rfc3339標(biāo)準(zhǔn)格式，格式為yyyy-MM-DDTHH:mm:ss+TIMEZONE，yyyy-MM-DD表示年月日，T出現(xiàn)在字符串中，表示time元素的開頭，HH:mm:ss表示時分秒，TIMEZONE表示時區(qū)（+08:00表示東八區(qū)時間，領(lǐng)先UTC 8小時，即北京時間）。例如：2015-05-20T13:29:35.+08:00表示，北京時間2015年5月20日 13點(diǎn)29分35秒。 示例值：2021-01-20T10:29:35+08:00 |
{
"subsidy_receipt_id": "1120200119165100000000000001",
"stock_id": "128888000000001",
"coupon_code": "ABCD12345678",
"transaction_id": "4200000913202101152566792388",
"payer_merchant": "1900000001",
"payee_merchant": "1900000002",
"amount": 100,
"description": "20210115DESCRIPTION",
"status": "SUCCESS",
"success_time": "2021-01-20T10:29:35.120+08:00",
"out_subsidy_no": "subsidy-abcd-12345678",
"create_time": "2021-01-20T10:29:35.120+08:00"
}
| 狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 參數(shù)錯誤 | 查看具體錯誤信息，調(diào)整參數(shù) |
| 500 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 多為網(wǎng)絡(luò)超時引起，請使用相同參數(shù)稍后重新調(diào)用 |
| 401 | SIGN_ERROR | 簽名驗(yàn)證失敗 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
| 429 | FREQUENCY_LIMITED | 頻率限制 | 調(diào)用太頻繁，請降低調(diào)用接口頻率 |
| 404 | RESOURCE_NOT_EXISTS | 券不存在 | 請檢查批次id和券Code是否填寫正確 |
| 404 | ORDERNOTEXIST | 訂單不存在 | 請檢查微信支付訂單號是否填寫正確 |
| 403 | ORDER_NOT_READY | 訂單未支付完成 | 請檢查微信支付訂單是否已完成支付 |
| 403 | USER_ERROR | 訂單支付用戶不是券擁有者 | 請檢查微信支付訂單的支付用戶與券的歸屬用戶是否同一個人 |
| 403 | NOAUTH | 補(bǔ)差付款方不合法 | 補(bǔ)差付款方必須為API的調(diào)用商戶 |
| 無權(quán)限操作 | 無權(quán)限調(diào)用此API | ||
| 403 | ACCOUNTERROR | 商戶資金賬戶不滿足補(bǔ)差要求 | 補(bǔ)差付款方或收款方資金賬戶未升級，請升級后重試 |
| 403 | NOTENOUGH | 出款賬戶余額不足 | 請給出款商戶賬戶充值后重試 |
| 500 | ERROR | 此補(bǔ)差流程已結(jié)束 | 此補(bǔ)差流程已結(jié)束，請勿重新發(fā)起 |
| 403 | RULELIMIT | 補(bǔ)差金額超出上限 | 補(bǔ)差金額不得超過券面額 |
| 微信支付訂單商戶單號與券核銷商戶單號不一致 | 請確認(rèn)商戶單號一致后，再次發(fā)起 | ||
| 銀行機(jī)構(gòu)支付訂單不允許補(bǔ)差 | 只允許普通商戶訂單或服務(wù)商訂單發(fā)起補(bǔ)差，請更換微信支付訂單號 | ||
| 券已被其他微信支付訂單補(bǔ)差 | 其他微信支付訂單已經(jīng)對這張券發(fā)起了補(bǔ)差，請核實(shí) | ||
| 該微信支付訂單在另一流程已發(fā)起了補(bǔ)差 | 請勿同一時間用不同的out_subsidy_no針對同一筆微信支付訂單&同一張券進(jìn)行補(bǔ)差，請稍候另一流程結(jié)束后再重試 | ||
| 訂單交易商戶與券歸屬方?jīng)]有任何關(guān)系 | 請確認(rèn)訂單交易商戶與券歸屬方是否有品牌連鎖關(guān)系 | ||
| 該批次的券不允許進(jìn)行補(bǔ)差 | 該券批次未打上“否允許營銷補(bǔ)差”的標(biāo)識，請核實(shí) | ||
| 此補(bǔ)差訂單不是分賬類型訂單 | 當(dāng)前只支持微信支付的分賬訂單進(jìn)行補(bǔ)差 | ||
| 超出訂單可補(bǔ)差總額限制 | 單筆微信支付訂單可給多張券進(jìn)行補(bǔ)差，總額不得超過1萬元 | ||
| 超出訂單可補(bǔ)差總數(shù)限制 | 單筆微信支付訂單可給多張券進(jìn)行補(bǔ)差，總次數(shù)不得超過20次 | ||
| 券未核銷 | 券當(dāng)前未被核銷，請核實(shí) | ||
| 券類型不合法 | 當(dāng)前僅支持滿減券類型進(jìn)行補(bǔ)差 |