微信批次單號查單接口。商戶可以通過該接口查詢轉(zhuǎn)賬批次單以及指定狀態(tài)的轉(zhuǎn)賬明細(xì)單。返回消息中包含微信批次單號、批次狀態(tài)、批次類型、轉(zhuǎn)賬總金額、轉(zhuǎn)賬總筆數(shù)、成功金額、失敗金額等信息。
# 接口說明
支持商戶:
【普通商戶】
請求方式:
【GET】/v3/transfer/batches/batch-id/{batch_id}
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認(rèn)證 生成認(rèn)證信息
- Accept 必填 string請設(shè)置為
application/json
Header HTTP頭參數(shù)
- batch_id 必填 string(64)【微信批次單號】 微信批次單號,微信商家轉(zhuǎn)賬系統(tǒng)返回的唯一標(biāo)識
Path 路徑參數(shù)
- need_query_detail 必填 boolean【是否查詢轉(zhuǎn)賬明細(xì)單】 true-是;false-否,默認(rèn)否。商戶可選擇是否查詢指定狀態(tài)的轉(zhuǎn)賬明細(xì)單,當(dāng)轉(zhuǎn)賬批次單狀態(tài)為“FINISHED”(已完成)時,才會返回滿足條件的轉(zhuǎn)賬明細(xì)單
- offset 選填 integer【請求資源起始位置】 該次請求資源的起始位置。返回的明細(xì)是按照設(shè)置的明細(xì)條數(shù)進(jìn)行分頁展示的,一次查詢可能無法返回所有明細(xì),我們使用該參數(shù)標(biāo)識查詢開始位置,默認(rèn)值為0
- limit 選填 integer【最大資源條數(shù)】 該次請求可返回的最大明細(xì)條數(shù),最小20條,最大100條,不傳則默認(rèn)20條。不足20條按實際條數(shù)返回
- detail_status 選填 string(32)【明細(xì)狀態(tài)】 WAIT_PAY: 待確認(rèn)。待商戶確認(rèn), 符合免密條件時, 系統(tǒng)會自動扭轉(zhuǎn)為轉(zhuǎn)賬中
ALL:全部。需要同時查詢轉(zhuǎn)賬成功、失敗和待確認(rèn)的明細(xì)單
SUCCESS:轉(zhuǎn)賬成功
FAIL:轉(zhuǎn)賬失敗。需要確認(rèn)失敗原因后,再決定是否重新發(fā)起對該筆明細(xì)單的轉(zhuǎn)賬(并非整個轉(zhuǎn)賬批次單)
當(dāng)need_query_detail為true時該字段必填
Query 查詢參數(shù)
請求示例
GET
# 應(yīng)答參數(shù)
- transfer_batch 必填 TransferBatchGet【轉(zhuǎn)賬批次單】 轉(zhuǎn)賬批次單基本信息
- 屬性
- transfer_detail_list 選填 array[TransferDetailCompact]【轉(zhuǎn)賬明細(xì)單列表】 當(dāng)批次狀態(tài)為“FINISHED”(已完成),且成功查詢到轉(zhuǎn)賬明細(xì)單時返回。包括微信明細(xì)單號、明細(xì)狀態(tài)信息
- 屬性
200OK
應(yīng)答示例
200 OK
# 錯誤碼
# 公共錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯誤 | 請根據(jù)錯誤提示正確傳入?yún)?shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務(wù)錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | INVALID_REQUEST | 請求參數(shù)符合參數(shù)格式,但不符合業(yè)務(wù)規(guī)則 | 查詢單據(jù)超過限定時間(30天),可以嘗試通過商戶平臺預(yù)約下載 |
404 | NOT_FOUND | 記錄不存在 | 查詢的轉(zhuǎn)賬批次單不存在 |
500 | SYSTEM_ERROR | 系統(tǒng)錯誤 | 5開頭的狀態(tài)碼都為系統(tǒng)問題,請使用相同參數(shù)稍后重新調(diào)用 |