# 下載接口說明
微信支付按天提供交易賬單文件,商戶可以通過該接口獲取賬單文件的下載地址。文件內包含交易相關的金額、時間、營銷等信息,供商戶核對訂單、退款、銀行到賬等情況。
注意:
- 微信側未成功下單的交易不會出現(xiàn)在對賬單中。支付成功后撤銷的交易會出現(xiàn)在對賬單中,跟原支付單訂單號一致;
- 對賬單中涉及金額的字段單位為“元”;
- 對賬單接口只能下載三個月以內的賬單;
- 小微商戶不單獨提供對賬單下載,如有需要,可聯(lián)系發(fā)起交易的服務商。
# 接口說明
支持商戶:
【普通服務商】【平臺商戶】
請求方式:
【GET】/v3/bill/tradebill
請求域名:
【主域名】
https://api.mch.weixin.qq.com
使用該域名將訪問就近的接入點【備域名】
https://api2.mch.weixin.qq.com
使用該域名將訪問異地的接入點 ,指引點擊查看
# 請求參數(shù)
- Authorization 必填 string請參考 簽名認證 生成認證信息
- Accept 必填 string請設置為
application/json
Header HTTP頭參數(shù)
- bill_date 必填 string(10)【賬單日期】 賬單日期,格式y(tǒng)yyy-MM-DD,僅支持三個月內的賬單下載申請。
- sub_mchid 選填 string(12)【子商戶號】 若商戶是直連商戶:
* 無需填寫該字段
若商戶是服務商:
* 不填則默認返回服務商下的交易或退款數(shù)據
* 如需下載某個子商戶下的交易或退款數(shù)據,則該字段必填 - bill_type 選填 string【賬單類型】 賬單類型,不填則默認是ALL
可選取值:ALL
: 返回當日所有訂單信息(不含充值退款訂單)SUCCESS
: 返回當日成功支付的訂單(不含充值退款訂單)REFUND
: 返回當日退款訂單(不含充值退款訂單)RECHARGE_REFUND
: 返回當日充值退款訂單ALL_SPECIAL
: 返回個性化賬單當日所有訂單信息SUC_SPECIAL
: 返回個性化賬單當日成功支付的訂單REF_SPECIAL
: 返回個性化賬單當日退款訂單
- tar_type 選填 string【壓縮類型】 壓縮類型,不填則以不壓縮的方式返回數(shù)據流
可選取值:GZIP
: GZIP格式壓縮,返回格式為.gzip的壓縮包賬單
Query 查詢參數(shù)
請求示例
GET
# 應答參數(shù)
- hash_type 必填 string【哈希類型】 哈希類型
可選取值:SHA1
: Secure Hash Algorithm 1
- hash_value 必填 string(1024)【哈希值】 原始賬單(gzip需要解壓縮)的摘要值,用于校驗文件的完整性
- download_url 必填 string(2048)【下載地址】 供下一步請求賬單文件的下載地址,該地址5min內有效。
200OK
應答示例
200 OK
# 錯誤碼
# 公共錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | PARAM_ERROR | 參數(shù)錯誤 | 請根據錯誤提示正確傳入參數(shù) |
400 | INVALID_REQUEST | HTTP 請求不符合微信支付 APIv3 接口規(guī)則 | 請參閱 接口規(guī)則 |
401 | SIGN_ERROR | 驗證不通過 | 請參閱 簽名常見問題 |
500 | SYSTEM_ERROR | 系統(tǒng)異常,請稍后重試 | 請稍后重試 |
# 業(yè)務錯誤碼
狀態(tài)碼 | 錯誤碼 | 描述 | 解決方案 |
---|---|---|---|
400 | INVALID_REQUEST | 參數(shù)錯誤 | 請檢查bill_date,并重新調用 |
400 | INVALID_REQUEST | 參數(shù)錯誤 | 請檢查sub_mchid,并重新調用 |
400 | NO_STATEMENT_EXIST | 賬單文件不存在 | 請檢查當前商戶號是否在指定日期有交易或退款發(fā)生 |
400 | STATEMENT_CREATING | 賬單生成中 | 請先檢查當前商戶號在指定日期內是否有成功的交易或退款,若有,則在T+1日上午10點后再重新下載 |
403 | NO_AUTH | 權限異常(無該子商戶賬單的權限) | 請使用正確的sub_mchid再重新調用 |
403 | NO_AUTH | 權限異常,小微商戶不單獨提供對賬單下載 | 可以不傳sub_mchid,以獲取服務商下全量商戶(包括小微商戶和非小微商戶)的對賬單 |
429 | FREQUENCY_LIMITED | 請求過于頻繁 | 請降低調用頻率 |