最新更新時(shí)間:2021.03.16 版本說(shuō)明
訂單發(fā)起退款的時(shí)候,可以對(duì)補(bǔ)貼成功的補(bǔ)差單發(fā)起回退。
? 補(bǔ)差回退以原補(bǔ)差單為依據(jù),支持多次回退,申請(qǐng)回退總金額不能超過(guò)補(bǔ)差金額。
? 此接口采用同步處理模式,即在接收到商戶請(qǐng)求后,會(huì)實(shí)時(shí)返回處理結(jié)果。
? 補(bǔ)差回退的前置條件是訂單發(fā)生退款。
? 系統(tǒng)異常(如返回SYSTEM_ERROR),請(qǐng)使用相同參數(shù)稍后重新調(diào)用,請(qǐng)務(wù)必用原商戶補(bǔ)差回退單號(hào)和原參數(shù)來(lái)重入此接口。
? 發(fā)起方維度=200QPS。
? 特約商戶維度=200QPS。
? 訂單維度1QPS。
適用對(duì)象:電商平臺(tái)
請(qǐng)求URL:https://api.mch.weixin.qq.com/v3/ecommerce/subsidies/return
請(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í)商戶,填寫(xiě)微信支付分配的商戶號(hào)。 示例值:1900000109 |
商戶補(bǔ)差回退單號(hào) | out_order_no | string[1,64] | 是 | body原發(fā)起補(bǔ)差請(qǐng)求時(shí)使用的商戶系統(tǒng)內(nèi)部的補(bǔ)差單號(hào)。 示例值:P20150806125346 |
微信訂單號(hào) | transaction_id | string[1,64] | 是 | body 微信支付訂單號(hào)。 示例值:4208450740201411110007820472 |
微信退款單號(hào) | refund_id | string[1,64] | 否 | body 微信退款單號(hào),微信支付系統(tǒng)退款返回的唯一標(biāo)識(shí)。 用戶零錢(qián)賬戶異常,無(wú)法在線發(fā)起退款時(shí),此字段可以不傳;其他情況下必傳。 示例值:3008450740201411110007820472 |
補(bǔ)差回退金額 | amount | int | 是 | body 補(bǔ)差回退金額,單位為分,只能為整數(shù),不能超過(guò)補(bǔ)差單的補(bǔ)差金額。 示例值:10 |
補(bǔ)差回退描述 | description | string[1,80] | 是 | body 補(bǔ)差回退描述,查詢的時(shí)候原樣帶回。 示例值:測(cè)試備注 |
{
?"sub_mchid": "1900000109",
?"out_order_no": "P20150806125346",
?"transaction_id": "4208450740201411110007820472",
?"refund_id": "3008450740201411110007820472",
?"amount": 10,
?"description": "測(cè)試備注"
}
參數(shù)名 | 變量 | 類型[長(zhǎng)度限制] | 必填 | 描述 |
---|---|---|---|---|
二級(jí)商戶號(hào) | sub_mchid | string[1,32] | 是 | 補(bǔ)差的電商平臺(tái)二級(jí)商戶,填寫(xiě)微信支付分配的商戶號(hào)。 示例值:1900000109 |
微信訂單號(hào) | transaction_id | string[1,64] | 是 | 微信支付訂單號(hào)。 示例值: 4208450740201411110007820472 |
微信補(bǔ)差回退單號(hào) | subsidy_refund_id | string[1,64] | 是 | 微信補(bǔ)差回退單號(hào),微信補(bǔ)差回退系統(tǒng)返回的唯一標(biāo)識(shí)。 示例值: 3008450740201411110007820472 |
微信退款單號(hào) | refund_id | string[1,64] | 是 | 微信退款單號(hào),微信支付系統(tǒng)退款返回的唯一標(biāo)識(shí)。 示例值: 3008450740201411110007820472 |
商戶補(bǔ)差回退單號(hào) | out_order_no | string[1,64] | 是 | 商戶系統(tǒng)內(nèi)部的補(bǔ)差回退單號(hào),在商戶系統(tǒng)內(nèi)部唯一,只能是數(shù)字、大小寫(xiě)字母_-|*@ ,同一補(bǔ)差回退單號(hào)多次請(qǐng)求等同一次。 示例值:P20150806125346 |
補(bǔ)差回退金額 | amount | int | 是 | 補(bǔ)差回退金額 示例值:10 |
補(bǔ)差回退描述 | description | string[1,80] | 是 | 補(bǔ)差回退描述 示例值:測(cè)試備注 |
補(bǔ)差回退結(jié)果 | result | string[1,16] | 是 | 補(bǔ)差回退結(jié)果,枚舉值: SUCCESS:成功 FAIL:失敗 示例值: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_refund_id": "3008450740201411110007820472",
?"refund_id": "3008450740201411110007820472",
?"out_order_no": "P20150806125346",
?"amount": 10,
?"description": "測(cè)試備注",
?"result": "SUCCESS",
?"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)降低頻率后重試 |