適用對象：直連商戶
請求URL：https://api.mch.weixin.qq.com/v3/marketing/busifavor/subsidy/return-receipts
請求方式：POST
前置條件：進(jìn)行補(bǔ)差的微信支付訂單發(fā)起了退款，且回退金額不得超過補(bǔ)差金額
是否支持冪等：是
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 |
| 微信支付退款單號 | refund_id | string[28, 32] | 是 | body微信支付退款單號 示例值：50100506732021010105138718375 |
| 原營銷補(bǔ)差扣款商戶號 | payer_merchant | string[1, 32] | 是 | body原營銷補(bǔ)差扣款商戶號，即回退資金收款商戶號 示例值：1900000001 |
| 原營銷補(bǔ)差入賬商戶號 | payee_merchant | string[1, 32] | 是 | body原營銷補(bǔ)差入賬商戶號，即回退資金扣款商戶號 示例值：1900000002 |
| 補(bǔ)差回退金額 | amount | int | 是 | body本次補(bǔ)差回退金額，單位為分。單個券Code回退總金額不能超過補(bǔ)差金額 示例值：100 |
| 補(bǔ)差回退描述 | description | string[1, 1024] | 是 | body回退備注描述，查詢的時候原樣帶回 示例值：20210115DESCRIPTION |
| 業(yè)務(wù)請求唯一單號 | out_subsidy_return_no | string[1, 128] | 是 | body商戶側(cè)需保證唯一性。可包含英文字母，數(shù)字，｜，_，*，-等內(nèi)容，不允許出現(xiàn)其他不合法符號 示例值：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"
}
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 補(bǔ)差回退單號 | subsidy_return_receipt_id | string[28, 32] | 否 | 補(bǔ)差回退唯一單號，由微信支付生成，僅在補(bǔ)差回退成功后有返回 示例值：2120200119165100000000000001 |
| 商家券批次號 | 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 |
| 微信支付退款單號 | refund_id | string[28, 32] | 是 | 微信支付退款單號 示例值：50100506732021010105138718375 |
| 原營銷補(bǔ)差扣款商戶號 | payer_merchant | string[1, 32] | 是 | 原營銷補(bǔ)差扣款商戶號，即回退資金收款商戶號 示例值：1900000001 |
| 原營銷補(bǔ)差入賬商戶號 | payee_merchant | string[1, 32] | 是 | 原營銷補(bǔ)差入賬商戶號，即回退資金扣款商戶號 示例值：1900000002 |
| 補(bǔ)差回退金額 | amount | int | 是 | 本次補(bǔ)差回退金額，單位為分。單個券Code回退總金額不能超過補(bǔ)差金額 示例值：100 |
| 補(bǔ)差回退描述 | description | string[1, 1024] | 是 | 回退備注描述，查詢的時候原樣帶回 示例值：20210115DESCRIPTION |
| 補(bǔ)差回退單據(jù)狀態(tài) | status | string[1, 32] | 是 | 補(bǔ)差付款單據(jù)狀態(tài) SUCCESS：補(bǔ)差回退成功 FAIL：補(bǔ)差回退失敗 示例值：SUCCESS |
| 補(bǔ)差回退失敗原因 | fail_reason | string[1, 1024] | 否 | 僅在補(bǔ)差回退失敗時，返回告知對應(yīng)失敗的原因 INSUFFICIENT_BALANCE：扣款商戶余額不足 RISK_BLOCK：商戶風(fēng)控?cái)r截 OTHER：其他原因 示例值：INSUFFICIENT_BALANCE |
| 補(bǔ)差回退完成時間 | return_done_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 |
| 補(bǔ)差付款單號 | subsidy_receipt_id | string[28, 32] | 是 | 此次補(bǔ)差回退操作對應(yīng)的補(bǔ)差付款單號 示例值：1120200119165100000000000001 |
| 業(yè)務(wù)請求唯一單號 | out_subsidy_return_no | string[1, 128] | 是 | 商戶側(cè)需保證唯一性。可包含英文字母，數(shù)字，｜，_，*，-等內(nèi)容，不允許出現(xiàn)其他不合法符號 示例值：subsidy-abcd-12345678 |
| 補(bǔ)差回退發(fā)起時間 | return_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_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"
}
| 狀態(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是否填寫正確 |